@hot-updater/react-native 1.0.7 → 1.1.0

package/android/src/main/java/com/hotupdater/HotUpdaterImpl.kt

@@ -1,5 +1,6 @@
 package com.hotupdater
 
+import android.app.Activity
 import android.app.ActivityOptions
 import android.app.Application
 import android.content.Context
@@ -7,23 +8,56 @@ import android.content.Intent
 import android.os.Process
 import android.util.Log
 import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withContext
-import java.io.File
+import java.util.concurrent.atomic.AtomicLong
 
 /**
  * Core implementation class for HotUpdater functionality
  */
 class HotUpdaterImpl {
     private val context: Context
+    private val environment: HotUpdaterInstanceEnvironment
     private val bundleStorage: BundleStorageService
     private val preferences: PreferencesService
+
+    // Each instance watches its own launch: its crash marker, and the launch
+    // gate that waits for one of its own views.
     private val recoveryManager: HotUpdaterRecoveryManager
+    private val activityStartGate: ActivityStartGate
     private val releaseCatalogCache: ReleaseCatalogCacheService
     private val installIdentity: InstallIdentityService
     private val keyValueStorage: KeyValueStorageService
-    private val activityStartGate: ActivityStartGate
+
+    // Read by native update checks on other threads while React Native sets it.
+    @Volatile
     private var currentLaunchSelection: LaunchSelection? = null
 
+    // The selection React Native runs in this process. A channel reset clears
+    // currentLaunchSelection, so React Native's next read picks the default
+    // channel's bundle, but the running bundle stays until a reload.
+    @Volatile
+    private var runningLaunchSelection: LaunchSelection? = null
+
+    // Counts the crash markers written for this instance's launches. A
+    // prepared launch keeps the count it started from: one written since,
+    // even while it was being prepared, makes the next start prepare again,
+    // which reads the marker. Crash recovery bumps it under its own lock, so
+    // it never waits for the launch lock.
+    private val launchInvalidations = AtomicLong()
+
+    @Volatile
+    private var currentLaunchInvalidations = 0L
+
+    // The selection a named instance's monitored launch runs, with that
+    // launch, under the launch lock.
+    private var monitoredLaunch: Pair<LaunchSelection, Long>? = null
+
+    // Serializes the launch's bundle selection with the update check's read
+    // of it, so a check never reads metadata the launch is still selecting from,
+    // and with a channel reset or built-in commit, which delete downloaded bundles.
+    private val launchPreparationLock = Any()
+
     /**
      * Primary constructor with dependency injection (for testing)
      */
@@ -31,27 +65,50 @@ class HotUpdaterImpl {
         context: Context,
         bundleStorage: BundleStorageService,
         preferences: PreferencesService,
+    ) : this(context, bundleStorage, preferences, HotUpdaterInstanceEnvironment.main)
+
+    /**
+     * @param activityStartGate the gate that arms this instance's launch;
+     * by default one that waits for a started activity showing one of its views
+     */
+    internal constructor(
+        context: Context,
+        bundleStorage: BundleStorageService,
+        preferences: PreferencesService,
+        environment: HotUpdaterInstanceEnvironment,
+        activityStartGate: ActivityStartGate? = null,
     ) {
         this.context = context.applicationContext
+        // An activity started before this process followed activities is
+        // known only from the context the app hands over.
+        (context as? Activity)?.let(HotUpdaterRecoveryAttribution.shared::noteActivity)
+        this.environment = environment
         this.bundleStorage = bundleStorage
         this.preferences = preferences
-        this.activityStartGate = ActivityStartGate(this.context as? Application)
-        this.recoveryManager = HotUpdaterRecoveryManager(this.context)
+        this.recoveryManager = HotUpdaterRecoveryManager(this.context, environment)
+        this.activityStartGate = activityStartGate ?: createActivityStartGate(this.context, environment)
         this.releaseCatalogCache =
-            ReleaseCatalogCacheService(
-                File(this.context.noBackupFilesDir, "hot-updater-release-catalog-cache"),
-            )
+            ReleaseCatalogCacheService(environment.releaseCatalogCacheDirectory(this.context))
         this.installIdentity = InstallIdentityService.create(this.context)
-        this.keyValueStorage = KeyValueStorageService.create(this.context)
+        this.keyValueStorage = KeyValueStorageService(environment.keyValueStorageFile(this.context))
     }
 
     /**
      * Convenience constructor for simple usage
      */
-    constructor(context: Context) : this(
+    constructor(context: Context) : this(context, HotUpdaterInstanceEnvironment.main)
+
+    /** The impl of a named instance, or of main, with its own storage and configuration. */
+    internal constructor(
+        context: Context,
+        environment: HotUpdaterInstanceEnvironment,
+        activityStartGate: ActivityStartGate? = null,
+    ) : this(
         context = context,
-        bundleStorage = createBundleStorage(context),
-        preferences = createPreferences(context),
+        bundleStorage = createBundleStorage(context, environment),
+        preferences = createPreferences(context, environment),
+        environment = environment,
+        activityStartGate = activityStartGate,
     )
 
     /**
@@ -79,18 +136,25 @@ class HotUpdaterImpl {
 
     companion object {
         private const val TAG = "HotUpdaterImpl"
-        private const val DEFAULT_CHANNEL = "production"
+        internal const val DEFAULT_CHANNEL = "production"
         private const val CHANNEL_STORAGE_KEY = "HotUpdaterChannel"
 
+        // How many times one start prepares its launch while crashes of the
+        // running launch keep writing markers.
+        private const val MAX_LAUNCH_PREPARATIONS = 3
+
         /**
          * Create BundleStorageService with all dependencies
          */
-        private fun createBundleStorage(context: Context): BundleStorageService {
+        private fun createBundleStorage(
+            context: Context,
+            environment: HotUpdaterInstanceEnvironment,
+        ): BundleStorageService {
             val appContext = context.applicationContext
-            val fileSystem = FileManagerService(appContext)
-            val preferences = createPreferences(appContext)
+            val fileSystem = FileManagerService(appContext, environment.filesRoot(appContext))
+            val preferences = createPreferences(appContext, environment)
             val downloadService = OkHttpDownloadService()
-            val isolationKey = getIsolationKey(appContext)
+            val isolationKey = environment.isolationKey(appContext)
 
             return BundleFileStorageService(
                 appContext,
@@ -98,43 +162,54 @@ class HotUpdaterImpl {
                 downloadService,
                 preferences,
                 isolationKey,
+                defaultChannelProvider = { environment.defaultChannel(appContext) },
+                fingerprintHashProvider = { environment.fingerprintHash(appContext) },
+                publicKeyProvider = { environment.publicKey(appContext) },
+                fallbackBundleURL = environment.fallbackBundleURL,
             )
         }
 
         /**
-         * Create PreferencesService with isolation key
+         * A launch counts once a started activity shows one of the instance's
+         * views. Main takes every view no named instance claims, so an app
+         * with only main waits for any React Native view, as it always has,
+         * and counts an activity started before the gate at once. A named
+         * instance is often prepared while the app already shows other
+         * screens, so it checks the activities already started for its view.
          */
-        private fun createPreferences(context: Context): PreferencesService {
-            val appContext = context.applicationContext
-            val isolationKey = getIsolationKey(appContext)
-            return VersionedPreferencesService(appContext, isolationKey)
+        private fun createActivityStartGate(
+            context: Context,
+            environment: HotUpdaterInstanceEnvironment,
+        ): ActivityStartGate {
+            val attribution = HotUpdaterRecoveryAttribution.shared
+            return ActivityStartGate(
+                context as? Application,
+                showsReactView = { activity -> attribution.showsViewOf(activity, environment.name) },
+                activitiesStartedBefore = activitiesStartedBefore(environment, attribution),
+                beforeCheckingViews = HotUpdaterRecoveryManager::resolveHeldContent,
+            )
         }
 
         /**
-         * Gets the complete isolation key for preferences storage
-         * @param context Application context
-         * @return The isolation key in format: HotUpdaterPrefs_{fingerprintOrVersion}_{channel}
+         * The activities already started that a gate created now checks for
+         * the instance's view: a named instance's, while main counts any
+         * started activity at once, as it always has (null).
          */
-        private fun getIsolationKey(context: Context): String {
-            // Programmatic override (brownfield/AAR). When set, it is used verbatim
-            // so the OTA cache can stay stable across host app version bumps.
-            HotUpdaterConfig.isolationKey?.takeIf { it.isNotEmpty() }?.let { return it }
+        internal fun activitiesStartedBefore(
+            environment: HotUpdaterInstanceEnvironment,
+            attribution: HotUpdaterRecoveryAttribution = HotUpdaterRecoveryAttribution.shared,
+        ): (() -> Collection<Activity>)? = if (environment.isMain) null else attribution::startedActivities
 
-            val fingerprintHash = getFingerprintHash(context)
-
-            // Get app version and channel
-            val appVersion = getAppVersion(context) ?: "unknown"
-            val appChannel = getChannel(context)
-
-            // Include both fingerprint hash and app version for complete isolation
-            val baseKey =
-                if (!fingerprintHash.isNullOrEmpty()) {
-                    "${fingerprintHash}_$appVersion"
-                } else {
-                    appVersion
-                }
-
-            return "HotUpdaterPrefs_${baseKey}_$appChannel"
+        /**
+         * Create PreferencesService with isolation key
+         */
+        private fun createPreferences(
+            context: Context,
+            environment: HotUpdaterInstanceEnvironment,
+        ): PreferencesService {
+            val appContext = context.applicationContext
+            val isolationKey = environment.isolationKey(appContext)
+            return VersionedPreferencesService(appContext, isolationKey, environment.preferencesPrefix)
         }
 
         fun getAppVersion(context: Context): String? =
@@ -177,22 +252,25 @@ class HotUpdaterImpl {
          * @param context Application context
          * @return The fingerprint hash or null if not set
          */
-        fun getFingerprintHash(context: Context): String? =
-            NativeConfigUtils.getString(
-                context,
-                NativeConfigUtils.FINGERPRINT_HASH_META_DATA_KEY,
-            )
+        fun getFingerprintHash(
+            @Suppress("UNUSED_PARAMETER") context: Context,
+        ): String? = resolveFingerprintHash()
+
+        /**
+         * The programmatic override (brownfield/AAR setups, see HotUpdaterConfig),
+         * else the fingerprint the build embedded, written by the
+         * generateHotUpdaterFingerprintHash build task.
+         */
+        private fun resolveFingerprintHash(): String? =
+            HotUpdaterConfig.fingerprintHash?.takeIf { it.isNotEmpty() }
+                ?: HotUpdaterConfig.buildFingerprintHash
     }
 
     /**
      * Gets the current fingerprint hash
      * @return The fingerprint hash or null if not set
      */
-    fun getFingerprintHash(): String? =
-        NativeConfigUtils.getString(
-            context,
-            NativeConfigUtils.FINGERPRINT_HASH_META_DATA_KEY,
-        )
+    fun getFingerprintHash(): String? = environment.fingerprintHash(context)
 
     /**
      * Gets the current update channel
@@ -209,19 +287,24 @@ class HotUpdaterImpl {
             return overriddenChannel
         }
 
-        return NativeConfigUtils.getString(
-            context,
-            NativeConfigUtils.CHANNEL_META_DATA_KEY,
-        ) ?: DEFAULT_CHANNEL
+        return environment.defaultChannel(context)
     }
 
-    fun getDefaultChannel(): String = getChannel(context)
+    fun getDefaultChannel(): String = environment.defaultChannel(context)
 
     /**
      * Gets the path to the bundle file
      * @return The path to the bundle file
      */
-    fun getJSBundleFile(): String = prepareLaunchIfNeeded().bundleUrl
+    fun getJSBundleFile(): String {
+        // Hot Updater's restart process only relaunches the app; preparing a
+        // launch there would consume the crash marker and launch state the
+        // relaunched process needs.
+        if (HotUpdaterProcess.isRestartProcess(context)) {
+            return bundleStorage.getFallbackBundleURL()
+        }
+        return prepareLaunchIfNeeded().bundleUrl
+    }
 
     /**
      * Updates the bundle from its manifest and complete asset descriptors.
@@ -244,18 +327,16 @@ class HotUpdaterImpl {
         fileResolver: ArtifactFileResolver? = null,
         progressCallback: (UpdateProgressPayload) -> Unit,
     ): UpdateBundleResult {
-        if (selection != null && !bundleStorage.stageReleaseSelection(selection)) {
-            throw StaleReleaseSelectionException()
-        }
         val result =
             bundleStorage.updateBundle(
-                bundleId,
-                manifestUrl,
-                manifestFileHash,
-                assets,
-                archiveUrl,
-                fileResolver,
-                progressCallback,
+                bundleId = bundleId,
+                manifestUrl = manifestUrl,
+                manifestFileHash = manifestFileHash,
+                assets = assets,
+                archiveUrl = archiveUrl,
+                fileResolver = fileResolver,
+                selection = selection,
+                progressCallback = progressCallback,
             )
 
         if (!channel.isNullOrEmpty()) {
@@ -269,43 +350,25 @@ class HotUpdaterImpl {
     }
 
     /**
-     * Reloads the React Native application
+     * Restarts the app process so the next launch loads the current bundle.
      * @param reactContext The original context (preferably ReactApplicationContext to get current activity)
      */
     suspend fun reload(reactContext: Context) {
         try {
-            currentLaunchSelection = null
-            withContext(Dispatchers.Main) {
-                performReactReload(reactContext)
-            }
-        } catch (e: Exception) {
-            Log.e("HotUpdaterImpl", "Failed to reload application", e)
-        }
-    }
-
-    suspend fun reloadProcess(reactContext: Context) {
-        try {
-            currentLaunchSelection = null
             withContext(Dispatchers.Main) {
                 if (!restartApplication(reactContext)) {
-                    Log.w(TAG, "Falling back to in-process reload because process restart could not be started")
-                    performReactReload(reactContext)
+                    throw IllegalStateException("Process restart could not be started")
                 }
             }
+            currentLaunchSelection = null
+            runningLaunchSelection = null
         } catch (e: Exception) {
             Log.e("HotUpdaterImpl", "Failed to restart application process", e)
             throw e
         }
     }
 
-    private suspend fun performReactReload(reactContext: Context) {
-        val reactIntegrationManager = ReactIntegrationManager(reactContext)
-        val bundleURL = getJSBundleFile()
-        reactIntegrationManager.setJSBundle(bundleURL)
-        reactIntegrationManager.reload()
-    }
-
-    // Use a cold restart in release builds so bundle application does not depend on RN reload timing.
+    // A cold restart, so applying a bundle does not depend on React Native reload timing.
     private fun restartApplication(reactContext: Context): Boolean {
         val applicationContext = reactContext.applicationContext
         val currentActivity =
@@ -381,7 +444,24 @@ class HotUpdaterImpl {
             selectionContextHash,
         )
 
-    suspend fun commitReleaseSelection(selection: PersistedSelection): Boolean = bundleStorage.commitReleaseSelection(selection)
+    suspend fun commitReleaseSelection(selection: PersistedSelection): Boolean {
+        if (selection.kind == "BUNDLE") return bundleStorage.commitReleaseSelection(selection)
+
+        // Committing the built-in bundle deletes every downloaded bundle, so it
+        // runs under the launch lock as a channel reset does: React Native never
+        // selects a bundle the commit is about to delete, and its next read picks
+        // the built-in bundle. The storage commit runs on another IO thread, so
+        // blocking this one cannot deadlock.
+        return withContext(Dispatchers.IO) {
+            synchronized(launchPreparationLock) {
+                val committed = runBlocking { bundleStorage.commitReleaseSelection(selection) }
+                if (committed) {
+                    currentLaunchSelection = null
+                }
+                committed
+            }
+        }
+    }
 
     fun getInstallId(): String = installIdentity.getInstallId()
 
@@ -438,6 +518,38 @@ class HotUpdaterImpl {
         return null
     }
 
+    /**
+     * The bundle this process runs. A channel reset clears [currentLaunchSelection]
+     * for the next launch, but the running bundle stays until React Native reloads.
+     */
+    fun getRunningBundleId(): String? = (currentLaunchSelection ?: runningLaunchSelection)?.launchedBundleId
+
+    /** Takes the queued native update events for JavaScript's `takeNativeUpdateEvents`. */
+    fun takeNativeUpdateEvents(): String? =
+        NativeUpdateEventQueue(::getStorageItem, ::setStorageItem, build = {
+            NativeUpdateEventQueue.buildOf(getAppVersion(), getMinBundleId(), CohortService(context).getCohort())
+        }).take()
+
+    /**
+     * The bundle the native update check counts as running: the launched one,
+     * or before React Native starts, the one its launch would pick. Before
+     * React Native starts, what the previous process left is settled first, so
+     * the check reads the selection, launch state, and crash history the
+     * launch will use. Preparing the launch here would arm crash monitoring and
+     * keep a forced update staged before React Native starts from applying in
+     * this process.
+     */
+    fun getBundleIdForUpdateCheck(): String? =
+        synchronized(launchPreparationLock) {
+            val launchSelection = currentLaunchSelection ?: runningLaunchSelection
+            if (launchSelection != null) {
+                return@synchronized launchSelection.launchedBundleId
+            }
+
+            bundleStorage.settlePreviousLaunch { recoveryManager.consumePendingCrashRecovery() }
+            bundleStorage.peekLaunchBundleId()
+        }
+
     /**
      * Gets the current manifest from bundle storage.
      */
@@ -450,40 +562,134 @@ class HotUpdaterImpl {
         return emptyMap()
     }
 
-    suspend fun resetChannel(): Boolean {
-        val success = bundleStorage.resetChannel()
-        if (success) {
-            preferences.setItem(CHANNEL_STORAGE_KEY, null)
-            currentLaunchSelection = null
+    suspend fun resetChannel(): Boolean =
+        withContext(Dispatchers.IO) {
+            // Under the launch lock, so React Native never selects a bundle the
+            // reset is about to delete. The storage reset runs on another IO
+            // thread, so blocking this one cannot deadlock.
+            synchronized(launchPreparationLock) {
+                val success = runBlocking { bundleStorage.resetChannel() }
+                if (success) {
+                    preferences.setItem(CHANNEL_STORAGE_KEY, null)
+                    currentLaunchSelection = null
+                }
+                success
+            }
+        }
+
+    private fun prepareLaunchIfNeeded(): LaunchSelection =
+        synchronized(launchPreparationLock) {
+            prepareLaunchLocked()
+        }
+
+    private fun prepareLaunchLocked(): LaunchSelection {
+        var invalidations = launchInvalidations.get()
+        currentLaunchSelection?.takeIf { currentLaunchInvalidations == invalidations }?.let { return it }
+
+        // The running launch's crash may write its marker while this one is
+        // prepared, after the marker was read: the selection would launch
+        // the failing bundle again. Its monitoring is replaced only once the
+        // new launch's starts, so the count is checked after that, and the
+        // launch prepared again, reading the marker, while it changed. A
+        // crash can't recur faster than a launch is prepared; should it, the
+        // latest selection goes, and the count it started from has the next
+        // start prepare again.
+        repeat(MAX_LAUNCH_PREPARATIONS - 1) {
+            val prepared = selectAndMonitorLaunchLocked()
+            val now = launchInvalidations.get()
+            if (now == invalidations) return publishLaunchLocked(prepared, invalidations)
+            invalidations = now
         }
-        return success
+        return publishLaunchLocked(selectAndMonitorLaunchLocked(), invalidations)
     }
 
-    private fun prepareLaunchIfNeeded(): LaunchSelection {
-        currentLaunchSelection?.let { return it }
+    private class PreparedLaunch(
+        val selection: LaunchSelection,
+        val launch: Long,
+        /** False when the selection continues the launch already monitored. */
+        val started: Boolean,
+    )
+
+    /**
+     * Whether [next] continues the named instance's launch of [current]
+     * rather than starting another: the same bundle, from the same URL,
+     * still unverified, or verified since. A launch's state is its bundle's
+     * persisted verification, so the same bundle selected again in this
+     * process, as after a reset that keeps it or a reload before the
+     * process restarts, is the same launch; another one would make its
+     * runtimes, which load the same URL, look like a replacement's.
+     */
+    private fun continuesLaunch(
+        current: LaunchSelection,
+        next: LaunchSelection,
+    ): Boolean =
+        current.launchedBundleId == next.launchedBundleId &&
+            current.bundleUrl == next.bundleUrl &&
+            (current.shouldRollbackOnCrash || !next.shouldRollbackOnCrash)
 
+    private fun selectAndMonitorLaunchLocked(): PreparedLaunch {
         val pendingRecovery = recoveryManager.consumePendingCrashRecovery()
         val selection = bundleStorage.prepareLaunch(pendingRecovery)
+        monitoredLaunch?.let { (current, launch) ->
+            if (!environment.isMain && continuesLaunch(current, selection) && recoveryManager.monitorsLaunch(launch)) {
+                return PreparedLaunch(selection, launch, started = false)
+            }
+        }
+        val launch =
+            recoveryManager.startMonitoring(
+                bundleId = selection.launchedBundleId,
+                shouldRollback = selection.shouldRollbackOnCrash,
+                onContentAppeared = { launchedBundleId ->
+                    bundleStorage.markLaunchCompleted(launchedBundleId)
+                },
+                onCrashOfAnotherInstance = { launchedBundleId ->
+                    bundleStorage.clearLaunchStarted(launchedBundleId)
+                },
+                // Restarting the app restarts main's host. A named instance's
+                // crash leaves its marker for its next launch to roll back.
+                onRecoveryRestartRequested =
+                    if (environment.isMain) {
+                        { restartApplication(context) }
+                    } else {
+                        null
+                    },
+                onRuntimeActivity = activityStartGate::watchActivity,
+                launchURL = selection.bundleUrl,
+                onCharged = { launchInvalidations.incrementAndGet() },
+            )
+        return PreparedLaunch(selection, launch, started = true)
+    }
+
+    private fun publishLaunchLocked(
+        prepared: PreparedLaunch,
+        invalidations: Long,
+    ): LaunchSelection {
+        val selection = prepared.selection
+        val launch = prepared.launch
+        monitoredLaunch = selection to launch
+        // A launch continued keeps its gate, which may have armed it already.
+        if (!prepared.started) {
+            runningLaunchSelection = selection
+            currentLaunchInvalidations = invalidations
+            currentLaunchSelection = selection
+            return selection
+        }
         // A headless JS task, such as a background push, loads the bundle without
         // an activity and never renders. Only a launch with an activity may leave
-        // an unfinished launch for the next process to roll back.
+        // an unfinished launch for the next process to roll back. A named
+        // runtime may also be pre-warmed while the app shows other screens, so
+        // its launch waits for one of its own views.
         activityStartGate.runWhenActivityStarted(
             if (selection.shouldRollbackOnCrash) {
-                { bundleStorage.markLaunchStarted(selection.launchedBundleId) }
+                {
+                    recoveryManager.armLaunch(launch) { bundleStorage.markLaunchStarted(selection.launchedBundleId) }
+                }
             } else {
                 null
             },
         )
-        recoveryManager.startMonitoring(
-            bundleId = selection.launchedBundleId,
-            shouldRollback = selection.shouldRollbackOnCrash,
-            onContentAppeared = { launchedBundleId ->
-                bundleStorage.markLaunchCompleted(launchedBundleId)
-            },
-            onRecoveryRestartRequested = {
-                restartApplication(context)
-            },
-        )
+        runningLaunchSelection = selection
+        currentLaunchInvalidations = invalidations
         currentLaunchSelection = selection
         return selection
     }