react-native-onyx 1.0.119 → 1.0.121

package/lib/OnyxCache.js

@@ -43,8 +43,17 @@ class OnyxCache {
         // bind all public methods to prevent problems with `this`
         _.bindAll(
             this,
-            'getAllKeys', 'getValue', 'hasCacheForKey', 'addKey', 'set', 'drop', 'merge',
-            'hasPendingTask', 'getTaskPromise', 'captureTask', 'removeLeastRecentlyUsedKeys',
+            'getAllKeys',
+            'getValue',
+            'hasCacheForKey',
+            'addKey',
+            'set',
+            'drop',
+            'merge',
+            'hasPendingTask',
+            'getTaskPromise',
+            'captureTask',
+            'removeLeastRecentlyUsedKeys',
             'setRecentKeysLimit',
         );
     }
@@ -126,7 +135,7 @@ class OnyxCache {
         const storageKeys = this.getAllKeys();
         const mergedKeys = _.keys(data);
         this.storageKeys = new Set([...storageKeys, ...mergedKeys]);
-        _.each(mergedKeys, key => this.addToAccessedKeys(key));
+        _.each(mergedKeys, (key) => this.addToAccessedKeys(key));
     }
 
     /**

package/lib/Str.js

@@ -8,9 +8,7 @@ import _ from 'underscore';
  * @return {Boolean} Returns true if the haystack starts with the needle.
  */
 function startsWith(haystack, needle) {
-    return _.isString(haystack)
-                && _.isString(needle)
-                && haystack.startsWith(needle);
+    return _.isString(haystack) && _.isString(needle) && haystack.startsWith(needle);
 }
 
 /**
@@ -26,4 +24,19 @@ function result(parameter, ...args) {
     return _.isFunction(parameter) ? parameter(...args) : parameter;
 }
 
-export {startsWith, result};
+/**
+ * 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};

package/lib/broadcast/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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

@@ -0,0 +1,14 @@
+/**
+ * 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

@@ -0,0 +1,35 @@
+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,
+};

package/lib/compose.js

@@ -18,7 +18,7 @@
  */
 export default function compose(...funcs) {
     if (funcs.length === 0) {
-        return arg => arg;
+        return (arg) => arg;
     }
 
     if (funcs.length === 1) {
@@ -26,5 +26,9 @@ export default function compose(...funcs) {
     }
 
     // eslint-disable-next-line rulesdir/prefer-underscore-method
-    return funcs.reduce((a, b) => (...args) => a(b(...args)));
+    return funcs.reduce(
+        (a, b) =>
+            (...args) =>
+                a(b(...args)),
+    );
 }

package/lib/metrics/PerformanceUtils.js

@@ -26,9 +26,7 @@ function diffObject(object, base) {
             }
 
             // eslint-disable-next-line no-param-reassign
-            result[key] = (_.isObject(value) && _.isObject(comparisonObject[key]))
-                ? changes(value, comparisonObject[key])
-                : value;
+            result[key] = _.isObject(value) && _.isObject(comparisonObject[key]) ? changes(value, comparisonObject[key]) : value;
         });
     }
     return changes(object, base);
@@ -62,7 +60,4 @@ function logSetStateCall(mapping, previousValue, newValue, caller, keyThatChange
     console.debug(`[Onyx-Debug] ${mapping.displayName} setState() called. Subscribed to key '${mapping.key}' (${caller})`, logParams);
 }
 
-export {
-    logSetStateCall,
-    setShouldDebugSetState,
-};
+export {logSetStateCall, setShouldDebugSetState};

package/lib/metrics/index.native.js

