expo-updates 0.28.2 → 0.28.4

package/CHANGELOG.md

@@ -10,6 +10,16 @@
 
 ### 💡 Others
 
+## 0.28.4 — 2025-04-14
+
+### 🎉 New features
+
+- [Android] Added `EX_UPDATES_COPY_EMBEDDED_ASSETS` flag which is false by default, to not copy embedded assets. ([#36059](https://github.com/expo/expo/pull/36059) by [@kudo](https://github.com/kudo))
+
+## 0.28.3 — 2025-04-11
+
+_This version does not introduce any user-facing changes._
+
 ## 0.28.2 — 2025-04-09
 
 _This version does not introduce any user-facing changes._

package/android/build.gradle

@@ -39,7 +39,7 @@ expoModule {
 }
 
 group = 'host.exp.exponent'
-version = '0.28.2'
+version = '0.28.4'
 
 // Utility method to derive boolean values from the environment or from Java properties,
 // and return them as strings to be used in BuildConfig fields
@@ -72,6 +72,9 @@ def exUpdatesCustomInit = getBoolStringFromPropOrEnv("EX_UPDATES_CUSTOM_INIT", f
 // (default true)
 def exUpdatesAndroidDelayLoadApp = getBoolStringFromPropOrEnv("EX_UPDATES_ANDROID_DELAY_LOAD_APP", true)
 
+// If true, updates will copy embedded assets to file system when startup. (default false)
+def exUpdatesCopyEmbeddedAssets = getBoolStringFromPropOrEnv("EX_UPDATES_COPY_EMBEDDED_ASSETS", false)
+
 def useDevClient = findProject(":expo-dev-client") != null
 
 android {
@@ -82,13 +85,14 @@ android {
   namespace "expo.modules.updates"
   defaultConfig {
     versionCode 31
-    versionName '0.28.2'
+    versionName '0.28.4'
     consumerProguardFiles("proguard-rules.pro")
     testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
 
     buildConfigField("boolean", "EX_UPDATES_NATIVE_DEBUG", exUpdatesNativeDebug)
     buildConfigField("boolean", "EX_UPDATES_CUSTOM_INIT", exUpdatesCustomInit)
     buildConfigField("boolean", "EX_UPDATES_ANDROID_DELAY_LOAD_APP", exUpdatesAndroidDelayLoadApp)
+    buildConfigField("boolean", "EX_UPDATES_COPY_EMBEDDED_ASSETS", exUpdatesCopyEmbeddedAssets)
     buildConfigField("boolean", "USE_DEV_CLIENT", useDevClient.toString())
   }
   testOptions {
@@ -136,16 +140,17 @@ dependencies {
   implementation("org.bouncycastle:bcutil-jdk15to18:1.78.1")
 
   testImplementation 'junit:junit:4.13.2'
-  testImplementation 'androidx.test:core:1.5.0'
+  testImplementation 'androidx.test:core:1.6.1'
+  testImplementation 'com.google.truth:truth:1.1.2'
   testImplementation "io.mockk:mockk:$mockk_version"
   testImplementation "org.jetbrains.kotlin:kotlin-test-junit:${kotlinVersion}"
   testImplementation 'org.jetbrains.kotlinx:kotlinx-coroutines-test:1.7.3'
   testImplementation 'org.robolectric:robolectric:4.14.1'
 
   androidTestImplementation 'com.squareup.okio:okio:2.9.0'
-  androidTestImplementation 'androidx.test:runner:1.5.2'
-  androidTestImplementation 'androidx.test:core:1.5.0'
-  androidTestImplementation 'androidx.test:rules:1.5.0'
+  androidTestImplementation 'androidx.test:runner:1.6.2'
+  androidTestImplementation 'androidx.test:core:1.6.1'
+  androidTestImplementation 'androidx.test:rules:1.6.1'
   androidTestImplementation "io.mockk:mockk-android:$mockk_version"
   androidTestImplementation "androidx.room:room-testing:$room_version"
   androidTestImplementation 'org.jetbrains.kotlinx:kotlinx-coroutines-test:1.7.3'

package/android/src/main/java/expo/modules/updates/UpdatesUtils.kt

@@ -19,7 +19,6 @@ import java.text.ParseException
 import java.text.SimpleDateFormat
 import java.util.*
 import java.util.regex.Pattern
-import kotlin.experimental.and
 
 /**
  * Miscellaneous helper functions that are used by multiple classes in the library.
@@ -145,11 +144,11 @@ object UpdatesUtils {
     }
   }
 
+  /**
+   * Create an asset filename in file system (files are saved in the `.expo-internal` directory)
+   */
   fun createFilenameForAsset(asset: AssetEntity): String {
-    var fileExtension: String? = ""
-    if (asset.type != null) {
-      fileExtension = if (asset.type!!.startsWith(".")) asset.type else "." + asset.type
-    }
+    val fileExtension = asset.getFileExtension()
     return if (asset.key == null) {
       // create a filename that's unlikely to collide with any other asset
       "asset-" + Date().time + "-" + Random().nextInt() + fileExtension

package/android/src/main/java/expo/modules/updates/db/dao/AssetDao.kt

@@ -5,6 +5,7 @@ import androidx.room.*
 import expo.modules.updates.db.entity.AssetEntity
 import expo.modules.updates.db.entity.UpdateAssetEntity
 import expo.modules.updates.db.entity.UpdateEntity
+import expo.modules.updates.utils.AndroidResourceAssetUtils
 import java.util.*
 
 /**
@@ -88,12 +89,17 @@ abstract class AssetDao {
   }
 
   fun loadAssetWithKey(key: String?): AssetEntity? {
-    val assets = loadAssetWithKeyInternal(key)
-    return if (assets.isNotEmpty()) {
-      assets[0]
-    } else {
-      null
+    val asset = loadAssetWithKeyInternal(key).firstOrNull() ?: return null
+
+    // Load some properties not stored in database but can be computed from other fields
+    asset.relativePath?.let {
+      val (embeddedAssetFilename, resourceFolder, resourceFilename) =
+        AndroidResourceAssetUtils.parseAndroidResponseAssetFromPath(it)
+      asset.embeddedAssetFilename = embeddedAssetFilename
+      asset.resourcesFolder = resourceFolder
+      asset.resourcesFilename = resourceFilename
     }
+    return asset
   }
 
   fun mergeAndUpdateAsset(existingEntity: AssetEntity, newEntity: AssetEntity) {
@@ -119,11 +125,11 @@ abstract class AssetDao {
     // we need to keep track of whether the calling class expects this asset to be the launch asset
     existingEntity.isLaunchAsset = newEntity.isLaunchAsset
     // some fields on the asset entity are not stored in the database but might still be used by application code
-    existingEntity.embeddedAssetFilename = newEntity.embeddedAssetFilename
-    existingEntity.resourcesFilename = newEntity.resourcesFilename
-    existingEntity.resourcesFolder = newEntity.resourcesFolder
-    existingEntity.scale = newEntity.scale
-    existingEntity.scales = newEntity.scales
+    newEntity.embeddedAssetFilename?.let { existingEntity.embeddedAssetFilename = it }
+    newEntity.resourcesFilename?.let { existingEntity.resourcesFilename = it }
+    newEntity.resourcesFolder?.let { existingEntity.resourcesFolder = it }
+    newEntity.scale?.let { existingEntity.scale = it }
+    newEntity.scales?.let { existingEntity.scales = it }
   }
 
   @Transaction

package/android/src/main/java/expo/modules/updates/db/entity/AssetEntity.kt

@@ -68,4 +68,13 @@ class AssetEntity(@field:ColumnInfo(name = "key") var key: String?, var type: St
 
   @Ignore
   var scales: Array<Float>? = null
+
+  internal fun getFileExtension(): String {
+    val type = this.type ?: return ""
+    return if (type.startsWith(".")) {
+      type
+    } else {
+      ".$type"
+    }
+  }
 }

package/android/src/main/java/expo/modules/updates/launcher/DatabaseLauncher.kt

@@ -2,6 +2,8 @@ package expo.modules.updates.launcher
 
 import android.content.Context
 import android.net.Uri
+import androidx.annotation.VisibleForTesting
+import expo.modules.updates.BuildConfig
 import expo.modules.updates.UpdatesConfiguration
 import expo.modules.updates.UpdatesUtils
 import expo.modules.updates.db.UpdatesDatabase
@@ -18,6 +20,7 @@ import expo.modules.updates.manifest.EmbeddedManifestUtils
 import expo.modules.updates.manifest.EmbeddedUpdate
 import expo.modules.updates.manifest.ManifestMetadata
 import expo.modules.updates.selectionpolicy.SelectionPolicy
+import expo.modules.updates.utils.AndroidResourceAssetUtils
 import org.json.JSONObject
 import java.io.File
 
@@ -44,7 +47,8 @@ class DatabaseLauncher(
   private val updatesDirectory: File?,
   private val fileDownloader: FileDownloader,
   private val selectionPolicy: SelectionPolicy,
-  private val logger: UpdatesLogger
+  private val logger: UpdatesLogger,
+  private val shouldCopyEmbeddedAssets: Boolean = BuildConfig.EX_UPDATES_COPY_EMBEDDED_ASSETS
 ) : Launcher {
   private val loaderFiles: LoaderFiles = LoaderFiles()
   override var launchedUpdate: UpdateEntity? = null
@@ -97,7 +101,18 @@ class DatabaseLauncher(
     val embeddedUpdate = EmbeddedManifestUtils.getEmbeddedUpdate(context, configuration)
     val extraHeaders = FileDownloader.getExtraHeadersForRemoteAssetRequest(launchedUpdate, embeddedUpdate?.updateEntity, launchedUpdate)
 
-    val launchAssetFile = ensureAssetExists(launchAsset, database, embeddedUpdate, extraHeaders)
+    val embeddedLaunchAsset = if (!shouldCopyEmbeddedAssets) {
+      embeddedUpdate?.assetEntityList
+        ?.find { it.key == launchAsset.key }
+        ?.embeddedAssetFilename
+        ?.let {
+          // react-native uses `assets://` to indicate loading a bundle from assets
+          "assets://$it"
+        }
+    } else {
+      null
+    }
+    val launchAssetFile = embeddedLaunchAsset ?: ensureAssetExists(launchAsset, database, embeddedUpdate, extraHeaders)
     if (launchAssetFile != null) {
       this.launchAssetFile = launchAssetFile.toString()
     }
@@ -110,12 +125,14 @@ class DatabaseLauncher(
           // we took care of this one above
           continue
         }
-        val filename = asset.relativePath
-        if (filename != null) {
+        val filename = asset.relativePath ?: continue
+        if (!AndroidResourceAssetUtils.isAndroidResourceAsset(filename)) {
           val assetFile = ensureAssetExists(asset, database, embeddedUpdate, extraHeaders)
           if (assetFile != null) {
             this[asset] = Uri.fromFile(assetFile).toString()
           }
+        } else {
+          this[asset] = filename
         }
       }
     }
@@ -158,6 +175,20 @@ class DatabaseLauncher(
         if (asset.isLaunchAsset) {
           continue
         }
+
+        if (!shouldCopyEmbeddedAssets) {
+          val filename = AndroidResourceAssetUtils.createEmbeddedFilenameForAsset(asset)
+          if (filename != null) {
+            asset.relativePath = filename
+            this[asset] = filename
+            logger.info("embeddedAssetFileMap: ${asset.key},${asset.type} => ${this[asset]}")
+          } else {
+            val cause = Exception("Missing embedded asset")
+            logger.error("embeddedAssetFileMap: no file for ${asset.key},${asset.type}", cause, UpdatesErrorCode.AssetsFailedToLoad)
+          }
+          continue
+        }
+
         val filename = UpdatesUtils.createFilenameForAsset(asset)
         asset.relativePath = filename
         val assetFile = File(updatesDirectory, filename)
@@ -175,7 +206,13 @@ class DatabaseLauncher(
     }
   }
 
-  fun ensureAssetExists(asset: AssetEntity, database: UpdatesDatabase, embeddedUpdate: EmbeddedUpdate?, extraHeaders: JSONObject): File? {
+  @VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
+  fun ensureAssetExists(
+    asset: AssetEntity,
+    database: UpdatesDatabase,
+    embeddedUpdate: EmbeddedUpdate?,
+    extraHeaders: JSONObject
+  ): File? {
     val assetFile = File(updatesDirectory, asset.relativePath ?: "")
     var assetFileExists = assetFile.exists()
     if (!assetFileExists) {

package/android/src/main/java/expo/modules/updates/loader/EmbeddedLoader.kt

@@ -1,6 +1,7 @@
 package expo.modules.updates.loader
 
 import android.content.Context
+import expo.modules.updates.BuildConfig
 import expo.modules.updates.UpdatesConfiguration
 import expo.modules.updates.db.entity.AssetEntity
 import expo.modules.updates.db.UpdatesDatabase
@@ -9,6 +10,7 @@ import expo.modules.updates.loader.FileDownloader.RemoteUpdateDownloadCallback
 import expo.modules.updates.UpdatesUtils
 import expo.modules.updates.db.entity.UpdateEntity
 import expo.modules.updates.logging.UpdatesLogger
+import expo.modules.updates.utils.AndroidResourceAssetUtils
 import java.io.File
 import java.io.FileNotFoundException
 import java.lang.AssertionError
@@ -16,14 +18,14 @@ import java.lang.Exception
 import java.util.*
 
 /**
- * Subclass of [Loader] which handles copying the embedded update's assets into the
- * expo-updates cache location.
+ * Subclass of [Loader] which handles embedded update assets
  *
- * Rather than launching the embedded update directly from its location in the app bundle/apk, we
- * first try to read it into the expo-updates cache and database and launch it like any other
- * update. The benefits of this include (a) a single code path for launching most updates and (b)
- * assets included in embedded updates and copied into the cache in this way do not need to be
- * re-downloaded if included in future updates.
+ * @param shouldCopyEmbeddedAssets if true, copying the embedded update's assets into the expo-updates cache location.
+ *   Rather than launching the embedded update directly from its location in the app bundle/apk, we
+ *   first try to read it into the expo-updates cache and database and launch it like any other
+ *   update. The benefits of this include (a) a single code path for launching most updates and (b)
+ *   assets included in embedded updates and copied into the cache in this way do not need to be
+ *   re-downloaded if included in future updates.
  */
 class EmbeddedLoader internal constructor(
   context: Context,
@@ -31,7 +33,8 @@ class EmbeddedLoader internal constructor(
   logger: UpdatesLogger,
   database: UpdatesDatabase,
   updatesDirectory: File,
-  private val loaderFiles: LoaderFiles
+  private val loaderFiles: LoaderFiles,
+  private val shouldCopyEmbeddedAssets: Boolean = BuildConfig.EX_UPDATES_COPY_EMBEDDED_ASSETS
 ) : Loader(
   context,
   configuration,
@@ -76,10 +79,19 @@ class EmbeddedLoader internal constructor(
     embeddedUpdate: UpdateEntity?,
     callback: AssetDownloadCallback
   ) {
+    if (!shouldCopyEmbeddedAssets) {
+      assetEntity.downloadTime = Date()
+      assetEntity.relativePath = AndroidResourceAssetUtils.createEmbeddedFilenameForAsset(assetEntity)
+      // Passing `isNew=true` aka `AssetLoadResult.FINISHED` to the callback,
+      // because we assume embedded asset is always existed without filesystem out of sync.
+      callback.onSuccess(assetEntity, true)
+      return
+    }
+
     val filename = UpdatesUtils.createFilenameForAsset(assetEntity)
     val destination = File(updatesDirectory, filename)
 
-    if (loaderFiles.fileExists(destination)) {
+    if (loaderFiles.fileExists(context, updatesDirectory, filename)) {
       assetEntity.relativePath = filename
       callback.onSuccess(assetEntity, false)
     } else {

package/android/src/main/java/expo/modules/updates/loader/Loader.kt

@@ -233,12 +233,8 @@ abstract class Loader protected constructor(
       }
 
       // if we already have a local copy of this asset, don't try to download it again!
-      if (assetEntity.relativePath != null && loaderFiles.fileExists(
-          File(
-            updatesDirectory,
-            assetEntity.relativePath
-          )
-        )
+      if (assetEntity.relativePath != null &&
+        loaderFiles.fileExists(context, updatesDirectory, assetEntity.relativePath)
       ) {
         handleAssetDownloadCompleted(assetEntity, AssetLoadResult.ALREADY_EXISTS)
         continue

package/android/src/main/java/expo/modules/updates/loader/LoaderFiles.kt

@@ -8,6 +8,7 @@ import expo.modules.updates.UpdatesUtils
 import expo.modules.updates.db.entity.AssetEntity
 import expo.modules.updates.manifest.EmbeddedManifestUtils
 import expo.modules.updates.manifest.Update
+import expo.modules.updates.utils.AndroidResourceAssetUtils
 import java.io.File
 import java.io.IOException
 import java.security.NoSuchAlgorithmException
@@ -16,8 +17,12 @@ import java.security.NoSuchAlgorithmException
  * Utility class for Loader and its subclasses, to allow for easy mocking
  */
 open class LoaderFiles {
-  fun fileExists(destination: File): Boolean {
-    return destination.exists()
+  fun fileExists(context: Context, updateDirectory: File?, relativePath: String?): Boolean {
+    val filePath = relativePath ?: return false
+    if (AndroidResourceAssetUtils.isAndroidAssetOrResourceExisted(context, filePath)) {
+      return true
+    }
+    return File(updateDirectory, filePath).exists()
   }
 
   fun readEmbeddedUpdate(

package/android/src/main/java/expo/modules/updates/utils/AndroidResourceAssetUtils.kt

@@ -0,0 +1,120 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+package expo.modules.updates.utils
+
+import android.annotation.SuppressLint
+import android.content.Context
+import androidx.core.net.toUri
+import expo.modules.core.errors.InvalidArgumentException
+import expo.modules.updates.db.entity.AssetEntity
+import java.io.IOException
+
+/**
+ * Helpers for Android embedded assets and resources
+ */
+internal object AndroidResourceAssetUtils {
+  private const val ANDROID_EMBEDDED_URL_BASE_ASSET = "file:///android_asset/"
+  private const val ANDROID_EMBEDDED_URL_BASE_RESOURCE = "file:///android_res/"
+
+  /**
+   * Create an embedded asset filename in `file:///android_res/` or `file:///android_asset/` format
+   */
+  fun createEmbeddedFilenameForAsset(asset: AssetEntity): String? {
+    val fileExtension = asset.getFileExtension()
+    if (asset.embeddedAssetFilename != null) {
+      return "${ANDROID_EMBEDDED_URL_BASE_ASSET}${asset.embeddedAssetFilename}$fileExtension"
+    }
+    if (asset.resourcesFolder != null && asset.resourcesFilename != null) {
+      return "${ANDROID_EMBEDDED_URL_BASE_RESOURCE}${asset.resourcesFolder}${getDrawableSuffix(asset.scale)}/${asset.resourcesFilename}$fileExtension"
+    }
+    return null
+  }
+
+  /**
+   * Return whether the filePath is an Android asset or resource
+   */
+  fun isAndroidResourceAsset(filePath: String): Boolean {
+    return filePath.startsWith(ANDROID_EMBEDDED_URL_BASE_RESOURCE) ||
+      filePath.startsWith(ANDROID_EMBEDDED_URL_BASE_ASSET)
+  }
+
+  /**
+   * Check a given file name is existed in Android embedded assets
+   */
+  fun isAndroidAssetExisted(context: Context, name: String) = try {
+    context.assets.open(name).close()
+    true
+  } catch (e: IOException) {
+    false
+  }
+
+  /**
+   * Check a given resource folder and filename is existed in Android embedded resources
+   */
+  @SuppressLint("DiscouragedApi")
+  fun isAndroidResourceExisted(context: Context, resourceFolder: String, resourceFilename: String): Boolean {
+    return context.resources.getIdentifier(
+      resourceFilename,
+      resourceFolder,
+      context.packageName
+    ) != 0
+  }
+
+  /**
+   * Check if given filePath matches and exists in the Android embedded assets or resources
+   */
+  fun isAndroidAssetOrResourceExisted(context: Context, filePath: String): Boolean {
+    val (embeddedAssetFilename, resourceFolder, resourceFilename) = parseAndroidResponseAssetFromPath(filePath)
+    return when {
+      embeddedAssetFilename != null -> isAndroidAssetExisted(context, embeddedAssetFilename)
+      resourceFolder != null && resourceFilename != null -> isAndroidResourceExisted(context, resourceFolder, resourceFilename)
+      else -> {
+        false
+      }
+    }
+  }
+
+  /**
+   * Data structure for Android embedded asset and resource
+   */
+  data class AndroidResourceAsset(
+    val embeddedAssetFilename: String?,
+    val resourcesFolder: String?,
+    val resourceFilename: String?
+  )
+
+  /**
+   * Parse a file path and return as `AndroidResourceAsset`
+   */
+  fun parseAndroidResponseAssetFromPath(filePath: String): AndroidResourceAsset {
+    if (filePath.startsWith(ANDROID_EMBEDDED_URL_BASE_RESOURCE)) {
+      val uri = filePath.toUri()
+      val pathSegments = uri.pathSegments
+      if (pathSegments.size < 3) {
+        throw InvalidArgumentException("Invalid resource file path: $filePath")
+      }
+      // Strip any qualifiers after a dash, for example "drawable-xhdpi" becomes "drawable"
+      val resourcesFolder = pathSegments[1].substringBefore('-')
+      // Strip file extension for resource name
+      val resourceFilename = pathSegments[2].substringBeforeLast('.', pathSegments[2])
+      return AndroidResourceAsset(null, resourcesFolder, resourceFilename)
+    }
+    if (filePath.startsWith(ANDROID_EMBEDDED_URL_BASE_ASSET)) {
+      val embeddedAssetFilename = filePath.substringAfterLast('/')
+      return AndroidResourceAsset(embeddedAssetFilename, null, null)
+    }
+    return AndroidResourceAsset(null, null, null)
+  }
+
+  private fun getDrawableSuffix(scale: Float?): String {
+    return when (scale) {
+      0.75f -> "-ldpi"
+      1f -> "-mdpi"
+      1.5f -> "-hdpi"
+      2f -> "-xhdpi"
+      3f -> "-xxhdpi"
+      4f -> "-xxxhdpi"
+      else -> ""
+    }
+  }
+}