react-native-onyx 1.0.129 → 1.0.131

package/lib/Onyx.d.ts

@@ -1,6 +1,5 @@
 import {Component} from 'react';
 import * as Logger from './Logger';
-import * as ActiveClientManager from './ActiveClientManager';
 import {CollectionKey, CollectionKeyBase, DeepRecord, KeyValueMapping, NullishDeep, OnyxCollection, OnyxEntry, OnyxKey} from './types';
 
 /**
@@ -79,7 +78,7 @@ type OnyxUpdate =
               | {
                     onyxMethod: typeof METHOD.MERGE;
                     key: TKey;
-                    value: NullishDeep<KeyValueMapping[TKey]>;
+                    value: OnyxEntry<NullishDeep<KeyValueMapping[TKey]>>;
                 };
       }[OnyxKey]
     | {
@@ -203,7 +202,7 @@ declare function multiSet(data: Partial<NullableKeyValueMapping>): Promise<void>
  * @param key ONYXKEYS key
  * @param value Object or Array value to merge
  */
-declare function merge<TKey extends OnyxKey>(key: TKey, value: NullishDeep<KeyValueMapping[TKey]>): Promise<void>;
+declare function merge<TKey extends OnyxKey>(key: TKey, value: OnyxEntry<NullishDeep<KeyValueMapping[TKey]>>): Promise<void>;
 
 /**
  * Clear out all the data in the store
@@ -292,11 +291,6 @@ declare function hasPendingMergeForKey(key: OnyxKey): boolean;
  */
 declare function setMemoryOnlyKeys(keyList: OnyxKey[]): void;
 
