-
Notifications
You must be signed in to change notification settings - Fork 42
/
MongooseAdapter.ts
executable file
·1022 lines (885 loc) · 38.6 KB
/
MongooseAdapter.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
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import R = require("ramda");
// Import mongo just for one of its type declarations (not imported at runtime).
// tslint:disable-next-line no-implicit-dependencies
import mongodb = require("mongodb");
import mongoose = require("mongoose");
import pluralize = require("pluralize");
import { Model, Document } from "mongoose";
import { AndExpression, SupportedOperators, ExpressionSort } from "../../types/";
import {
isId as isIdentifier,
isFieldExpression
} from '../../steps/pre-query/parse-query-params';
import { partition, setDifference, reduceToObject } from "../../util/misc";
import { values as objectValues } from "../../util/objectValueEntries";
import {
getReferencePaths, getReferencedModelName,
getDiscriminatorKey, getVersionKey, getMetaKeys
} from './utils/schema';
import { getTypePath } from "./utils/subtyping";
import docToResource from "./utils/doc-to-resource";
import { getTypeName } from "../../util/naming-conventions";
import * as util from "./lib";
import * as Errors from '../../util/errors';
import Data from "../../types/Generic/Data";
import { ResourceWithTypePath } from "../../types/Resource";
import ResourceIdentifier from "../../types/ResourceIdentifier";
import Relationship from '../../types/Relationship';
import FieldDocumentation from "../../types/Documentation/Field";
import FieldTypeDocumentation from "../../types/Documentation/FieldType";
import RelationshipTypeDocumentation from "../../types/Documentation/RelationshipType";
import { Adapter, TypeInfo, TypeIdMapOf, ReturnedResource } from "../AdapterInterface";
import CreateQuery from "../../types/Query/CreateQuery";
import FindQuery from "../../types/Query/FindQuery";
import DeleteQuery from "../../types/Query/DeleteQuery";
import UpdateQuery from "../../types/Query/UpdateQuery";
import AddToRelationshipQuery from "../../types/Query/AddToRelationshipQuery";
import RemoveFromRelationshipQuery from "../../types/Query/RemoveFromRelationshipQuery";
/**
* Whether a field expression argument represents a [number, number] tuple.
* @param {any} v The argument to validate
* @returns boolean
*/
const isPoint = R.allPass([
Array.isArray, // tslint:disable-line no-unbound-method
R.pipe(R.length, R.equals(2)), // tslint:disable-line no-unbound-method
R.all(it => Number(it) === it)
]);
export default class MongooseAdapter implements Adapter<typeof MongooseAdapter> {
// Workaround for https://github.com/Microsoft/TypeScript/issues/3841.
// Doing this makes our implements declaration work.
"constructor": typeof MongooseAdapter;
// Some precomputed name mappings that we use throughout.
// Note: a type name here can be a subtype (in the sense of Query.type,
// or what goes in a typePath), even though subtypes aren't rendered in
// the json-api `type` key. We need these mappings to read discriminator key
// values correctly, and it's also just more convenient for users to pass in
// models keyed by model name b/c that's how mongoose stores them.
protected typeNamesToModelNames: { [typeName: string]: string | undefined };
protected modelNamesToTypeNames: { [modelName: string]: string | undefined };
constructor(
protected models: { [modelName: string]: Model<any> } = (mongoose as any).models,
protected toTypeName: (modelName: string) => string = getTypeName,
protected idGenerator?: ((doc: Document) => mongodb.ObjectID)
) {
this.typeNamesToModelNames = {};
this.modelNamesToTypeNames = {};
for(const modelName of Object.keys(models)) {
const typeName = toTypeName(modelName);
this.typeNamesToModelNames[typeName] = modelName;
this.modelNamesToTypeNames[modelName] = typeName;
}
}
// Partially applied versions of the static/utility methods to simplify things.
docToResource(doc: Document, fields?: object) {
return docToResource(this.models, this.modelNamesToTypeNames, doc, fields);
}
docsToResourceData(docs: null | Document | Document[], isPlural: boolean, fields?: object) {
return this.constructor.docsToResourceData(
this.models,
this.modelNamesToTypeNames,
docs,
isPlural,
fields
);
}
getTypePath(model: Model<any>) {
return getTypePath(model, this.modelNamesToTypeNames);
}
/**
* Returns a Promise for the primary resources, the included resources,
* and the size of the full collection, if the primary resources represent
* a paginated view of the collection.
*/
async find(query: FindQuery) {
const {
type,
populates: includePaths,
select: fields,
sort: sorts,
offset,
limit,
isSingular: singular
} = query;
const mode = singular ? "findOne" : "find";
const filters = query.getFilters();
const mongofiedFilters = util.toMongoCriteria(filters);
const model = this.getModel(type);
this.constructor.assertIdsValid(filters, singular);
const isPaginating =
mode !== "findOne" &&
(typeof offset !== "undefined" || typeof limit !== "undefined");
let primaryDocumentsPromise: Promise<Document | Document[]>,
includedResourcesPromise: Promise<ReturnedResource[] | undefined>;
const queryBuilder =
mode === "findOne" // ternary is a hack for TS compiler
? model[mode](mongofiedFilters)
: model[mode](mongofiedFilters);
// a promised query result that counts how many results we'd have if we
// weren't paginating. just resolves to undefined if we aren't paginating.
const collectionSizePromise = isPaginating
? model.count(mongofiedFilters).exec()
: Promise.resolve(undefined);
// do sorting
if(Array.isArray(sorts)) {
const geoDistanceSort = sorts.find((it): it is ExpressionSort => {
const exp = (it as ExpressionSort).expression;
return exp && exp.operator === 'geoDistance';
});
if(geoDistanceSort) {
if(sorts.length !== 1) {
throw Errors.invalidQueryParamValue({
detail: `Cannot combine geoDistance sorts with other sorts.`,
source: { parameter: "sort" }
});
}
if(geoDistanceSort.direction !== "ASC") {
throw Errors.invalidQueryParamValue({
detail: `Cannot sort by descending geoDistance; only ascending.`,
source: { parameter: "sort" }
});
}
// TODO: Add an optimization here where, if there's a geoWithin filter
// centered on the same point as the geoDistance sort, we remove the
// filter and instead set maxDistance on the near to its radius.
// Also, get back locs and put them in meta.
queryBuilder.near(geoDistanceSort.expression.args[0].value, {
center: {
type: "Point", coordinates: geoDistanceSort.expression.args[1]
},
maxDistance: 4503599627370496,
spherical: true
})
}
else {
queryBuilder.sort(
sorts.map(it => {
if(!("field" in it)) {
throw new Error("Got unsupported expression sort field; shouldn't happen.");
}
return (it.direction === 'DESC' ? '-' : '') + it.field;
}).join(" ")
);
}
}
if(offset) {
queryBuilder.skip(offset);
}
if(limit) {
queryBuilder.limit(limit);
}
// in an ideal world, we'd use mongoose here to filter the fields before
// querying. But, because filtering out fields can really complicate population
// for (nested) includes, we don't yet filter at query time but instead just
// hide filtered fields in @docToResource. There is a more-efficient way to
// do this down the road, though -- something like taking the provided fields
// and expanding them just enough (by looking at the relationship paths) to
// make sure that we have the relationship fields to populate --while still
// querying for less data than we would without any fields restriction.
// For reference, the code for safely using the user's `fields` input, by
// putting them into a mongoose `.select()` object so that the user can't
// prefix a field with a minus on input to affect the query, is below.
// Reference: http://mongoosejs.com/docs/api.html#query_Query-select.
// let arrToSelectObject = (prev, curr) => { prev[curr] = 1; return prev; };
// for(let type in fields) {
// fields[type] = fields[type].reduce(arrToSelectObject, {});
// }
// support includes, but only a level deep for now (recursive includes,
// especially if done in an efficient way query wise, are a pain in the ass).
if(includePaths && includePaths.length > 0) {
const populatedPaths: string[] = [];
const refPaths = getReferencePaths(model);
includePaths.map((it) => it.split(".")).forEach((pathParts) => {
// first, check that the include path is valid.
if(!refPaths.includes(pathParts[0])) {
throw Errors.invalidIncludePath({
detail: `Resources of type "${type}" don't have a(n) "${pathParts[0]}" relationship.`
});
}
if(pathParts.length > 1) {
throw Errors.unsupportedIncludePath({
detail: `Multi-level include paths like ${pathParts.join('.')} aren't yet supported.`
});
}
// Finally, do the population
populatedPaths.push(pathParts[0]);
queryBuilder.populate(pathParts[0]);
});
let includedResources: ReturnedResource[] = [];
primaryDocumentsPromise = Promise.resolve(queryBuilder.exec()).then((docOrDocs) => {
includedResources =
objectValues(
Data.fromJSON(docOrDocs) // fromJSON to handle docOrDocs === null.
.flatMap<ReturnedResource>((doc) => {
return Data.of(populatedPaths).flatMap((path) => {
// Handle case that doc[path], which should hold id(s) of the
// referenced documents, is undefined b/c the relationship isn't set.
return typeof doc[path] === 'undefined'
? Data.empty as Data<ReturnedResource>
: Data.fromJSON(doc[path]).map(docAtPath => {
return this.docToResource(docAtPath, fields) as ReturnedResource;
});
});
})
.values
// Remove duplicates
.reduce((acc, resource) => {
acc[`${resource.type}/${resource.id}`] = resource;
return acc;
}, {} as { [id: string]: ReturnedResource })
);
return docOrDocs;
});
includedResourcesPromise =
primaryDocumentsPromise.then(() => includedResources);
}
else {
primaryDocumentsPromise = Promise.resolve(queryBuilder.exec());
includedResourcesPromise = Promise.resolve(undefined);
}
return Promise.all([
primaryDocumentsPromise.then((it) => {
return this.docsToResourceData(it, mode === 'find', fields) as Data<ReturnedResource>;
}),
includedResourcesPromise,
collectionSizePromise
]).then(([primary, included, collectionSize]) => {
return { primary, included, collectionSize };
}).catch(util.errorHandler);
}
/**
* Returns a Promise that fulfills with the created Resource. The Promise
* may also reject with an error if creation failed or was unsupported.
*/
async create(query: CreateQuery) {
const { records: resourceData } = query;
const getSmallestSubType = (it: ResourceWithTypePath) => it.typePath[0];
const setIdWithGenerator =
typeof this.idGenerator === "function" &&
((doc) => { doc._id = (this.idGenerator as Function)(doc); });
const resourcesByParentType = partition('type', resourceData);
const creationPromises = Object.keys(resourcesByParentType).map(type => {
const model = this.getModel(type);
const discriminatorKey = getDiscriminatorKey(model);
const resources = resourcesByParentType[type];
const docObjects = resources.map((resource) => {
const finalModel = this.getModel(getSmallestSubType(resource));
const forbiddenKeys = getMetaKeys(finalModel);
if(forbiddenKeys.some(k => k in resource.attrs || k in resource.relationships)) {
throw Errors.illegalFieldName();
}
return util.resourceToDocObject(resource, (typePath: string[]) => {
if(typePath.length === 1) {
return {};
}
const smallestSubType = getSmallestSubType(resource);
if(!discriminatorKey || !this.getModel(smallestSubType)) {
throw new Error("Unexpected model name. Should've been caught earlier.");
}
return { [discriminatorKey]: this.typeNamesToModelNames[smallestSubType] };
});
});
if(setIdWithGenerator) {
docObjects.forEach(setIdWithGenerator);
}
return model.create(docObjects)
.catch(e => util.errorHandler(e, { type })) as Promise<mongoose.Document[]>;
});
return Promise.all(creationPromises).then((docArrays) => {
const makeCollection = !resourceData.isSingular;
const finalDocs = docArrays.reduce((a, b) => a.concat(b), []);
// TODO: why isn't fields passed here, but is only passed in find...
// is that appropriate? (Probably... check spec, and common sense.)
return {
created:
this.docsToResourceData(finalDocs, makeCollection) as Data<ReturnedResource>
};
});
}
/**
*/
async update(query: UpdateQuery) {
const { type: parentType, patch } = query;
const parentModel = this.getModel(parentType);
const prefetchedDocs = patch.map(it => it.adapterExtra).values.filter(it => !!it);
const getOIdAsString = R.pipe<Record<"_id", mongodb.ObjectID>, mongodb.ObjectID, string>(R.prop('_id'), String);
const docIdsToFetch = [...setDifference(
patch.map(R.prop('id')).values,
prefetchedDocs.map(getOIdAsString),
)];
// We only execute this if there's a non-zero number of docs still to fetch.
const remainingDocsQuery =
parentModel.find({ _id: { $in: docIdsToFetch } }).lean();
const docsToUpdate = docIdsToFetch.length === 0
? prefetchedDocs
: [...prefetchedDocs, ...(await remainingDocsQuery.exec() as any)];
// We can store just by id, because we know all the types will be
// the same :). (They'll all be the root type of `UpdateQuery.type`.)
const docsToUpdateById = docsToUpdate.reduce(reduceToObject(getOIdAsString), {});
const updateOpts = {
new: true,
// we validate the full doc in memory below,
// so no need to run the validators again on update
runValidators: false,
upsert: false,
// discard updates to fields not recognized in the schema.
// TODO: set this to 'throw' instead?
strict: true
};
const singleDocUpdateQueries = await patch.mapAsync(async (resourceUpdate) => {
// tslint:disable-next-line no-shadowed-variable
const Model = this.getModel(resourceUpdate.typePath[0]);
const versionKey = getVersionKey(Model);
if(!Model) {
throw new Error("Unknown model name.");
}
const existingDoc = docsToUpdateById[resourceUpdate.id];
const changeSet = util.resourceToDocObject(resourceUpdate);
// Doc couldn't be found when we searched for it above.
if(!existingDoc) {
throw Errors.genericNotFound({
detail: `First missing resource was (${resourceUpdate.type}, ${resourceUpdate.id}).`
});
}
const forbiddenKeys = getMetaKeys(Model);
if(forbiddenKeys.some(k => k in changeSet)) {
throw Errors.illegalFieldName();
}
// Construct an in-memory document for this resource and
// apply the updates to it. Using .set ensures that setters get run, etc.
const updatedDoc = Model.hydrate(existingDoc).set(changeSet);
// Test that the doc is valid, using special
// mongo error handling function if it isn't.
try {
await updatedDoc.validate();
} catch(e) {
util.errorHandler(e, { type: resourceUpdate.type, id: resourceUpdate.id });
}
// Then, we can't .save() because that won't let us add a criteria
// on the version key. So, we construct an update based on the modified
// paths of the updatedDoc (again, we don't just use the changeSet because
// we want the result of applying setters) and findOneAndUpdate that.
// Note: even if we were hydrating the model with an empty doc, we'd want
// to call modifiedPaths to exclude keys for which the model set a default
const modifiedPaths = updatedDoc.modifiedPaths();
const updatedDocObject = updatedDoc.toObject();
const finalUpdate = modifiedPaths.reduce((acc, key) => {
acc[key] = updatedDocObject[key];
return acc;
}, {
// Increment the version key so other updates based on reads
// of an old version fail (with the version check below).
"$inc": { [versionKey]: 1 }
});
const criteria = {
_id: resourceUpdate.id,
[versionKey]: existingDoc[versionKey]
};
// Note: the query below has to be wrapped in an array (or something)
// so that it's not run automatically (because we're in an async function
// and query is a thenable, so js would await the query). We don't want
// it to run because we only wan to run the queries if all docs'
// validation succeeds.
return [parentModel.findOneAndUpdate(criteria, finalUpdate, updateOpts)];
});
// Don't run ANY of the queries unless all could be built successfully
// (I.e., every changeset was valid).
return {
updated: await singleDocUpdateQueries.flatMapAsync(async ([docUpdateQuery]) => {
const doc: mongoose.Document =
await (docUpdateQuery.exec().catch(e => {
util.errorHandler(e, {
type: <string>this.modelNamesToTypeNames[(docUpdateQuery as any).model.modelName],
id: String(docUpdateQuery.getQuery()._id)
})
}));
if(!doc) {
throw Errors.occFail();
}
return this.docsToResourceData(doc, false) as Data<ReturnedResource>;
})
};
}
async delete(query: DeleteQuery) {
// Delete queries in theory let users delete resources that match arbitrary
// criteria. Atm, though, json-api only supports delete by id(s). And, below,
// we assume that ids are the only criteria in use, e.g., when we check the
// length of the result set. So, throw if that assumption doesn't hold.
if(!query.isSimpleIdQuery()) {
throw new Error("Unsupported delete query");
}
// On deletion, the library doesn't load + verify for us the subtypes of
// the resources the user is trying to delete (because that overhead isn't
// strictly necessary, unlike in the update case where it's needed to run
// the proper beforeSave). So, we have to do that ourselves first. If any
// types are invalid, we do no deletions and return 400.
const { type, isSingular: singular } = query;
const mode = singular ? 'findOne' : 'find';
const filters = query.getFilters();
const mongofiedFilters = util.toMongoCriteria(filters);
// Before we query to verify the subtypes, lets throw a targeted error
// message if we can identify that any of the ids are in an invalid format.
this.constructor.assertIdsValid(filters, singular);
// Ok, now, in order to verify that all ids of the right type, we need to
// query on the root model of `Query.type` (Query.type could be a subtype);
// if we query with the subtype model, ids that don't match the subtype will
// just not match any docs, and we won't be able to distinguish the
// "a doc is missing (404)" case from the "invalid type (400)" case.
const QueryTypeModel = this.getModel(type);
const baseModelName = QueryTypeModel.baseModelName || QueryTypeModel.modelName;
const BaseModel = this.getModel(<string>this.modelNamesToTypeNames[baseModelName]);
const queryBuilder = mode === 'findOne' // ternary is a hack for TS compiler
? BaseModel[mode](mongofiedFilters)
: BaseModel[mode](mongofiedFilters);
const docsToDelete = await queryBuilder.exec().then((docOrDocsOrNull) => {
return Data.fromJSON<mongoose.Document>(docOrDocsOrNull);
}, util.errorHandler);
// Now, we verify all the type paths.
const hasTypePathThrough = (throughType: string, doc: Document) => {
return this.getTypePath(doc.constructor as Model<any>).includes(throughType);
}
if(!docsToDelete.every(R.partial(hasTypePathThrough, [type]))) {
throw Errors.invalidResourceType();
}
// Ok, having verified that all the resources are of the right (sub) type,
// we now want to check if no resources could be found and this is a single
// delete. In that case only, we return 404. (If some resources were missing
// and this is a bulk delete, we just delete the ones that we did find [as
// making the client retry is inconvenient, and the result of removing the
// missing ids and repeating the request would be the same].)
if(singular && docsToDelete.size === 0) {
throw Errors.genericNotFound();
}
// Finally, we can delete all the docs,
// calling .remove() to run the user's middleware.
docsToDelete.forEach(it => { it.remove(); });
return {
deleted:
docsToDelete.map(it => this.docToResource(it)) as Data<ReturnedResource>
};
}
/**
* Unlike update(), which would do full replacement of a to-many relationship
* if new linkage was provided, this method adds the new linkage to the existing
* relationship. It doesn't do a find-then-save, so some mongoose hooks may not
* run. But validation and the update query hooks will work.
*/
async addToRelationship(query: AddToRelationshipQuery) {
return this.updateRelationship(query);
}
/**
* Like @addToRelationship, but removes the provided linkage.
*/
async removeFromRelationship(query: RemoveFromRelationshipQuery) {
return this.updateRelationship(query);
}
private async updateRelationship(
query: AddToRelationshipQuery | RemoveFromRelationshipQuery
) {
const { type, id, relationshipName, linkage } = query;
// Below, we verify that the `type` key in linkage matches the `type` name
// of the root model that the relationship is supposed to hold.
//
// TODO: if the relationship is supposed to hold resources only of a
// specific subtype, validate that the linkage provided actually points to
// a document of that subtype (and actually points to an existing document
// at all!).
//
// TODO: update this to work like update(), where we find the doc and do an
// update on it so that save middleware can run and so we know the subtype
// of the owning document. Right now, we always run the parent model's
// findOneAndUpdate middleware, even if type/id points to a subtype resource.
// Likewise, we always read the supertype's schema when deciding which linkage
// types are allowed. That's bad too.
const model = this.getModel(type);
const linkageType = this.getRelationshipLinkageType(model, relationshipName);
if(!linkage.every(it => it.type === linkageType)) {
throw Errors.invalidLinkageType({
detail: `All linkage must have type: ${linkageType}.`
});
}
const updatedIds = linkage.map(it => it.id);
const options = {
runValidators: true,
context: "query",
// get the old doc back, as we can infer the new relationship state from
// that (by unioning the linkage), but can't go the other way (as there's
// no way to know from the final linkage if any items were already there)
new: false
};
const update = {
...(query instanceof RemoveFromRelationshipQuery
? { $pullAll: { [relationshipName]: updatedIds } }
: { $addToSet: { [relationshipName]: { $each: updatedIds } } }),
$inc: { [getVersionKey(model)]: 1 }
};
return model.findOneAndUpdate({ "_id": id }, update, options).exec()
.then(unUpdatedDoc => {
const beforeData =
Data.fromJSON(unUpdatedDoc[relationshipName])
.map(oid => new ResourceIdentifier(linkageType, String(oid)));
const finalIdsIterator = query instanceof AddToRelationshipQuery
? new Set([...beforeData.values.map(it => it.id), ...updatedIds]).values()
: setDifference(beforeData.values.map(it => it.id), updatedIds).values();
const afterData = Data.of(
[...finalIdsIterator].map(thisId =>
new ResourceIdentifier(linkageType, thisId)
)
);
const owner = { type, id: String(id), path: relationshipName };
return {
before: Relationship.of({ data: beforeData, owner }),
after: Relationship.of({ data: afterData, owner })
}
})
.catch(util.errorHandler);
}
/**
* Takes the json-api (i.e., parent-most) `type` and id for a set or resources,
* and returns the typePath for each resource. Must return subtypes earlier
* in the array, per typePath rules. Can also return extra data about the
* resource, which will be stored with it, for use optimizing future queries.
* Any resources that aren't found won't have an entry in the results object.
*/
async getTypePaths(items: { type: string; id: string }[]) {
const itemsByType = partition("type", items);
const types = Object.keys(itemsByType);
const res = {};
for(const type of types) {
const theseItems = itemsByType[type];
const BaseModel = this.getModel(type);
const discriminatorKey = getDiscriminatorKey(BaseModel);
// When we have a .lean() doc straight from mongo, we can't
// just use .constructor to get the model. So we have to be
// a bit more clever.
const modelForLeanDoc = (it: any) =>
(discriminatorKey && it[discriminatorKey])
? this.getModel(<string>this.modelNamesToTypeNames[it[discriminatorKey]])
: BaseModel;
// If we know the model has no subtypes,
// we can skip a query altogether and just return the type path.
if(!BaseModel.discriminators) {
res[type] = theseItems.reduce((acc, item) => {
acc[item.id] = { typePath: this.getTypePath(BaseModel) };
return acc;
}, {} as { [id: string]: TypeInfo });
}
else {
const docsPromise =
BaseModel.find({ _id: { $in: theseItems.map(it => it.id) }}).lean().exec();
res[type] = docsPromise.then(docs => {
return (docs as any[]).reduce((acc, doc) => {
acc[String(doc._id)] = {
typePath: this.getTypePath(modelForLeanDoc(doc)),
extra: doc
};
return acc;
}, {} as { [id: string]: TypeInfo });
})
}
}
const values = await Promise.all(types.map(type => res[type]));
return types.reduce((acc, type, i) => {
acc[type] = values[i];
return acc;
}, {} as TypeIdMapOf<TypeInfo>);
}
getModel(typeName: string) {
const modelName = this.typeNamesToModelNames[typeName];
if(!modelName || !this.models[modelName]) {
// don't use an APIError here, since we don't want to
// show this internals-specific method to the user.
throw new Error(
`No model for type "${typeName}" is registered with the MongooseAdapter.`
);
}
return this.models[modelName];
}
/**
* Return the paths that, for the provided type, must always must be filled
* with relationship info, if they're present. Occassionally, a path might be
* optionally fillable w/ relationship info [TODO: when? what does this mean?];
* this shouldn't return those paths.
*/
getRelationshipNames(typeName) {
const model = this.getModel(typeName);
return getReferencePaths(model);
}
/**
* Given a model and a relationship path, returns the legal/expected value
* for the JSON:API `type` key of all linkage present in the relationship.
*
* @param {Model<any>} ownerModel The model on which the relationship exists
* @param {string} relName The name of the relationship
*/
protected getRelationshipLinkageType(ownerModel: Model<any>, relName: string) {
try {
const refModelName = getReferencedModelName(ownerModel, relName);
const refModelType = this.modelNamesToTypeNames[refModelName as string];
const refModel = this.getModel(refModelType as string);
return this.getTypePath(refModel).pop() as string;
} catch(e) {
throw new Error(`Missing/invalid model name for relationship ${relName}.`);
}
}
/**
* We want return a singular Data<Resource> when the result is conceptually
* singular, and a non-singular one otherwise. But, because mongoose returns
* a single doc if you query for a one-item array of ids, and because we
* sometimes generate arrays (e.g. of promises for documents' successful
* creation) even when only creating/updating one document, just looking at
* whether docs is an array isn't enough to tell us whether the result is
* singular. And, in all these cases, we want to handle the possibility that
* the query returned no documents when we needed one, such that we must 404.
* This function centralizes all that logic.
*
* @param {object} models A model name => model dictionary
* @param {object} modelNamesToTypeNames A model name => type name dictionary
* @param {null | mongoose.Document | mongoose.Document[]} docs The docs to
* turn into a Data<Resource>
* @param {boolean} isPlural Whether the result is not conceptually singular.
* @param {object} fields
*/
static docsToResourceData(
models: any,
modelNamesToTypeNames,
docs: null | mongoose.Document | mongoose.Document[],
isPlural: boolean,
fields?: object
) {
// if docs is an empty array and we're making a collection, that's ok.
// but, if we're looking for a single doc, we must 404 if we didn't find any.
if(!docs || (!isPlural && Array.isArray(docs) && docs.length === 0)) {
throw Errors.genericNotFound();
}
const docsArray = !Array.isArray(docs) ? [docs] : docs;
const resources = docsArray.map((it) =>
docToResource(models, modelNamesToTypeNames, it, fields)
);
return isPlural
? Data.of(resources)
: Data.pure(resources[0]);
}
static getStandardizedSchema(
model: mongoose.Model<any>,
pluralizer: typeof pluralize.plural = pluralize.plural.bind(pluralize)
) {
const versionKey = getVersionKey(model);
const discriminatorKey = getDiscriminatorKey(model);
const virtuals = (model.schema as any).virtuals;
const schemaFields: FieldDocumentation[] = [];
const getFieldType = (path, schemaType) => {
if(path === "_id") {
return new FieldTypeDocumentation("Id", false);
}
const typeOptions = schemaType.options.type;
const holdsArray = Array.isArray(typeOptions);
const baseType = holdsArray ? typeOptions[0].ref : typeOptions.name;
const refModelName = getReferencedModelName(model, path);
return !refModelName ?
new FieldTypeDocumentation(baseType, holdsArray) :
new RelationshipTypeDocumentation(
holdsArray, refModelName, getTypeName(refModelName, pluralizer)
);
};
model.schema.eachPath((name, type) => {
if([versionKey, discriminatorKey].includes(name)) {
return;
}
// cast type to any for typescript because we're using
// an uncomfortable number of undocumented properties below.
const schemaType = type as any;
const fieldType = getFieldType(name, schemaType);
const publicName = name === "_id" ? "id" : name;
const likelyAutoGenerated =
publicName === "id" ||
(fieldType.baseType === "Date" &&
/created|updated|modified/.test(publicName) &&
typeof schemaType.options.default === "function");
let defaultVal;
if(likelyAutoGenerated) {
defaultVal = "__AUTO__";
}
else if(schemaType.options.default && typeof schemaType.options.default !== "function") {
defaultVal = schemaType.options.default;
}
// find the "base type's" options (used below), in case
// we have an array of values of the same type at this path.
const baseTypeOptions = Array.isArray(schemaType.options.type)
? schemaType.options.type[0]
: schemaType.options;
// Add validation info
const validationRules = {
required: !!schemaType.options.required,
oneOf: baseTypeOptions.enum
? schemaType.enumValues ||
(schemaType.caster && schemaType.caster.enumValues)
: undefined,
max: schemaType.options.max || undefined
};
schemaType.validators.forEach((validatorObj) => {
Object.assign(validationRules, validatorObj.validator.JSONAPIDocumentation);
});
schemaFields.push(
new FieldDocumentation(
publicName,
fieldType,
validationRules,
this.toFriendlyName(publicName),
defaultVal
)
);
});
for(const virtual in virtuals) {
// skip the id virtual, since we properly handled _id above.
if(virtual === "id") {
continue;
}
// for virtual properties, we can't infer type or validation rules at all,
// so we add them with just a friendly name and leave the rest undefined.
// The user is expected to override/set this in a resource type description.
schemaFields.push(
new FieldDocumentation(
virtual,
undefined,
undefined,
this.toFriendlyName(virtual)
)
);
}
return schemaFields;
}
static toFriendlyName(pathOrModelName: string) {
const ucFirst = (v) => v.charAt(0).toUpperCase() + v.slice(1);
// pascal case is "upper camel case", i.e. "MyName" as opposed to "myName".
// this variable holds a normalized, pascal cased version of pathOrModelName,
// such that `ModelFormat`, `pathFormat` `nested.path.format` all become
// ModelFormat, PathFormat, and NestedPathFormat.
const pascalCasedString = pathOrModelName.split(".").map(ucFirst).join("");
// Now, to handle acronyms like InMLBTeam, we need to define a word as a
// capital letter, plus (0 or more capital letters where the capital letter
// is not followed by a non-capital letter or 0 or more non capital letters).
let matches;
const words: string[] = [];
const wordsRe = /[A-Z]([A-Z]*(?![^A-Z])|[^A-Z]*)/g;
// tslint:disable-next-line no-conditional-assignment
while((matches = wordsRe.exec(pascalCasedString)) !== null) {
words.push(matches[0]);
}
return words.join(" ");
}
/**
* This function checks that filter constraints on the id field are testing
* against the valid mongo id format, and throws a 400/404 error if not.
* The origin for it is that, by default, Mongoose would throw a CastError
* upon encountering an id string that it couldn't convert to an ObjectId,
* and we wanted to issue 404 errors in those cases (e.g., GET /people/1)
* rather than 500s, which is what the CastError got converted to.
*
* @param {AndExpression} filters A set of filter constraints to check.
* @param {boolean} isSingular Whether the query that the filters came from
* is singular. Influences error message.
*/
static assertIdsValid(filters: AndExpression, isSingular: boolean): void {
const idsArray = filters.args.reduce((acc, filter) => {
// We're only validating the RHS of binary operators where the left
// hand side is a reference to a field named id.
return isIdentifier(filter.args[0]) && filter.args[0].value === 'id'
? acc.concat(filter.args[1] as any as (string | string[]))
: acc;
}, [] as string[]);
if(!idsArray.every(this.idIsValid)) {
throw isSingular
? Errors.genericNotFound({ detail: "Invalid ID." })
: Errors.invalidId();
}
}
static idIsValid(id) {
return typeof id === "string" && /^[0-9a-fA-F]{24}$/.test(id);
}
static supportedOperators: SupportedOperators = {
// These operators are treated with the library's built-in rules for
// whether they're binary and how to validate their arguments.
"and": { },
"or": { },
'eq': { },
'neq': { },
'ne': { },
'in': { },
'nin': { },
'lt': { },
'gt': { },
'lte': { },
'gte': { },
// Operators that other adapters really might not support, for which
// the library doesn't have built-in arg validation logic.
'geoDistance': {
arity: 2,
// geoDistance produces a number not a bool,
// so it's used for sorting and not filtering
legalIn: ["sort"],
finalizeArgs(operators, operator, args) {
if(!isIdentifier(args[0])) {
throw new SyntaxError(
`"geoDistance" operator expects field reference as first argument.`
);
}
if(!isPoint(args[1])) {
throw new SyntaxError(
`"geoDistance" operator expects [lng,lat] as second argument.`
);
}
return args;
}
},
'geoWithin': {
arity: 2,
legalIn: ["filter"],
finalizeArgs(operators, operator, args) {
if(!isIdentifier(args[0])) {
throw new SyntaxError(
`"geoWithin" operator expects field reference as first argument.`
);
}
// geoWithin only supports checking for points inside a circle atm.
const isToGeoCircle = R.allPass([
isFieldExpression,
R.propEq("operator", "toGeoCircle")
]);
if(!isToGeoCircle(args[1])) {
throw new SyntaxError(
`"geoDistance" operator expects a toGeoCircle as second argument.`
);
}
return args;
}
},
/**
* Returns a circle for use in spherical geo-spatial queries, centered at
* the provided latitude and with the provided radius. Is roughly equivalent
* to mongo's $centerSphere; however the second argument is a distance in
* meters, not radians. [The conversion from meters to radians happens when
* the operator is applied, in toMongoCriteria.]
*
* Note: this is only valid within a geoWithin field expression, but we
* can't validate that here. Instead, it's validated in toMongoCriteria.