async-storage(windows): start with windows implementation

Author: krizzu

examples/example-react-native/app.json

@@ -20,10 +20,6 @@
       "dist/assets",
       "dist/main.macos.jsbundle"
     ],
-    "visionos": [
-      "dist/assets",
-      "dist/main.visionos.jsbundle"
-    ],
     "windows": [
       "dist/assets",
       "dist/main.windows.bundle"

examples/example-react-native/package.json

@@ -5,10 +5,12 @@
   "scripts": {
     "android": "react-native run-android",
     "ios": "react-native run-ios",
-    "windows": "react-native run-windows",
+    "windows": "install-windows-test-app && react-native run-windows",
+    "macos": "react-native run-macos",
     "build:android": "yarn mkdist && react-native bundle --entry-file index.js --platform android --dev true --bundle-output dist/main.android.jsbundle --assets-dest dist/res",
     "build:ios": "yarn mkdist && react-native bundle --entry-file index.js --platform ios --dev true --bundle-output dist/main.ios.jsbundle --assets-dest dist",
     "build:windows": "yarn mkdist && react-native bundle --entry-file index.js --platform windows --dev true --bundle-output dist/main.windows.bundle --assets-dest dist",
+    "build:macos": "yarn mkdist && react-native bundle --entry-file index.js --platform macos --dev true --bundle-output dist/main.macos.bundle --assets-dest dist",
     "test:lint": "eslint .",
     "test:ts": "tsc --noEmit",
     "mkdist": "node -e \"require('node:fs').mkdirSync('dist', { recursive: true, mode: 0o755 })\"",

examples/example-react-native/react-native.config.js

@@ -8,9 +8,12 @@ const project = (() => {
       ios: {
         sourceDir: "ios",
       },
+      macos: {
+        sourceDir: "macos",
+      },
       windows: {
         sourceDir: "windows",
-        solutionFile: "windows/Example.sln",
+        solutionFile: "Example.sln",
       },
     });
   } catch (_) {

packages/async-storage/src/AsyncStorageError.ts

@@ -18,7 +18,7 @@ enum AsyncStorageErrorType {
 
   /**
    * Other errors related to Native Shared Storage or Legacy Storage exception.
-   * ex. Storage could not be initialized
+   * ex. Storage could not be initialized or wrongly formatted output is generated
    */
   OtherStorageError = "OtherStorageError",
 

packages/async-storage/src/createAsyncStorage.native.ts

@@ -114,7 +114,7 @@ class LegacyAsyncStorageImpl implements AsyncStorage {
     const mod = NativeAsyncStorage;
     if (!mod) {
       throw AsyncStorageError.jsError(
-        `Native module is null, access legacy storage`,
+        `Native module is null, cannot access legacy storage`,
         AsyncStorageError.Type.NativeModuleError
       );
     }

packages/async-storage/src/createAsyncStorage.windows.ts

@@ -0,0 +1,147 @@
+import type { AsyncStorage } from "./AsyncStorage";
+import { AsyncStorageError } from "./AsyncStorageError";
+import { TurboModuleRegistry, type TurboModule } from "react-native";
+
+/**
+ * Because of missing support for Windows native target by Room KMP,
+ * Windows target uses v2 implementation of AsyncStorage.
+ */
+export function createAsyncStorage(_: string): AsyncStorage {
+  return getLegacyStorage();
+}
+
+export function getLegacyStorage(): AsyncStorage {
+  return LegacyAsyncStorageImpl.instance;
+}
+
+class LegacyAsyncStorageImpl implements AsyncStorage {
+  private constructor() {}
+
+  static instance = new LegacyAsyncStorageImpl();
+
+  private get db(): NativeAsyncStorageSpec {
+    const mod = RNCAsyncStorage;
+    if (!mod) {
+      throw AsyncStorageError.jsError(
+        `Native module is null, cannot access storage.`,
+        AsyncStorageError.Type.NativeModuleError
+      );
+    }
+    return mod;
+  }
+
+  getItem = async (key: string): Promise<string | null> => {
+    try {
+      return await new Promise((resolve, reject) => {
+        this.db.multiGet([key], (errors, result) => {
+          if (errors?.length) {
+            const error = errors[0]!;
+            reject(
+              AsyncStorageError.jsError(
+                error.message,
+                AsyncStorageError.Type.OtherStorageError
+              )
+            );
+          } else {
+            resolve(result?.[0]?.[1] ?? null);
+          }
+        });
+      });
+    } catch (e) {
+      throw AsyncStorageError.nativeError(e);
+    }
+  };
+
+  setItem = async (key: string, value: string): Promise<void> => {
+    try {
+      throw new Error("todo");
+    } catch (e) {
+      throw AsyncStorageError.nativeError(e);
+    }
+  };
+
+  removeItem = async (key: string): Promise<void> => {
+    try {
+      throw new Error("todo");
+    } catch (e) {
+      throw AsyncStorageError.nativeError(e);
+    }
+  };
+
+  getMany = async (keys: string[]): Promise<Record<string, string | null>> => {
+    try {
+      throw new Error("todo");
+    } catch (e) {
+      throw AsyncStorageError.nativeError(e);
+    }
+  };
+
+  setMany = async (entries: Record<string, string>): Promise<void> => {
+    try {
+      throw new Error("todo");
+    } catch (e) {
+      throw AsyncStorageError.nativeError(e);
+    }
+  };
+
+  removeMany = async (keys: string[]): Promise<void> => {
+    try {
+      throw new Error("todo");
+    } catch (e) {
+      throw AsyncStorageError.nativeError(e);
+    }
+  };
+
+  getAllKeys = async (): Promise<string[]> => {
+    try {
+      throw new Error("todo");
+    } catch (e) {
+      throw AsyncStorageError.nativeError(e);
+    }
+  };
+
+  clear = async (): Promise<void> => {
+    try {
+      throw new Error("todo");
+    } catch (e) {
+      throw AsyncStorageError.nativeError(e);
+    }
+  };
+}
+
+/**
+ *
+ * This is a backward compatibility layer, to support Windows target in v3.
+ * Room KMP does not support Windows native target currently, so shared-storage cannot be used.
+ * https://issuetracker.google.com/issues/363195546
+ */
+const RNCAsyncStorage =
+  TurboModuleRegistry.get<NativeAsyncStorageSpec>("RNCAsyncStorage");
+
+type ErrorLike = {
+  message: string;
+  key?: string;
+};
+
+interface NativeAsyncStorageSpec extends TurboModule {
+  multiGet: (
+    keys: string[],
+    callback: (error?: ErrorLike[], result?: [string, string][]) => void
+  ) => void;
+  multiSet: (
+    kvPairs: [string, string][],
+    callback: (error?: ErrorLike[]) => void
+  ) => void;
+  multiRemove: (
+    keys: readonly string[],
+    callback: (error?: ErrorLike[]) => void
+  ) => void;
+  multiMerge: (
+    kvPairs: [string, string][],
+    callback: (error?: ErrorLike[]) => void
+  ) => void;
+  getAllKeys: (
+    callback: (error?: ErrorLike[], result?: [string, string][]) => void
+  ) => void;
+  clear: (callback: (error?: ErrorLike[]) => void) => void;
+}

packages/async-storage/windows/.gitignore

@@ -39,3 +39,4 @@ Ankh.NoLoad
 
 #Files generated by the VS build
 **/Generated Files/**
+ReactNativeAsyncStorage/packages.json.lock