react-native-onyx 1.0.48 → 1.0.50

package/lib/Onyx.js

@@ -1,14 +1,14 @@
 /* eslint-disable no-continue */
-import _ from 'underscore';
-import Str from 'expensify-common/lib/str';
 import {deepEqual} from 'fast-equals';
 import lodashGet from 'lodash/get';
-import Storage from './storage';
+import _ from 'underscore';
 import * as Logger from './Logger';
 import cache from './OnyxCache';
+import * as Str from './Str';
 import createDeferredTask from './createDeferredTask';
 import fastMerge from './fastMerge';
 import * as PerformanceUtils from './metrics/PerformanceUtils';
+import Storage from './storage';
 
 // Method constants
 const METHOD = {
@@ -1216,6 +1216,14 @@ function update(data) {
     return clearPromise.then(() => Promise.all(_.map(promises, p => p())));
 }
 
+/**
+ * When set these keys will not be persisted to storage
+ * @param {string[]} keyList
+ */
+function setMemoryOnlyKeys(keyList) {
+    Storage.setMemoryOnlyKeys(keyList);
+}
+
 /**
  * Initialize the store with actions and listening for storage events
  *
@@ -1304,6 +1312,7 @@ const Onyx = {
     removeFromEvictionBlockList,
     isSafeEvictionKey,
     METHOD,
+    setMemoryOnlyKeys,
 };
 
 /**

package/lib/Str.js

@@ -0,0 +1,29 @@
+import _ from 'underscore';
+
+/**
+ * Returns true if the haystack begins with the needle
+ *
+ * @param {String} haystack  The full string to be searched
+ * @param {String} needle    The case-sensitive string to search for
+ * @return {Boolean} Returns true if the haystack starts with the needle.
+ */
+function startsWith(haystack, needle) {
+    return _.isString(haystack)
+                && _.isString(needle)
+                && haystack.startsWith(needle);
+}
+
+/**
+ * Checks if parameter is a string or function.
+ * If it is a string, then we will just return it.
+ * If it is a function, then we will call it with
+ * any additional arguments and return the result.
+ *
+ * @param {String|Function} parameter
+ * @returns {*}
+ */
+function result(parameter, ...args) {
+    return _.isFunction(parameter) ? parameter(...args) : parameter;
+}
+
+export {startsWith, result};

package/lib/storage/providers/LocalForage.js

@@ -8,6 +8,7 @@ import localforage from 'localforage';
 import _ from 'underscore';
 import {extendPrototype} from 'localforage-removeitems';
 import SyncQueue from '../../SyncQueue';
+import * as Str from '../../Str';
 import fastMerge from '../../fastMerge';
 
 extendPrototype(localforage);
@@ -16,6 +17,11 @@ localforage.config({
     name: 'OnyxDB',
 });
 
+/**
+ * Keys that will not ever be persisted to disk.
+ */
+let memoryOnlyKeys = [];
+
 const provider = {
     /**
      * Writing very quickly to IndexedDB causes performance issues and can lock up the page and lead to jank.
@@ -23,6 +29,10 @@ const provider = {
      * to the next.
      */
     setItemQueue: new SyncQueue(({key, value, shouldMerge}) => {
+        if (_.find(memoryOnlyKeys, noCacheKey => Str.startsWith(key, noCacheKey))) {
+            return Promise.resolve();
+        }
+
         if (shouldMerge) {
             return localforage.getItem(key)
                 .then((existingValue) => {
@@ -125,6 +135,13 @@ const provider = {
     setItem(key, value) {
         return this.setItemQueue.push({key, value});
     },
+
+    /**
+     * @param {string[]} keyList
+     */
+    setMemoryOnlyKeys(keyList) {
+        memoryOnlyKeys = keyList;
+    },
 };
 
 export default provider;

package/lib/storage/providers/SQLiteStorage.js

@@ -128,6 +128,11 @@ const provider = {
     * @returns {Promise<void>}
     */
     clear: () => db.executeAsync('DELETE FROM keyvaluepairs;', []),
+
+    /**
+     * Noop on mobile for now.
+     */
+    setMemoryOnlyKeys: () => {},
 };
 
 export default provider;

package/lib/withOnyx.js

@@ -3,11 +3,11 @@
  * something in Onyx (a key/value store). That way, as soon as data in Onyx changes, the state will be set and the view
  * will automatically change to reflect the new data.
  */
+import PropTypes from 'prop-types';
 import React from 'react';
 import _ from 'underscore';
-import PropTypes from 'prop-types';
-import Str from 'expensify-common/lib/str';
 import Onyx from './Onyx';
+import * as Str from './Str';
 
 /**
  * Returns the display name of a component

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "1.0.48",
+  "version": "1.0.50",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",
@@ -58,7 +58,6 @@
     "eslint-config-expensify": "^2.0.24",
     "eslint-plugin-jsx-a11y": "^6.6.1",
     "eslint-plugin-react": "^7.31.10",
-    "expensify-common": "git+https://github.com/Expensify/expensify-common.git#427295da130a4eacc184d38693664280d020dffd",
     "jest": "^26.5.2",
     "jest-cli": "^26.5.2",
     "jsdoc-to-markdown": "^7.1.0",
@@ -75,7 +74,6 @@
     "webpack-merge": "^5.8.0"
   },
   "peerDependencies": {
-    "expensify-common": ">=1",
     "localforage": "^1.10.0",
     "localforage-removeitems": "^1.4.0",
     "react": ">=18.1.0",