feat(async-storage): legacy storage for android, example updated

Author: krizzu

examples/example-react-native/App.tsx

@@ -1,22 +1,55 @@
-/**
- * Sample React Native App
- * https://github.com/facebook/react-native
- *
- * @format
- */
-
-import React from "react";
-import { StatusBar, useColorScheme, View } from "react-native";
-import GetSetClear from "./src/BasicCrud";
+import React, { useState } from "react";
+import {
+  Button,
+  SafeAreaView,
+  StatusBar,
+  useColorScheme,
+  View,
+} from "react-native";
+import BasicCrud from "./src/BasicCrud";
+import LegacyBasicCrud from "./src/LegacyBasicCrud";
 
 function App(): React.JSX.Element {
   const isDarkMode = useColorScheme() === "dark";
+  const [example, setExample] = useState<"basic" | "legacy-basic">("basic");
 
   return (
-    <View style={{ flex: 1, justifyContent: "center", alignItems: "center" }}>
-      <StatusBar barStyle={isDarkMode ? "light-content" : "dark-content"} />
-      <GetSetClear />
-    </View>
+    <SafeAreaView style={{ flex: 1, paddingTop: 60 }}>
+      <View style={{ flex: 1, justifyContent: "center", alignItems: "center" }}>
+        <StatusBar barStyle={isDarkMode ? "light-content" : "dark-content"} />
+
+        <View
+          style={{
+            maxHeight: 60,
+            alignItems: "center",
+            flexDirection: "row",
+            gap: 4,
+          }}
+        >
+          <Button
+            disabled={example === "basic"}
+            title="Basic"
+            onPress={() => setExample("basic")}
+          />
+          <Button
+            disabled={example === "legacy-basic"}
+            title="LegacyBasic"
+            onPress={() => setExample("legacy-basic")}
+          />
+        </View>
+
+        <View style={{ flex: 1 }}>
+          {(() => {
+            switch (example) {
+              case "basic":
+                return <BasicCrud />;
+              case "legacy-basic":
+                return <LegacyBasicCrud />;
+            }
+          })()}
+        </View>
+      </View>
+    </SafeAreaView>
   );
 }
 

examples/example-react-native/src/LegacyBasicCrud.tsx

@@ -0,0 +1,82 @@
+/* eslint-disable */
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import AsyncStorage from "@react-native-async-storage/async-storage";
+import React, { useState } from "react";
+import { Alert, Button, StyleSheet, Text, View } from "react-native";
+
+export const STORAGE_KEY = "legacy-random";
+
+const LegacyBasicCrud: React.FC = () => {
+  const [storedNumber, setStoredNumber] = React.useState<number | null>(null);
+  const [storage] = useState(() => AsyncStorage);
+
+  function reportError(e: any) {
+    Alert.alert(e?.name ?? "Error", JSON.stringify(e, null, 2));
+  }
+
+  async function readCurrent() {
+    try {
+      const value = await storage.getItem(STORAGE_KEY);
+      setStoredNumber(value ? Number(value) : null);
+    } catch (e: any) {
+      reportError(e);
+    }
+  }
+
+  const increaseByTen = async () => {
+    const newNumber = (storedNumber ?? 0) + 10;
+
+    try {
+      await storage.setItem(STORAGE_KEY, `${newNumber}`);
+      setStoredNumber(newNumber);
+      await readCurrent();
+    } catch (e) {
+      reportError(e);
+    }
+  };
+
+  const removeItem = async () => {
+    await storage.removeItem(STORAGE_KEY).catch(reportError);
+    await readCurrent();
+  };
+
+  const listAllKeys = async () => {
+    try {
+      const keys = await storage.getAllKeys();
+      Alert.alert("keys", keys.join(", "));
+    } catch (e) {
+      reportError(e);
+    }
+  };
+
+  React.useEffect(() => {
+    readCurrent();
+  }, [storage]);
+
+  return (
+    <View>
+      <Text style={styles.text}>Currently stored: </Text>
+      <Text style={styles.text}>{storedNumber}</Text>
+      <Button title="Increase by 10" onPress={increaseByTen} />
+      <Button title="remove item" onPress={removeItem} />
+      <Button title="list all keys" onPress={listAllKeys} />
+    </View>
+  );
+};
+
+const styles = StyleSheet.create({
+  text: {
+    color: "#000000",
+    fontSize: 20,
+    textAlign: "center",
+    margin: 10,
+  },
+});
+
+export default LegacyBasicCrud;

packages/async-storage/android/build.gradle

@@ -11,18 +11,21 @@ buildscript {
     dependencies {
         classpath "com.android.tools.build:gradle:8.7.2"
         // noinspection DifferentKotlinGradleVersion
-        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion')}"
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('KOTLIN_VERSION')}"
+        classpath "com.google.devtools.ksp:symbol-processing-gradle-plugin:${getExtOrDefault('KSP_VERSION')}"
     }
 }
 
 
 apply plugin: "com.android.library"
 apply plugin: "kotlin-android"