-/**
- * Sets the callback to be called when the clear finishes executing.
- */
-declare function onClear(callback: () => void): void;
-
 declare const Onyx: {
     connect: typeof connect;
     disconnect: typeof disconnect;
@@ -315,10 +309,6 @@ declare const Onyx: {
     isSafeEvictionKey: typeof isSafeEvictionKey;
     METHOD: typeof METHOD;
     setMemoryOnlyKeys: typeof setMemoryOnlyKeys;
-    onClear: typeof onClear;
-    isClientManagerReady: typeof ActiveClientManager.isReady;
-    isClientTheLeader: typeof ActiveClientManager.isClientTheLeader;
-    subscribeToClientChange: typeof ActiveClientManager.subscribeToClientChange;
 };
 
 export default Onyx;

package/lib/Onyx.js

@@ -7,8 +7,6 @@ import * as Str from './Str';
 import createDeferredTask from './createDeferredTask';
 import * as PerformanceUtils from './metrics/PerformanceUtils';
 import Storage from './storage';
-import * as Broadcast from './broadcast';
-import * as ActiveClientManager from './ActiveClientManager';
 import utils from './utils';
 import unstable_batchedUpdates from './batch';
 import DevTools from './DevTools';
@@ -22,8 +20,6 @@ const METHOD = {
     CLEAR: 'clear',
 };
 
-const ON_CLEAR = 'on_clear';
-
 // Key/value store of Onyx key and arrays of values to merge
 const mergeQueue = {};
 const mergeQueuePromise = {};
@@ -54,12 +50,6 @@ let defaultKeyStates = {};
 // Connections can be made before `Onyx.init`. They would wait for this task before resolving
 const deferredInitTask = createDeferredTask();
 
-// The promise of the clear function, saved so that no writes happen while it's executing
-let isClearing = false;
-
-// Callback to be executed after the clear execution ends
-let onClearCallback = null;
-
 let batchUpdatesPromise = null;
 let batchUpdatesQueue = [];
 
@@ -1090,15 +1080,6 @@ function removeNullValues(key, value) {
  * @returns {Promise}
  */
 function set(key, value) {
-    if (!ActiveClientManager.isClientTheLeader()) {
-        Broadcast.sendMessage({type: METHOD.SET, key, value});
-        return Promise.resolve();
-    }
-
-    if (isClearing) {
-        return Promise.resolve();
-    }
-
     // If the value is null, we remove the key from storage
     const {value: valueAfterRemoving, wasRemoved} = removeNullValues(key, value);
 
@@ -1155,15 +1136,6 @@ function prepareKeyValuePairsForStorage(data) {
  * @returns {Promise}
  */
 function multiSet(data) {
-    if (!ActiveClientManager.isClientTheLeader()) {
-        Broadcast.sendMessage({type: METHOD.MULTI_SET, data});
-        return Promise.resolve();
-    }
-
-    if (isClearing) {
-        return Promise.resolve();
-    }
-
     const keyValuePairs = prepareKeyValuePairsForStorage(data);
 
     const updatePromises = _.map(keyValuePairs, ([key, value]) => {
@@ -1227,15 +1199,6 @@ function applyMerge(existingValue, changes, shouldRemoveNullObjectValues) {
  * @returns {Promise}
  */
 function merge(key, changes) {
-    if (!ActiveClientManager.isClientTheLeader()) {
-        Broadcast.sendMessage({type: METHOD.MERGE, key, changes});
-        return Promise.resolve();
-    }
-
-    if (isClearing) {
-        return Promise.resolve();
-    }
-
     // Top-level undefined values are ignored
     // Therefore we need to prevent adding them to the merge queue
     if (_.isUndefined(changes)) {
@@ -1289,7 +1252,7 @@ function merge(key, changes) {
             const updatePromise = broadcastUpdate(key, modifiedData, 'merge', hasChanged, wasRemoved);
 
             // If the value has not changed, calling Storage.setItem() would be redundant and a waste of performance, so return early instead.
-            if (!hasChanged || isClearing || wasRemoved) {
+            if (!hasChanged || wasRemoved) {
                 return updatePromise;
             }
 
@@ -1344,17 +1307,6 @@ function initializeWithDefaultKeyStates() {
  * @returns {Promise<void>}
  */
 function clear(keysToPreserve = []) {
-    if (!ActiveClientManager.isClientTheLeader()) {
-        Broadcast.sendMessage({type: METHOD.CLEAR, keysToPreserve});
-        return Promise.resolve();
-    }
-
-    if (isClearing) {
-        return Promise.resolve();
-    }
-
-    isClearing = true;
-
     return getAllKeys().then((keys) => {
         const keysToBeClearedFromStorage = [];
         const keyValuesToResetAsCollection = {};
@@ -1415,8 +1367,6 @@ function clear(keysToPreserve = []) {
         return Storage.removeItems(keysToBeClearedFromStorage)
             .then(() => Storage.multiSet(defaultKeyValuePairs))
             .then(() => {
-                isClearing = false;
-                Broadcast.sendMessage({type: METHOD.CLEAR, keysToPreserve});
                 DevTools.clearState(keysToPreserve);
                 return Promise.all(updatePromises);
             });
@@ -1571,48 +1521,6 @@ function setMemoryOnlyKeys(keyList) {
     cache.setRecentKeysLimit(Infinity);
 }
 
-/**
- * Sets the callback to be called when the clear finishes executing.
- * @param {Function} callback
- */
-function onClear(callback) {
-    onClearCallback = callback;
-}
-
-/**
- * Subscribes to the Broadcast channel and executes actions based on the
- * types of events.
- */
-function subscribeToEvents() {
-    Broadcast.subscribe(({data}) => {
-        if (!ActiveClientManager.isClientTheLeader()) {
-            return;
-        }
-        switch (data.type) {
-            case METHOD.CLEAR:
-                clear(data.keysToPreserve);
-                break;
-            case METHOD.SET:
-                set(data.key, data.value);
-                break;
-            case METHOD.MULTI_SET:
-                multiSet(data.key, data.value);
-                break;
-            case METHOD.MERGE:
-                merge(data.key, data.changes);
-                break;
-            case ON_CLEAR:
-                if (!onClearCallback) {
-                    break;
-                }
-                onClearCallback();
-                break;
-            default:
-                break;
-        }
-    });
-}
-
 /**
  * Initialize the store with actions and listening for storage events
  *
@@ -1647,15 +1555,6 @@ function init({
     shouldSyncMultipleInstances = Boolean(global.localStorage),
     debugSetState = false,
 } = {}) {
-    ActiveClientManager.init();
-
-    ActiveClientManager.isReady().then(() => {
-        if (!ActiveClientManager.isClientTheLeader()) {
-            return;
-        }
-        subscribeToEvents();
-    });
-
     if (captureMetrics) {
         // The code here is only bundled and applied when the captureMetrics is set
         // eslint-disable-next-line no-use-before-define
@@ -1720,10 +1619,6 @@ const Onyx = {
     setMemoryOnlyKeys,
     tryGetCachedValue,
     hasPendingMergeForKey,
-    onClear,
-    isClientManagerReady: ActiveClientManager.isReady,
-    isClientTheLeader: ActiveClientManager.isClientTheLeader,
-    subscribeToClientChange: ActiveClientManager.subscribeToClientChange,
 };
 
 /**

package/lib/Str.js

@@ -24,19 +24,4 @@ function result(parameter, ...args) {
     return _.isFunction(parameter) ? parameter(...args) : parameter;
 }
 
-/**
- * A simple GUID generator taken from https://stackoverflow.com/a/32760401/9114791
- *
- * @param {String} [prefix] an optional prefix to put in front of the guid
- * @returns {String}
- */
-function guid(prefix = '') {
-    function s4() {
-        return Math.floor((1 + Math.random()) * 0x10000)
-            .toString(16)
-            .substring(1);
-    }
-    return `${prefix}${s4()}${s4()}-${s4()}-${s4()}-${s4()}-${s4()}${s4()}${s4()}`;
-}
-
-export {guid, startsWith, result};
+export {startsWith, result};

package/lib/utils.d.ts

@@ -1,4 +1,4 @@
-import { OnyxKey } from './types';
+import {OnyxKey} from './types';
 
 /**
  * Merges two objects and removes null values if "shouldRemoveNullObjectValues" is set to true
@@ -14,4 +14,4 @@ declare function fastMerge<T>(target: T, source: T, shouldRemoveNullObjectValues
  */
 declare function formatActionName(method: string, key?: OnyxKey): string;
 
-export default { fastMerge, formatActionName };
+export default {fastMerge, formatActionName};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "1.0.129",
+  "version": "1.0.131",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",
@@ -33,14 +33,12 @@
   "browser": "web.js",
   "types": "lib/index.d.ts",
   "scripts": {
-    "lint": "eslint .",
-    "lint-tests": "eslint tests/**",
-    "test": "jest",
     "build": "webpack --config webpack.config.js",
     "build:docs": "node buildDocs.js",
-    "e2e": "playwright test",
-    "e2e-ui": "playwright test --ui",
-    "prettier": "prettier --write ."
+    "lint": "eslint .",
+    "lint-tests": "eslint tests/**",
+    "prettier": "prettier --write .",
+    "test": "jest"
   },
   "dependencies": {
     "ascii-table": "0.0.9",
@@ -51,7 +49,6 @@
     "@babel/core": "7.20.12",
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-react": "^7.18.6",
-    "@playwright/test": "^1.38.1",
     "@react-native-community/eslint-config": "^2.0.0",
     "@testing-library/jest-native": "^3.4.2",
     "@testing-library/react-native": "^7.0.2",
@@ -88,9 +85,9 @@
     "idb-keyval": "^6.2.1",
     "react": ">=18.1.0",
     "react-dom": ">=18.1.0",
-    "react-native-device-info": "^10.3.0",
     "react-native-performance": "^5.1.0",
-    "react-native-quick-sqlite": "^8.0.0-beta.2"
+    "react-native-quick-sqlite": "^8.0.0-beta.2",
+    "react-native-device-info": "^10.3.0"
   },
   "peerDependenciesMeta": {
     "idb-keyval": {
@@ -120,8 +117,7 @@
     ],
     "testPathIgnorePatterns": [
       "<rootDir>/node_modules/",
-      "<rootDir>/tests/unit/mocks/",
-      "<rootDir>/tests/e2e/"
+      "<rootDir>/tests/unit/mocks/"
     ],
     "testMatch": [
       "**/tests/unit/**/*.[jt]s?(x)",

package/lib/ActiveClientManager/index.d.ts

@@ -1,22 +0,0 @@
-/**
- * Determines when the client is ready. We need to wait till the init method is called and the leader message is sent.
- */
-declare function isReady(): Promise<void>;
-
-/**
- * Subscribes to the broadcast channel to listen for messages from other tabs, so that
- * all tabs agree on who the leader is, which should always be the last tab to open.
- */
-declare function init(): void;
-
-/**
- * Returns a boolean indicating if the current client is the leader.
- */
-declare function isClientTheLeader(): boolean;
-
-/**
- * Subscribes to when the client changes.
- */
-declare function subscribeToClientChange(callback: () => {}): void;
-
-export {isReady, init, isClientTheLeader, subscribeToClientChange};

package/lib/ActiveClientManager/index.native.js

@@ -1,18 +0,0 @@
-/**
- * For native devices, there will never be more than one
- * client running at a time, so this lib is a big no-op
- */
-
-function isReady() {
-    return Promise.resolve();
-}
-
-function isClientTheLeader() {
-    return true;
-}
-
-function init() {}
-
-function subscribeToClientChange() {}
-
-export {isClientTheLeader, init, isReady, subscribeToClientChange};

package/lib/ActiveClientManager/index.web.js

@@ -1,94 +0,0 @@
-/**
- * When you have many tabs in one browser, the data of Onyx is shared between all of them. Since we persist write requests in Onyx, we need to ensure that
- * only one tab is processing those saved requests or we would be duplicating data (or creating errors).
- * This file ensures exactly that by tracking all the clientIDs connected, storing the most recent one last and it considers that last clientID the "leader".
- */
-
-import * as Str from '../Str';
-import * as Broadcast from '../broadcast';
-
-const NEW_LEADER_MESSAGE = 'NEW_LEADER';
-const REMOVED_LEADER_MESSAGE = 'REMOVE_LEADER';
-
-const clientID = Str.guid();
-const subscribers = [];
-let timestamp = null;
-
-let activeClientID = null;
-let setIsReady = () => {};
-const isReadyPromise = new Promise((resolve) => {
-    setIsReady = resolve;
-});
-
-/**
- * Determines when the client is ready. We need to wait both till we saved our ID in onyx AND the init method was called
- * @returns {Promise}
- */
-function isReady() {
-    return isReadyPromise;
-}
-
-/**
- * Returns a boolean indicating if the current client is the leader.
- *
- * @returns {Boolean}
- */
-function isClientTheLeader() {
-    return activeClientID === clientID;
-}
-
-/**
- * Subscribes to when the client changes.
- * @param {Function} callback
- */
-function subscribeToClientChange(callback) {
-    subscribers.push(callback);
-}
-
-/**
- * Subscribe to the broadcast channel to listen for messages from other tabs, so that
- * all tabs agree on who the leader is, which should always be the last tab to open.
- */
-function init() {
-    Broadcast.subscribe((message) => {
-        switch (message.data.type) {
-            case NEW_LEADER_MESSAGE: {
-                // Only update the active leader if the message received was from another
-                // tab that initialized after the current one; if the timestamps are the
-                // same, it uses the client ID to tie-break
-                const isTimestampEqual = timestamp === message.data.timestamp;
-                const isTimestampNewer = timestamp > message.data.timestamp;
-                if (isClientTheLeader() && (isTimestampNewer || (isTimestampEqual && clientID > message.data.clientID))) {
-                    return;
-                }
-                activeClientID = message.data.clientID;
-
-                subscribers.forEach((callback) => callback());
-                break;
-            }
-            case REMOVED_LEADER_MESSAGE:
-                activeClientID = clientID;
-                timestamp = Date.now();
-                Broadcast.sendMessage({type: NEW_LEADER_MESSAGE, clientID, timestamp});
-                subscribers.forEach((callback) => callback());
-                break;
-            default:
-                break;
-        }
-    });
-
-    activeClientID = clientID;
-    timestamp = Date.now();
-
-    Broadcast.sendMessage({type: NEW_LEADER_MESSAGE, clientID, timestamp});
-    setIsReady();
-
-    window.addEventListener('beforeunload', () => {
-        if (!isClientTheLeader()) {
-            return;
-        }
-        Broadcast.sendMessage({type: REMOVED_LEADER_MESSAGE, clientID});
-    });
-}
-
-export {isClientTheLeader, init, isReady, subscribeToClientChange};

package/lib/broadcast/index.d.ts

@@ -1,17 +0,0 @@
-/**
- * Sends a message to the broadcast channel.
- */
-declare function sendMessage(message: string): void;
-
-/**
- * Subscribes to the broadcast channel. Every time a new message
- * is received, the callback is called.
- */
-declare function subscribe(callback: () => {}): void;
-
-/**
- * Disconnects from the broadcast channel.
- */
-declare function disconnect(): void;
-
-export {sendMessage, subscribe, disconnect};

package/lib/broadcast/index.native.js

@@ -1,12 +0,0 @@
-/**
- * For native devices, there will never be more than one
- * client running at a time, so this lib is a big no-op
- */
-
-function sendMessage() {}
-
-function subscribe() {}
-
-function disconnect() {}
-
-export {sendMessage, subscribe, disconnect};

package/lib/broadcast/index.web.js

@@ -1,33 +0,0 @@
-const BROADCAST_ONYX = 'BROADCAST_ONYX';
-
-const subscriptions = [];
-const channel = new BroadcastChannel(BROADCAST_ONYX);
-
-/**
- * Sends a message to the broadcast channel.
- * @param {String} message
- */
-function sendMessage(message) {
-    channel.postMessage(message);
-}
-
-/**
- * Subscribes to the broadcast channel. Every time a new message
- * is received, the callback is called.
- * @param {Function} callback
- */
-function subscribe(callback) {
-    subscriptions.push(callback);
-    channel.onmessage = (message) => {
-        subscriptions.forEach((c) => c(message));
-    };
-}
-
-/**
- * Disconnects from the broadcast channel.
- */
-function disconnect() {
-    channel.close();
-}
-
-export {sendMessage, subscribe, disconnect};