[iOS] appLaunched event is not fired after upgrading from 6.12.2 to 7.18.1 when using Swift

[varungupta85]

🐛 Bug Report

I use Swift for my iOS app. I have been using react-native-navigation for a few years now for my app and it has worked fine. I tried updating the package version from 6.12.2 to 7.18.1 and the app no longer starts. I have narrowed down the issue to appLaunched event not fired due to which the app is not started.

If I go back to version 6.12.2, it works fine. I have reproduced the issue in the playground repo in this fork branch

https://github.com/varungupta85/react-native-navigation/tree/swift-issue

Have you read the Contributing Guidelines on issues?

Yes

To Reproduce

1. Start the playground app
2. Observe that the app is not displayed

Expected behavior

App should come up

Actual Behavior

Black screen is seen indefinitely

Your Environment

• React Native Navigation version: 7.18.1
• React Native version: 0.63.2
• Platform(s) (iOS, Android, or both?): iOS
• Device info (Simulator/Device? OS version? Debug/Release?): Both

Reproducible Demo

https://github.com/varungupta85/react-native-navigation/tree/swift-issue

Are you willing to resolve this issue by submitting a Pull Request?

• ✖️   Yes, I have the time, and I know how to start.
• ✅   Yes, I have the time, but I don't know how to start. I would need guidance.
• ✖️   No, I don’t have the time and I’m okay to wait for the community / maintainers to resolve this issue.

[varungupta85]

cc @danilobuerger @yogevbd

[Andrew-Chen-Wang]

@varungupta85 I noticed that you used makeKey instead of makeKeyWindow. Can you try using the makeKeyWindow method? I'm not sure if this is an Objective C thing only though. Also, typically we use makeKeyAndVisible IIRC, so see if that works.

The AppDelegate.swift file may also not be set up correctly? Idk check out facebookarchive/react-native-fbsdk#770

[varungupta85]

@Andrew-Chen-Wang

I tried using makeKeyAndVisible but that didn't help. The AppDelegate.swift is correct. I have been using it like this for a few years in my app which is available on the App Store. After I update to 7.18.1, it stops working and I narrowed it down to the appLaunched event listener never getting fired. I don't know how to change the react-native-navigation version to 6.12.2. I guess you can't since it is using the code in the repository but if there is a way, I am sure this exact could work with version 6.12.2 without any changes. I am posting the AppDelegate.swift file for my app which works fine using 6.12.2.

/**
 * Copyright (c) 2015-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 */

import Foundation
import UIKit
import Firebase