-
 apply plugin: "com.facebook.react"
 
-def getExtOrIntegerDefault(name) {
-    return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["AsyncStorage_" + name]).toInteger()
+// to support migration from old storage
+apply plugin: 'com.google.devtools.ksp'
+
+def getExtOrDefault(name) {
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["AsyncStorage_" + name])
 }
 
 def isNewArchitectureEnabled() {
@@ -32,11 +35,11 @@ def isNewArchitectureEnabled() {
 android {
     namespace "org.asyncstorage"
 
-    compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+    compileSdkVersion getExtOrDefault("compileSdkVersion").toInteger()
 
     defaultConfig {
-        minSdkVersion getExtOrIntegerDefault("minSdkVersion")
-        targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+        minSdkVersion getExtOrDefault("minSdkVersion").toInteger()
+        targetSdkVersion getExtOrDefault("targetSdkVersion").toInteger()
     }
 
     buildFeatures {
@@ -101,4 +104,11 @@ repositories {
 dependencies {
     implementation "com.facebook.react:react-android"
     implementation "org.asyncstorage.shared_storage:storage-android:1.0.0"
+
+
+    def room_version = getExtOrDefault("ROOM_VERSION")
+
+    implementation "androidx.room:room-runtime:$room_version"
+    implementation "androidx.room:room-ktx:$room_version"
+    ksp "androidx.room:room-compiler:$room_version"
 }

packages/async-storage/android/gradle.properties

@@ -1,4 +1,6 @@
-AsyncStorage_kotlinVersion=2.2.10
+AsyncStorage_KOTLIN_VERSION=2.2.10
+AsyncStorage_KSP_VERSION=2.2.10-2.0.2
+AsyncStorage_ROOM_VERSION=2.7.2
 AsyncStorage_minSdkVersion=24
 AsyncStorage_targetSdkVersion=36
-AsyncStorage_compileSdkVersion=36
+AsyncStorage_compileSdkVersion=36

packages/async-storage/android/src/main/kotlin/org/asyncstorage/legacy_storage/LegacyStorageModule.kt

@@ -0,0 +1,89 @@
+package org.asyncstorage.legacy_storage
+
+import android.content.Context
+import com.facebook.react.bridge.Arguments
+import com.facebook.react.bridge.Promise
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReadableArray
+import kotlinx.coroutines.CoroutineExceptionHandler
+import kotlinx.coroutines.CoroutineName
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.launch
+
+class LegacyStorageModule(reactContext: ReactApplicationContext) : CoroutineScope {
+
+    override val coroutineContext =
+        Dispatchers.IO + CoroutineName("AsyncStorageScope") + SupervisorJob()
+
+    private val storage = StorageSupplier.getInstance(reactContext)
+
+    companion object {
+        @JvmStatic
+        fun getStorageInstance(ctx: Context): AsyncStorageAccess {
+            return StorageSupplier.getInstance(ctx)
+        }
+    }
+
+    fun multiGet(keys: ReadableArray, promise: Promise) {
+        launch(createExceptionHandler(promise)) {
+            val entries = storage.getValues(keys.toKeyList())
+            promise.resolve(entries.toKeyValueArgument())
+        }
+    }
+
+    fun multiSet(keyValueArray: ReadableArray, promise: Promise) {
+        launch(createExceptionHandler(promise)) {
+            val entries = keyValueArray.toEntryList()
+            storage.setValues(entries)
+            promise.resolve(null)
+        }
+    }
+
+    fun multiRemove(keys: ReadableArray, promise: Promise) {
+        launch(createExceptionHandler(promise)) {
+            storage.removeValues(keys.toKeyList())
+            promise.resolve(null)
+        }
+    }
+
+    fun multiMerge(keyValueArray: ReadableArray, promise: Promise) {
+        launch(createExceptionHandler(promise)) {
+            val entries = keyValueArray.toEntryList()
+            storage.mergeValues(entries)
+            promise.resolve(null)
+        }
+    }
+
+    fun getAllKeys(promise: Promise) {
+        launch(createExceptionHandler(promise)) {
+            val keys = storage.getKeys()
+            val result = Arguments.createArray()
+            keys.forEach { result.pushString(it) }
+            promise.resolve(result)
+        }
+    }
+
+    fun clear(promise: Promise) {
+        launch(createExceptionHandler(promise)) {
+            storage.clear()
+            promise.resolve(null)
+        }
+    }
+}
+
+internal fun createExceptionHandler(promise: Promise): CoroutineExceptionHandler {
+    return CoroutineExceptionHandler { _, throwable ->
+        val error = Arguments.createMap()
+        error.putString("type", "LegacyStorageException")
+        error.putString(
+            "message",
+            throwable.message
+                ?: throwable.localizedMessage
+                ?: "Unknown LegacyAsyncStorage error: $throwable",
+        )
+
+        promise.reject(code = "AsyncStorageError", throwable, userInfo = error)
+    }
+}