@react-native-firebase/crashlytics 27.0.0 → 27.1.0

package/ios/RNFBCrashlyticsUnitTests/RNFBCrashlyticsFatalExitTests.m

@@ -0,0 +1,268 @@
+/**
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library 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 <XCTest/XCTest.h>
+
+#import <Firebase/Firebase.h>
+#import "RNFBCrashlyticsHelper.h"
+
+@interface RNFBCrashlyticsFatalExitTests : XCTestCase
+@end
+
+@implementation RNFBCrashlyticsFatalExitTests {
+  NSMutableArray<NSString *> *_events;
+}
+
+- (void)setUp {
+  [super setUp];
+  [FIRCrashlytics resetTestState];
+  _events = [NSMutableArray new];
+}
+
+- (void)tearDown {
+  [FIRCrashlytics resetTestState];
+  [super tearDown];
+}
+
+- (void)appendEvent:(NSString *)event {
+  @synchronized(_events) {
+    [_events addObject:event];
+  }
+}
+
+- (NSArray<NSString *> *)eventsSnapshot {
+  @synchronized(_events) {
+    return [_events copy];
+  }
+}
+
+- (void)recordFatal {
+  [RNFBCrashlyticsHelper recordJavaScriptErrorWithMessage:@"fatal"
+                                                   frames:@[]
+                              isUnhandledPromiseRejection:NO];
+}
+
+/** Lets late watchdog / queue blocks run so "at most once" assertions are meaningful. */
+- (void)drainFor:(NSTimeInterval)seconds {
+  XCTestExpectation *drained = [self expectationWithDescription:@"drained"];
+  dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(seconds * NSEC_PER_SEC)),
+                 dispatch_get_main_queue(), ^{
+                   [drained fulfill];
+                 });
+  [self waitForExpectations:@[ drained ] timeout:seconds + 5];
+}
+
+/** Returns once every block already enqueued on serial `queue` has run (a happens-before edge). */
+- (void)drainQueue:(dispatch_queue_t)queue {
+  dispatch_block_t noop = ^{
+  };
+  dispatch_sync(queue, noop);
+}
+
+- (void)testShared_isProductionSingleton {
+  XCTAssertNotNil([RNFBCrashlyticsFatalExit shared]);
+  XCTAssertEqual([RNFBCrashlyticsFatalExit shared], [RNFBCrashlyticsFatalExit shared]);
+  XCTAssertEqualWithAccuracy(RNFBCrashlyticsFatalExitWatchdogTimeout, 2.0, 0.0001);
+}
+
+- (void)testRecordThenTerminate_savesOnMainBeforeTerminatorRuns {
+  FIRCrashlytics.onExceptionModelSaved = ^(FIRExceptionModel *model) {
+    [self appendEvent:[@"save:" stringByAppendingString:model.reason]];
+  };
+  XCTestExpectation *terminated = [self expectationWithDescription:@"terminated"];
+  __block NSUInteger terminations = 0;
+  // Held suspended until the main-queue terminate has run, so the watchdog cannot win under load.
+  dispatch_queue_t watchdogQueue =
+      dispatch_queue_create("rnfb.crashlytics.test.watchdog", DISPATCH_QUEUE_SERIAL);
+  dispatch_suspend(watchdogQueue);
+  RNFBCrashlyticsFatalExit *fatalExit = [[RNFBCrashlyticsFatalExit alloc]
+      initWithTerminator:^{
+        terminations += 1;
+        [self appendEvent:@"exit"];
+        XCTAssertTrue([NSThread isMainThread]);
+        [terminated fulfill];
+      }
+          terminateQueue:dispatch_get_main_queue()
+           watchdogQueue:watchdogQueue
+         watchdogTimeout:0.2];
+
+  // Production calls in on the module's own (non-main) method queue.
+  __block BOOL started = NO;
+  dispatch_queue_t moduleQueue =
+      dispatch_queue_create("rnfb.crashlytics.test.module", DISPATCH_QUEUE_SERIAL);
+  dispatch_async(moduleQueue, ^{
+    started = [fatalExit recordThenTerminate:^{
+      [self recordFatal];
+    }];
+  });
+
+  [self waitForExpectations:@[ terminated ] timeout:5];
+  dispatch_resume(watchdogQueue);
+  [self drainFor:0.4];  // past the watchdog, which must not terminate again
+  [self drainQueue:watchdogQueue];
+  [self drainQueue:moduleQueue];  // `started` is written on moduleQueue
+
+  XCTAssertTrue(started);
+  XCTAssertEqual(terminations, 1u);
+  NSArray *expected = @[ @"save:fatal", @"exit" ];
+  XCTAssertEqualObjects([self eventsSnapshot], expected);
+  XCTAssertEqual(FIRCrashlytics.savedExceptionModels.count, 1u);
+  XCTAssertEqualObjects(FIRCrashlytics.savedExceptionModels.firstObject.name, @"JavaScriptError");
+}
+
+- (void)testRecordThenTerminate_contextInitPending_terminatesBeforeSave {
+  [FIRCrashlytics holdContextInit];
+  FIRCrashlytics.onExceptionModelSaved = ^(FIRExceptionModel *model) {
+    [self appendEvent:[@"save:" stringByAppendingString:model.reason]];
+  };
+  XCTestExpectation *terminated = [self expectationWithDescription:@"terminated"];
+  __block NSUInteger terminations = 0;
+  __block NSUInteger savedAtExit = NSUIntegerMax;
+  __block BOOL recordedAtExit = NO;
+  dispatch_queue_t watchdogQueue =
+      dispatch_queue_create("rnfb.crashlytics.test.watchdog", DISPATCH_QUEUE_SERIAL);
+  dispatch_suspend(watchdogQueue);
+  RNFBCrashlyticsFatalExit *fatalExit = [[RNFBCrashlyticsFatalExit alloc]
+      initWithTerminator:^{
+        terminations += 1;
+        savedAtExit = FIRCrashlytics.savedExceptionModels.count;
+        recordedAtExit = FIRCrashlytics.lastRecordedExceptionModel != nil;
+        [self appendEvent:@"exit"];
+        [FIRCrashlytics fulfillContextInit];
+        [terminated fulfill];
+      }
+          terminateQueue:dispatch_get_main_queue()
+           watchdogQueue:watchdogQueue
+         watchdogTimeout:0.2];
+
+  __block BOOL started = NO;
+  dispatch_queue_t moduleQueue =
+      dispatch_queue_create("rnfb.crashlytics.test.module", DISPATCH_QUEUE_SERIAL);
+  dispatch_async(moduleQueue, ^{
+    started = [fatalExit recordThenTerminate:^{
+      [self recordFatal];
+    }];
+  });
+
+  [self waitForExpectations:@[ terminated ] timeout:5];
+  dispatch_resume(watchdogQueue);
+  [self drainFor:0.4];
+  [self drainQueue:watchdogQueue];
+  [self drainQueue:moduleQueue];
+
+  XCTAssertTrue(started);
+  XCTAssertEqual(terminations, 1u);
+  XCTAssertTrue(recordedAtExit);
+  XCTAssertEqual(savedAtExit, 0u);
+  NSArray *expected = @[ @"exit", @"save:fatal" ];
+  XCTAssertEqualObjects([self eventsSnapshot], expected);
+}
+
+- (void)testWatchdog_terminatesWhenTerminateQueueIsHung {
+  dispatch_queue_t hungQueue = dispatch_queue_create("rnfb.crashlytics.test.hung", 0);
+  dispatch_semaphore_t release = dispatch_semaphore_create(0);
+  dispatch_async(hungQueue, ^{
+    dispatch_semaphore_wait(release, DISPATCH_TIME_FOREVER);
+  });
+
+  XCTestExpectation *terminated = [self expectationWithDescription:@"terminated"];
+  __block NSUInteger terminations = 0;
+  __block BOOL terminatedWhileHung = NO;
+  __block BOOL hung = YES;
+  RNFBCrashlyticsFatalExit *fatalExit = [[RNFBCrashlyticsFatalExit alloc]
+      initWithTerminator:^{
+        terminations += 1;
+        terminatedWhileHung = hung;
+        [terminated fulfill];
+      }
+          terminateQueue:hungQueue
+           watchdogQueue:dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0)
+         watchdogTimeout:0.1];
+
+  XCTAssertTrue([fatalExit recordThenTerminate:^{
+    [self recordFatal];
+  }]);
+  [self waitForExpectations:@[ terminated ] timeout:5];
+
+  hung = NO;
+  dispatch_semaphore_signal(release);
+  [self drainQueue:hungQueue];  // the queued terminate block has now run
+
+  XCTAssertTrue(terminatedWhileHung);
+  XCTAssertEqual(terminations, 1u);
+}
+
+- (void)testRecordRaises_stillTerminatesAndIgnoresLaterFatals {
+  XCTestExpectation *terminated = [self expectationWithDescription:@"terminated"];
+  __block NSUInteger terminations = 0;
+  RNFBCrashlyticsFatalExit *fatalExit = [[RNFBCrashlyticsFatalExit alloc]
+      initWithTerminator:^{
+        terminations += 1;
+        [terminated fulfill];
+      }
+          terminateQueue:dispatch_get_main_queue()
+           watchdogQueue:dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0)
+         watchdogTimeout:0.1];
+
+  BOOL first = [fatalExit recordThenTerminate:^{
+    [NSException raise:NSInternalInconsistencyException format:@"record failed"];
+  }];
+  BOOL second = [fatalExit recordThenTerminate:^{
+    [self recordFatal];
+  }];
+
+  [self waitForExpectations:@[ terminated ] timeout:5];
+  [self drainFor:0.3];
+
+  XCTAssertTrue(first);
+  XCTAssertFalse(second);
+  XCTAssertEqual(terminations, 1u);
+  XCTAssertEqual(FIRCrashlytics.savedExceptionModels.count, 0u);
+}
+
+- (void)testSecondFatalWhileTerminating_isIgnored {
+  XCTestExpectation *terminated = [self expectationWithDescription:@"terminated"];
+  __block NSUInteger terminations = 0;
+  __block NSUInteger records = 0;
+  RNFBCrashlyticsFatalExit *fatalExit = [[RNFBCrashlyticsFatalExit alloc]
+      initWithTerminator:^{
+        terminations += 1;
+        [terminated fulfill];
+      }
+          terminateQueue:dispatch_get_main_queue()
+           watchdogQueue:dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0)
+         watchdogTimeout:0.1];
+
+  BOOL first = [fatalExit recordThenTerminate:^{
+    records += 1;
+    [self recordFatal];
+  }];
+  BOOL second = [fatalExit recordThenTerminate:^{
+    records += 1;
+    [self recordFatal];
+  }];
+
+  [self waitForExpectations:@[ terminated ] timeout:5];
+  [self drainFor:0.3];
+
+  XCTAssertTrue(first);
+  XCTAssertFalse(second);
+  XCTAssertEqual(records, 1u);
+  XCTAssertEqual(terminations, 1u);
+  XCTAssertEqual(FIRCrashlytics.savedExceptionModels.count, 1u);
+}
+
+@end

