Merge pull request #16 from bookingcom/gtarasov/hangs_to_crashlytics

Adding optional support to send fatal and non-fatal hangs to Firebase Crashlytics

Author: pilot34

.github/workflows/tests.yml

@@ -24,7 +24,7 @@ jobs:
 
       - name: SwiftLint
         run:
-          Pods/SwiftLint/swiftlint
+          Pods/SwiftLint/swiftlint lint --strict
       # to compile swift package we should remove workspace and xcodeproj
       # otherwise xcodebuild takes schemes from them
       - name: Remove workspace
@@ -34,6 +34,8 @@ jobs:
       - name: Compile
         run: |
           xcodebuild -scheme PerformanceSuite -destination 'generic/platform=iOS'
+          xcodebuild -scheme PerformanceSuiteCrashlytics -destination 'generic/platform=iOS'
+          xcodebuild -scheme PerformanceApp -destination 'generic/platform=iOS'
       # restore removed files just in case it is needed for the further steps    
       - name: Restore workspace
         run: |

Package.resolved

@@ -11,14 +11,50 @@ let package = Package(
         .library(
             name: "PerformanceSuite",
             targets: ["PerformanceSuite"]),
+        .library(
+            name: "PerformanceSuiteCrashlytics",
+            targets: ["PerformanceSuiteCrashlytics"]),
+        .executable(
+            name: "PerformanceApp",
+            targets: ["PerformanceApp"]
+        ),
+    ],
+    dependencies: [
+        .package(url: "https://github.com/firebase/firebase-ios-sdk.git", from: .init(10, 0, 0)),
+        .package(url: "https://github.com/yene/GCDWebServer", exact: .init(3, 5, 7)),
     ],
     targets: [
         .target(
             name: "PerformanceSuite",
             dependencies: ["MainThreadCallStack"],
             path: "PerformanceSuite/Sources"
         ),
+        .target(
+            name: "PerformanceSuiteCrashlytics",
+            dependencies: [
+                "PerformanceSuite",
+                "MainThreadCallStack",
+                "CrashlyticsImports",
+                .product(name: "FirebaseCrashlytics", package: "firebase-ios-sdk"),
+            ],
+            path: "PerformanceSuite/Crashlytics/Sources"
+        ),
+        .target(name: "CrashlyticsImports",
+                dependencies: [
+                    .product(name: "FirebaseCrashlytics", package: "firebase-ios-sdk")
+                ],
+                path: "PerformanceSuite/Crashlytics/Imports"),
         .target(name: "MainThreadCallStack",
                 path: "PerformanceSuite/MainThreadCallStack"),
+
+        .executableTarget(
+            name: "PerformanceApp",
+            dependencies: [
+                "PerformanceSuite",
+                "PerformanceSuiteCrashlytics",
+                .product(name: "GCDWebServer", package: "GCDWebServer"),
+            ],
+            path: "PerformanceSuite/PerformanceApp"
+        ),
     ]
 )

Package.swift

@@ -6,28 +6,41 @@ Pod::Spec.new do |s|
   s.license              = { :type => 'MIT', :file => 'LICENSE' }
   s.author               = { 'Gleb Tarasov' => '[email protected]' }
   s.source               = { :git => 'https://github.com/bookingcom/perfsuite-ios.git', :tag => s.version.to_s }
-  s.source_files         = 'PerformanceSuite/Sources/**/*.swift', 'PerformanceSuite/MainThreadCallStack/**/*.{h,c}'  
-  s.public_header_files = 'PerformanceSuite/MainThreadCallStack/include/*.h'
-  s.platform             = :ios, "14.0"
-  s.swift_version        = "5.7.1"
+  s.platform             = :ios, '14.0'
+  s.swift_version        = '5.7.1'
+  s.default_subspec      = 'Core'
+
+  s.subspec 'Core' do |core_spec|
+    core_spec.source_files = 'PerformanceSuite/Sources/**/*.swift', 'PerformanceSuite/MainThreadCallStack/**/*.{h,c}'  
+    core_spec.public_header_files = 'PerformanceSuite/MainThreadCallStack/include/*.h'
+  end
+
+  s.subspec 'Crashlytics' do |cr_spec|
+    cr_spec.source_files = 'PerformanceSuite/Crashlytics/Sources/*.swift', 'PerformanceSuite/Crashlytics/Imports/include/*.h'  
+    cr_spec.public_header_files = 'PerformanceSuite/Crashlytics/Imports/include/*.h'
+    cr_spec.dependency 'PerformanceSuite/Core'
+    cr_spec.dependency 'FirebaseCrashlytics'
+  end
 
   # Sample App which is also used for UI tests as a host
   s.app_spec 'PerformanceApp' do |app_spec|
