-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
util.ts
683 lines (579 loc) · 18.1 KB
/
util.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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
import { Buffer } from 'buffer';
import { monotonicFactory, ULID } from 'ulid';
import { v4 as uuid } from 'uuid';
import { ModelInstanceCreator } from './datastore/datastore';
import {
AllOperators,
isPredicateGroup,
isPredicateObj,
ModelInstanceMetadata,
PersistentModel,
PersistentModelConstructor,
PredicateGroups,
PredicateObject,
PredicatesGroup,
RelationshipType,
RelationType,
ModelKeys,
ModelAttributes,
SchemaNamespace,
SortPredicatesGroup,
SortDirection,
isModelAttributeKey,
isModelAttributePrimaryKey,
isModelAttributeCompositeKey,
NonModelTypeConstructor,
} from './types';
import { WordArray } from 'amazon-cognito-identity-js';
export const exhaustiveCheck = (obj: never, throwOnError: boolean = true) => {
if (throwOnError) {
throw new Error(`Invalid ${obj}`);
}
};
export const isNullOrUndefined = (val: any): boolean => {
return typeof val === 'undefined' || val === undefined || val === null;
};
export const validatePredicate = <T extends PersistentModel>(
model: T,
groupType: keyof PredicateGroups<T>,
predicatesOrGroups: (PredicateObject<T> | PredicatesGroup<T>)[]
) => {
let filterType: keyof Pick<any[], 'every' | 'some'>;
let isNegation = false;
if (predicatesOrGroups.length === 0) {
return true;
}
switch (groupType) {
case 'not':
filterType = 'every';
isNegation = true;
break;
case 'and':
filterType = 'every';
break;
case 'or':
filterType = 'some';
break;
default:
exhaustiveCheck(groupType);
}
const result: boolean = predicatesOrGroups[filterType](predicateOrGroup => {
if (isPredicateObj(predicateOrGroup)) {
const { field, operator, operand } = predicateOrGroup;
const value = model[field];
return validatePredicateField(value, operator, operand);
}
if (isPredicateGroup(predicateOrGroup)) {
const { type, predicates } = predicateOrGroup;
return validatePredicate(model, type, predicates);
}
throw new Error('Not a predicate or group');
});
return isNegation ? !result : result;
};
export const validatePredicateField = <T>(
value: T,
operator: keyof AllOperators,
operand: T | [T, T]
) => {
switch (operator) {
case 'ne':
return value !== operand;
case 'eq':
return value === operand;
case 'le':
return value <= operand;
case 'lt':
return value < operand;
case 'ge':
return value >= operand;
case 'gt':
return value > operand;
case 'between':
const [min, max] = <[T, T]>operand;
return value >= min && value <= max;
case 'beginsWith':
return (
!isNullOrUndefined(value) &&
(<string>(<unknown>value)).startsWith(<string>(<unknown>operand))
);
case 'contains':
return (
!isNullOrUndefined(value) &&
(<string>(<unknown>value)).indexOf(<string>(<unknown>operand)) > -1
);
case 'notContains':
return (
isNullOrUndefined(value) ||
(<string>(<unknown>value)).indexOf(<string>(<unknown>operand)) === -1
);
default:
exhaustiveCheck(operator, false);
return false;
}
};
export const isModelConstructor = <T extends PersistentModel>(
obj: any
): obj is PersistentModelConstructor<T> => {
return (
obj && typeof (<PersistentModelConstructor<T>>obj).copyOf === 'function'
);
};
const nonModelClasses = new WeakSet<NonModelTypeConstructor<any>>();
export function registerNonModelClass(clazz: NonModelTypeConstructor<any>) {
nonModelClasses.add(clazz);
}
export const isNonModelConstructor = (
obj: any
): obj is NonModelTypeConstructor<any> => {
return nonModelClasses.has(obj);
};
/*
When we have GSI(s) with composite sort keys defined on a model
There are some very particular rules regarding which fields must be included in the update mutation input
The field selection becomes more complex as the number of GSIs with composite sort keys grows
To summarize: any time we update a field that is part of the composite sort key of a GSI, we must include:
1. all of the other fields in that composite sort key
2. all of the fields from any other composite sort key that intersect with the fields from 1.
E.g.,
Model @model
@key(name: 'key1' fields: ['hk', 'a', 'b', 'c'])
@key(name: 'key2' fields: ['hk', 'a', 'b', 'd'])
@key(name: 'key3' fields: ['hk', 'x', 'y', 'z'])
Model.a is updated => include ['a', 'b', 'c', 'd']
Model.c is updated => include ['a', 'b', 'c', 'd']
Model.d is updated => include ['a', 'b', 'c', 'd']
Model.x is updated => include ['x', 'y', 'z']
This function accepts a model's attributes and returns grouped sets of composite key fields
Using our example Model above, the function will return:
[
Set('a', 'b', 'c', 'd'),
Set('x', 'y', 'z'),
]
This gives us the opportunity to correctly include the required fields for composite keys
When crafting the mutation input in Storage.getUpdateMutationInput
See 'processCompositeKeys' test in util.test.ts for more examples
*/
export const processCompositeKeys = (
attributes: ModelAttributes
): Set<string>[] => {
const extractCompositeSortKey = ({
properties: {
// ignore the HK (fields[0]) we only need to include the composite sort key fields[1...n]
fields: [, ...sortKeyFields],
},
}) => sortKeyFields;
const compositeKeyFields = attributes
.filter(isModelAttributeCompositeKey)
.map(extractCompositeSortKey);
/*
if 2 sets of fields have any intersecting fields => combine them into 1 union set
e.g., ['a', 'b', 'c'] and ['a', 'b', 'd'] => ['a', 'b', 'c', 'd']
*/
const combineIntersecting = (fields): Set<string>[] =>
fields.reduce((combined, sortKeyFields) => {
const sortKeyFieldsSet = new Set(sortKeyFields);
if (combined.length === 0) {
combined.push(sortKeyFieldsSet);
return combined;
}
// does the current set share values with another set we've already added to `combined`?
const intersectingSetIdx = combined.findIndex(existingSet => {
return [...existingSet].some(f => sortKeyFieldsSet.has(f));
});
if (intersectingSetIdx > -1) {
const union = new Set([
...combined[intersectingSetIdx],
...sortKeyFieldsSet,
]);
// combine the current set with the intersecting set we found above
combined[intersectingSetIdx] = union;
} else {
// none of the sets in `combined` have intersecting values with the current set
combined.push(sortKeyFieldsSet);
}
return combined;
}, []);
const initial = combineIntersecting(compositeKeyFields);
// a single pass pay not be enough to correctly combine all the fields
// call the function once more to get a final merged list of sets
const combined = combineIntersecting(initial);
return combined;
};
export const establishRelationAndKeys = (
namespace: SchemaNamespace
): [RelationshipType, ModelKeys] => {
const relationship: RelationshipType = {};
const keys: ModelKeys = {};
Object.keys(namespace.models).forEach((mKey: string) => {
relationship[mKey] = { indexes: [], relationTypes: [] };
keys[mKey] = {};
const model = namespace.models[mKey];
Object.keys(model.fields).forEach((attr: string) => {
const fieldAttribute = model.fields[attr];
if (
typeof fieldAttribute.type === 'object' &&
'model' in fieldAttribute.type
) {
const connectionType = fieldAttribute.association.connectionType;
relationship[mKey].relationTypes.push({
fieldName: fieldAttribute.name,
modelName: fieldAttribute.type.model,
relationType: connectionType,
targetName: fieldAttribute.association['targetName'],
associatedWith: fieldAttribute.association['associatedWith'],
});
if (connectionType === 'BELONGS_TO') {
relationship[mKey].indexes.push(
fieldAttribute.association['targetName']
);
}
}
});
if (model.attributes) {
keys[mKey].compositeKeys = processCompositeKeys(model.attributes);
for (const attribute of model.attributes) {
if (!isModelAttributeKey(attribute)) {
continue;
}
if (isModelAttributePrimaryKey(attribute)) {
keys[mKey].primaryKey = attribute.properties.fields;
}
const { fields } = attribute.properties;
for (const field of fields) {
// only add index if it hasn't already been added
const exists = relationship[mKey].indexes.includes(field);
if (!exists) {
relationship[mKey].indexes.push(field);
}
}
}
}
});
return [relationship, keys];
};
const topologicallySortedModels = new WeakMap<SchemaNamespace, string[]>();
export const traverseModel = <T extends PersistentModel>(
srcModelName: string,
instance: T,
namespace: SchemaNamespace,
modelInstanceCreator: ModelInstanceCreator,
getModelConstructorByModelName: (
namsespaceName: string,
modelName: string
) => PersistentModelConstructor<any>
) => {
const relationships = namespace.relationships;
const modelConstructor = getModelConstructorByModelName(
namespace.name,
srcModelName
);
const relation = relationships[srcModelName];
const result: {
modelName: string;
item: T;
instance: T;
}[] = [];
const newInstance = modelConstructor.copyOf(instance, draftInstance => {
relation.relationTypes.forEach((rItem: RelationType) => {
const modelConstructor = getModelConstructorByModelName(
namespace.name,
rItem.modelName
);
switch (rItem.relationType) {
case 'HAS_ONE':
if (instance[rItem.fieldName]) {
let modelInstance: T;
try {
modelInstance = modelInstanceCreator(
modelConstructor,
instance[rItem.fieldName]
);
} catch (error) {
// Do nothing
}
result.push({
modelName: rItem.modelName,
item: instance[rItem.fieldName],
instance: modelInstance,
});
(<any>draftInstance)[rItem.fieldName] = (<PersistentModel>(
draftInstance[rItem.fieldName]
)).id;
}
break;
case 'BELONGS_TO':
if (instance[rItem.fieldName]) {
let modelInstance: T;
try {
modelInstance = modelInstanceCreator(
modelConstructor,
instance[rItem.fieldName]
);
} catch (error) {
// Do nothing
}
const isDeleted = (<ModelInstanceMetadata>(
draftInstance[rItem.fieldName]
))._deleted;
if (!isDeleted) {
result.push({
modelName: rItem.modelName,
item: instance[rItem.fieldName],
instance: modelInstance,
});
}
}
if (draftInstance[rItem.fieldName]) {
(<any>draftInstance)[rItem.targetName] = (<PersistentModel>(
draftInstance[rItem.fieldName]
)).id;
delete draftInstance[rItem.fieldName];
}
break;
case 'HAS_MANY':
// Intentionally blank
break;
default:
exhaustiveCheck(rItem.relationType);
break;
}
});
});
result.unshift({
modelName: srcModelName,
item: newInstance,
instance: newInstance,
});
if (!topologicallySortedModels.has(namespace)) {
topologicallySortedModels.set(
namespace,
Array.from(namespace.modelTopologicalOrdering.keys())
);
}
const sortedModels = topologicallySortedModels.get(namespace);
result.sort((a, b) => {
return (
sortedModels.indexOf(a.modelName) - sortedModels.indexOf(b.modelName)
);
});
return result;
};
export const getIndex = (rel: RelationType[], src: string): string => {
let index = '';
rel.some((relItem: RelationType) => {
if (relItem.modelName === src) {
index = relItem.targetName;
}
});
return index;
};
export const getIndexFromAssociation = (
indexes: string[],
src: string
): string => {
const index = indexes.find(idx => idx === src);
return index;
};
export enum NAMESPACES {
DATASTORE = 'datastore',
USER = 'user',
SYNC = 'sync',
STORAGE = 'storage',
}
const DATASTORE = NAMESPACES.DATASTORE;
const USER = NAMESPACES.USER;
const SYNC = NAMESPACES.SYNC;
const STORAGE = NAMESPACES.STORAGE;
export { USER, SYNC, STORAGE, DATASTORE };
let privateModeCheckResult;
export const isPrivateMode = () => {
return new Promise(resolve => {
const dbname = uuid();
let db;
const isPrivate = () => {
privateModeCheckResult = false;
resolve(true);
};
const isNotPrivate = async () => {
if (db && db.result && typeof db.result.close === 'function') {
await db.result.close();
}
await indexedDB.deleteDatabase(dbname);
privateModeCheckResult = true;
return resolve(false);
};
if (privateModeCheckResult === true) {
return isNotPrivate();
}
if (privateModeCheckResult === false) {
return isPrivate();
}
if (indexedDB === null) return isPrivate();
db = indexedDB.open(dbname);
db.onerror = isPrivate;
db.onsuccess = isNotPrivate;
});
};
const randomBytes = function(nBytes: number): Buffer {
return Buffer.from(new WordArray().random(nBytes).toString(), 'hex');
};
const prng = () => randomBytes(1).readUInt8(0) / 0xff;
export function monotonicUlidFactory(seed?: number): ULID {
const ulid = monotonicFactory(prng);
return () => {
return ulid(seed);
};
}
/**
* Uses performance.now() if available, otherwise, uses Date.now() (e.g. react native without a polyfill)
*
* The values returned by performance.now() always increase at a constant rate,
* independent of the system clock (which might be adjusted manually or skewed
* by software like NTP).
*
* Otherwise, performance.timing.navigationStart + performance.now() will be
* approximately equal to Date.now()
*
* See: https://developer.mozilla.org/en-US/docs/Web/API/Performance/now#Example
*/
export function getNow() {
if (
typeof performance !== 'undefined' &&
performance &&
typeof performance.now === 'function'
) {
return performance.now() | 0; // convert to integer
} else {
return Date.now();
}
}
export function sortCompareFunction<T extends PersistentModel>(
sortPredicates: SortPredicatesGroup<T>
) {
return function compareFunction(a, b) {
// enable multi-field sort by iterating over predicates until
// a comparison returns -1 or 1
for (const predicate of sortPredicates) {
const { field, sortDirection } = predicate;
// reverse result when direction is descending
const sortMultiplier = sortDirection === SortDirection.ASCENDING ? 1 : -1;
if (a[field] < b[field]) {
return -1 * sortMultiplier;
}
if (a[field] > b[field]) {
return 1 * sortMultiplier;
}
}
return 0;
};
}
// deep compare any 2 values
// primitives or object types (including arrays, Sets, and Maps)
// returns true if equal by value
// if nullish is true, treat undefined and null values as equal
// to normalize for GQL response values for undefined fields
export function valuesEqual(
valA: any,
valB: any,
nullish: boolean = false
): boolean {
let a = valA;
let b = valB;
const nullishCompare = (_a, _b) => {
return (
(_a === undefined || _a === null) && (_b === undefined || _b === null)
);
};
// if one of the values is a primitive and the other is an object
if (
(a instanceof Object && !(b instanceof Object)) ||
(!(a instanceof Object) && b instanceof Object)
) {
return false;
}
// compare primitive types
if (!(a instanceof Object)) {
if (nullish && nullishCompare(a, b)) {
return true;
}
return a === b;
}
// make sure object types match
if (
(Array.isArray(a) && !Array.isArray(b)) ||
(Array.isArray(b) && !Array.isArray(a))
) {
return false;
}
if (a instanceof Set && b instanceof Set) {
a = [...a];
b = [...b];
}
if (a instanceof Map && b instanceof Map) {
a = Object.fromEntries(a);
b = Object.fromEntries(b);
}
const aKeys = Object.keys(a);
const bKeys = Object.keys(b);
// last condition is to ensure that [] !== [null] even if nullish. However [undefined] === [null] when nullish
if (aKeys.length !== bKeys.length && (!nullish || Array.isArray(a))) {
return false;
}
// iterate through the longer set of keys
// e.g., for a nullish comparison of a={ a: 1 } and b={ a: 1, b: null }
// we want to iterate through bKeys
const keys = aKeys.length >= bKeys.length ? aKeys : bKeys;
for (const key of keys) {
const aVal = a[key];
const bVal = b[key];
if (!valuesEqual(aVal, bVal, nullish)) {
return false;
}
}
return true;
}
export const isAWSDate = (val: string): boolean => {
return !!/^\d{4}-\d{2}-\d{2}(Z|[+-]\d{2}:\d{2}($|:\d{2}))?$/.exec(val);
};
export const isAWSTime = (val: string): boolean => {
return !!/^\d{2}:\d{2}(:\d{2}(.\d+)?)?(Z|[+-]\d{2}:\d{2}($|:\d{2}))?$/.exec(
val
);
};
export const isAWSDateTime = (val: string): boolean => {
return !!/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(:\d{2}(.\d+)?)?(Z|[+-]\d{2}:\d{2}($|:\d{2}))?$/.exec(
val
);
};
export const isAWSTimestamp = (val: number): boolean => {
return !!/^\d+$/.exec(String(val));
};
export const isAWSEmail = (val: string): boolean => {
return !!/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/.exec(
val
);
};
export const isAWSJSON = (val: string): boolean => {
try {
JSON.parse(val);
return true;
} catch {
return false;
}
};
export const isAWSURL = (val: string): boolean => {
try {
return !!new URL(val);
} catch {
return false;
}
};
export const isAWSPhone = (val: string): boolean => {
return !!/^\+?\d[\d\s-]+$/.exec(val);
};
export const isAWSIPAddress = (val: string): boolean => {
return !!/((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?$))$/.exec(
val
);
};