Merge sessions-main with master (#10787)

Author: samedson

Crashlytics/CHANGELOG.md

@@ -1,3 +1,6 @@
+# Unreleased
+- [added] Added dependency on Firebase Sessions SDK to power future metrics and debugging features in Crashlytics
+
 # 10.4.0
 - [added] Updated Crashlytics to include the Firebase Installation ID for consistency with other products (#10645).
 

Crashlytics/Crashlytics/Components/FIRCLSContext.h

@@ -86,6 +86,7 @@ typedef struct {
   const char* rootPath;
   const char* previouslyCrashedFileRootPath;
   const char* sessionId;
+  const char* appQualitySessionId;
   const char* betaToken;
   bool errorsEnabled;
   bool customExceptionsEnabled;
@@ -96,10 +97,12 @@ typedef struct {
 } FIRCLSContextInitData;
 
 #ifdef __OBJC__
-bool FIRCLSContextInitialize(FIRCLSInternalReport* report,
-                             FIRCLSSettings* settings,
-                             FIRCLSFileManager* fileManager);
-
+bool FIRCLSContextInitialize(FIRCLSContextInitData* initData, FIRCLSFileManager* fileManager);
+FIRCLSContextInitData FIRCLSContextBuildInitData(FIRCLSInternalReport* report,
+                                                 FIRCLSSettings* settings,
+                                                 FIRCLSFileManager* fileManager,
+                                                 NSString* appQualitySessionId);
+bool FIRCLSContextRecordMetadata(NSString* rootPath, const FIRCLSContextInitData* initData);
 #endif
 
 void FIRCLSContextBaseInit(void);

Crashlytics/Crashlytics/Components/FIRCLSContext.m

@@ -47,13 +47,13 @@
 
 static const int64_t FIRCLSContextInitWaitTime = 5LL * NSEC_PER_SEC;
 
-static bool FIRCLSContextRecordMetadata(const char* path, const FIRCLSContextInitData* initData);
 static const char* FIRCLSContextAppendToRoot(NSString* root, NSString* component);
 static void FIRCLSContextAllocate(FIRCLSContext* context);
 
 FIRCLSContextInitData FIRCLSContextBuildInitData(FIRCLSInternalReport* report,
                                                  FIRCLSSettings* settings,
-                                                 FIRCLSFileManager* fileManager) {
+                                                 FIRCLSFileManager* fileManager,
+                                                 NSString* appQualitySessionId) {
   // Because we need to start the crash reporter right away,
   // it starts up either with default settings, or cached settings
   // from the last time they were fetched
@@ -64,6 +64,7 @@ FIRCLSContextInitData FIRCLSContextBuildInitData(FIRCLSInternalReport* report,
 
   initData.customBundleId = nil;
   initData.sessionId = [[report identifier] UTF8String];
+  initData.appQualitySessionId = [appQualitySessionId UTF8String];
   initData.rootPath = [[report path] UTF8String];
   initData.previouslyCrashedFileRootPath = [[fileManager rootPath] UTF8String];
   initData.errorsEnabled = [settings errorReportingEnabled];
@@ -77,12 +78,7 @@ FIRCLSContextInitData FIRCLSContextBuildInitData(FIRCLSInternalReport* report,
   return initData;
 }
 
-bool FIRCLSContextInitialize(FIRCLSInternalReport* report,
-                             FIRCLSSettings* settings,
-                             FIRCLSFileManager* fileManager) {
-  FIRCLSContextInitData initDataObj = FIRCLSContextBuildInitData(report, settings, fileManager);
-  FIRCLSContextInitData* initData = &initDataObj;
-
+bool FIRCLSContextInitialize(FIRCLSContextInitData* initData, FIRCLSFileManager* fileManager) {
   if (!initData) {
     return false;
   }
@@ -100,7 +96,7 @@ bool FIRCLSContextInitialize(FIRCLSInternalReport* report,
 
   // setup our SDK log file synchronously, because other calls may depend on it
   _firclsContext.readonly->logPath = FIRCLSContextAppendToRoot(rootPath, @"sdk.log");
-  _firclsContext.readonly->initialReportPath = FIRCLSDupString([report.path UTF8String]);
+  _firclsContext.readonly->initialReportPath = FIRCLSDupString(initData->rootPath);
   if (!FIRCLSUnlinkIfExists(_firclsContext.readonly->logPath)) {
     FIRCLSErrorLog(@"Unable to write initialize SDK write paths %s", strerror(errno));
   }
@@ -209,9 +205,7 @@ bool FIRCLSContextInitialize(FIRCLSInternalReport* report,
   }
 
   dispatch_group_async(group, queue, ^{
-    const char* metaDataPath = [[rootPath stringByAppendingPathComponent:FIRCLSReportMetadataFile]
-        fileSystemRepresentation];
-    if (!FIRCLSContextRecordMetadata(metaDataPath, initData)) {
+    if (!FIRCLSContextRecordMetadata(rootPath, initData)) {
       FIRCLSSDKLog("Unable to record context metadata\n");
     }
   });
@@ -360,7 +354,8 @@ bool FIRCLSContextMarkAndCheckIfCrashed(void) {
 
 static bool FIRCLSContextRecordIdentity(FIRCLSFile* file,
                                         const char* sessionId,
-                                        const char* betaToken) {
+                                        const char* betaToken,
+                                        const char* appQualitySessionId) {
   FIRCLSFileWriteSectionStart(file, "identity");
 
   FIRCLSFileWriteHashStart(file);
@@ -371,6 +366,8 @@ static bool FIRCLSContextRecordIdentity(FIRCLSFile* file,
   FIRCLSFileWriteHashEntryUint64(file, "started_at", time(NULL));
 
   FIRCLSFileWriteHashEntryString(file, "session_id", sessionId);
+  FIRCLSFileWriteHashEntryString(file, "app_quality_session_id", appQualitySessionId);
+
   // install_id is written into the proto directly. This is only left here to
   // support Apple Report Converter.
   FIRCLSFileWriteHashEntryString(file, "install_id", "");
@@ -404,11 +401,13 @@ static bool FIRCLSContextRecordApplication(FIRCLSFile* file, const char* customB
   return true;
 }
 
-static bool FIRCLSContextRecordMetadata(const char* path, const FIRCLSContextInitData* initData) {
+bool FIRCLSContextRecordMetadata(NSString* rootPath, const FIRCLSContextInitData* initData) {
   const char* sessionId = initData->sessionId;
   const char* betaToken = initData->betaToken;
   const char* customBundleId = initData->customBundleId;
-
+  const char* appQualitySessionId = initData->appQualitySessionId;
+  const char* path =
+      [[rootPath stringByAppendingPathComponent:FIRCLSReportMetadataFile] fileSystemRepresentation];
   if (!FIRCLSUnlinkIfExists(path)) {
     FIRCLSSDKLog("Unable to unlink existing metadata file %s\n", strerror(errno));
   }
@@ -420,7 +419,7 @@ static bool FIRCLSContextRecordMetadata(const char* path, const FIRCLSContextIni
     return false;
   }
 
-  if (!FIRCLSContextRecordIdentity(&file, sessionId, betaToken)) {
+  if (!FIRCLSContextRecordIdentity(&file, sessionId, betaToken, appQualitySessionId)) {
     FIRCLSSDKLog("Unable to write out identity metadata\n");
   }
 

Crashlytics/Crashlytics/Controllers/FIRCLSContextManager.h

@@ -0,0 +1,43 @@
+//
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#import <Foundation/Foundation.h>
+
+#import "Crashlytics/Crashlytics/Models/FIRCLSFileManager.h"
+#import "Crashlytics/Crashlytics/Models/FIRCLSInternalReport.h"
+#import "Crashlytics/Crashlytics/Models/FIRCLSSettings.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+///
+/// The ContextManager determines when to build the context object,
+/// and write its metadata. It was created because the FIRCLSContext
+/// is interacted with via functions, which makes it hard to include in tests.
+/// In addition, we this class is responsible for re-writing the Metadata object
+/// when the App Quality Session ID changes.
+///
+@interface FIRCLSContextManager : NSObject
+
+/// This should be set immediately when the FirebaseSessions SDK generates
+/// a new Session ID.
+@property(nonatomic, copy) NSString *appQualitySessionId;
+
+- (BOOL)setupContextWithReport:(FIRCLSInternalReport *)report
+                      settings:(FIRCLSSettings *)settings
+                   fileManager:(FIRCLSFileManager *)fileManager;
+
+@end
+
+NS_ASSUME_NONNULL_END

Crashlytics/Crashlytics/Controllers/FIRCLSContextManager.m

@@ -0,0 +1,78 @@
+//
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#import "Crashlytics/Crashlytics/Controllers/FIRCLSContextManager.h"
+
+#import "Crashlytics/Crashlytics/Components/FIRCLSContext.h"
+
+@interface FIRCLSContextManager ()
+
+@property(nonatomic, assign) BOOL hasInitializedContext;
+
+@property(nonatomic, strong) FIRCLSInternalReport *report;
+@property(nonatomic, strong) FIRCLSSettings *settings;
+@property(nonatomic, strong) FIRCLSFileManager *fileManager;
+
+@end
+
+@implementation FIRCLSContextManager
+
+- (instancetype)init {
+  self = [super init];
+  if (!self) {
+    return self;
+  }
+
+  _appQualitySessionId = @"";
+
+  return self;
+}
+
+- (BOOL)setupContextWithReport:(FIRCLSInternalReport *)report
+                      settings:(FIRCLSSettings *)settings
+                   fileManager:(FIRCLSFileManager *)fileManager {
+  _report = report;
+  _settings = settings;
+  _fileManager = fileManager;
+
+  _hasInitializedContext = true;
+
+  FIRCLSContextInitData initDataObj = self.buildInitData;
+  return FIRCLSContextInitialize(&initDataObj, self.fileManager);
+}
+
+- (void)setAppQualitySessionId:(NSString *)appQualitySessionId {
+  _appQualitySessionId = appQualitySessionId;
+
+  // This may be called before the context is originally initialized. In that case
+  // skip the write because it will be written as soon as the context is initialized.
+  // On future Session ID updates, this will be true and the context metadata will be
+  // rewritten.
+  if (!self.hasInitializedContext) {
+    return;
+  }
+
+  FIRCLSContextInitData initDataObj = self.buildInitData;
+  if (!FIRCLSContextRecordMetadata(self.report.path, &initDataObj)) {
+    FIRCLSErrorLog(@"Failed to write context file while updating App Quality Session ID");
+  }
+}
+
+- (FIRCLSContextInitData)buildInitData {
+  return FIRCLSContextBuildInitData(self.report, self.settings, self.fileManager,
+                                    self.appQualitySessionId);
+}
+
+@end

Crashlytics/Crashlytics/Controllers/FIRCLSManagerData.h

@@ -25,6 +25,7 @@ NS_ASSUME_NONNULL_BEGIN
 @class FIRCLSOnDemandModel;
 @class FIRCLSSettings;
 @class FIRCLSLaunchMarkerModel;
+@class FIRCLSContextManager;
 @class GDTCORTransport;
 @protocol FIRAnalyticsInterop;
 
@@ -80,6 +81,9 @@ NS_ASSUME_NONNULL_BEGIN
 // Settings fetched from the server
 @property(nonatomic, strong) FIRCLSSettings *settings;
 
+// Sets up the Context and writes Metadata files to the crash report
+@property(nonatomic, strong) FIRCLSContextManager *contextManager;
+
 // These queues function together as a single startup queue
 @property(nonatomic, strong) NSOperationQueue *operationQueue;
 @property(nonatomic, strong) dispatch_queue_t dispatchQueue;

Crashlytics/Crashlytics/Controllers/FIRCLSManagerData.m

@@ -15,6 +15,7 @@
 #import "Crashlytics/Crashlytics/Controllers/FIRCLSManagerData.h"
 
 #import "Crashlytics/Crashlytics/Components/FIRCLSApplication.h"
+#import "Crashlytics/Crashlytics/Controllers/FIRCLSContextManager.h"
 #import "Crashlytics/Crashlytics/Models/FIRCLSExecutionIdentifierModel.h"
 #import "Crashlytics/Crashlytics/Models/FIRCLSInstallIdentifierModel.h"
 #import "Crashlytics/Crashlytics/Models/FIRCLSSettings.h"
@@ -44,6 +45,7 @@ - (instancetype)initWithGoogleAppID:(NSString *)googleAppID
   _dataArbiter = dataArbiter;
   _settings = settings;
   _onDemandModel = onDemandModel;
+  _contextManager = [[FIRCLSContextManager alloc] init];
 
   _appIDModel = [[FIRCLSApplicationIdentifierModel alloc] init];
   _installIDModel = [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:installations];

Crashlytics/Crashlytics/Controllers/FIRCLSReportManager.h

@@ -22,6 +22,7 @@
 @class FIRCLSExistingReportManager;
 @class FIRCLSAnalyticsManager;
 @class FIRCLSManagerData;
+@class FIRCLSContextManager;
 
 NS_ASSUME_NONNULL_BEGIN
 

Crashlytics/Crashlytics/Controllers/FIRCLSReportManager.m

@@ -41,6 +41,7 @@
 #import "Crashlytics/Crashlytics/Components/FIRCLSApplication.h"
 #import "Crashlytics/Crashlytics/Components/FIRCLSUserLogging.h"
 #import "Crashlytics/Crashlytics/Controllers/FIRCLSAnalyticsManager.h"
+#import "Crashlytics/Crashlytics/Controllers/FIRCLSContextManager.h"
 #import "Crashlytics/Crashlytics/Controllers/FIRCLSExistingReportManager.h"
 #import "Crashlytics/Crashlytics/Controllers/FIRCLSManagerData.h"
 #import "Crashlytics/Crashlytics/Controllers/FIRCLSMetricKitManager.h"
@@ -135,6 +136,8 @@ @interface FIRCLSReportManager () {
 @property(nonatomic, strong) FIRCLSAnalyticsManager *analyticsManager;
 @property(nonatomic, strong) FIRCLSExistingReportManager *existingReportManager;
 
+@property(nonatomic, strong) FIRCLSContextManager *contextManager;
+
 // Internal Managers
 @property(nonatomic, strong) FIRCLSSettingsManager *settingsManager;
 @property(nonatomic, strong) FIRCLSNotificationManager *notificationManager;
@@ -165,6 +168,7 @@ - (instancetype)initWithManagerData:(FIRCLSManagerData *)managerData
   _installIDModel = managerData.installIDModel;
   _settings = managerData.settings;
   _executionIDModel = managerData.executionIDModel;
+  _contextManager = managerData.contextManager;
 
   _existingReportManager = existingReportManager;
   _analyticsManager = analyticsManager;
@@ -416,7 +420,9 @@ - (BOOL)startCrashReporterWithProfilingMark:(FIRCLSProfileMark)mark
     return NO;
   }
 
-  if (!FIRCLSContextInitialize(report, self.settings, _fileManager)) {
+  if (![self.contextManager setupContextWithReport:report
+                                          settings:self.settings
+                                       fileManager:_fileManager]) {
     return NO;
   }