/
serializableStateInvariantMiddleware.ts
236 lines (205 loc) · 6.19 KB
/
serializableStateInvariantMiddleware.ts
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
import isPlainObject from './isPlainObject'
import type { Middleware } from 'redux'
import { getTimeMeasureUtils } from './utils'
/**
* Returns true if the passed value is "plain", i.e. a value that is either
* directly JSON-serializable (boolean, number, string, array, plain object)
* or `undefined`.
*
* @param val The value to check.
*
* @public
*/
export function isPlain(val: any) {
const type = typeof val
return (
val == null ||
type === 'string' ||
type === 'boolean' ||
type === 'number' ||
Array.isArray(val) ||
isPlainObject(val)
)
}
interface NonSerializableValue {
keyPath: string
value: unknown
}
/**
* @public
*/
export function findNonSerializableValue(
value: unknown,
path: string = '',
isSerializable: (value: unknown) => boolean = isPlain,
getEntries?: (value: unknown) => [string, any][],
ignoredPaths: readonly string[] = []
): NonSerializableValue | false {
let foundNestedSerializable: NonSerializableValue | false
if (!isSerializable(value)) {
return {
keyPath: path || '<root>',
value: value,
}
}
if (typeof value !== 'object' || value === null) {
return false
}
const entries = getEntries != null ? getEntries(value) : Object.entries(value)
const hasIgnoredPaths = ignoredPaths.length > 0
for (const [key, nestedValue] of entries) {
const nestedPath = path ? path + '.' + key : key
if (hasIgnoredPaths && ignoredPaths.indexOf(nestedPath) >= 0) {
continue
}
if (!isSerializable(nestedValue)) {
return {
keyPath: nestedPath,
value: nestedValue,
}
}
if (typeof nestedValue === 'object') {
foundNestedSerializable = findNonSerializableValue(
nestedValue,
nestedPath,
isSerializable,
getEntries,
ignoredPaths
)
if (foundNestedSerializable) {
return foundNestedSerializable
}
}
}
return false
}
/**
* Options for `createSerializableStateInvariantMiddleware()`.
*
* @public
*/
export interface SerializableStateInvariantMiddlewareOptions {
/**
* The function to check if a value is considered serializable. This
* function is applied recursively to every value contained in the
* state. Defaults to `isPlain()`.
*/
isSerializable?: (value: any) => boolean
/**
* The function that will be used to retrieve entries from each
* value. If unspecified, `Object.entries` will be used. Defaults
* to `undefined`.
*/
getEntries?: (value: any) => [string, any][]
/**
* An array of action types to ignore when checking for serializability.
* Defaults to []
*/
ignoredActions?: string[]
/**
* An array of dot-separated path strings to ignore when checking
* for serializability, Defaults to ['meta.arg', 'meta.baseQueryMeta']
*/
ignoredActionPaths?: string[]
/**
* An array of dot-separated path strings to ignore when checking
* for serializability, Defaults to []
*/
ignoredPaths?: string[]
/**
* Execution time warning threshold. If the middleware takes longer
* than `warnAfter` ms, a warning will be displayed in the console.
* Defaults to 32ms.
*/
warnAfter?: number
/**
* Opt out of checking state. When set to `true`, other state-related params will be ignored.
*/
ignoreState?: boolean
/**
* Opt out of checking actions. When set to `true`, other action-related params will be ignored.
*/
ignoreActions?: boolean
}
/**
* Creates a middleware that, after every state change, checks if the new
* state is serializable. If a non-serializable value is found within the
* state, an error is printed to the console.
*
* @param options Middleware options.
*
* @public
*/
export function createSerializableStateInvariantMiddleware(
options: SerializableStateInvariantMiddlewareOptions = {}
): Middleware {
if (process.env.NODE_ENV === 'production') {
return () => (next) => (action) => next(action)
}
const {
isSerializable = isPlain,
getEntries,
ignoredActions = [],
ignoredActionPaths = ['meta.arg', 'meta.baseQueryMeta'],
ignoredPaths = [],
warnAfter = 32,
ignoreState = false,
ignoreActions = false,
} = options
return (storeAPI) => (next) => (action) => {
const result = next(action)
const measureUtils = getTimeMeasureUtils(
warnAfter,
'SerializableStateInvariantMiddleware'
)
if (
!ignoreActions &&
!(ignoredActions.length && ignoredActions.indexOf(action.type) !== -1)
) {
measureUtils.measureTime(() => {
const foundActionNonSerializableValue = findNonSerializableValue(
action,
'',
isSerializable,
getEntries,
ignoredActionPaths
)
if (foundActionNonSerializableValue) {
const { keyPath, value } = foundActionNonSerializableValue
console.error(
`A non-serializable value was detected in an action, in the path: \`${keyPath}\`. Value:`,
value,
'\nTake a look at the logic that dispatched this action: ',
action,
'\n(See https://redux.js.org/faq/actions#why-should-type-be-a-string-or-at-least-serializable-why-should-my-action-types-be-constants)',
'\n(To allow non-serializable values see: https://redux-toolkit.js.org/usage/usage-guide#working-with-non-serializable-data)'
)
}
})
}
if (!ignoreState) {
measureUtils.measureTime(() => {
const state = storeAPI.getState()
const foundStateNonSerializableValue = findNonSerializableValue(
state,
'',
isSerializable,
getEntries,
ignoredPaths
)
if (foundStateNonSerializableValue) {
const { keyPath, value } = foundStateNonSerializableValue
console.error(
`A non-serializable value was detected in the state, in the path: \`${keyPath}\`. Value:`,
value,
`
Take a look at the reducer(s) handling this action type: ${action.type}.
(See https://redux.js.org/faq/organizing-state#can-i-put-functions-promises-or-other-non-serializable-items-in-my-store-state)`
)
}
})
measureUtils.warnIfExceeded()
}
return result
}
}