mirror of
https://github.com/invoke-ai/InvokeAI
synced 2024-08-30 20:32:17 +00:00
eb17dfdeaa
Our app changes redux state very, very often. As our undo/redo history grows, the calls to persist state start to take in the 100ms range, due to a the deep cloning of the history. This causes very noticeable performance lag. The deep cloning is required because we need to blacklist certain items in redux from being persisted (e.g. the app's connection status). Debouncing the whole process of persistence is a simple and effective solution. Unfortunately, `redux-persist` dropped `debounce` between v4 and v5, replacing it with `throttle`. `throttle`, instead of delaying the expensive action until a period of X ms of inactivity, simply ensures the action is executed at least every X ms. Of course, this does not fix our performance issue. The patch is very simple. It adds a `debounce` argument - a number of milliseconds - and debounces `redux-persist`'s `update()` method (provided by `createPersistoid`) by that many ms. Before this, I also tried writing a custom storage adapter for `redux-persist` to debounce the calls to `localStorage.setItem()`. While this worked and was far less invasive, it doesn't actually address the issue. It turns out `setItem()` is a very fast part of the process. We use `redux-deep-persist` to simplify the `redux-persist` configuration, which can get complicated when you need to blacklist or whitelist deeply nested state. There is also a patch here for that library because it uses the same types as `redux-persist`. Unfortunately, the last release of `redux-persist` used a package `flat-stream` which was malicious and has been removed from npm. The latest commits to `redux-persist` (about 1 year ago) do not build; we cannot use the master branch. And between the last release and last commit, the changes have all been breaking. Patching this last release (about 3 years old at this point) directly is far simpler than attempting to fix the upstream library's master branch or figuring out an alternative to the malicious and now non-existent dependency.
25 lines
1.2 KiB
Diff
25 lines
1.2 KiB
Diff
diff --git a/node_modules/redux-deep-persist/lib/types.d.ts b/node_modules/redux-deep-persist/lib/types.d.ts
|
|
index b67b8c2..7fc0fa1 100644
|
|
--- a/node_modules/redux-deep-persist/lib/types.d.ts
|
|
+++ b/node_modules/redux-deep-persist/lib/types.d.ts
|
|
@@ -35,6 +35,7 @@ export interface PersistConfig<S, RS = any, HSS = any, ESS = any> {
|
|
whitelist?: Array<string>;
|
|
transforms?: Array<Transform<HSS, ESS, S, RS>>;
|
|
throttle?: number;
|
|
+ debounce?: number;
|
|
migrate?: PersistMigrate;
|
|
stateReconciler?: false | StateReconciler<S>;
|
|
getStoredState?: (config: PersistConfig<S, RS, HSS, ESS>) => Promise<PersistedState>;
|
|
diff --git a/node_modules/redux-deep-persist/src/types.ts b/node_modules/redux-deep-persist/src/types.ts
|
|
index 398ac19..cbc5663 100644
|
|
--- a/node_modules/redux-deep-persist/src/types.ts
|
|
+++ b/node_modules/redux-deep-persist/src/types.ts
|
|
@@ -91,6 +91,7 @@ export interface PersistConfig<S, RS = any, HSS = any, ESS = any> {
|
|
whitelist?: Array<string>;
|
|
transforms?: Array<Transform<HSS, ESS, S, RS>>;
|
|
throttle?: number;
|
|
+ debounce?: number;
|
|
migrate?: PersistMigrate;
|
|
stateReconciler?: false | StateReconciler<S>;
|
|
/**
|