-
Notifications
You must be signed in to change notification settings - Fork 92
/
ValidationManager.ts
443 lines (401 loc) · 13.7 KB
/
ValidationManager.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
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
import { config } from "config";
import { State } from "./DatasetAddCommon";
import JsonPath from "jsonpath";
import {
RefObject,
useState,
useEffect,
useRef,
MutableRefObject
} from "react";
import uniq from "lodash/uniq";
/**
* A global module to manage / coordinate validation workflow.
* The overall workflow:
* - every UI component should attempt to register itself to participant the validation
* - ValidationManager will determine whether should get the component involved in the validation process based on config
* - UI components are also responsible for
* - Register the component when componentDidMount and de-register itself when componentWillUnmount
* - Supplie functions for updating component's valid / invalid status (see definition of `ValidationItem`)
* - call `onInputFocusOut` when focus is removed from the component
* - `ValidationManager` supplies `useValidation` hook to facilite this process
* - `ValidationManager` also provides function like `validateAll` to validate all active components on screen
* - To enable `ValidationManager`, `setStateDataGetter` should also be called when the page component is mounted so that `ValidationManager` has access to state data
*/
/**
* A list of field json path (query against [add dataset page state](https://github.com/magda-io/magda/blob/master/magda-web-client/src/Components/Dataset/Add/DatasetAddCommon.ts#L133) that should be validated / Mandatory.
* We currently don't use json path here to query any json data.
* Use json path as a standard way to name the mandatory field only.
* e.g. ["$.dataset.title", "$.files[1].license", "$.dataset.defaultLicense"]
*/
export type ValidationFieldList = string[];
export type ElementLikeType = {
getBoundingClientRect: () => ClientRect | DOMRect | null;
scrollIntoView: (arg?: boolean | ScrollIntoViewOptions) => void;
blur: () => void;
focus: (options?: FocusOptions) => void;
};
export type RefType<T = ElementType> =
| MutableRefObject<T | null>
| RefObject<T>;
export type ElementType =
| HTMLInputElement
| HTMLTextAreaElement
| HTMLSelectElement
| HTMLDivElement
| HTMLSpanElement
| ElementLikeType;
export interface ValidationItem<T = ElementType> {
/**
* the json path will be used:
* - as the id of the ValidationItem
* - to query input value from [add dataset page state](https://github.com/magda-io/magda/blob/5d9adef14f8aeea5bf3039ecad7c362601393307/magda-web-client/src/Components/Dataset/Add/DatasetAddCommon.ts#L133)
*
* @type {string}
* @memberof ValidationItem
*/
jsonPath: string;
/**
* Field label / name
*/
label: string;
/**
* ValidationManager will call this function to turn on the `Invalid` style of the input ctrl
* that is belong to this `ValidationItem` when necessary
*/
setError: (errorMesssage: string) => void;
/**
* ValidationManager will call this function to turn off the `Invalid` style of the input ctrl
* that is belong to this `ValidationItem` when necessary
*/
clearError: () => void;
/**
* A react reference of a DOM element that belongs to this `ValidationItem`.
* ValidationManager will try move this Dom element into viewport when necessary
*/
elRef: RefType<T>;
}
const validationFieldList: ValidationFieldList = config.mandatoryFields.map(
convertConfigFieldItem
);
let validationItems: ValidationItem[] = [];
let stateDataGetter: () => State;
/**
* Convert field name string in the config to json path that we use internally
*
* @param {string} field
* @returns {string[]}
*/
function convertConfigFieldItem(field: string): string {
switch (field) {
case "dataset.title":
return "$.dataset.title";
case "dataset.description":
return "$.dataset.description";
case "dataset.defaultLicense":
return "$.dataset.defaultLicense";
case "files.title":
return "$.files[*].title";
case "files.format":
return "$.files[*].format";
case "files.license":
return "$.files[*].license";
case "dataset.publisher":
return "$.dataset.publisher";
case "licenseLevel":
return "$.licenseLevel";
case "dataset.defaultLicense":
return "$.dataset.defaultLicense";
case "files.license":
return "$.files[*].license";
case "informationSecurity.classification":
return "$.informationSecurity.classification";
case "informationSecurity.disseminationLimits":
return "$.informationSecurity.disseminationLimits";
default:
throw new Error(`Unknown mandatory field config name: ${field}`);
}
}
export const setStateDataGetter = (getter: () => State) => {
stateDataGetter = getter;
};
function getStateData() {
if (typeof stateDataGetter === "undefined") {
throw new Error("State data getter function is not set yet!");
}
return stateDataGetter();
}
function findItemByExactJsonPathMatch(
jsonPath: string
): ValidationItem | undefined {
if (!jsonPath) {
return undefined;
}
return validationItems.find(item => item.jsonPath === jsonPath);
}
function findItemsByJsonPath(jsonPath: string): ValidationItem[] {
if (!jsonPath) {
return [];
}
const item = findItemByExactJsonPathMatch(jsonPath);
if (typeof item !== "undefined") {
// --- we will stop if we find an exact matched item
return [item];
}
const items: ValidationItem[] = [];
const stateData = getStateData();
JsonPath.paths(stateData, jsonPath)
.map(item => JsonPath.stringify(item))
.forEach(resolvedJsonPath => {
const item = findItemByExactJsonPathMatch(resolvedJsonPath);
if (typeof item !== "undefined") {
items.push(item);
}
});
return items;
}
function findItemsByJsonPaths(jsonPaths: string[]): ValidationItem[] {
if (!jsonPaths || !jsonPaths.length) {
return [];
}
return uniq(jsonPaths.flatMap(jsonPath => findItemsByJsonPath(jsonPath)));
}
export function shouldValidate(jsonPath: string) {
if (typeof stateDataGetter === "undefined") {
// --- if stateDataGetter is not set, Validation function should be turned off
return false;
}
if (validationFieldList.indexOf(jsonPath) !== -1) {
return true;
}
const stateData = getStateData();
const idx = validationFieldList.findIndex(fieldPath => {
if (
JsonPath.paths(stateData, fieldPath)
.map(item => JsonPath.stringify(item))
.indexOf(jsonPath) !== -1
) {
return true;
} else {
return false;
}
});
if (idx !== -1) {
return true;
} else {
return false;
}
}
export const registerValidationItem = (vItem: ValidationItem) => {
if (
shouldValidate(vItem.jsonPath) &&
validationItems.indexOf(vItem) === -1
) {
validationItems.push(vItem);
}
};
export const deregisterValidationItem = (
jsonPathOrItem: string | ValidationItem
) => {
if (typeof jsonPathOrItem === "string") {
const jsonPath = jsonPathOrItem;
// --- should clearError when deregister
validationItems
.filter(item => item.jsonPath === jsonPath)
.forEach(item => {
item.clearError();
});
validationItems = validationItems.filter(
item => item.jsonPath !== jsonPath
);
} else {
jsonPathOrItem.clearError();
validationItems = validationItems.filter(
item => item !== jsonPathOrItem
);
}
};
function isEmptyValue(jsonPath: string) {
const stateData = getStateData();
const value = JsonPath.query(stateData, jsonPath)[0];
if (typeof value === "undefined" || value === null) {
return true;
}
if (typeof value === "string" && value.trim() === "") {
return true;
}
return false;
}
function getItemsFromJsonPath(jsonPath: string) {
return validationItems.filter(item => item.jsonPath === jsonPath);
}
/**
* Execute validation logic on a validation item
*
* @param {ValidationItem} item
* @returns {boolean}
*/
function validateItem(item: ValidationItem) {
if (isEmptyValue(item.jsonPath)) {
item.setError(`Error: \`${item.label}\` is a mandatory field.`);
return false;
} else {
item.clearError();
return true;
}
}
/**
* Input should call this function when focus is removed from it
*
* @param {string} jsonPath
* @returns {boolean} True = the field is valid; False = the field is invalid;
*/
export const onInputFocusOut = (jsonPath: string) => {
const items = getItemsFromJsonPath(jsonPath);
if (!items || !items.length) {
return false;
}
if (items.map(item => validateItem(item)).filter(r => !r).length) {
return false;
} else {
return true;
}
};
/**
* Validate a list of validation items
* This function will:
* - Re-validate all inputs
* - Set/unset invalid status of the inputs
* - Move first invalid input (if any) into the viewport
*
* @param {ValidationItem[]} items
* @returns {boolean} True = all fields are valid; False = there is at least one field is invalid;
*/
function validateSelectedItems(items: ValidationItem[]) {
let offsetY: number;
let elRef: RefType<ElementType> | undefined;
let hasInvalidItem = false;
items.forEach(item => {
if (!validateItem(item)) {
hasInvalidItem = true;
if (!item.elRef.current) {
// --- if element ref is not ready
// --- skip moving viewport
return;
}
const offset = getOffset(item.elRef);
if (typeof offsetY === "undefined") {
elRef = item.elRef;
if (offset) {
offsetY = offset.top;
}
} else if (offset && offset.top < offsetY) {
elRef = item.elRef;
offsetY = offset.top;
}
}
});
if (typeof elRef !== "undefined" && elRef.current) {
// --- there is an invalid input
// --- try to move into viewport
// --- please note: we use [Scroll behavior polyfill](https://github.com/iamdustan/smoothscroll)
elRef.current.scrollIntoView({ behavior: "smooth" });
if (typeof elRef.current.focus === "function") {
elRef.current.focus();
}
}
return !hasInvalidItem;
}
/**
* Validate all registered inputs.
* This function should be called when user requests to move to next page.
* This function will:
* - Re-validate all inputs
* - Set/unset invalid status of the inputs
* - Move first invalid input (if any) into the viewport
*
* @returns {boolean} True = all fields are valid; False = there is at least one field is invalid;
*/
export const validateAll = () => validateSelectedItems(validationItems);
/**
* Validate all inputs matching a list of json Paths.
* This function should be called when user requests to move to next page.
* This function will:
* - Re-validate all inputs
* - Set/unset invalid status of the inputs
* - Move first invalid input (if any) into the viewport
* @param {string[]} fieldPathList a list of json path for selecting inputs
* @returns {boolean} True = all fields are valid; False = there is at least one field is invalid;
*/
export const validateFields = (fieldPathList: string[] = []) => {
if (typeof stateDataGetter === "undefined") {
// --- if stateDataGetter is not set, Validation function should be turned off
return true;
}
const items = findItemsByJsonPaths(fieldPathList);
if (!items.length) {
return true;
}
return validateSelectedItems(items);
};
export const getOffset = (el: RefType<ElementType>) => {
if (!el.current) {
return null;
}
const rect = el.current.getBoundingClientRect();
if (!rect) {
return null;
}
return {
top: rect.top + document.body.scrollTop,
left: rect.left + document.body.scrollLeft
};
};
export const deregisterAllValidationItem = () => {
validationItems = [];
};
interface ValidationHookStateType<T extends ElementType> {
ref: MutableRefObject<T | null>;
isValidationError: boolean;
validationErrorMessage: string;
}
export const useValidation = <T extends ElementType = ElementType>(
fieldJsonPath: string | undefined,
fieldLabel: string | undefined
): [boolean, string, MutableRefObject<T | null>] => {
const [state, setState] = useState<ValidationHookStateType<T>>({
ref: useRef<T>(null),
isValidationError: false,
validationErrorMessage: ""
});
useEffect(() => {
const validationItem = {
jsonPath: fieldJsonPath ? fieldJsonPath : "",
label: fieldLabel ? fieldLabel : "",
elRef: state.ref,
setError: errorMessage => {
setState({
ref: state.ref,
isValidationError: true,
validationErrorMessage: errorMessage
});
},
clearError: () => {
setState({
ref: state.ref,
isValidationError: false,
validationErrorMessage: ""
});
}
};
if (fieldJsonPath) {
registerValidationItem(validationItem);
}
return () => {
if (fieldJsonPath) {
deregisterValidationItem(validationItem);
}
};
}, [fieldJsonPath, fieldLabel]);
return [state.isValidationError, state.validationErrorMessage, state.ref];
};