Fix to ensure that the installation ID is right set for sending events. (#8578)

Author: visumickey

FirebasePerformance/CHANGELOG.md

@@ -1,3 +1,6 @@
+# Version 8.6.1
+* Fix the case where the event were dropped for missing a critical field in the event.
+
 # Version 8.6.0
 * Add Firebase Performance support for Swift Package Manager. (#6528)
 * Fix a crash due to a race condition. (#8485)

FirebasePerformance/Sources/FPRClient.m

@@ -271,16 +271,16 @@ - (void)processAndLogEvent:(firebase_perf_v1_PerfMetric)event {
   });
 
   // Attempts to dispatch events if successfully retrieve installation ID.
-  __block firebase_perf_v1_PerfMetric curEvent = event;
   [self.installations
       installationIDWithCompletion:^(NSString *_Nullable identifier, NSError *_Nullable error) {
         if (error) {
           FPRLogError(kFPRClientInstanceIDNotAvailable, @"FIRInstallations error: %@",
                       error.description);
         } else {
           dispatch_group_async(self.eventsQueueGroup, self.eventsQueue, ^{
-            curEvent.application_info.app_instance_id = FPREncodeString(identifier);
-            [self.gdtLogger logEvent:event];
+            firebase_perf_v1_PerfMetric updatedEvent = event;
+            updatedEvent.application_info.app_instance_id = FPREncodeString(identifier);
+            [self.gdtLogger logEvent:updatedEvent];
           });
         }
       }];

FirebasePerformance/Tests/Unit/FPRClientTest.m

@@ -17,6 +17,7 @@
 #import "FirebasePerformance/Sources/Configurations/FPRConfigurations+Private.h"
 #import "FirebasePerformance/Sources/FPRClient+Private.h"
 #import "FirebasePerformance/Sources/FPRClient.h"
+#import "FirebasePerformance/Sources/FPRNanoPbUtils.h"
 #import "FirebasePerformance/Sources/Loggers/FPRGDTLogger.h"
 #import "FirebasePerformance/Sources/Loggers/FPRGDTLogger_Private.h"
 
@@ -29,6 +30,8 @@
 #import <OCMock/OCMock.h>
 #import "SharedTestUtilities/GDTCORTransportFake.h"
 
+NSString *const kFPRMockInstallationId = @"mockId";
+
 @interface FPRClientTest : FPRTestCase
 
 /** Configuration which can be assigned as a fake object for event dispatch control. */
@@ -47,7 +50,7 @@ - (void)setUp {
   // Arrange installations object.
   FPRFakeInstallations *installations = [FPRFakeInstallations installations];
   self.client = [[FPRClient alloc] init];
-  installations.identifier = @"mockId";
+  installations.identifier = kFPRMockInstallationId;
   self.client.installations = (FIRInstallations *)installations;
 
   // Arrange remote config object.
@@ -73,6 +76,9 @@ - (void)testLogAndProcessEventsForTrace {
   // Act on event logging call.
   [self.client processAndLogEvent:perfMetric];
 
+  firebase_perf_v1_PerfMetric expectedMetric = perfMetric;
+  expectedMetric.application_info.app_instance_id = FPREncodeString(kFPRMockInstallationId);
+
   // Wait for async job to execute event logging.
   dispatch_group_wait(self.client.eventsQueueGroup, DISPATCH_TIME_FOREVER);
 
@@ -82,8 +88,10 @@ - (void)testLogAndProcessEventsForTrace {
         (GDTCORTransportFake *)self.client.gdtLogger.gdtfllTransport;
     XCTAssertEqual(fakeGdtTransport.logEvents.count, 1);
     GDTCOREvent *event = fakeGdtTransport.logEvents.firstObject;
+    XCTAssertNotNil(
+        FPRDecodeString([(FPRGDTEvent *)event.dataObject metric].application_info.app_instance_id));
     XCTAssertEqualObjects([event.dataObject transportBytes],
-                          [[FPRGDTEvent gdtEventForPerfMetric:perfMetric] transportBytes]);
+                          [[FPRGDTEvent gdtEventForPerfMetric:expectedMetric] transportBytes]);
   });
 }
 
@@ -96,6 +104,9 @@ - (void)testLogAndProcessEventsForNetworkTrace {
   // Act on event logging call.
   [self.client processAndLogEvent:perfMetric];
 
+  firebase_perf_v1_PerfMetric expectedMetric = perfMetric;
+  expectedMetric.application_info.app_instance_id = FPREncodeString(kFPRMockInstallationId);
+
   // Wait for async job to execute event logging.
   dispatch_group_wait(self.client.eventsQueueGroup, DISPATCH_TIME_FOREVER);
 
@@ -105,8 +116,10 @@ - (void)testLogAndProcessEventsForNetworkTrace {
         (GDTCORTransportFake *)self.client.gdtLogger.gdtfllTransport;
     XCTAssertEqual(fakeGdtTransport.logEvents.count, 1);
     GDTCOREvent *event = fakeGdtTransport.logEvents.firstObject;
+    XCTAssertNotNil(
+        FPRDecodeString([(FPRGDTEvent *)event.dataObject metric].application_info.app_instance_id));
     XCTAssertEqualObjects([event.dataObject transportBytes],
-                          [[FPRGDTEvent gdtEventForPerfMetric:perfMetric] transportBytes]);
+                          [[FPRGDTEvent gdtEventForPerfMetric:expectedMetric] transportBytes]);
   });
 }
 
@@ -118,6 +131,9 @@ - (void)testLogAndProcessEventsForGauge {
   // Act on event logging call.
   [self.client processAndLogEvent:perfMetric];
 
+  firebase_perf_v1_PerfMetric expectedMetric = perfMetric;
+  expectedMetric.application_info.app_instance_id = FPREncodeString(kFPRMockInstallationId);
+
   // Wait for async job to execute event logging.
   dispatch_group_wait(self.client.eventsQueueGroup, DISPATCH_TIME_FOREVER);
 
@@ -127,8 +143,10 @@ - (void)testLogAndProcessEventsForGauge {
         (GDTCORTransportFake *)self.client.gdtLogger.gdtfllTransport;
     XCTAssertEqual(fakeGdtTransport.logEvents.count, 1);
     GDTCOREvent *event = fakeGdtTransport.logEvents.firstObject;
+    XCTAssertNotNil(
+        FPRDecodeString([(FPRGDTEvent *)event.dataObject metric].application_info.app_instance_id));
     XCTAssertEqualObjects([event.dataObject transportBytes],
-                          [[FPRGDTEvent gdtEventForPerfMetric:perfMetric] transportBytes]);
+                          [[FPRGDTEvent gdtEventForPerfMetric:expectedMetric] transportBytes]);
   });
 }