Add config option to use old file name for local storage preferences …

…instead of namespaces for backward compatibility in existing apps
p7s1digital · Jun 14, 2023 · 47b902b · 47b902b
1 parent f315d3c
commit 47b902b
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/jsbridge/src/main/kotlin/de/prosiebensat1digital/oasisjsbridge/JsBridgeConfig.kt b/jsbridge/src/main/kotlin/de/prosiebensat1digital/oasisjsbridge/JsBridgeConfig.kt
@@ -62,6 +62,16 @@ private constructor() {
     class LocalStorageConfig {
         var enabled: Boolean = false
         var useDefaultLocalStorage: Boolean = true
+
+        /**
+         * Only disable namespaces if a particular instance of JsBridge requires access to local
+         * storage key/value pairs that were saved with a previous version of the library.
+         *
+         * You should try to avoid using multiple unrelated instances of JsBridge without namespaces
+         * or with an identical namespace. An exception would be if you want to explicitly share data
+         * between instances and the possibility of key name collisions is not an issue.
+         */
+        var useNamespaces: Boolean = true
     }
 
     class JvmConfig {

diff --git a/jsbridge/src/main/kotlin/de/prosiebensat1digital/oasisjsbridge/extensions/LocalStorage.kt b/jsbridge/src/main/kotlin/de/prosiebensat1digital/oasisjsbridge/extensions/LocalStorage.kt
@@ -13,10 +13,11 @@ interface LocalStorageInteface : JsToNativeInterface {
     fun clear()
 }
 
-class LocalStorage(context: Context, namespace: String) : LocalStorageInteface {
+class LocalStorage(context: Context, namespace: String?) : LocalStorageInteface {
 
     private val localStoragePreferences = context.getSharedPreferences(
-        "${namespace.takeIf { it.isNotEmpty() } ?: "default"}.LOCAL_STORAGE_PREFERENCES",
+        namespace?.let { "${it.takeIf { it.isNotEmpty() } ?: "default"}.LOCAL_STORAGE_PREFERENCES" }
+            ?: "${context.applicationInfo.packageName}.LOCAL_STORAGE_PREFERENCE_FILE_KEY",
         Context.MODE_PRIVATE
     )
 

diff --git a/...src/main/kotlin/de/prosiebensat1digital/oasisjsbridge/extensions/LocalStorageExtension.kt b/...src/main/kotlin/de/prosiebensat1digital/oasisjsbridge/extensions/LocalStorageExtension.kt
@@ -29,7 +29,7 @@ internal class LocalStorageExtension(
 
     init {
         if (config.useDefaultLocalStorage) {
-            val localStorage: LocalStorageInteface = LocalStorage(context, namespace)
+            val localStorage: LocalStorageInteface = LocalStorage(context, namespace.takeIf { config.useNamespaces })
             val localStorageJsValue = JsValue.fromNativeObject(jsBridge, localStorage)
             localStorageJsValue.assignToGlobal("localStorage")
         }