Return a boolean in trackEventName:withCustomProperties: to allow c…

…lient side logging.
Automattic · Aug 30, 2023 · a9bfbbc · a9bfbbc
1 parent bce4ea9
commit a9bfbbc
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 11 deletions.
diff --git a/Sources/Event Logging/TracksService.h b/Sources/Event Logging/TracksService.h
@@ -35,7 +35,12 @@ extern NSString *const TrackServiceDidSendQueuedEventsNotification;
 - (void)switchToAnonymousUserWithAnonymousID:(NSString *)anonymousID;
 
 - (void)trackEventName:(NSString *)eventName;
-- (void)trackEventName:(NSString *)eventName withCustomProperties:(NSDictionary *)customProperties;
+
+/// Tracks an event with custom properties and returns a boolean that indicates whether the creation is successful.
+/// - Parameters:
+///   - eventName: Name of the event.
+///   - customProperties: Custom event properties whose property name should only have alpha characters and underscores.
+- (BOOL)trackEventName:(NSString *)eventName withCustomProperties:(NSDictionary *)customProperties;
 
 - (void)sendQueuedEvents;
 - (void)clearQueuedEvents;

diff --git a/Sources/Event Logging/TracksService.m b/Sources/Event Logging/TracksService.m
@@ -134,19 +134,20 @@ - (void)trackEventName:(NSString *)eventName
 }
 
 
-- (void)trackEventName:(NSString *)eventName withCustomProperties:(NSDictionary *)customProperties
+- (BOOL)trackEventName:(NSString *)eventName withCustomProperties:(NSDictionary *)customProperties
 {
     eventName = [NSString stringWithFormat:@"%@_%@", self.eventNamePrefix, eventName];
 
-    [self.tracksEventService createTracksEventWithName:eventName
-                                              username:self.username
-                                                userID:self.userID
-                                             userAgent:self.userAgent
-                                              userType:self.isAnonymous ? TracksEventUserTypeAnonymous : TracksEventUserTypeAuthenticated
-                                             eventDate:[NSDate date]
-                                      customProperties:customProperties
-                                      deviceProperties:[self mutableDeviceProperties]
-                                        userProperties:self.userProperties];
+    TracksEvent * _Nullable event = [self.tracksEventService createTracksEventWithName:eventName
+                                                                            username:self.username
+                                                                              userID:self.userID
+                                                                           userAgent:self.userAgent
+                                                                            userType:self.isAnonymous ? TracksEventUserTypeAnonymous : TracksEventUserTypeAuthenticated
+                                                                           eventDate:[NSDate date]
+                                                                    customProperties:customProperties
+                                                                    deviceProperties:[self mutableDeviceProperties]
+                                                                      userProperties:self.userProperties];
+    return event != nil;
 }
 
 - (NSUInteger)queuedEventCount