-
Notifications
You must be signed in to change notification settings - Fork 603
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* createRainbowStore * Migrate browserHistory store to createRainbowStore, fix addRecent
- Loading branch information
1 parent
d4df288
commit 5fb88b4
Showing
3 changed files
with
156 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| import { debounce } from 'lodash'; | ||
| import { MMKV } from 'react-native-mmkv'; | ||
| import { create } from 'zustand'; | ||
| import { PersistOptions, StorageValue, persist, subscribeWithSelector } from 'zustand/middleware'; | ||
| import { StateCreator } from 'zustand/vanilla'; | ||
| import { RainbowError, logger } from '@/logger'; | ||
|
|
||
| const PERSIST_RATE_LIMIT_MS = 3000; | ||
|
|
||
| const rainbowStorage = new MMKV({ id: 'rainbow-storage' }); | ||
|
|
||
| /** | ||
| * Configuration options for creating a persistable Rainbow store. | ||
| */ | ||
| interface RainbowPersistConfig<S> { | ||
| /** | ||
| * A function that determines which parts of the state should be persisted. | ||
| * By default, the entire state is persisted. | ||
| */ | ||
| partialize?: (state: S) => Partial<S>; | ||
| /** | ||
| * The unique key for the persisted store. | ||
| */ | ||
| storageKey: string; | ||
| /** | ||
| * The version of the store's schema. | ||
| * Useful for handling schema changes across app versions. | ||
| * @default 0 | ||
| */ | ||
| version?: number; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a persist storage object for the Rainbow store. | ||
| * @param config - The configuration options for the persistable Rainbow store. | ||
| * @returns An object containing the persist storage and version. | ||
| */ | ||
| function createPersistStorage<S>(config: RainbowPersistConfig<S>) { | ||
| const { storageKey, version = 0 } = config; | ||
|
|
||
| const persistStorage: PersistOptions<S, Partial<S>>['storage'] = { | ||
| getItem: (name: string) => { | ||
| const key = `${storageKey}:${name}`; | ||
| const serializedValue = rainbowStorage.getString(key); | ||
| if (!serializedValue) return null; | ||
| return deserializeState<S>(serializedValue); | ||
| }, | ||
| setItem: (name, value) => lazyPersist(storageKey, name, value), | ||
| removeItem: (name: string) => { | ||
| const key = `${storageKey}:${name}`; | ||
| rainbowStorage.delete(key); | ||
| }, | ||
| }; | ||
|
|
||
| return { persistStorage, version }; | ||
| } | ||
|
|
||
| /** | ||
| * Initiates a debounced persist operation for a given store state. | ||
| * @param storageKey - The key prefix for the store in the central MMKV storage. | ||
| * @param name - The name of the store. | ||
| * @param value - The state value to be persisted. | ||
| */ | ||
| const lazyPersist = debounce( | ||
| <S>(storageKey: string, name: string, value: StorageValue<S>) => { | ||
| try { | ||
| const key = `${storageKey}:${name}`; | ||
| const serializedValue = serializeState(value.state, value.version ?? 0); | ||
| rainbowStorage.set(key, serializedValue); | ||
| } catch (error) { | ||
| logger.error(new RainbowError('Failed to serialize persisted store data'), { error }); | ||
| } | ||
| }, | ||
| PERSIST_RATE_LIMIT_MS, | ||
| { leading: false, trailing: true, maxWait: PERSIST_RATE_LIMIT_MS } | ||
| ); | ||
|
|
||
| /** | ||
| * Serializes the state and version into a JSON string. | ||
| * @param state - The state to be serialized. | ||
| * @param version - The version of the state. | ||
| * @returns The serialized state as a JSON string. | ||
| */ | ||
| function serializeState<S>(state: S, version: number): string { | ||
| try { | ||
| return JSON.stringify({ state, version }); | ||
| } catch (error) { | ||
| logger.error(new RainbowError('Failed to serialize Rainbow store data'), { error }); | ||
| throw error; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Deserializes the state and version from a JSON string. | ||
| * @param serializedState - The serialized state as a JSON string. | ||
| * @returns An object containing the deserialized state and version. | ||
| */ | ||
| function deserializeState<S>(serializedState: string): { state: S; version: number } { | ||
| try { | ||
| return JSON.parse(serializedState); | ||
| } catch (error) { | ||
| logger.error(new RainbowError('Failed to deserialize persisted Rainbow store data'), { error }); | ||
| throw error; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Creates a Rainbow store with optional persistence functionality. | ||
| * @param createState - The state creator function for the Rainbow store. | ||
| * @param persistConfig - The configuration options for the persistable Rainbow store. | ||
| * @returns A Zustand store with the specified state and optional persistence. | ||
| */ | ||
| export function createRainbowStore<S>( | ||
| createState: StateCreator<S, [], [['zustand/subscribeWithSelector', never]]>, | ||
| persistConfig?: RainbowPersistConfig<S> | ||
| ) { | ||
| if (!persistConfig) { | ||
| return create<S>()(subscribeWithSelector(createState)); | ||
| } | ||
|
|
||
| const { persistStorage, version } = createPersistStorage(persistConfig); | ||
|
|
||
| return create<S>()( | ||
| subscribeWithSelector( | ||
| persist(createState, { | ||
| name: persistConfig.storageKey, | ||
| partialize: persistConfig.partialize || (state => state), | ||
| storage: persistStorage, | ||
| version, | ||
| }) | ||
| ) | ||
| ); | ||
| } |