Serialize EditorDependencies in parcelable

Author: jkmassel

android/Gutenberg/src/main/java/org/wordpress/gutenberg/GutenbergView.kt

@@ -27,6 +27,8 @@ import androidx.webkit.WebViewAssetLoader.AssetsPathHandler
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.cancel
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import org.json.JSONException
@@ -66,8 +68,7 @@ class GutenbergView : WebView {
     private var networkRequestListener: NetworkRequestListener? = null
     private var loadingListener: EditorLoadingListener? = null
 
-    private val coroutineScope = CoroutineScope(Dispatchers.Main + Job())
-    private var dependencyLoadingJob: Job? = null
+    private val coroutineScope = CoroutineScope(Dispatchers.Main + SupervisorJob())
 
     /**
      * Stores the contextId from the most recent openMediaLibrary call
@@ -311,7 +312,7 @@ class GutenbergView : WebView {
     private fun prepareAndLoadEditor() {
         loadingListener?.onDependencyLoadingStarted()
 
-        dependencyLoadingJob = coroutineScope.launch {
+        coroutineScope.launch {
             try {
                 val editorService = EditorService.create(
                     context = context,
@@ -758,7 +759,7 @@ class GutenbergView : WebView {
 
     override fun onDetachedFromWindow() {
         super.onDetachedFromWindow()
-        dependencyLoadingJob?.cancel()
+        coroutineScope.cancel()
         clearConfig()
         this.stopLoading()
         FileCache.clearCache(context)

android/Gutenberg/src/main/java/org/wordpress/gutenberg/model/EditorDependenciesSerializer.kt

@@ -0,0 +1,109 @@
+package org.wordpress.gutenberg.model
+
+import android.content.Context
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
+import java.io.File
+import java.util.UUID
+
+/**
+ * Handles serialization of [EditorDependencies] to and from disk.
+ *
+ * Since [EditorDependencies] contains non-serializable types like [File],
+ * this class provides methods to serialize dependencies to a temporary file
+ * and deserialize them back. This is useful for passing large dependency
+ * objects between activities without exceeding Intent size limits.
+ *
+ * ## Usage
+ *
+ * ```kotlin
+ * // In the sending activity:
+ * val filePath = EditorDependenciesSerializer.writeToDisk(context, dependencies)
+ * intent.putExtra("dependencies_path", filePath)
+ *
+ * // In the receiving activity:
+ * val filePath = intent.getStringExtra("dependencies_path")
+ * val dependencies = EditorDependenciesSerializer.readFromDisk(filePath)
+ * ```
+ */
+object EditorDependenciesSerializer {
+    private val json = Json {
+        ignoreUnknownKeys = true
+        encodeDefaults = true
+    }
+
+    /**
+     * Serializable representation of [EditorDependencies].
+     *
+     * This class mirrors [EditorDependencies] but with serializable types:
+     * - [File] references are stored as path strings
+     * - [Date] objects are stored as Unix timestamps
+     */
+    @Serializable
+    private data class SerializedDependencies(
+        val editorSettings: EditorSettings,
+        val assetBundleRaw: EditorAssetBundle.RawAssetBundle,
+        val assetBundleRootPath: String,
+        val preloadList: EditorPreloadList?
+    )
+
+    /**
+     * Writes [EditorDependencies] to a temporary file in the app's cache directory.
+     *
+     * @param context The Android context.
+     * @param dependencies The dependencies to serialize.
+     * @return The absolute path to the created file.
+     */
+    fun writeToDisk(context: Context, dependencies: EditorDependencies): String {
+        val serialized = SerializedDependencies(
+            editorSettings = dependencies.editorSettings,
+            assetBundleRaw = EditorAssetBundle.RawAssetBundle(
+                manifest = dependencies.assetBundle.manifest,
+                downloadDate = dependencies.assetBundle.downloadDate
+            ),
+            assetBundleRootPath = dependencies.assetBundle.bundleRoot.absolutePath,
+            preloadList = dependencies.preloadList
+        )
+
+        val fileName = "editor_dependencies_${UUID.randomUUID()}.json"
+        val file = File(context.cacheDir, fileName)
+        file.writeText(json.encodeToString(serialized))
+
+        return file.absolutePath
+    }
+
+    /**
+     * Reads [EditorDependencies] from a file and deletes the file.
+     *
+     * @param filePath The absolute path to the serialized dependencies file.
+     * @return The deserialized dependencies, or `null` if the file doesn't exist or is invalid.
+     */
+    fun readFromDisk(filePath: String?): EditorDependencies? {
+        if (filePath == null) return null
+
+        val file = File(filePath)
+        if (!file.exists()) return null
+
+        return try {
+            val data = file.readText()
+            val serialized = json.decodeFromString<SerializedDependencies>(data)
+
+            val dependencies = EditorDependencies(
+                editorSettings = serialized.editorSettings,
+                assetBundle = serialized.assetBundleRaw.toEditorAssetBundle(
+                    File(serialized.assetBundleRootPath)
+                ),
+                preloadList = serialized.preloadList
+            )
+
+            // Clean up the temp file
+            file.delete()
+
+            dependencies
+        } catch (e: Exception) {
+            file.delete()
+            null
+        }
+    }
+}

android/Gutenberg/src/main/java/org/wordpress/gutenberg/views/EditorProgressView.kt

@@ -6,6 +6,7 @@ import android.view.Gravity
 import android.widget.LinearLayout
 import android.widget.ProgressBar
 import android.widget.TextView
+import androidx.core.widget.TextViewCompat
 import org.wordpress.gutenberg.model.EditorProgress
 
 /**
@@ -62,7 +63,7 @@ class EditorProgressView @JvmOverloads constructor(
                 marginEnd = dpToPx(16)
             }
             gravity = Gravity.CENTER
-            setTextAppearance(android.R.style.TextAppearance_Material_Body1)
+            TextViewCompat.setTextAppearance(this, android.R.style.TextAppearance_Material_Body1)
         }
 
         addView(progressBar)

android/app/src/main/java/com/example/gutenbergkit/EditorActivity.kt

@@ -52,9 +52,15 @@ import org.wordpress.gutenberg.model.EditorConfiguration
 import org.wordpress.gutenberg.GutenbergView
 import org.wordpress.gutenberg.EditorLoadingListener
 import org.wordpress.gutenberg.model.EditorDependencies
+import org.wordpress.gutenberg.model.EditorDependenciesSerializer
 import org.wordpress.gutenberg.model.EditorProgress
 
 class EditorActivity : ComponentActivity() {
+
+    companion object {
+        const val EXTRA_DEPENDENCIES_PATH = "dependencies_path"
+    }
+
     private var gutenbergView: GutenbergView? = null
     private lateinit var filePickerLauncher: ActivityResultLauncher<Intent>
     override fun onCreate(savedInstanceState: Bundle?) {
@@ -89,8 +95,9 @@ class EditorActivity : ComponentActivity() {
                 intent.getParcelableExtra<EditorConfiguration>(MainActivity.EXTRA_CONFIGURATION)
             } ?: EditorConfiguration.bundled()
 
-        // Get dependencies from the holder (set by SitePreparationActivity)
-        val dependencies = EditorDependenciesHolder.getAndClear()
+        // Read dependencies from disk if a file path was provided
+        val dependenciesPath = intent.getStringExtra(EXTRA_DEPENDENCIES_PATH)
+        val dependencies = EditorDependenciesSerializer.readFromDisk(dependenciesPath)
 
         setContent {
             AppTheme {

android/app/src/main/java/com/example/gutenbergkit/EditorDependenciesHolder.kt

@@ -54,6 +54,7 @@ import androidx.compose.ui.unit.dp
 import androidx.lifecycle.ViewModelProvider
 import com.example.gutenbergkit.ui.theme.AppTheme
 import org.wordpress.gutenberg.model.EditorConfiguration
+import org.wordpress.gutenberg.model.EditorDependenciesSerializer
 
 class SitePreparationActivity : ComponentActivity() {
 
@@ -146,11 +147,14 @@ class SitePreparationActivity : ComponentActivity() {
         configuration: EditorConfiguration,
         dependencies: org.wordpress.gutenberg.model.EditorDependencies?
     ) {
-        // Store dependencies in the holder for EditorActivity to retrieve
-        EditorDependenciesHolder.set(dependencies)
-
         val intent = Intent(this, EditorActivity::class.java).apply {
             putExtra(MainActivity.EXTRA_CONFIGURATION, configuration)
+
+            // Serialize dependencies to disk and pass the file path
+            if (dependencies != null) {
+                val filePath = EditorDependenciesSerializer.writeToDisk(this@SitePreparationActivity, dependencies)
+                putExtra(EditorActivity.EXTRA_DEPENDENCIES_PATH, filePath)
+            }
         }
         startActivity(intent)
     }