Merge pull request #699 from ParsePlatform/nlutsenko.generics.analytics

Add nullability annotations and generic types to AnalyticsController.

Author: nlutsenko

Parse/Internal/Analytics/Controller/PFAnalyticsController.h

@@ -12,9 +12,12 @@
 #import <Parse/PFConstants.h>
 
 #import "PFDataProvider.h"
+#import "PFMacros.h"
 
 @class BFTask PF_GENERIC(__covariant BFGenericType);
 
+NS_ASSUME_NONNULL_BEGIN
+
 @interface PFAnalyticsController : NSObject
 
 @property (nonatomic, weak, readonly) id<PFEventuallyQueueProvider> dataSource;
@@ -42,8 +45,8 @@
 
  @return `BFTask` with result set to `@YES`.
  */
-- (BFTask *)trackAppOpenedEventAsyncWithRemoteNotificationPayload:(NSDictionary *)payload
-                                                     sessionToken:(NSString *)sessionToken;
+- (BFTask PF_GENERIC(PFVoid)*)trackAppOpenedEventAsyncWithRemoteNotificationPayload:(nullable NSDictionary *)payload
+                                                                       sessionToken:(nullable NSString *)sessionToken;
 
 /**
  Tracks the occurrence of a custom event with additional dimensions.
@@ -54,8 +57,10 @@
 
  @return `BFTask` with result set to `@YES`.
  */
-- (BFTask *)trackEventAsyncWithName:(NSString *)name
-                         dimensions:(NSDictionary *)dimensions
-                       sessionToken:(NSString *)sessionToken;
+- (BFTask PF_GENERIC(PFVoid)*)trackEventAsyncWithName:(NSString *)name
+                                           dimensions:(nullable NSDictionary PF_GENERIC(NSString *, NSString *)*)dimensions
+                                         sessionToken:(nullable NSString *)sessionToken;
 
 @end
+
+NS_ASSUME_NONNULL_END

Parse/Internal/Analytics/Controller/PFAnalyticsController.m

@@ -48,8 +48,8 @@ + (instancetype)controllerWithDataSource:(id<PFEventuallyQueueProvider>)dataSour
 #pragma mark - Track Event
 ///--------------------------------------
 
-- (BFTask *)trackAppOpenedEventAsyncWithRemoteNotificationPayload:(NSDictionary *)payload
-                                                     sessionToken:(NSString *)sessionToken {
+- (BFTask PF_GENERIC(PFVoid)*)trackAppOpenedEventAsyncWithRemoteNotificationPayload:(nullable NSDictionary *)payload
+                                                                       sessionToken:(nullable NSString *)sessionToken {
     @weakify(self);
     return [[BFTask taskFromExecutor:[BFExecutor defaultPriorityBackgroundExecutor] withBlock:^id{
         @strongify(self);
@@ -62,12 +62,12 @@ - (BFTask *)trackAppOpenedEventAsyncWithRemoteNotificationPayload:(NSDictionary
         PFRESTCommand *command = [PFRESTAnalyticsCommand trackAppOpenedEventCommandWithPushHash:pushDigest
                                                                                    sessionToken:sessionToken];
         return [self.eventuallyQueue enqueueCommandInBackground:command];
-    }] continueWithSuccessResult:@YES];
+    }] continueWithSuccessResult:nil];
 }
 
-- (BFTask *)trackEventAsyncWithName:(NSString *)name
-                         dimensions:(NSDictionary *)dimensions
-                       sessionToken:(NSString *)sessionToken {
+- (BFTask PF_GENERIC(PFVoid)*)trackEventAsyncWithName:(NSString *)name
+                                           dimensions:(nullable NSDictionary PF_GENERIC(NSString *, NSString *)*)dimensions
+                                         sessionToken:(nullable NSString *)sessionToken {
     PFParameterAssert([[name stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]] length],
                       @"A name for the custom event must be provided.");
 
@@ -86,7 +86,7 @@ - (BFTask *)trackEventAsyncWithName:(NSString *)name
                                                                              dimensions:encodedDimensions
                                                                            sessionToken:sessionToken];
         return [self.eventuallyQueue enqueueCommandInBackground:command];
-    }] continueWithSuccessResult:@YES];
+    }] continueWithSuccessResult:nil];
 }
 
 ///--------------------------------------

Tests/Unit/AnalyticsControllerTests.m

@@ -60,15 +60,23 @@ - (void)testTrackEventWithInvalidParameters {
     id dataSource = [self dataSourceMockWithCommandResult:nil];
     PFAnalyticsController *controller = [PFAnalyticsController controllerWithDataSource:dataSource];
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wnonnull"
     PFAssertThrowsInvalidArgumentException([controller trackEventAsyncWithName:nil dimensions:nil sessionToken:nil]);
+#pragma clang diagnostic pop
+
     PFAssertThrowsInvalidArgumentException([controller trackEventAsyncWithName:@" " dimensions:nil sessionToken:nil]);
     PFAssertThrowsInvalidArgumentException([controller trackEventAsyncWithName:@"\n" dimensions:nil sessionToken:nil]);
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wobjc-literal-conversion"
     PFAssertThrowsInvalidArgumentException([controller trackEventAsyncWithName:@"f"
                                                                     dimensions:@{ @2 : @"five" }
                                                                   sessionToken:nil]);
     PFAssertThrowsInvalidArgumentException([controller trackEventAsyncWithName:@"f"
                                                                     dimensions:@{ @"num" : @5 }
                                                                   sessionToken:nil]);
+#pragma clang diagnostic pop
 }
 
 - (void)testTrackEventParameters {
@@ -103,7 +111,7 @@ - (void)testTrackEventResult {
     [[controller trackEventAsyncWithName:@"a"
                               dimensions:nil
                             sessionToken:nil] continueWithSuccessBlock:^id(BFTask *task) {
-        XCTAssertEqualObjects(task.result, @YES);
+        XCTAssertNil(task.result);
         [expectation fulfill];
         return nil;
     }];
@@ -140,7 +148,7 @@ - (void)testTrackAppOpenedResult {
     XCTestExpectation *expectation = [self currentSelectorTestExpectation];
     [[controller trackAppOpenedEventAsyncWithRemoteNotificationPayload:nil
                                                           sessionToken:nil] continueWithSuccessBlock:^id(BFTask *task) {
-        XCTAssertEqualObjects(task.result, @YES);
+        XCTAssertNil(task.result);
         [expectation fulfill];
         return nil;
     }];