@@ -47,9 +47,9 @@ function decorateWithMetrics(func, alias = func.name) {
         const originalPromise = func.apply(this, args);
 
         /*
-        * Then handlers added here are not affecting the original promise
-        * They create a separate chain that's not exposed (returned) to the original caller
-        * */
+         * Then handlers added here are not affecting the original promise
+         * They create a separate chain that's not exposed (returned) to the original caller
+         * */
         originalPromise
             .then((result) => {
                 measureMarkToNow(mark, {result});
@@ -84,26 +84,29 @@ function sum(list, prop) {
  */
 function getMetrics() {
     const summaries = _.chain(performance.getEntriesByType('measure'))
-        .filter(entry => entry.detail && decoratedAliases.has(entry.detail.alias))
-        .groupBy(entry => entry.detail.alias)
+        .filter((entry) => entry.detail && decoratedAliases.has(entry.detail.alias))
+        .groupBy((entry) => entry.detail.alias)
         .map((calls, methodName) => {
             const total = sum(calls, 'duration');
-            const avg = (total / calls.length) || 0;
+            const avg = total / calls.length || 0;
             const max = _.max(calls, 'duration').duration || 0;
             const min = _.min(calls, 'duration').duration || 0;
 
             // Latest complete call (by end time) for all the calls made to the current method
-            const lastCall = _.max(calls, call => call.startTime + call.duration);
+            const lastCall = _.max(calls, (call) => call.startTime + call.duration);
 
-            return [methodName, {
+            return [
                 methodName,
-                total,
-                max,
-                min,
-                avg,
-                lastCall,
-                calls,
-            }];
+                {
+                    methodName,
+                    total,
+                    max,
+                    min,
+                    avg,
+                    lastCall,
+                    calls,
+                },
+            ];
         })
         .object() // Create a map like methodName -> StatSummary
         .value();
@@ -111,10 +114,7 @@ function getMetrics() {
     const totalTime = sum(_.values(summaries), 'total');
 
     // Latest complete call (by end time) of all methods up to this point
-    const lastCompleteCall = _.max(
-        _.values(summaries),
-        summary => summary.lastCall.startTime + summary.lastCall.duration,
-    ).lastCall;
+    const lastCompleteCall = _.max(_.values(summaries), (summary) => summary.lastCall.startTime + summary.lastCall.duration).lastCall;
 
     return {
         totalTime,
@@ -177,7 +177,7 @@ function printMetrics({raw = false, format = 'console', methods} = {}) {
     const methodNames = _.isArray(methods) ? methods : _.keys(summaries);
 
     const methodCallTables = _.chain(methodNames)
-        .filter(methodName => summaries[methodName] && summaries[methodName].avg > 0)
+        .filter((methodName) => summaries[methodName] && summaries[methodName].avg > 0)
         .map((methodName) => {
             const {calls, ...methodStats} = summaries[methodName];
             tableSummary.addRow(
@@ -186,7 +186,7 @@ function printMetrics({raw = false, format = 'console', methods} = {}) {
                 toDuration(methodStats.max, raw),
                 toDuration(methodStats.min, raw),
                 toDuration(methodStats.avg, raw),
-                toDuration((methodStats.lastCall.startTime + methodStats.lastCall.duration) - timeOrigin, raw),
+                toDuration(methodStats.lastCall.startTime + methodStats.lastCall.duration - timeOrigin, raw),
                 calls.length,
             );
 
@@ -194,12 +194,12 @@ function printMetrics({raw = false, format = 'console', methods} = {}) {
                 title: methodName,
                 heading: ['start time', 'end time', 'duration', 'args'],
                 leftAlignedCols: [3],
-                rows: _.map(calls, call => ([
+                rows: _.map(calls, (call) => [
                     toDuration(call.startTime - performance.timeOrigin, raw),
-                    toDuration((call.startTime + call.duration) - timeOrigin, raw),
+                    toDuration(call.startTime + call.duration - timeOrigin, raw),
                     toDuration(call.duration, raw),
                     _.map(call.detail.args, String).join(', ').slice(0, 60), // Restrict cell width to 60 chars max
-                ])),
+                ]),
             });
         })
         .value();
@@ -219,17 +219,9 @@ function printMetrics({raw = false, format = 'console', methods} = {}) {
         }).join('\n\n');
     }
 
-    const lastComplete = lastCompleteCall && toDuration(
-        (lastCompleteCall.startTime + lastCompleteCall.duration) - timeOrigin, raw,
-    );
+    const lastComplete = lastCompleteCall && toDuration(lastCompleteCall.startTime + lastCompleteCall.duration - timeOrigin, raw);
 
-    const mainOutput = [
-        '### Onyx Benchmark',
-        `  - Total: ${toDuration(totalTime, raw)}`,
-        `  - Last call finished at: ${lastComplete || 'N/A'}`,
-        '',
-        tableSummary.toString(),
-    ];
+    const mainOutput = ['### Onyx Benchmark', `  - Total: ${toDuration(totalTime, raw)}`, `  - Last call finished at: ${lastComplete || 'N/A'}`, '', tableSummary.toString()];
 
     /* eslint-disable no-console */
     console.info(mainOutput.join('\n'));
@@ -248,7 +240,7 @@ function resetMetrics() {
     const {summaries} = getMetrics();
 
     _.chain(summaries)
-        .map(summary => summary.calls)
+        .map((summary) => summary.calls)
         .flatten()
         .each((measure) => {
             performance.clearMarks(measure.detail.alias);
@@ -256,9 +248,4 @@ function resetMetrics() {
         });
 }
 
-export {
-    decorateWithMetrics,
-    getMetrics,
-    resetMetrics,
-    printMetrics,
-};
+export {decorateWithMetrics, getMetrics, resetMetrics, printMetrics};

package/lib/metrics/index.web.js

@@ -1,13 +1,10 @@
 // For web-only implementations of Onyx, this module will just be a no-op
 
-function decorateWithMetrics(func) { return func; }
+function decorateWithMetrics(func) {
+    return func;
+}
 function getMetrics() {}
 function printMetrics() {}
 function resetMetrics() {}
 
-export {
-    decorateWithMetrics,
-    getMetrics,
-    resetMetrics,
-    printMetrics,
-};
+export {decorateWithMetrics, getMetrics, resetMetrics, printMetrics};

package/lib/storage/WebStorage.js

@@ -31,17 +31,13 @@ const webStorage = {
      */
     keepInstancesSync(onStorageKeyChanged) {
         // Override set, remove and clear to raise storage events that we intercept in other tabs
-        this.setItem = (key, value) => Storage.setItem(key, value)
-            .then(() => raiseStorageSyncEvent(key));
+        this.setItem = (key, value) => Storage.setItem(key, value).then(() => raiseStorageSyncEvent(key));
 
-        this.removeItem = key => Storage.removeItem(key)
-            .then(() => raiseStorageSyncEvent(key));
+        this.removeItem = (key) => Storage.removeItem(key).then(() => raiseStorageSyncEvent(key));
 
-        this.removeItems = keys => Storage.removeItems(keys)
-            .then(() => raiseStorageSyncManyKeysEvent(keys));
+        this.removeItems = (keys) => Storage.removeItems(keys).then(() => raiseStorageSyncManyKeysEvent(keys));
 
-        this.mergeItem = (key, batchedChanges, modifiedData) => Storage.mergeItem(key, batchedChanges, modifiedData)
-            .then(() => raiseStorageSyncEvent(key));
+        this.mergeItem = (key, batchedChanges, modifiedData) => Storage.mergeItem(key, batchedChanges, modifiedData).then(() => raiseStorageSyncEvent(key));
 
         // If we just call Storage.clear other tabs will have no idea which keys were available previously
         // so that they can call keysChanged for them. That's why we iterate over every key and raise a storage sync
@@ -49,7 +45,7 @@ const webStorage = {
         this.clear = () => {
             let allKeys;
 
-            // They keys must be retreived before storage is cleared or else the list of keys would be empty
+            // The keys must be retrieved before storage is cleared or else the list of keys would be empty
             return Storage.getAllKeys()
                 .then((keys) => {
                     allKeys = keys;
@@ -70,8 +66,7 @@ const webStorage = {
             }
 
             const onyxKey = event.newValue;
-            Storage.getItem(onyxKey)
-                .then(value => onStorageKeyChanged(onyxKey, value));
+            Storage.getItem(onyxKey).then((value) => onStorageKeyChanged(onyxKey, value));
         });
     },
 };

package/lib/storage/__mocks__/index.js

@@ -14,13 +14,13 @@ const idbKeyvalMock = {
     },
     multiSet(pairs) {
         const setPromises = _.map(pairs, ([key, value]) => this.setItem(key, value));
-        return new Promise(resolve => Promise.all(setPromises).then(() => resolve(storageMapInternal)));
+        return new Promise((resolve) => Promise.all(setPromises).then(() => resolve(storageMapInternal)));
     },
     getItem(key) {
         return Promise.resolve(storageMapInternal[key]);
     },
     multiGet(keys) {
-        const getPromises = _.map(keys, key => new Promise(resolve => this.getItem(key).then(value => resolve([key, value]))));
+        const getPromises = _.map(keys, (key) => new Promise((resolve) => this.getItem(key).then((value) => resolve([key, value]))));
         return Promise.all(getPromises);
     },
     multiMerge(pairs) {

package/lib/storage/providers/IDBKeyVal.js

@@ -1,15 +1,4 @@
-import {
-    set,
-    keys,
-    getMany,
-    setMany,
-    get,
-    clear,
-    del,
-    delMany,
-    createStore,
-    promisifyRequest,
-} from 'idb-keyval';
+import {set, keys, getMany, setMany, get, clear, del, delMany, createStore, promisifyRequest} from 'idb-keyval';
 import _ from 'underscore';
 import utils from '../../utils';
 
@@ -38,8 +27,7 @@ const provider = {
      * @param {String[]} keysParam
      * @return {Promise<Array<[key, value]>>}
      */
-    multiGet: keysParam => getMany(keysParam, getCustomStore())
-        .then(values => _.map(values, (value, index) => [keysParam[index], value])),
+    multiGet: (keysParam) => getMany(keysParam, getCustomStore()).then((values) => _.map(values, (value, index) => [keysParam[index], value])),
 
     /**
      * Multiple merging of existing and new values in a batch
@@ -47,21 +35,22 @@ const provider = {
      * This function also removes all nested null values from an object.
      * @return {Promise<void>}
      */
-    multiMerge: pairs => getCustomStore()('readwrite', (store) => {
-        // Note: we are using the manual store transaction here, to fit the read and update
-        // of the items in one transaction to achieve best performance.
-
-        const getValues = Promise.all(_.map(pairs, ([key]) => promisifyRequest(store.get(key))));
-
-        return getValues.then((values) => {
-            const upsertMany = _.map(pairs, ([key, value], index) => {
-                const prev = values[index];
-                const newValue = utils.fastMerge(prev, value);
-                return promisifyRequest(store.put(newValue, key));
+    multiMerge: (pairs) =>
+        getCustomStore()('readwrite', (store) => {
+            // Note: we are using the manual store transaction here, to fit the read and update
+            // of the items in one transaction to achieve best performance.
+
+            const getValues = Promise.all(_.map(pairs, ([key]) => promisifyRequest(store.get(key))));
+
+            return getValues.then((values) => {
+                const upsertMany = _.map(pairs, ([key, value], index) => {
+                    const prev = values[index];
+                    const newValue = utils.fastMerge(prev, value);
+                    return promisifyRequest(store.put(newValue, key));
+                });
+                return Promise.all(upsertMany);
             });
-            return Promise.all(upsertMany);
-        });
-    }),
+        }),
 
     /**
      * Merging an existing value with a new one
@@ -80,7 +69,7 @@ const provider = {
      * @param {Array<[key, value]>} pairs
      * @return {Promise<void>}
      */
-    multiSet: pairs => setMany(pairs, getCustomStore()),
+    multiSet: (pairs) => setMany(pairs, getCustomStore()),
 
     /**
      * Clear everything from storage and also stops the SyncQueue from adding anything more to storage
@@ -102,17 +91,17 @@ const provider = {
      * @param {String} key
      * @return {Promise<*>}
      */
-    getItem: key => get(key, getCustomStore())
-
-        // idb-keyval returns undefined for missing items, but this needs to return null so that idb-keyval does the same thing as SQLiteStorage.
-        .then(val => (val === undefined ? null : val)),
+    getItem: (key) =>
+        get(key, getCustomStore())
+            // idb-keyval returns undefined for missing items, but this needs to return null so that idb-keyval does the same thing as SQLiteStorage.
+            .then((val) => (val === undefined ? null : val)),
 
     /**
      * Remove given key and it's value from storage
      * @param {String} key
      * @returns {Promise<void>}
      */
-    removeItem: key => del(key, getCustomStore()),
+    removeItem: (key) => del(key, getCustomStore()),
 
     /**
      * Remove given keys and their values from storage
@@ -120,7 +109,7 @@ const provider = {
      * @param {Array} keysParam
      * @returns {Promise}
      */
-    removeItems: keysParam => delMany(keysParam, getCustomStore()),
+    removeItems: (keysParam) => delMany(keysParam, getCustomStore()),
 
     /**
      * Gets the total bytes of the database file
@@ -131,8 +120,9 @@ const provider = {
             throw new Error('StorageManager browser API unavailable');
         }
 
-        return window.navigator.storage.estimate()
-            .then(value => ({
+        return window.navigator.storage
+            .estimate()
+            .then((value) => ({
                 bytesUsed: value.usage,
                 bytesRemaining: value.quota - value.usage,
             }))