Merge pull request #263 from Automattic/issue/262-fix-TracksLogging

Fix `TracksLogWarn` messages aren't logged with Cocoapods integration
Automattic · Sep 1, 2023 · 6ff2e44 · 6ff2e44
2 parents aad902b + 5a1d29d
commit 6ff2e44
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 15 deletions.
diff --git a/Automattic-Tracks-iOS.podspec b/Automattic-Tracks-iOS.podspec
@@ -2,7 +2,7 @@
 
 Pod::Spec.new do |s|
   s.name          = 'Automattic-Tracks-iOS'
-  s.version       = '2.3.0'
+  s.version       = '2.4.0'
 
   s.summary       = 'Simple way to track events in an iOS app with Automattic Tracks internal service'
   s.description   = <<-DESC

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,6 +30,26 @@ _None._
 
 -->
 
+## 2.4.0
+
+### Breaking Changes
+
+_None._
+
+### New Features
+
+- `TracksService.trackEventName:withCustomProperties:` now returns a boolean that indicates whether the event creation is successful.
+
+### Bug Fixes
+
+- `TracksLogging` now works when the library is integrated with Cocoapods for internal Tracks error/warning messages.
+
+### Internal Changes
+
+- `TracksService.trackEventName:withCustomProperties:` now logs the event name when there is a validation error from creating a Tracks event.
+
+_None._
+
 ## 2.3.0
 
 ### Breaking Changes

diff --git a/Sources/Event Logging/TracksEventService.m b/Sources/Event Logging/TracksEventService.m
@@ -58,7 +58,7 @@ - (TracksEvent *)createTracksEventWithName:(NSString *)name
     NSError *error;
     BOOL isValid = [tracksEvent validateObject:&error];
     if (!isValid) {
-        TracksLogWarn(@"Error when validating TracksEvent: %@", error);
+        TracksLogWarn(@"Error when validating TracksEvent %@: %@", name, error);
         return nil;
     }
 

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

diff --git a/Sources/Model/ObjC/Common/TracksLogging.m b/Sources/Model/ObjC/Common/TracksLogging.m
@@ -9,7 +9,7 @@
 #if SWIFT_PACKAGE
         Class loggingClass = NSClassFromString(@"AutomatticTracksModel.TracksLogging");
 #else
-        Class loggingClass = NSClassFromString(@"TracksLogging");
+        Class loggingClass = NSClassFromString(@"AutomatticTracks.TracksLogging");
 #endif
         if ([loggingClass conformsToProtocol: @protocol(TracksLoggingConfiguration)]) {
             result = loggingClass;

diff --git a/Sources/Model/ObjC/Constants/TracksConstants.m b/Sources/Model/ObjC/Constants/TracksConstants.m
@@ -1,4 +1,4 @@
 #import "TracksConstants.h"
 
 NSString *const TracksErrorDomain = @"TracksErrorDomain";
-NSString *const TracksLibraryVersion = @"2.3.0";
+NSString *const TracksLibraryVersion = @"2.4.0";