feat: forward screen custom attributes (#31)

* feat: forward screen custom attributes

Author: mmustafa-tse

mParticle-Google-Analytics-Firebase/MPKitFirebaseAnalytics.m

@@ -162,8 +162,8 @@ - (MPKitExecStatus *)logScreen:(MPEvent *)event {
         return [self execStatus:MPKitReturnCodeFail];
     }
 
-    NSString *standardizedFirebaseEventName = [self standardizeNameOrKey:event.name forEvent:YES];
-    [FIRAnalytics logEventWithName:kFIREventScreenView parameters:@{kFIRParameterScreenName: standardizedFirebaseEventName}];
+    NSMutableDictionary *screenParameters = [self getParametersForScreen:event];
+    [FIRAnalytics logEventWithName:kFIREventScreenView parameters:screenParameters];
 
     return [self execStatus:MPKitReturnCodeSuccess];
 }
@@ -235,7 +235,7 @@ - (id)standardizeValue:(id)value forEvent:(BOOL)forEvent {
     return standardizedValue;
 }
 
-- (NSDictionary<NSString *, id> *)standardizeValues:(NSDictionary<NSString *, id> *)values forEvent:(BOOL)forEvent {
+- (NSMutableDictionary<NSString *, id> *)standardizeValues:(NSDictionary<NSString *, id> *)values forEvent:(BOOL)forEvent {
     NSMutableDictionary<NSString *, id>  *standardizedValue = [[NSMutableDictionary alloc] init];
 
     for (NSString *key in values.allKeys) {
@@ -246,6 +246,13 @@ - (id)standardizeValue:(id)value forEvent:(BOOL)forEvent {
     return standardizedValue;
 }
 
+- (NSMutableDictionary<NSString *, id> *)getParametersForScreen:(MPEvent *)screenEvent {
+    NSMutableDictionary *standardizedScreenParameters = [self standardizeValues:screenEvent.customAttributes forEvent:YES];
+    NSString *standardizedFirebaseEventName = [self standardizeNameOrKey:screenEvent.name forEvent:YES];
+    standardizedScreenParameters[kFIRParameterScreenName] = standardizedFirebaseEventName;
+    return standardizedScreenParameters;
+}
+
 - (MPKitExecStatus *)onLoginComplete:(FilteredMParticleUser *)user request:(FilteredMPIdentityApiRequest *)request {
     if (forwardRequestsServerSide) {
         return [self execStatus:MPKitReturnCodeUnavailable];

mParticle-Google-Analytics-FirebaseTests/MPKitFirebaseAnalyticsTests.m

@@ -11,6 +11,7 @@ @interface MPKitFirebaseAnalytics()
 - (NSString *)standardizeNameOrKey:(NSString *)nameOrKey forEvent:(BOOL)forEvent;
 - (NSString *)getEventNameForCommerceEvent:(MPCommerceEvent *)commerceEvent parameters:(NSDictionary<NSString *, id> *)parameters;
 - (NSDictionary<NSString *, id> *)getParameterForCommerceEvent:(MPCommerceEvent *)commerceEvent;
+- (NSMutableDictionary<NSString *, id> *)getParametersForScreen:(MPEvent *)screenEvent;
 @end
 
 @interface mParticle_Firebase_AnalyticsTests : XCTestCase
@@ -148,4 +149,28 @@ - (void)testCommerceEventCheckoutOptions {
     XCTAssertEqualObjects(kFIREventAddShippingInfo, eventName);
 }
 
+- (void)testScreenNameAttributes {
+    MPKitFirebaseAnalytics *exampleKit = [[MPKitFirebaseAnalytics alloc] init];
+    [exampleKit didFinishLaunchingWithConfiguration:@{}];
+
+    MPEvent *event = [[MPEvent alloc] initWithName:@"testScreenName" type:MPEventTypeOther];
+    event.customAttributes = @{@"testScreenAttribute":@"value"};
+    MPKitExecStatus *execStatus = [exampleKit logScreen:event];
+
+    XCTAssertTrue(execStatus.success);
+
+    NSMutableDictionary<NSString *, id> *screenParameters = [exampleKit getParametersForScreen:event];
+
+    // Even though we only pass one custom attribute, the parameters should include the standardized screen name, so the total expected count is two
+    XCTAssertEqual(screenParameters.count, 2);
+
+    NSString *standardizedScreenName = [exampleKit standardizeNameOrKey:event.name forEvent:YES];
+    NSString *screenNameParameter = screenParameters[kFIRParameterScreenName];
+
+    // Test screen name parameter is not Nil and exists in the screen parameters dictionary
+    XCTAssertNotNil(screenNameParameter);
+    // Test screen name parameter value is correct
+    XCTAssertEqualObjects(screenNameParameter, standardizedScreenName);
+}
+
 @end