#if FB_SONARKIT_ENABLED
private func InitializeFlipper(_ application: UIApplication?) {
    let client = FlipperClient.shared()
    let layoutDescriptorMapper = SKDescriptorMapper()
    client?.add(FlipperKitLayoutPlugin(rootNode: application, with: layoutDescriptorMapper))
    client?.add(FKUserDefaultsPlugin(suiteName: nil))
    client?.add(FlipperKitReactPlugin())
    client?.add(FlipperKitNetworkPlugin(networkAdapter: SKIOSNetworkAdapter()))
    client?.start()
}
#endif

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate, UNUserNotificationCenterDelegate {
  var window: UIWindow?
  var bridge: RCTBridge!
  
  enum BackgroundMode: Int {
    case fetch
    case remoteNotification
  }
  
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    #if FB_SONARKIT_ENABLED
        InitializeFlipper(application)
    #endif

    FirebaseApp.configure()
    
    #if DEBUG
      let jsCodeLocation = RCTBundleURLProvider.sharedSettings().jsBundleURL(forBundleRoot: "index", fallbackResource:nil)
    #else
      let jsCodeLocation = Bundle.main.url(forResource: "main", withExtension: "jsbundle")
    #endif
    
    ReactNativeNavigation.bootstrap(jsCodeLocation, launchOptions: launchOptions)
    self.bridge = ReactNativeNavigation.getBridge()
    
    // Define UNUserNotificationCenter
    let center = UNUserNotificationCenter.current()
    center.delegate = self
    
    // Initialize background fetch
    UIApplication.shared.setMinimumBackgroundFetchInterval(UIApplication.backgroundFetchIntervalMinimum)
        
    return true
  }

  func applicationSignificantTimeChange(_ application: UIApplication) {
    let appEventEmitter = self.bridge.module(for: AppEventEmitter.self) as! AppEventEmitter
    var localTimeZoneName: String { return TimeZone.current.identifier }
    appEventEmitter.sendEvent(withName: "timezoneChanged", body: [
      "timezone": localTimeZoneName
      ])
  }
  
    func applicationWillTerminate(_ application: UIApplication) {
      showAppTerminatedNotification()
    }
  
  //  func applicationDidReceiveMemoryWarning(application: UIApplication) {
  //    let appEventEmitter = self.bridge.moduleForClass(AppEventEmitter) as! AppEventEmitter
  //    appEventEmitter.sendEventWithName("lowMemoryWarning", body:nil)
  //  }
  
  //   func timezoneChanged() {
  //     let appEventEmitter = self.bridge.moduleForClass(AppEventEmitter) as! AppEventEmitter
  //     appEventEmitter.sendEventWithName("timezoneChanged", body:nil)
  //   }
  
  // Required to register for notifications
  func application(_ application: UIApplication,didRegister notificationSettings: UIUserNotificationSettings) {
    RNCPushNotificationIOS.didRegister(notificationSettings)
  }
  
  // Required for the register event.
  func application(_ application: UIApplication,didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    RNCPushNotificationIOS.didRegisterForRemoteNotifications(withDeviceToken: deviceToken)
  }
  
  // Required for the notification event.
  func application(_ application: UIApplication,didReceiveRemoteNotification notification: [AnyHashable: Any]) {
    RNCPushNotificationIOS.didReceiveRemoteNotification(notification)
  }
  
  // Required for the notification event with content-available key set to 1.
  func application(_ application: UIApplication,didReceiveRemoteNotification notification: [AnyHashable: Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
    RNCPushNotificationIOS.didReceiveRemoteNotification(notification, fetchCompletionHandler: completionHandler)
  }
  
  // Required for the localNotification event.
  func application(_ application: UIApplication,didReceive notification: UILocalNotification) {
    RNCPushNotificationIOS.didReceive(notification)
  }
  
  // IOS 10+ Required for localNotification event
  func userNotificationCenter(
      _ center: UNUserNotificationCenter,
      didReceive response: UNNotificationResponse,
      withCompletionHandler completionHandler: @escaping () -> Void
  ) {
      RNCPushNotificationIOS.didReceive(response)
      completionHandler()
  }
  
  //Called when a notification is delivered to a foreground app.
  func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
      completionHandler([.sound, .alert, .badge])
  }
  
  // Required for the registrationError event.
  func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
    RNCPushNotificationIOS.didFailToRegisterForRemoteNotificationsWithError(error)
  }
  
  func application(_ application: UIApplication, performFetchWithCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
    // Call the background fetch process.
    let appEventEmitter = self.bridge.module(for: AppEventEmitter.self) as! AppEventEmitter
    appEventEmitter.sendEvent(withName: "periodicFetch", body: nil)
    self.backgroundFetch(BackgroundMode.fetch, completionHandler: completionHandler)
  }
  
  func backgroundFetch(_ backgroundMode: BackgroundMode, completionHandler: @escaping (UIBackgroundFetchResult) -> Void) -> Void {
    // For debugging.
    //debugLocalNotification("Background Fetch Started.")
    
    // Dispatch the completion handler call at a later time.
    // For now, set 15 seconds of delay to give enough time for javascript to sync with firebase.
    // We may need to adjust this in the future.
    let dispatchDelayTime: Double = 15.0
    DispatchQueue.main.asyncAfter(deadline: DispatchTime.now() + Double(Int64(dispatchDelayTime * Double(NSEC_PER_SEC))) / Double(NSEC_PER_SEC), execute: {
      // Call the completion handler.
      // Pass NewData all the time for now.
      // At this point, it is unknown whether it is OK to pass NewData all the time or
      // we need to strictly diffentiate between NewData and NoData.
      // We may modify this in the future.
      completionHandler(UIBackgroundFetchResult.newData)
    });
  }
}