-    app_spec.source_files = 'PerformanceSuite/PerformanceApp/*.swift'
+    app_spec.source_files = 'PerformanceSuite/PerformanceApp/**/*.swift'
     app_spec.dependency 'GCDWebServer'
+    app_spec.dependency 'PerformanceSuite/Crashlytics'
   end
 
   # Unit tests
   s.test_spec 'Tests' do |test_spec|
     test_spec.requires_app_host = true
-    test_spec.source_files = 'PerformanceSuite/Tests/*.swift'
+    test_spec.source_files = 'PerformanceSuite/Tests/**/*.swift'
+    test_spec.dependency 'PerformanceSuite/Crashlytics'
   end
 
   # UI Tests
   s.test_spec 'UITests' do |test_spec|
     test_spec.requires_app_host = true
     test_spec.test_type = :ui
-    test_spec.source_files = ['PerformanceSuite/UITests/*.swift', 'PerformanceSuite/PerformanceApp/UITestsInterop.swift']
+    test_spec.source_files = 'PerformanceSuite/UITests/**/*.swift', 'PerformanceSuite/PerformanceApp/UITestsInterop.swift'
     test_spec.app_host_name = 'PerformanceSuite/PerformanceApp'
     test_spec.dependency 'PerformanceSuite/PerformanceApp'
     test_spec.dependency 'GCDWebServer'

PerformanceSuite.podspec

@@ -0,0 +1,2 @@
+// we need some .c code for SwiftPM target to have .o file, otherwise it doesn't compile
+int fake_function() {}

PerformanceSuite/Crashlytics/Imports/CrashlyticsAdapter.c

@@ -0,0 +1,56 @@
+@import FirebaseCrashlytics;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// We are using private function from Crashlytics to be able to record
+/// custom exception without immediately sending it.
+///
+/// We will record stack trace for hang as fatal hang, and if it turned out 
+/// to be a non-fatal hang, we will remove this Firebase report and replace it 
+/// with non-fatal report.
+///
+/// We do not use recordExceptionModel here, because it doesn't return path 
+/// to the report, so it is much harder to remove created report to re-create it 
+/// with the different hang type.
+NSString *FIRCLSExceptionRecordOnDemandModel(FIRExceptionModel *exceptionModel,
+                                             int previousRecordedOnDemandExceptions,
+                                             int previousDroppedOnDemandExceptions);
+
+/// We need to pass proper type (first argument) to this method
+/// to record stack traces of all the methods, 
+/// that's why we cannot use public `FIRCLSExceptionRecordOnDemandModel`
+NSString *FIRCLSExceptionRecordOnDemand(int type,
+                                        const char *name,
+                                        const char *reason,
+                                        NSArray<FIRStackFrame *> *frames,
+                                        BOOL fatal,
+                                        int previousRecordedOnDemandExceptions,
+                                        int previousDroppedOnDemandExceptions);
+
+
+/// Firebase marker file which indicates that exception happened during the previous launch.
+/// If this file is present: `FIRCrashlytics.didCrashDuringPreviousExecution` will be `YES` on the next launch.
+extern const char *FIRCLSCrashedMarkerFileName;
+
+/// This is FIRCLSFileManager, but this class is private.
+/// We need to get rootPath to be able to remove marker file after we do recordOnDemandExceptionModel.
+/// Because we do not want hangs to be considered as crashes in Crashlytics on the next launch.
+@protocol RootPathProvider<NSObject>
+
+@property(nonatomic, readonly, nullable) NSString *rootPath;
+
+@end
+
+@interface FIRCrashlytics (OnDemandException)
+
+/// We use `recordOnDemandExceptionModel` instead of `recordExceptionModel`,
+/// because `recordExceptionModel` will send data only on the next launch,
+/// but we want to send non-fatal hang events as soon as we receive it.
+- (void)recordOnDemandExceptionModel:(FIRExceptionModel *)exceptionModel;
+
+/// We need file manager to get `rootPath` folder
+@property(nonatomic, readonly, nullable) id<RootPathProvider> fileManager;
+
+@end
+
+NS_ASSUME_NONNULL_END