package/ios/RNFBCrashlyticsUnitTests/RNFBCrashlyticsUnitTests.xcodeproj/project.pbxproj

@@ -13,6 +13,7 @@
 		CL1000000000000000000020 /* RNFBCrashlyticsHelper.m in Sources */ = {isa = PBXBuildFile; fileRef = CL1000000000000000000021 /* RNFBCrashlyticsHelper.m */; };
 		CL1000000000000000000022 /* RNFBCrashlyticsHelperHostStubTests.m in Sources */ = {isa = PBXBuildFile; fileRef = CL1000000000000000000023 /* RNFBCrashlyticsHelperHostStubTests.m */; };
 		CL1000000000000000000024 /* FIRCrashlyticsHostStub.m in Sources */ = {isa = PBXBuildFile; fileRef = CL1000000000000000000025 /* FIRCrashlyticsHostStub.m */; };
+		CL1000000000000000000027 /* RNFBCrashlyticsFatalExitTests.m in Sources */ = {isa = PBXBuildFile; fileRef = CL1000000000000000000028 /* RNFBCrashlyticsFatalExitTests.m */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXFileReference section */
@@ -23,6 +24,7 @@
 		CL1000000000000000000021 /* RNFBCrashlyticsHelper.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = RNFBCrashlyticsHelper.m; path = ../RNFBCrashlytics/RNFBCrashlyticsHelper.m; sourceTree = SOURCE_ROOT; };
 		CL1000000000000000000023 /* RNFBCrashlyticsHelperHostStubTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = RNFBCrashlyticsHelperHostStubTests.m; sourceTree = "<group>"; };
 		CL1000000000000000000025 /* FIRCrashlyticsHostStub.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = FIRCrashlyticsHostStub.m; path = HostStubs/Firebase/FIRCrashlyticsHostStub.m; sourceTree = "<group>"; };
+		CL1000000000000000000028 /* RNFBCrashlyticsFatalExitTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = RNFBCrashlyticsFatalExitTests.m; sourceTree = "<group>"; };
 		CL1000000000000000000026 /* RNFBCrashlyticsHelper.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = RNFBCrashlyticsHelper.h; path = ../RNFBCrashlytics/RNFBCrashlyticsHelper.h; sourceTree = SOURCE_ROOT; };
 /* End PBXFileReference section */
 
@@ -62,6 +64,7 @@
 				CL1000000000000000000026 /* RNFBCrashlyticsHelper.h */,
 				CL1000000000000000000021 /* RNFBCrashlyticsHelper.m */,
 				CL1000000000000000000023 /* RNFBCrashlyticsHelperHostStubTests.m */,
+				CL1000000000000000000028 /* RNFBCrashlyticsFatalExitTests.m */,
 				CL1000000000000000000025 /* FIRCrashlyticsHostStub.m */,
 			);
 			name = Sources;