func showAppTerminatedNotification () {
  let notification = UILocalNotification()
  notification.alertBody = "Since you have stopped the app, alarms will not ring when your phone is on silent. Tap to start the app."
  notification.userInfo = ["type": "internalNotification"]
  UIApplication.shared.scheduleLocalNotification(notification)
}

// For easy debugging.
// In order for this to work, you need to have -DDEBUG flag in Build Settings ->
// Swift Compiler - Custom Flags -> Other Swift Flags -> Debug
func print(_ object: Any) {
  // Debug print.
  #if DEBUG
    print (object, terminator: "")
  #endif
}

func debugLocalNotification (_ alertBody: String) {
  #if DEBUG
    // Local notification for debugging.
    print(alertBody)
    let notification = UILocalNotification()
    notification.alertBody = alertBody
    var userInfo = [String:String]()
    userInfo["type"] = "debug"
    notification.userInfo = userInfo
    UIApplication.shared.scheduleLocalNotification(notification)
  #endif
}

[Andrew-Chen-Wang]

Can you ensure this function is being called?

react-native-navigation/lib/ios/RNNBridgeManager.mm

Lines 106 to 110 in ec60931

	- (void)onJavaScriptLoaded {
	[_commandsHandler setReadyToReceiveCommands:true];
	[_modalManager
	connectModalHostViewManager:[self.bridge moduleForClass:RCTModalHostViewManager.class]];
	[[_bridge moduleForClass:[RNNEventEmitter class]] sendOnAppLaunched];

[yogevbd]

@varungupta85 I see your AppDelegate is missing extraModulesForBridge. see here

[varungupta85]

@yogevbd Sorry for the delay in response. It is very easy to miss GitHub notifications since there are so many of them. I have the extraModulesForBridge method also defined. I upgrade to react-native 0.66 and tried upgrading react-native-naivgation also to the latest. This time, I getting the following runtime error:

2021-10-07 17:42:41.498781+0530 MyApp[49547:1570220] *** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[GUL_MyApp.AppDelegate-AD29C34F-3B60-4C9C-A546-A75A165A30EB window]: unrecognized selector sent to instance 0x600003304170'
*** First throw call stack:
(
	0   CoreFoundation                      0x000000011173abb4 __exceptionPreprocess + 242
	1   libobjc.A.dylib                     0x0000000108f98be7 objc_exception_throw + 48
	2   CoreFoundation                      0x0000000111749821 +[NSObject(NSObject) instanceMethodSignatureForSelector:] + 0
	3   UIKitCore                           0x00000001270e7f90 -[UIResponder doesNotRecognizeSelector:] + 264
	4   CoreFoundation                      0x000000011173ee57 ___forwarding___ + 820
	5   CoreFoundation                      0x00000001117411e8 _CF_forwarding_prep_0 + 120
	6   MyApp                           0x0000000105948a2f -[ReactNativeNavigation mainWindow] + 95
	7   MyApp                           0x0000000105948868 -[ReactNativeNavigation bootstrapWithBridge:] + 72
	8   MyApp                           0x0000000105948320 +[ReactNativeNavigation bootstrapWithBridge:] + 96
	9   MyApp                           0x0000000104ead7ce $s9MyApp0B8DelegateC11application_29didFinishLaunchingWithOptionsSbSo13UIApplicationC_SDySo0j6LaunchI3KeyaypGSgtF + 366
	10  MyApp                           0x0000000104eadaf7 $s9MyApp0B8DelegateC11application_29didFinishLaunchingWithOptionsSbSo13UIApplicationC_SDySo0j6LaunchI3KeyaypGSgtFTo + 183
	11  UIKitCore                           0x00000001270ace21 -[UIApplication _handleDelegateCallbacksWithOptions:isSuspended:restoreState:] + 216
	12  UIKitCore                           0x00000001270aea91 -[UIApplication _callInitializationDelegatesWithActions:forCanvas:payload:fromOriginatingProcess:] + 4115
	13  UIKitCore                           0x00000001270b4403 -[UIApplication _runWithMainScene:transitionContext:completion:] + 1221
	14  UIKitCore                           0x0000000126635668 -[_UISceneLifecycleMultiplexer completeApplicationLaunchWithFBSScene:transitionContext:] + 122
	15  UIKitCore                           0x0000000126c1e3e2 _UIScenePerformActionsWithLifecycleActionMask + 88
	16  UIKitCore                           0x000000012663615f __101-[_UISceneLifecycleMultiplexer _evalTransitionToSettings:fromSettings:forceExit:withTransitionStore:]_block_invoke + 198
	17  UIKitCore                           0x0000000126635b95 -[_UISceneLifecycleMultiplexer _performBlock:withApplicationOfDeactivationReasons:fromReasons:] + 248
	18  UIKitCore                           0x0000000126635f93 -[_UISceneLifecycleMultiplexer _evalTransitionToSettings:fromSettings:forceExit:withTransitionStore:] + 840
	19  UIKitCore                           0x0000000126635842 -[_UISceneLifecycleMultiplexer uiScene:transitionedFromState:withTransitionContext:] + 351
	20  UIKitCore                           0x000000012663fbc6 __186-[_UIWindowSceneFBSSceneTransitionContextDrivenLifecycleSettingsDiffAction _performActionsForUIScene:withUpdatedFBSScene:settingsDiff:fromSettings:transitionContext:lifecycleActionType:]_block_invoke + 178
	21  UIKitCore                           0x0000000126b037a3 +[BSAnimationSettings(UIKit) tryAnimatingWithSettings:actions:completion:] + 871
	22  UIKitCore                           0x0000000126c3af9a _UISceneSettingsDiffActionPerformChangesWithTransitionContext + 246
	23  UIKitCore                           0x000000012663f844 -[_UIWindowSceneFBSSceneTransitionContextDrivenLifecycleSettingsDiffAction _performActionsForUIScene:withUpdatedFBSScene:settingsDiff:fromSettings:transitionContext:lifecycleActionType:] + 346
	24  UIKitCore                           0x000000012643ed6e __64-[UIScene scene:didUpdateWithDiff:transitionContext:completion:]_block_invoke.573 + 797
	25  UIKitCore                           0x000000012643d71b -[UIScene _emitSceneSettingsUpdateResponseForCompletion:afterSceneUpdateWork:] + 253
	26  UIKitCore                           0x000000012643e92d -[UIScene scene:didUpdateWithDiff:transitionContext:completion:] + 255
	27  UIKitCore                           0x00000001270b2ce6 -[UIApplication workspace:didCreateScene:withTransitionContext:completion:] + 508
	28  UIKitCore                           0x0000000126b3362e -[UIApplicationSceneClientAgent scene:didInitializeWithEvent:completion:] + 358
	29  FrontBoardServices                  0x0000000114690d98 -[FBSScene _callOutQueue_agent_didCreateWithTransitionContext:completion:] + 419
	30  FrontBoardServices                  0x00000001146bd4a3 __94-[FBSWorkspaceScenesClient createWithSceneID:groupID:parameters:transitionContext:completion:]_block_invoke.180 + 102
	31  FrontBoardServices                  0x000000011469f21a -[FBSWorkspace _calloutQueue_executeCalloutFromSource:withBlock:] + 209
	32  FrontBoardServices                  0x00000001146bd082 __94-[FBSWorkspaceScenesClient createWithSceneID:groupID:parameters:transitionContext:completion:]_block_invoke + 352
	33  libdispatch.dylib                   0x000000010d759c0c _dispatch_client_callout + 8
	34  libdispatch.dylib                   0x000000010d75cb7f _dispatch_block_invoke_direct + 295
	35  FrontBoardServices                  0x00000001146e3dc8 __FBSSERIALQUEUE_IS_CALLING_OUT_TO_A_BLOCK__ + 30
	36  FrontBoardServices                  0x00000001146e3cbe -[FBSSerialQueue _targetQueue_performNextIfPossible] + 174
	37  FrontBoardServices                  0x00000001146e3df0 -[FBSSerialQueue _performNextFromRunLoopSource] + 19
	38  CoreFoundation                      0x00000001116a8e25 __CFRUNLOOP_IS_CALLING_OUT_TO_A_SOURCE0_PERFORM_FUNCTION__ + 17
	39  CoreFoundation                      0x00000001116a8d1d __CFRunLoopDoSource0 + 180
	40  CoreFoundation                      0x00000001116a81f2 __CFRunLoopDoSources0 + 242
	41  CoreFoundation                      0x00000001116a2951 __CFRunLoopRun + 875
	42  CoreFoundation                      0x00000001116a2103 CFRunLoopRunSpecific + 567
	43  GraphicsServices                    0x000000011202ecd3 GSEventRunModal + 139
	44  UIKitCore                           0x00000001270b0e63 -[UIApplication _run] + 928
	45  UIKitCore                           0x00000001270b5a53 UIApplicationMain + 101
	46  MyApp                           0x0000000104eb009f main + 63
	47  dyld                                0x0000000108687e1e start_sim + 10
	48  ???                                 0x0000000000000001 0x0 + 1
	49  ???                                 0x0000000000000001 0x0 + 1
)
libc++abi: terminating with uncaught exception of type NSException
dyld4 config: DYLD_ROOT_PATH=/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS.simruntime/Contents/Resources/RuntimeRoot DYLD_LIBRARY_PATH=/Users/varungupta/Library/Developer/Xcode/DerivedData/MyApp-fmnuefdhjqqnmpducwxhppwxjzsj/Build/Products/Debug-iphonesimulator:/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS.simruntime/Contents/Resources/RuntimeRoot/usr/lib/system/introspection DYLD_INSERT_LIBRARIES=/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS.simruntime/Contents/Resources/RuntimeRoot/usr/lib/libBacktraceRecording.dylib:/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS.simruntime/Contents/Resources/RuntimeRoot/usr/lib/libMainThreadChecker.dylib:/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS.simruntime/Contents/Resources/RuntimeRoot/Developer/Library/PrivateFrameworks/DTDDISupport.framework/libViewDebuggerSupport.dylib DYLD_FRAMEWORK_PATH=/Users/varungupta/Library/Developer/Xcode/DerivedData/MyApp-fmnuefdhjqqnmpducwxhppwxjzsj/Build/Products/Debug-iphonesimulator
terminating with uncaught exception of type NSException
*** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[GUL_MyApp.AppDelegate-AD29C34F-3B60-4C9C-A546-A75A165A30EB window]: unrecognized selector sent to instance 0x600003304170'
CoreSimulator 776.3 - Device: iPhone 12 Pro Max (82E4DA05-412A-4DD3-888E-986B27C59246) - Runtime: iOS 15.0 (19A339) - DeviceType: iPhone 12 Pro Max
(Recorded stack frame) 

I think it has something to do with react-native-navigation. I have updated other packages also to the latest. I am using react-native-navigation version 7.22.3 now.

Please let me know how can I debug/fix this problem.

[varungupta85]

This is where it breaks when I add "Exception Breakpoint" in Xcode

I am not sure what kind of message is sent that is causing it to break. Please help.

[danilobuerger]

Most likely https://stackoverflow.com/a/58851340/2525941

[varungupta85]

Thanks @danilobuerger. That in fact was the problem. I had it earlier but it somehow got deleted during edits.

Now I am back on the earlier issue where the appLaunched event is not emitted. I have created a new reproducible example that I created just now using react-native 0.66. It is present here https://github.com/varungupta85/RNSample66.

There are two branches

1. master: Uses the default objective-C code and it runs fine
2. use-swift: AppDelegate file is converted to Swift and the app get stuck on the splash screen.

I don't see any error logs or anything else that tells about the potential problem.

To run the project,

1. Clone the repo
2. npm install
3. pod install in the ios directory
4. Run the project
5. Observe that the app is stuck on the splash screen

I don't have much experience with the iOS native side code and I would really appreciate it if you could help me out here.

[varungupta85]

I did some more research and created one more sample project to verify that the problem is somewhere within the react-native-navigation package. I created one more repository https://github.com/varungupta85/RNSample66Issue1.

This repository also contains a sample project using react-native 0.66. The master branch contains that the default template which runs fine. The use-swift branch contains the AppDelegate file changed to Swift same way as done in the RNSample66 repo and it also works fine.

This points to the fact that there is some issue with react-native-navigation that is causing the issue.

cc @yogevbd @danilobuerger @guyca

[AlexDM0]

Same issue here. I was hoping to update before our release but so far I can't get it to start the app. I also have a swift based appdelegate.