react-native-onyx 2.0.14 → 2.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,7 +10,6 @@ const set = jest.fn((key, value) => {
10
10
  return Promise.resolve(value);
11
11
  });
12
12
  const idbKeyvalMock = {
13
- name: 'KeyValMockProvider',
14
13
  init: () => undefined,
15
14
  setItem(key, value) {
16
15
  return set(key, value);
@@ -1,6 +1,6 @@
1
1
  import type StorageProvider from './providers/types';
2
2
  type Storage = {
3
3
  getStorageProvider: () => StorageProvider;
4
- } & Omit<StorageProvider, 'name'>;
4
+ } & StorageProvider;
5
5
  declare const Storage: Storage;
6
6
  export default Storage;
@@ -1,71 +1,12 @@
1
1
  "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
25
2
  var __importDefault = (this && this.__importDefault) || function (mod) {
26
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
27
4
  };
28
5
  Object.defineProperty(exports, "__esModule", { value: true });
29
- const Logger = __importStar(require("../Logger"));
30
6
  const platforms_1 = __importDefault(require("./platforms"));
31
7
  const InstanceSync_1 = __importDefault(require("./InstanceSync"));
32
- const NoopProvider_1 = __importDefault(require("./providers/NoopProvider"));
33
- let provider = platforms_1.default;
8
+ const provider = platforms_1.default;
34
9
  let shouldKeepInstancesSync = false;
35
- let finishInitalization;
36
- const initPromise = new Promise((resolve) => {
37
- finishInitalization = resolve;
38
- });
39
- /**
40
- * Degrade performance by removing the storage provider and only using cache
41
- */
42
- function degradePerformance(error) {
43
- Logger.logAlert(`Error while using ${provider.name}. Falling back to only using cache and dropping storage.`);
44
- console.error(error);
45
- provider = NoopProvider_1.default;
46
- }
47
- /**
48
- * Runs a piece of code and degrades performance if certain errors are thrown
49
- */
50
- function tryOrDegradePerformance(fn) {
51
- return new Promise((resolve, reject) => {
52
- initPromise.then(() => {
53
- try {
54
- resolve(fn());
55
- }
56
- catch (error) {
57
- // Test for known critical errors that the storage provider throws, e.g. when storage is full
58
- if (error instanceof Error) {
59
- // IndexedDB error when storage is full (https://github.com/Expensify/App/issues/29403)
60
- if (error.message.includes('Internal error opening backing store for indexedDB.open')) {
61
- degradePerformance(error);
62
- }
63
- }
64
- reject(error);
65
- }
66
- });
67
- });
68
- }
69
10
  const Storage = {
70
11
  /**
71
12
  * Returns the storage provider currently in use
@@ -78,92 +19,90 @@ const Storage = {
78
19
  * and enables fallback providers if necessary
79
20
  */
80
21
  init() {
81
- tryOrDegradePerformance(provider.init).finally(() => {
82
- finishInitalization();
83
- });
22
+ provider.init();
84
23
  },
85
24
  /**
86
25
  * Get the value of a given key or return `null` if it's not available
87
26
  */
88
- getItem: (key) => tryOrDegradePerformance(() => provider.getItem(key)),
27
+ getItem: (key) => provider.getItem(key),
89
28
  /**
90
29
  * Get multiple key-value pairs for the give array of keys in a batch
91
30
  */
92
- multiGet: (keys) => tryOrDegradePerformance(() => provider.multiGet(keys)),
31
+ multiGet: (keys) => provider.multiGet(keys),
93
32
  /**
94
33
  * Sets the value for a given key. The only requirement is that the value should be serializable to JSON string
95
34
  */
96
- setItem: (key, value) => tryOrDegradePerformance(() => {
35
+ setItem: (key, value) => {
97
36
  const promise = provider.setItem(key, value);
98
37
  if (shouldKeepInstancesSync) {
99
38
  return promise.then(() => InstanceSync_1.default.setItem(key));
100
39
  }
101
40
  return promise;
102
- }),
41
+ },
103
42
  /**
104
43
  * Stores multiple key-value pairs in a batch
105
44
  */
106
- multiSet: (pairs) => tryOrDegradePerformance(() => provider.multiSet(pairs)),
45
+ multiSet: (pairs) => provider.multiSet(pairs),
107
46
  /**
108
47
  * Merging an existing value with a new one
109
48
  */
110
- mergeItem: (key, changes, modifiedData) => tryOrDegradePerformance(() => {
49
+ mergeItem: (key, changes, modifiedData) => {
111
50
  const promise = provider.mergeItem(key, changes, modifiedData);
112
51
  if (shouldKeepInstancesSync) {
113
52
  return promise.then(() => InstanceSync_1.default.mergeItem(key));
114
53
  }
115
54
  return promise;
116
- }),
55
+ },
117
56
  /**
118
57
  * Multiple merging of existing and new values in a batch
119
58
  * This function also removes all nested null values from an object.
120
59
  */
121
- multiMerge: (pairs) => tryOrDegradePerformance(() => provider.multiMerge(pairs)),
60
+ multiMerge: (pairs) => provider.multiMerge(pairs),
122
61
  /**
123
62
  * Removes given key and its value
124
63
  */
125
- removeItem: (key) => tryOrDegradePerformance(() => {
64
+ removeItem: (key) => {
126
65
  const promise = provider.removeItem(key);
127
66
  if (shouldKeepInstancesSync) {
128
67
  return promise.then(() => InstanceSync_1.default.removeItem(key));
129
68
  }
130
69
  return promise;
131
- }),
70
+ },
132
71
  /**
133
72
  * Remove given keys and their values
134
73
  */
135
- removeItems: (keys) => tryOrDegradePerformance(() => {
74
+ removeItems: (keys) => {
136
75
  const promise = provider.removeItems(keys);
137
76
  if (shouldKeepInstancesSync) {
138
77
  return promise.then(() => InstanceSync_1.default.removeItems(keys));
139
78
  }
140
79
  return promise;
141
- }),
80
+ },
142
81
  /**
143
82
  * Clears everything
144
83
  */
145
- clear: () => tryOrDegradePerformance(() => {
84
+ clear: () => {
146
85
  if (shouldKeepInstancesSync) {
147
86
  return InstanceSync_1.default.clear(() => provider.clear());
148
87
  }
149
88
  return provider.clear();
150
- }),
89
+ },
151
90
  // This is a noop for now in order to keep clients from crashing see https://github.com/Expensify/Expensify/issues/312438
152
- setMemoryOnlyKeys: () => tryOrDegradePerformance(() => provider.setMemoryOnlyKeys()),
91
+ setMemoryOnlyKeys: () => provider.setMemoryOnlyKeys(),
153
92
  /**
154
93
  * Returns all available keys
155
94
  */
156
- getAllKeys: () => tryOrDegradePerformance(() => provider.getAllKeys()),
95
+ getAllKeys: () => provider.getAllKeys(),
157
96
  /**
158
97
  * Gets the total bytes of the store
159
98
  */
160
- getDatabaseSize: () => tryOrDegradePerformance(() => provider.getDatabaseSize()),
99
+ getDatabaseSize: () => provider.getDatabaseSize(),
161
100
  /**
162
101
  * @param onStorageKeyChanged - Storage synchronization mechanism keeping all opened tabs in sync (web only)
163
102
  */
164
103
  keepInstancesSync(onStorageKeyChanged) {
165
104
  // If InstanceSync is null, it means we're on a native platform and we don't need to keep instances in sync
166
- if (InstanceSync_1.default === null)
105
+ if (InstanceSync_1.default == null)
167
106
  return;
168
107
  shouldKeepInstancesSync = true;
169
108
  InstanceSync_1.default.init(onStorageKeyChanged);
@@ -9,10 +9,6 @@ const utils_1 = __importDefault(require("../../utils"));
9
9
  // which might not be available in certain environments that load the bundle (e.g. electron main process).
10
10
  let idbKeyValStore;
11
11
  const provider = {
12
- /**
13
- * The name of the provider that can be printed to the logs
14
- */
15
- name: 'IDBKeyValProvider',
16
12
  /**
17
13
  * Initializes the storage provider
18
14
  */
@@ -9,10 +9,6 @@ const utils_1 = __importDefault(require("../../utils"));
9
9
  const DB_NAME = 'OnyxDB';
10
10
  let db;
11
11
  const provider = {
12
- /**
13
- * The name of the provider that can be printed to the logs
14
- */
15
- name: 'SQLiteProvider',
16
12
  /**
17
13
  * Initializes the storage provider
18
14
  */
@@ -6,10 +6,6 @@ type KeyList = Key[];
6
6
  type KeyValuePairList = KeyValuePair[];
7
7
  type OnStorageKeyChanged = (key: Key, value: Value | null) => void;
8
8
  type StorageProvider = {
9
- /**
10
- * The name of the provider that can be printed to the logs
11
- */
12
- name: string;
13
9
  /**
14
10
  * Initializes the storage provider
15
11
  */
@@ -73,4 +69,4 @@ type StorageProvider = {
73
69
  keepInstancesSync?: (onStorageKeyChanged: OnStorageKeyChanged) => void;
74
70
  };
75
71
  export default StorageProvider;
76
- export type { Value, Key, KeyList, KeyValuePair, KeyValuePairList, OnStorageKeyChanged };
72
+ export type { Value, Key, KeyList, KeyValuePairList, OnStorageKeyChanged };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "react-native-onyx",
3
- "version": "2.0.14",
3
+ "version": "2.0.15",
4
4
  "author": "Expensify, Inc.",
5
5
  "homepage": "https://expensify.com",
6
6
  "description": "State management for React Native",
@@ -1,3 +0,0 @@
1
- import type StorageProvider from './types';
2
- declare const provider: StorageProvider;
3
- export default provider;
@@ -1,89 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const provider = {
4
- /**
5
- * The name of the provider that can be printed to the logs
6
- */
7
- name: 'NoopProvider',
8
- /**
9
- * Initializes the storage provider
10
- */
11
- init() {
12
- // do nothing
13
- },
14
- /**
15
- * Get the value of a given key or return `null` if it's not available in memory
16
- * @param {String} key
17
- * @return {Promise<*>}
18
- */
19
- getItem() {
20
- return Promise.resolve(null);
21
- },
22
- /**
23
- * Get multiple key-value pairs for the give array of keys in a batch.
24
- */
25
- multiGet() {
26
- return Promise.resolve([]);
27
- },
28
- /**
29
- * Sets the value for a given key. The only requirement is that the value should be serializable to JSON string
30
- */
31
- setItem() {
32
- return Promise.resolve();
33
- },
34
- /**
35
- * Stores multiple key-value pairs in a batch
36
- */
37
- multiSet() {
38
- return Promise.resolve();
39
- },
40
- /**
41
- * Merging an existing value with a new one
42
- */
43
- mergeItem() {
44
- return Promise.resolve();
45
- },
46
- /**
47
- * Multiple merging of existing and new values in a batch
48
- * This function also removes all nested null values from an object.
49
- */
50
- multiMerge() {
51
- return Promise.resolve([]);
52
- },
53
- /**
54
- * Remove given key and it's value from memory
55
- */
56
- removeItem() {
57
- return Promise.resolve();
58
- },
59
- /**
60
- * Remove given keys and their values from memory
61
- */
62
- removeItems() {
63
- return Promise.resolve();
64
- },
65
- /**
66
- * Clear everything from memory
67
- */
68
- clear() {
69
- return Promise.resolve();
70
- },
71
- // This is a noop for now in order to keep clients from crashing see https://github.com/Expensify/Expensify/issues/312438
72
- setMemoryOnlyKeys() {
73
- // do nothing
74
- },
75
- /**
76
- * Returns all keys available in memory
77
- */
78
- getAllKeys() {
79
- return Promise.resolve([]);
80
- },
81
- /**
82
- * Gets the total bytes of the store.
83
- * `bytesRemaining` will always be `Number.POSITIVE_INFINITY` since we don't have a hard limit on memory.
84
- */
85
- getDatabaseSize() {
86
- return Promise.resolve({ bytesRemaining: Number.POSITIVE_INFINITY, bytesUsed: 0 });
87
- },
88
- };
89
- exports.default = provider;