@@ -129,6 +132,7 @@
 				CL1000000000000000000020 /* RNFBCrashlyticsHelper.m in Sources */,
 				CL1000000000000000000024 /* FIRCrashlyticsHostStub.m in Sources */,
 				CL1000000000000000000022 /* RNFBCrashlyticsHelperHostStubTests.m in Sources */,
+				CL1000000000000000000027 /* RNFBCrashlyticsFatalExitTests.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

package/ios_config.sh

@@ -16,6 +16,16 @@
 #
 set -e
 
+# upload-symbols talks to the network and has no timeout of its own, so a stalled
+# request can hang the whole build. perl's alarm is used because macOS has no
+# `timeout`. A timeout exits non-zero, which the callers below report as a
+# warning without failing the build.
+UPLOAD_SYMBOLS_TIMEOUT_SEC="${RNFB_CRASHLYTICS_UPLOAD_TIMEOUT_SEC:-300}"
+
+run_upload_symbols() {
+  perl -e 'alarm shift; exec @ARGV' "${UPLOAD_SYMBOLS_TIMEOUT_SEC}" "$@"
+}
+
 if [[ ${PODS_ROOT} && -f "${PODS_ROOT}/FirebaseCrashlytics/run" ]]; then
   echo "info: Exec FirebaseCrashlytics Run from Pods"
   if ! "${PODS_ROOT}/FirebaseCrashlytics/run"; then
@@ -49,14 +59,14 @@ else
     echo "warning: GoogleService-Info.plist not found at ${PROJECT_DIR}/${TARGET_NAME}/GoogleService-Info.plist or ${PROJECT_DIR}/GoogleService-Info.plist. Skipping dSYM upload."
   elif [[ -x "${SPM_UPLOAD_SYMBOLS}" ]]; then
     echo "info: Exec FirebaseCrashlytics upload-symbols from SPM"
-    if ! "${SPM_UPLOAD_SYMBOLS}" -gsp "${GSP_PATH}" -p ios "${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}"; then
-      echo "warning: FirebaseCrashlytics upload-symbols (SPM) failed; continuing without failing the build. Common causes: no network, invalid/placeholder GoogleService-Info.plist credentials, or Firebase project mismatch."
+    if ! run_upload_symbols "${SPM_UPLOAD_SYMBOLS}" -gsp "${GSP_PATH}" -p ios "${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}"; then
+      echo "warning: FirebaseCrashlytics upload-symbols (SPM) failed or timed out; continuing without failing the build. Common causes: no network, invalid/placeholder GoogleService-Info.plist credentials, or Firebase project mismatch."
     fi
   elif [[ -f "${SPM_UPLOAD_SYMBOLS}" ]]; then
     echo "info: Exec FirebaseCrashlytics upload-symbols from SPM (chmod +x)"
     chmod +x "${SPM_UPLOAD_SYMBOLS}"
-    if ! "${SPM_UPLOAD_SYMBOLS}" -gsp "${GSP_PATH}" -p ios "${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}"; then
-      echo "warning: FirebaseCrashlytics upload-symbols (SPM) failed; continuing without failing the build. Common causes: no network, invalid/placeholder GoogleService-Info.plist credentials, or Firebase project mismatch."
+    if ! run_upload_symbols "${SPM_UPLOAD_SYMBOLS}" -gsp "${GSP_PATH}" -p ios "${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}"; then
+      echo "warning: FirebaseCrashlytics upload-symbols (SPM) failed or timed out; continuing without failing the build. Common causes: no network, invalid/placeholder GoogleService-Info.plist credentials, or Firebase project mismatch."
     fi
   else
     echo "warning: FirebaseCrashlytics run script not found at CocoaPods, framework, or SPM paths. Skipping dSYM upload."

package/lib/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '27.0.0';
+export const version = '27.1.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/crashlytics",
-  "version": "27.0.0",
+  "version": "27.1.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - Firebase Crashlytics is a lightweight, realtime crash reporter that helps you track, prioritize, and fix stability issues that erode your app quality. React Native Firebase provides automatic crash reporting for both native and JavaScript errors, including unhandled promise rejections.",
   "main": "./dist/module/index.js",
@@ -49,14 +49,14 @@
     "crashlytics"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "27.0.0",
+    "@react-native-firebase/app": "27.1.0",
     "expo": ">=47.0.0"
   },
   "dependencies": {
     "stacktrace-js": "^2.0.2"
   },
   "devDependencies": {
-    "@react-native-firebase/app": "27.0.0",
+    "@react-native-firebase/app": "27.1.0",
     "expo": "^55.0.18",
     "react-native-builder-bob": "^0.41.0",
     "typescript": "^6.0.3"
@@ -104,5 +104,5 @@
       ]
     ]
   },
-  "gitHead": "0c7e942bca361f1765abaf233bf447d795718eff"
+  "gitHead": "c65e1ee3b78bcd0c5b66996100d7d1e579ca1614"
 }