-
Notifications
You must be signed in to change notification settings - Fork 14
/
storage.tsx
279 lines (255 loc) · 7.09 KB
/
storage.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
/* eslint-disable consistent-return */
import React, { PropsWithChildren, ReactNode } from 'react';
import {
PluginModule,
injectable,
inject,
Service,
stateKey,
identifierKey,
nameKey,
} from 'reactant-module';
import { Reducer, ReducersMapObject, Store } from 'redux';
import {
persistStore,
persistReducer,
Storage,
PersistConfig,
Persistor,
REHYDRATE,
} from 'redux-persist';
import { PersistGate } from 'redux-persist/integration/react';
const StorageOptions = Symbol('StorageOptions');
export interface IStorageOptions extends Partial<PersistConfig<any>> {
/**
* define storage container
*/
storage: Storage;
/**
* define storage loading UI
*/
loading?: ReactNode;
}
export type SetStorageOptions<T> = Pick<
Partial<PersistConfig<any>>,
Exclude<keyof PersistConfig<any>, 'key' | 'blacklist' | 'whitelist'>
> & {
/**
* define persistent data blacklist
*/
blacklist?: (keyof T)[];
/**
* define persistent data whitelist
*/
whitelist?: (keyof T)[];
};
@injectable()
class ReactantStorage extends PluginModule {
protected blacklist: string[] = ['router', 'lastAction'];
persistor?: Persistor;
rehydrated = false;
constructor(@inject(StorageOptions) options: IStorageOptions) {
super();
this.options = {
...options,
whitelist: options.whitelist ?? [],
};
this.persistRootConfig = {
key: 'root',
...this.options,
};
}
protected persistConfig: Record<string, PersistConfig<any>> = {};
protected persistRootConfig: Pick<
IStorageOptions,
Exclude<keyof IStorageOptions, 'key'>
> & {
key: string;
};
public options: IStorageOptions;
private storageSettingMap = new Map<object, Function>();
/**
* set module to storage persistent
*/
setStorage<T extends object>(target: T, options: SetStorageOptions<T>) {
const module: Service = target;
if (__DEV__) {
if (typeof module[nameKey] !== 'string') {
throw new Error(
`Module '${module.constructor.name}' is invalid for using 'setStorage', the parameter 'options.name' of the decorator '@injectable(options)' that decorates the '${module.constructor.name}' module must be specified as a string.`
);
}
if (typeof module[stateKey] !== 'object') {
throw new Error(
`Module '${module.constructor.name}' is invalid for using 'setStorage', the current module does not have any global state that is decorated with '@state'.`
);
}
if (Object.prototype.hasOwnProperty.call(module[stateKey], '_persist')) {
throw new Error(
`Module '${module.constructor.name}' is invalid for using 'setStorage', the current module should not customize the state with the key '_persist'.`
);
}
}
this.storageSettingMap.set(module, () => {
const persistConfig = {
storage: this.options.storage,
...options,
key: module[identifierKey],
};
Object.assign(this.persistConfig, {
[module[identifierKey]!]: persistConfig,
});
});
}
/**
* get every module rehydrated
*/
getRehydrated(target: object) {
const module: Service = target;
if (!this.storageSettingMap.has(module)) {
throw new Error(
`Module '${module.constructor.name}' is not set to storage persistent.`
);
}
const state = module[stateKey]!;
return state._persist.rehydrated;
}
beforeCombineRootReducers(reducers: ReducersMapObject): ReducersMapObject {
for (const [_, set] of this.storageSettingMap) {
set();
}
if (__DEV__) {
if (reducers._persist) {
throw new Error(
`Storage module conflict with the names of other modules, make sure that no module has a name of '_persist'.`
);
}
}
Object.keys(reducers).forEach((key) => {
const isTempIdentifier = /^@@reactant\//.test(key);
if (isTempIdentifier) {
this.blacklist.push(key);
}
const persistConfig = this.persistConfig[key];
if (persistConfig) {
const reducer = persistReducer(persistConfig, reducers[key]);
Object.assign(reducers, {
[key]: reducer,
});
} else if (this.persistRootConfig.blacklist) {
// use blacklist mode
if (isTempIdentifier) {
if (__DEV__) {
console.warn(
`For state persistence, The '@injectable({ name })' in the ${key} module has not been set yet.`
);
}
}
}
});
return reducers;
}
afterCombineRootReducers(rootReducer: Reducer) {
return persistReducer(
{
blacklist: [...Object.keys(this.persistConfig), ...this.blacklist],
...this.persistRootConfig,
},
rootReducer
);
}
/**
* manual persist
*/
manualPersist = false;
/**
* persistence paused
*/
paused = false;
afterCreateStore(store: Store) {
this.paused = this.manualPersist;
const { replaceReducer } = store;
// eslint-disable-next-line no-param-reassign
store.replaceReducer = (reducer: Reducer) => {
this.rehydrated = false;
replaceReducer(reducer);
this.persistor = persistStore(
store,
// TODO: fix type https://github.com/rt2zz/redux-persist/pull/1247
{
manualPersist: this.manualPersist,
} as any,
() => {
// after redux-persist action rehydrate
this.rehydrated = true;
this._onRehydrated?.();
}
);
this._enhancePersistor();
};
this.persistor = persistStore(
store,
// TODO: fix type https://github.com/rt2zz/redux-persist/pull/1247
{
manualPersist: this.manualPersist,
} as any,
() => {
// after redux-persist action rehydrate
this.rehydrated = true;
this._onRehydrated?.();
}
);
this._enhancePersistor();
return store;
}
private _enhancePersistor() {
if (!this.persistor) {
throw new Error(`Persistor is not created yet.`);
}
const { pause, persist } = this.persistor;
this.persistor.pause = () => {
if (!this.paused) {
this.paused = true;
pause();
}
};
this.persistor.persist = () => {
if (this.paused) {
this.paused = false;
persist();
}
};
}
protected rehydrateCallbackSet = new Set<() => void>();
protected _onRehydrated() {
if (!this.rehydrateCallbackSet.size) return;
const callbacks = Array.from(this.rehydrateCallbackSet);
this.rehydrateCallbackSet.clear();
for (const callback of callbacks) {
callback();
}
}
/**
* onRehydrated
*
* callback function will be called after rehydration is finished.
*/
onRehydrated(callback: () => void) {
if (this.rehydrated) {
callback();
} else {
this.rehydrateCallbackSet.add(callback);
}
}
provider = (props: PropsWithChildren<{}>) => {
return (
<PersistGate
loading={this.options.loading || null}
persistor={this.persistor!}
>
{props.children}
</PersistGate>
);
};
}
export { ReactantStorage as Storage, StorageOptions, REHYDRATE };