mirror of
https://github.com/facebook/react-native.git
synced 2026-11-18 20:19:07 +00:00
refactor(react-native-github): remove AsyncStorage from JS
Summary: ## Changelog [JS][Removed] - Removed AsyncStorage module from react-native Reviewed By: NickGerleman Differential Revision: D40302352 fbshipit-source-id: 9377ea12036e498dde0b4b0f56de5c4fb9bd2461
This commit is contained in:
1 parent
4de2aaba50
commit
20eeb1bfe3
9 files changed
+15
-870
No files matched your search
Vendored
-120
@@ -1,120 +0,0 @@
|
||||
/**
|
||||
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*
|
||||
* @format
|
||||
*/
|
||||
|
||||
/**
|
||||
* AsyncStorage is a simple, unencrypted, asynchronous, persistent, key-value storage
|
||||
* system that is global to the app. It should be used instead of LocalStorage.
|
||||
*
|
||||
* It is recommended that you use an abstraction on top of `AsyncStorage`
|
||||
* instead of `AsyncStorage` directly for anything more than light usage since
|
||||
* it operates globally.
|
||||
*
|
||||
* On iOS, `AsyncStorage` is backed by native code that stores small values in a
|
||||
* serialized dictionary and larger values in separate files. On Android,
|
||||
* `AsyncStorage` will use either [RocksDB](http://rocksdb.org/) or SQLite
|
||||
* based on what is available.
|
||||
*
|
||||
* @see https://reactnative.dev/docs/asyncstorage#content
|
||||
*/
|
||||
export interface AsyncStorageStatic {
|
||||
/**
|
||||
* Fetches key and passes the result to callback, along with an Error if there is any.
|
||||
*/
|
||||
getItem(
|
||||
key: string,
|
||||
callback?: (error?: Error, result?: string) => void,
|
||||
): Promise<string | null>;
|
||||
|
||||
/**
|
||||
* Sets value for key and calls callback on completion, along with an Error if there is any
|
||||
*/
|
||||
setItem(
|
||||
key: string,
|
||||
value: string,
|
||||
callback?: (error?: Error) => void,
|
||||
): Promise<void>;
|
||||
|
||||
removeItem(key: string, callback?: (error?: Error) => void): Promise<void>;
|
||||
|
||||
/**
|
||||
* Merges existing value with input value, assuming they are stringified json. Returns a Promise object.
|
||||
* Not supported by all native implementation
|
||||
*/
|
||||
mergeItem(
|
||||
key: string,
|
||||
value: string,
|
||||
callback?: (error?: Error) => void,
|
||||
): Promise<void>;
|
||||
|
||||
/**
|
||||
* Erases all AsyncStorage for all clients, libraries, etc. You probably don't want to call this.
|
||||
* Use removeItem or multiRemove to clear only your own keys instead.
|
||||
*/
|
||||
clear(callback?: (error?: Error) => void): Promise<void>;
|
||||
|
||||
/**
|
||||
* Gets all keys known to the app, for all callers, libraries, etc
|
||||
*/
|
||||
getAllKeys(
|
||||
callback?: (error?: Error, keys?: string[]) => void,
|
||||
): Promise<string[]>;
|
||||
|
||||
/**
|
||||
* multiGet invokes callback with an array of key-value pair arrays that matches the input format of multiSet
|
||||
*/
|
||||
multiGet(
|
||||
keys: string[],
|
||||
callback?: (errors?: Error[], result?: [string, string][]) => void,
|
||||
): Promise<[string, string][]>;
|
||||
|
||||
/**
|
||||
* multiSet and multiMerge take arrays of key-value array pairs that match the output of multiGet,
|
||||
*
|
||||
* multiSet([['k1', 'val1'], ['k2', 'val2']], cb);
|
||||
*/
|
||||
multiSet(
|
||||
keyValuePairs: string[][],
|
||||
callback?: (errors?: Error[]) => void,
|
||||
): Promise<void>;
|
||||
|
||||
/**
|
||||
* Delete all the keys in the keys array.
|
||||
*/
|
||||
multiRemove(
|
||||
keys: string[],
|
||||
callback?: (errors?: Error[]) => void,
|
||||
): Promise<void>;
|
||||
|
||||
/**
|
||||
* Merges existing values with input values, assuming they are stringified json.
|
||||
* Returns a Promise object.
|
||||
*
|
||||
* Not supported by all native implementations.
|
||||
*/
|
||||
multiMerge(
|
||||
keyValuePairs: string[][],
|
||||
callback?: (errors?: Error[]) => void,
|
||||
): Promise<void>;
|
||||
}
|
||||
|
||||
/**
|
||||
* AsyncStorage has been extracted from react-native core and will be removed in a future release.
|
||||
* It can now be installed and imported from `@react-native-community/async-storage` instead of 'react-native'.
|
||||
* @see https://github.com/react-native-community/async-storage
|
||||
* @deprecated
|
||||
*/
|
||||
export const AsyncStorage: AsyncStorageStatic;
|
||||
|
||||
/**
|
||||
* AsyncStorage has been extracted from react-native core and will be removed in a future release.
|
||||
* It can now be installed and imported from `@react-native-community/async-storage` instead of 'react-native'.
|
||||
* @see https://github.com/react-native-community/async-storage
|
||||
* @deprecated
|
||||
*/
|
||||
export type AsyncStorage = AsyncStorageStatic;
|
||||
@@ -1,385 +0,0 @@
|
||||
/**
|
||||
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*
|
||||
* @format
|
||||
* @flow strict
|
||||
* @jsdoc
|
||||
*/
|
||||
|
||||
import NativeAsyncLocalStorage from './NativeAsyncLocalStorage';
|
||||
import NativeAsyncSQLiteDBStorage from './NativeAsyncSQLiteDBStorage';
|
||||
import invariant from 'invariant';
|
||||
|
||||
// Use SQLite if available, otherwise file storage.
|
||||
const RCTAsyncStorage = NativeAsyncSQLiteDBStorage || NativeAsyncLocalStorage;
|
||||
|
||||
type GetRequest = {
|
||||
keys: Array<string>,
|
||||
callback: ?(errors: ?Array<Error>, result: ?Array<Array<string>>) => void,
|
||||
keyIndex: number,
|
||||
resolve: (
|
||||
result?:
|
||||
| void
|
||||
| null
|
||||
| Promise<?Array<Array<string>>>
|
||||
| Array<Array<string>>,
|
||||
) => void,
|
||||
reject: (error?: mixed) => void,
|
||||
};
|
||||
|
||||
/**
|
||||
* `AsyncStorage` is a simple, unencrypted, asynchronous, persistent, key-value
|
||||
* storage system that is global to the app. It should be used instead of
|
||||
* LocalStorage.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage
|
||||
*/
|
||||
const AsyncStorage = {
|
||||
_getRequests: ([]: Array<GetRequest>),
|
||||
_getKeys: ([]: Array<string>),
|
||||
_immediate: (null: ?number),
|
||||
|
||||
/**
|
||||
* Fetches an item for a `key` and invokes a callback upon completion.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage#getitem
|
||||
*/
|
||||
getItem: function (
|
||||
key: string,
|
||||
callback?: ?(error: ?Error, result: ?string) => void,
|
||||
): Promise<?string> {
|
||||
invariant(RCTAsyncStorage, 'RCTAsyncStorage not available');
|
||||
return new Promise((resolve, reject) => {
|
||||
RCTAsyncStorage.multiGet([key], function (errors, result) {
|
||||
// Unpack result to get value from [[key,value]]
|
||||
const value = result && result[0] && result[0][1] ? result[0][1] : null;
|
||||
const errs = convertErrors(errors);
|
||||
callback && callback(errs && errs[0], value);
|
||||
if (errs) {
|
||||
reject(errs[0]);
|
||||
} else {
|
||||
resolve(value);
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* Sets the value for a `key` and invokes a callback upon completion.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage#setitem
|
||||
*/
|
||||
setItem: function (
|
||||
key: string,
|
||||
value: string,
|
||||
callback?: ?(error: ?Error) => void,
|
||||
): Promise<void> {
|
||||
invariant(RCTAsyncStorage, 'RCTAsyncStorage not available');
|
||||
return new Promise((resolve, reject) => {
|
||||
RCTAsyncStorage.multiSet([[key, value]], function (errors) {
|
||||
const errs = convertErrors(errors);
|
||||
callback && callback(errs && errs[0]);
|
||||
if (errs) {
|
||||
reject(errs[0]);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* Removes an item for a `key` and invokes a callback upon completion.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage#removeitem
|
||||
*/
|
||||
removeItem: function (
|
||||
key: string,
|
||||
callback?: ?(error: ?Error) => void,
|
||||
): Promise<void> {
|
||||
invariant(RCTAsyncStorage, 'RCTAsyncStorage not available');
|
||||
return new Promise((resolve, reject) => {
|
||||
RCTAsyncStorage.multiRemove([key], function (errors) {
|
||||
const errs = convertErrors(errors);
|
||||
callback && callback(errs && errs[0]);
|
||||
if (errs) {
|
||||
reject(errs[0]);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* Merges an existing `key` value with an input value, assuming both values
|
||||
* are stringified JSON.
|
||||
*
|
||||
* **NOTE:** This is not supported by all native implementations.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage#mergeitem
|
||||
*/
|
||||
mergeItem: function (
|
||||
key: string,
|
||||
value: string,
|
||||
callback?: ?(error: ?Error) => void,
|
||||
): Promise<void> {
|
||||
invariant(RCTAsyncStorage, 'RCTAsyncStorage not available');
|
||||
return new Promise((resolve, reject) => {
|
||||
RCTAsyncStorage.multiMerge([[key, value]], function (errors) {
|
||||
const errs = convertErrors(errors);
|
||||
callback && callback(errs && errs[0]);
|
||||
if (errs) {
|
||||
reject(errs[0]);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* Erases *all* `AsyncStorage` for all clients, libraries, etc. You probably
|
||||
* don't want to call this; use `removeItem` or `multiRemove` to clear only
|
||||
* your app's keys.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage#clear
|
||||
*/
|
||||
clear: function (callback?: ?(error: ?Error) => void): Promise<void> {
|
||||
invariant(RCTAsyncStorage, 'RCTAsyncStorage not available');
|
||||
return new Promise((resolve, reject) => {
|
||||
RCTAsyncStorage.clear(function (error) {
|
||||
callback && callback(convertError(error));
|
||||
if (error && convertError(error)) {
|
||||
reject(convertError(error));
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* Gets *all* keys known to your app; for all callers, libraries, etc.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage#getallkeys
|
||||
*/
|
||||
getAllKeys: function (
|
||||
callback?: ?(error: ?Error, keys: ?Array<string>) => void,
|
||||
): Promise<?Array<string>> {
|
||||
invariant(RCTAsyncStorage, 'RCTAsyncStorage not available');
|
||||
return new Promise((resolve, reject) => {
|
||||
RCTAsyncStorage.getAllKeys(function (error, keys) {
|
||||
callback && callback(convertError(error), keys);
|
||||
if (error) {
|
||||
reject(convertError(error));
|
||||
} else {
|
||||
resolve(keys);
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* The following batched functions are useful for executing a lot of
|
||||
* operations at once, allowing for native optimizations and provide the
|
||||
* convenience of a single callback after all operations are complete.
|
||||
*
|
||||
* These functions return arrays of errors, potentially one for every key.
|
||||
* For key-specific errors, the Error object will have a key property to
|
||||
* indicate which key caused the error.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Flushes any pending requests using a single batch call to get the data.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage#flushgetrequests
|
||||
* */
|
||||
/* $FlowFixMe[missing-this-annot] The 'this' type annotation(s) required by
|
||||
* Flow's LTI update could not be added via codemod */
|
||||
flushGetRequests: function (): void {
|
||||
const getRequests = this._getRequests;
|
||||
const getKeys = this._getKeys;
|
||||
|
||||
this._getRequests = [];
|
||||
this._getKeys = [];
|
||||
|
||||
invariant(RCTAsyncStorage, 'RCTAsyncStorage not available');
|
||||
RCTAsyncStorage.multiGet(getKeys, function (errors, result) {
|
||||
// Even though the runtime complexity of this is theoretically worse vs if we used a map,
|
||||
// it's much, much faster in practice for the data sets we deal with (we avoid
|
||||
// allocating result pair arrays). This was heavily benchmarked.
|
||||
//
|
||||
// Is there a way to avoid using the map but fix the bug in this breaking test?
|
||||
// https://github.com/facebook/react-native/commit/8dd8ad76579d7feef34c014d387bf02065692264
|
||||
const map: {[string]: string} = {};
|
||||
result &&
|
||||
result.forEach(([key, value]) => {
|
||||
map[key] = value;
|
||||
return value;
|
||||
});
|
||||
const reqLength = getRequests.length;
|
||||
for (let i = 0; i < reqLength; i++) {
|
||||
const request = getRequests[i];
|
||||
const requestKeys = request.keys;
|
||||
const requestResult = requestKeys.map(key => [key, map[key]]);
|
||||
request.callback && request.callback(null, requestResult);
|
||||
request.resolve && request.resolve(requestResult);
|
||||
}
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* This allows you to batch the fetching of items given an array of `key`
|
||||
* inputs. Your callback will be invoked with an array of corresponding
|
||||
* key-value pairs found.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage#multiget
|
||||
*/
|
||||
/* $FlowFixMe[missing-this-annot] The 'this' type annotation(s) required by
|
||||
* Flow's LTI update could not be added via codemod */
|
||||
multiGet: function (
|
||||
keys: Array<string>,
|
||||
callback?: ?(errors: ?Array<Error>, result: ?Array<Array<string>>) => void,
|
||||
): Promise<?Array<Array<string>>> {
|
||||
if (!this._immediate) {
|
||||
this._immediate = setImmediate(() => {
|
||||
this._immediate = null;
|
||||
this.flushGetRequests();
|
||||
});
|
||||
}
|
||||
|
||||
return new Promise<?Array<Array<string>>>((resolve, reject) => {
|
||||
this._getRequests.push({
|
||||
keys,
|
||||
callback,
|
||||
// do we need this?
|
||||
keyIndex: this._getKeys.length,
|
||||
resolve,
|
||||
reject,
|
||||
});
|
||||
// avoid fetching duplicates
|
||||
keys.forEach(key => {
|
||||
if (this._getKeys.indexOf(key) === -1) {
|
||||
this._getKeys.push(key);
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* Use this as a batch operation for storing multiple key-value pairs. When
|
||||
* the operation completes you'll get a single callback with any errors.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage#multiset
|
||||
*/
|
||||
multiSet: function (
|
||||
keyValuePairs: Array<Array<string>>,
|
||||
callback?: ?(errors: ?Array<Error>) => void,
|
||||
): Promise<void> {
|
||||
invariant(RCTAsyncStorage, 'RCTAsyncStorage not available');
|
||||
return new Promise((resolve, reject) => {
|
||||
RCTAsyncStorage.multiSet(keyValuePairs, function (errors) {
|
||||
const error = convertErrors(errors);
|
||||
callback && callback(error);
|
||||
if (error) {
|
||||
reject(error);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* Call this to batch the deletion of all keys in the `keys` array.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage#multiremove
|
||||
*/
|
||||
multiRemove: function (
|
||||
keys: Array<string>,
|
||||
callback?: ?(errors: ?Array<Error>) => void,
|
||||
): Promise<void> {
|
||||
invariant(RCTAsyncStorage, 'RCTAsyncStorage not available');
|
||||
return new Promise((resolve, reject) => {
|
||||
RCTAsyncStorage.multiRemove(keys, function (errors) {
|
||||
const error = convertErrors(errors);
|
||||
callback && callback(error);
|
||||
if (error) {
|
||||
reject(error);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* Batch operation to merge in existing and new values for a given set of
|
||||
* keys. This assumes that the values are stringified JSON.
|
||||
*
|
||||
* **NOTE**: This is not supported by all native implementations.
|
||||
*
|
||||
* See https://reactnative.dev/docs/asyncstorage#multimerge
|
||||
*/
|
||||
multiMerge: function (
|
||||
keyValuePairs: Array<Array<string>>,
|
||||
callback?: ?(errors: ?Array<Error>) => void,
|
||||
): Promise<void> {
|
||||
invariant(RCTAsyncStorage, 'RCTAsyncStorage not available');
|
||||
return new Promise((resolve, reject) => {
|
||||
RCTAsyncStorage.multiMerge(keyValuePairs, function (errors) {
|
||||
const error = convertErrors(errors);
|
||||
callback && callback(error);
|
||||
if (error) {
|
||||
reject(error);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
// Not all native implementations support merge.
|
||||
// TODO: Check whether above comment is correct. multiMerge is guaranteed to
|
||||
// exist in the module spec so we should be able to just remove this check.
|
||||
if (RCTAsyncStorage && !RCTAsyncStorage.multiMerge) {
|
||||
// $FlowFixMe[unclear-type]
|
||||
delete (AsyncStorage: any).mergeItem;
|
||||
// $FlowFixMe[unclear-type]
|
||||
delete (AsyncStorage: any).multiMerge;
|
||||
}
|
||||
|
||||
function convertErrors(
|
||||
// NOTE: The native module spec only has the Array case, but the Android
|
||||
// implementation passes a single object.
|
||||
errs: ?(
|
||||
| {message: string, key?: string}
|
||||
| Array<{message: string, key?: string}>
|
||||
),
|
||||
) {
|
||||
if (!errs) {
|
||||
return null;
|
||||
}
|
||||
return (Array.isArray(errs) ? errs : [errs]).map(e => convertError(e));
|
||||
}
|
||||
|
||||
declare function convertError(void | null): null;
|
||||
declare function convertError({message: string, key?: string}): Error;
|
||||
/* $FlowFixMe[missing-local-annot] The type annotation(s) required by Flow's
|
||||
* LTI update could not be added via codemod */
|
||||
function convertError(error) {
|
||||
if (!error) {
|
||||
return null;
|
||||
}
|
||||
const out = new Error(error.message);
|
||||
// $FlowFixMe[unclear-type]
|
||||
(out: any).key = error.key;
|
||||
return out;
|
||||
}
|
||||
|
||||
module.exports = AsyncStorage;
|
||||
@@ -1,45 +0,0 @@
|
||||
/**
|
||||
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*
|
||||
* @flow strict
|
||||
* @format
|
||||
*/
|
||||
|
||||
import type {TurboModule} from '../TurboModule/RCTExport';
|
||||
|
||||
import * as TurboModuleRegistry from '../TurboModule/TurboModuleRegistry';
|
||||
|
||||
export interface Spec extends TurboModule {
|
||||
+getConstants: () => {};
|
||||
+multiGet: (
|
||||
keys: Array<string>,
|
||||
callback: (
|
||||
errors: ?Array<{message: string, key?: string}>,
|
||||
kvPairs: ?Array<Array<string>>,
|
||||
) => void,
|
||||
) => void;
|
||||
+multiSet: (
|
||||
kvPairs: Array<Array<string>>,
|
||||
callback: (errors: ?Array<{message: string, key?: string}>) => void,
|
||||
) => void;
|
||||
+multiMerge: (
|
||||
kvPairs: Array<Array<string>>,
|
||||
callback: (errors: ?Array<{message: string, key?: string}>) => void,
|
||||
) => void;
|
||||
+multiRemove: (
|
||||
keys: Array<string>,
|
||||
callback: (errors: ?Array<{message: string, key?: string}>) => void,
|
||||
) => void;
|
||||
+clear: (callback: (error: {message: string, key?: string}) => void) => void;
|
||||
+getAllKeys: (
|
||||
callback: (
|
||||
error: ?{message: string, key?: string},
|
||||
allKeys: ?Array<string>,
|
||||
) => void,
|
||||
) => void;
|
||||
}
|
||||
|
||||
export default (TurboModuleRegistry.get<Spec>('AsyncLocalStorage'): ?Spec);
|
||||
@@ -1,45 +0,0 @@
|
||||
/**
|
||||
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*
|
||||
* @flow strict
|
||||
* @format
|
||||
*/
|
||||
|
||||
import type {TurboModule} from '../TurboModule/RCTExport';
|
||||
|
||||
import * as TurboModuleRegistry from '../TurboModule/TurboModuleRegistry';
|
||||
|
||||
export interface Spec extends TurboModule {
|
||||
+getConstants: () => {};
|
||||
+multiGet: (
|
||||
keys: Array<string>,
|
||||
callback: (
|
||||
errors: ?Array<{message: string, key?: string}>,
|
||||
kvPairs: ?Array<Array<string>>,
|
||||
) => void,
|
||||
) => void;
|
||||
+multiSet: (
|
||||
kvPairs: Array<Array<string>>,
|
||||
callback: (errors: ?Array<{message: string, key?: string}>) => void,
|
||||
) => void;
|
||||
+multiMerge: (
|
||||
kvPairs: Array<Array<string>>,
|
||||
callback: (errors: ?Array<{message: string, key?: string}>) => void,
|
||||
) => void;
|
||||
+multiRemove: (
|
||||
keys: Array<string>,
|
||||
callback: (errors: ?Array<{message: string, key?: string}>) => void,
|
||||
) => void;
|
||||
+clear: (callback: (error: {message: string, key?: string}) => void) => void;
|
||||
+getAllKeys: (
|
||||
callback: (
|
||||
error: ?{message: string, key?: string},
|
||||
allKeys: ?Array<string>,
|
||||
) => void,
|
||||
) => void;
|
||||
}
|
||||
|
||||
export default (TurboModuleRegistry.get<Spec>('AsyncSQLiteDBStorage'): ?Spec);
|
||||
Reference in new issue
Block a user