Platform specific mocks

.gitignore

@@ -16,4 +16,8 @@ dist/
 .github/OSBotify-private-key.asc
 
 # Published package
-*.tgz
+*.tgz
+
+# Yalc
+.yalc
+yalc.lock

jest.config.js

@@ -3,6 +3,7 @@ module.exports = {
     transform: {
         '\\.[jt]sx?$': 'babel-jest',
     },
+    modulePathIgnorePatterns: ['<rootDir>/dist/'],
     testPathIgnorePatterns: ['<rootDir>/node_modules/', '<rootDir>/tests/unit/mocks/', '<rootDir>/tests/e2e/'],
     testMatch: ['**/tests/unit/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'],
     globals: {

jestSetup.js

@@ -1,7 +1,26 @@
+jest.mock('idb-keyval', () => {
+    const idbKeyValMockBase = require('./node_modules/idb-keyval/dist/mock');
+
+    return {
+        clear: jest.fn(idbKeyValMockBase.clear),
+        createStore: jest.fn(idbKeyValMockBase.createStore),
+        del: jest.fn(idbKeyValMockBase.del),
+        delMany: jest.fn(idbKeyValMockBase.delMany),
+        entries: jest.fn(idbKeyValMockBase.entries),
+        get: jest.fn(idbKeyValMockBase.get),
+        getMany: jest.fn(idbKeyValMockBase.getMany),
+        keys: jest.fn(idbKeyValMockBase.keys),
+        promisifyRequest: jest.fn(idbKeyValMockBase.promisifyRequest),
+        set: jest.fn(idbKeyValMockBase.set),
+        setMany: jest.fn(idbKeyValMockBase.setMany),
+        update: jest.fn(idbKeyValMockBase.update),
+        values: jest.fn(idbKeyValMockBase.values),
+    };
+});
+
 jest.mock('./lib/storage');
+jest.mock('./lib/storage/providers/IDBKeyValProvider', () => require('./lib/storage/providers/__mocks__/IDBKeyValProvider'));
 jest.mock('./lib/storage/platforms/index.native', () => require('./lib/storage/__mocks__'));
-jest.mock('./lib/storage/platforms/index', () => require('./lib/storage/__mocks__'));
-jest.mock('./lib/storage/providers/IDBKeyValProvider', () => require('./lib/storage/__mocks__'));
 
 jest.mock('react-native-device-info', () => ({getFreeDiskStorage: () => {}}));
 jest.mock('react-native-quick-sqlite', () => ({

lib/Logger.ts

@@ -1,6 +1,6 @@
 type LogData = {
     message: string;
-    level: 'alert' | 'info';
+    level: 'alert' | 'info' | 'hmmm';
 };
 type LoggerCallback = (data: LogData) => void;
 
@@ -28,4 +28,11 @@ function logInfo(message: string) {
     logger({message: `[Onyx] ${message}`, level: 'info'});
 }
 
-export {registerLogger, logInfo, logAlert};
+/**
+ * Send an hmmm message to the logger
+ */
+function logHmmm(message: string) {
+    logger({message: `[Onyx] ${message}`, level: 'hmmm'});
+}
+
+export {registerLogger, logInfo, logAlert, logHmmm};

lib/index.ts

@@ -1,7 +1,7 @@
 import Onyx from './Onyx';
 import type {OnyxUpdate, ConnectOptions} from './Onyx';
 import type {CustomTypeOptions, OnyxCollection, OnyxEntry, NullishDeep, KeyValueMapping, OnyxKey, Selector, WithOnyxInstanceState, OnyxValue} from './types';
-import type {UseOnyxResult, FetchStatus} from './useOnyx';
+import type {UseOnyxResult, FetchStatus, ResultMetadata} from './useOnyx';
 import useOnyx from './useOnyx';
 import withOnyx from './withOnyx';
 
@@ -21,4 +21,5 @@ export type {
     UseOnyxResult,
     OnyxValue,
     FetchStatus,
+    ResultMetadata,
 };

lib/storage/InstanceSync/index.ts

@@ -10,6 +10,8 @@ const InstanceSync = {
     setItem: NOOP,
     removeItem: NOOP,
     removeItems: NOOP,
+    multiMerge: NOOP,
+    multiSet: NOOP,
     mergeItem: NOOP,
     clear: <T extends () => void>(callback: T) => Promise.resolve(callback()),
 };

lib/storage/InstanceSync/index.web.ts

@@ -6,7 +6,7 @@
 import type {OnyxKey} from '../../types';
 import NoopProvider from '../providers/NoopProvider';
 import type {KeyList, OnStorageKeyChanged} from '../providers/types';
 import type StorageProvider from '../providers/types';
 
 const SYNC_ONYX = 'SYNC_ONYX';
 
@@ -50,6 +50,8 @@
     setItem: raiseStorageSyncEvent,
     removeItem: raiseStorageSyncEvent,
     removeItems: raiseStorageSyncManyKeysEvent,
+    multiMerge: raiseStorageSyncManyKeysEvent,
+    multiSet: raiseStorageSyncManyKeysEvent,
     mergeItem: raiseStorageSyncEvent,
     clear: (clearImplementation: () => void) => {
         let allKeys: KeyList;

lib/storage/index.ts

@@ -3,7 +3,7 @@
 import PlatformStorage from './platforms';
 import InstanceSync from './InstanceSync';
 import MemoryOnlyProvider from './providers/MemoryOnlyProvider';
 import type StorageProvider from './providers/types';
 
 let provider = PlatformStorage;
 let shouldKeepInstancesSync = false;
@@ -20,7 +20,7 @@
  * Degrade performance by removing the storage provider and only using cache
  */
 function degradePerformance(error: Error) {
-    Logger.logAlert(`Error while using ${provider.name}. Falling back to only using cache and dropping storage.`);
+    Logger.logHmmm(`Error while using ${provider.name}. Falling back to only using cache and dropping storage.\n Error: ${error.message}\n Stack: ${error.stack}\n Cause: ${error.cause}`);
     console.error(error);
     provider = MemoryOnlyProvider;
 }
@@ -76,17 +76,17 @@
     /**
      * Get the value of a given key or return `null` if it's not available
      */
     getItem: (key) => tryOrDegradePerformance(() => provider.getItem(key)),
 
     /**
      * Get multiple key-value pairs for the give array of keys in a batch
      */
     multiGet: (keys) => tryOrDegradePerformance(() => provider.multiGet(keys)),
 
     /**
      * Sets the value for a given key. The only requirement is that the value should be serializable to JSON string
      */
     setItem: (key, value) =>
         tryOrDegradePerformance(() => {
             const promise = provider.setItem(key, value);
 
@@ -100,7 +100,16 @@
     /**
      * Stores multiple key-value pairs in a batch
      */
-    multiSet: (pairs) => tryOrDegradePerformance(() => provider.multiSet(pairs)),
+    multiSet: (pairs) =>
+        tryOrDegradePerformance(() => {
+            const promise = provider.multiSet(pairs);
+
+            if (shouldKeepInstancesSync) {
+                return promise.then(() => InstanceSync.multiSet(pairs.map((pair) => pair[0])));
+            }
+
+            return promise;
+        }),
 
     /**
      * Merging an existing value with a new one
@@ -120,7 +129,16 @@
      * Multiple merging of existing and new values in a batch
      * This function also removes all nested null values from an object.
      */
-    multiMerge: (pairs) => tryOrDegradePerformance(() => provider.multiMerge(pairs)),
+    multiMerge: (pairs) =>
+        tryOrDegradePerformance(() => {
+            const promise = provider.multiMerge(pairs);
+
+            if (shouldKeepInstancesSync) {
+                return promise.then(() => InstanceSync.multiMerge(pairs.map((pair) => pair[0])));
+            }
+
+            return promise;
+        }),
 
     /**
      * Removes given key and its value

lib/storage/providers/IDBKeyValProvider.ts

@@ -1,12 +1,12 @@
 import type {UseStore} from 'idb-keyval';
 import {set, keys, getMany, setMany, get, clear, del, delMany, createStore, promisifyRequest} from 'idb-keyval';
 import utils from '../../utils';
-import type StorageProvider from './types';
+import type {StorageProvider} from './types';
 import type {OnyxKey, OnyxValue} from '../../types';
 
 // We don't want to initialize the store while the JS bundle loads as idb-keyval will try to use global.indexedDB
 // which might not be available in certain environments that load the bundle (e.g. electron main process).
 let idbKeyValStore: UseStore;
 
 const provider: StorageProvider = {
     /**
@@ -71,3 +71,5 @@
 };
 
 export default provider;
+
+export {idbKeyValStore};

lib/storage/providers/MemoryOnlyProvider.ts

@@ -1,7 +1,6 @@
 import _ from 'underscore';
 import utils from '../../utils';
-import type StorageProvider from './types';
-import type {KeyValuePair} from './types';
+import type {KeyValuePair, StorageProvider} from './types';
 import type {OnyxKey, OnyxValue} from '../../types';
 
 type Store = Record<OnyxKey, OnyxValue<OnyxKey>>;

lib/storage/providers/NoopProvider.ts

@@ -1,4 +1,4 @@
-import type StorageProvider from './types';
+import type {StorageProvider} from './types';
 
 const provider: StorageProvider = {
     /**

lib/storage/providers/SQLiteProvider.ts

@@ -5,9 +5,8 @@
 import type {BatchQueryResult, QuickSQLiteConnection} from 'react-native-quick-sqlite';
 import {open} from 'react-native-quick-sqlite';
 import {getFreeDiskStorage} from 'react-native-device-info';
-import type StorageProvider from './types';
 import utils from '../../utils';
-import type {KeyList, KeyValuePairList} from './types';
+import type {StorageProvider, KeyList, KeyValuePairList} from './types';
 
 const DB_NAME = 'OnyxDB';
 let db: QuickSQLiteConnection;

lib/storage/providers/__mocks__/IDBKeyValProvider.ts

@@ -0,0 +1,26 @@
+import _ from 'underscore';
+import type {UseStore} from 'idb-keyval';
+import idbKeyVal from 'idb-keyval';
+import type {StorageProvider, MockStorageProvider} from '../types';
+
+const IDBKeyValProvider = jest.requireActual('../IDBKeyValProvider');
+const idbKeyValStore: UseStore = IDBKeyValProvider.idbKeyValStore;
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const {name: _name, ...IDBKeyValProviderFunctions} = IDBKeyValProvider.default as StorageProvider;
+const IDBKeyValProviderMockBase = _.reduce<typeof IDBKeyValProviderFunctions, Partial<MockStorageProvider>>(
+    IDBKeyValProviderFunctions,
+    (mockAcc, fn, fnName) => ({
+        ...mockAcc,
+        [fnName]: jest.fn(fn),
+    }),
+    {name: IDBKeyValProvider.name},
+) as MockStorageProvider;
+
+const IDBKeyValProviderMock = {
+    ...IDBKeyValProviderMockBase,
+    idbKeyval: idbKeyVal,
+    idbKeyValStore,
+};
+
+export default IDBKeyValProviderMock;

lib/storage/providers/types.ts

@@ -39,7 +39,7 @@ type StorageProvider = {
     /**
      * Multiple merging of existing and new values in a batch
      */
-    multiMerge: (pairs: KeyValuePairList) => Promise<BatchQueryResult | IDBValidKey[]>;
+    multiMerge: (pairs: KeyValuePairList) => Promise<BatchQueryResult | IDBValidKey[] | void>;
 
     /**
      * Merges an existing value with a new one by leveraging JSON_PATCH
@@ -79,5 +79,27 @@ type StorageProvider = {
     keepInstancesSync?: (onStorageKeyChanged: OnStorageKeyChanged) => void;
 };
 
-export default StorageProvider;
-export type {KeyList, KeyValuePair, KeyValuePairList, OnStorageKeyChanged};
+type MethodsOnly<T, Excluded extends keyof T = never> = Pick<
+    T,
+    {
+        // eslint-disable-next-line @typescript-eslint/ban-types
+        [K in keyof T]: T[K] extends Function ? K : never;
+    }[keyof T] &
+        Exclude<keyof T, Excluded>
+>;
+
+interface MockStorageProviderGenerics {
+    getItem: jest.Mock<Promise<OnyxValue<OnyxKey> | null>, [OnyxKey]>;
+    setItem: jest.Mock<Promise<QueryResult | void>, [OnyxKey, OnyxValue<OnyxKey>]>;
+}
+
+type MockStorageProviderMethods = {
+    [K in keyof MethodsOnly<StorageProvider, 'getItem' | 'setItem'>]: jest.Mock<ReturnType<StorageProvider[K]>, Parameters<StorageProvider[K]>>;
+};
+
+type MockStorageProvider<AdditionalProps = Record<string, unknown>> = MockStorageProviderGenerics &
+    MockStorageProviderMethods & {
+        name: string;
+    } & AdditionalProps;
+
+export type {StorageProvider, KeyList, KeyValuePair, KeyValuePairList, OnStorageKeyChanged, MockStorageProvider};

lib/useOnyx.ts

@@ -188,4 +188,4 @@ function useOnyx<TKey extends OnyxKey, TReturnValue = OnyxValue<TKey>>(key: TKey
 
 export default useOnyx;
 
-export type {UseOnyxResult, FetchStatus};
+export type {UseOnyxResult, ResultMetadata, FetchStatus};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "2.0.22",
+  "version": "2.0.26",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",