@travetto/model-mongo 2.0.0 → 2.1.0

package/README.md

@@ -92,8 +92,6 @@ export class MongoModelConfig {
    */
   @Field(Object)
   options: mongo.MongoClientOptions = {
-    useNewUrlParser: true,
-    useUnifiedTopology: true
   };
 
   /**
@@ -111,7 +109,10 @@ export class MongoModelConfig {
    */
   async fetch(val: string) {
     return ResourceManager.read(val)
-      .catch(e => fs.readFile(val))
+      .then(res => typeof res === 'string' ? res : res.toString('utf8'))
+      .catch(e => fs.readFile(val)
+        .then(res => typeof res === 'string' ? res : res.toString('utf8'))
+      )
       .catch(() => val);
   }
 
@@ -122,16 +123,16 @@ export class MongoModelConfig {
     const opts = this.options;
     if (opts.ssl) {
       if (opts.sslCert) {
-        opts.sslCert = await this.fetch(opts.sslCert as string);
+        opts.tlsCertificateFile = await this.fetch(opts.sslCert);
       }
       if (opts.sslKey) {
-        opts.sslKey = await this.fetch(opts.sslKey as string);
+        opts.sslKey = await this.fetch(opts.sslKey);
       }
       if (opts.sslCA) {
-        opts.sslCA = await Promise.all(opts.sslCA.map(k => this.fetch(k as string)));
+        opts.sslCA = await this.fetch(opts.sslCA);
       }
       if (opts.sslCRL) {
-        opts.sslCRL = await Promise.all(opts.sslCRL.map(k => this.fetch(k as string)));
+        opts.sslCRL = await this.fetch(opts.sslCRL);
       }
     }
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/model-mongo",
   "displayName": "MongoDB Model Support",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Mongo backing for the travetto model module.",
   "keywords": [
     "mongo",
@@ -26,11 +26,10 @@
     "directory": "module/model-mongo"
   },
   "dependencies": {
-    "@travetto/config": "^2.0.0",
-    "@travetto/model": "^2.0.0",
-    "@travetto/model-query": "2.0.0",
-    "@types/mongodb": "^3.6.17",
-    "mongodb": "^3.6.9"
+    "@travetto/config": "^2.1.0",
+    "@travetto/model": "^2.1.0",
+    "@travetto/model-query": "2.1.0",
+    "mongodb": "^4.3.1"
   },
   "publishConfig": {
     "access": "public"

package/src/config.ts

@@ -44,8 +44,6 @@ export class MongoModelConfig {
    */
   @Field(Object)
   options: mongo.MongoClientOptions = {
-    useNewUrlParser: true,
-    useUnifiedTopology: true
   };
 
   /**
@@ -63,7 +61,10 @@ export class MongoModelConfig {
    */
   async fetch(val: string) {
     return ResourceManager.read(val)
-      .catch(e => fs.readFile(val))
+      .then(res => typeof res === 'string' ? res : res.toString('utf8'))
+      .catch(e => fs.readFile(val)
+        .then(res => typeof res === 'string' ? res : res.toString('utf8'))
+      )
       .catch(() => val);
   }
 
@@ -74,16 +75,16 @@ export class MongoModelConfig {
     const opts = this.options;
     if (opts.ssl) {
       if (opts.sslCert) {
-        opts.sslCert = await this.fetch(opts.sslCert as string);
+        opts.tlsCertificateFile = await this.fetch(opts.sslCert);
       }
       if (opts.sslKey) {
-        opts.sslKey = await this.fetch(opts.sslKey as string);
+        opts.sslKey = await this.fetch(opts.sslKey);
       }
       if (opts.sslCA) {
-        opts.sslCA = await Promise.all(opts.sslCA.map(k => this.fetch(k as string)));
+        opts.sslCA = await this.fetch(opts.sslCA);
       }
       if (opts.sslCRL) {
-        opts.sslCRL = await Promise.all(opts.sslCRL.map(k => this.fetch(k as string)));
+        opts.sslCRL = await this.fetch(opts.sslCRL);
       }
     }
   }

package/src/internal/util.ts

@@ -31,17 +31,18 @@ export class MongoUtil {
       f = f[key as keyof typeof f] as IndexField<T>;
       keys.push(key);
     }
-    return { [keys.join('.')]: (f as boolean) === true ? 1 : f as number } as Record<string, number>;
+    const rf = f as unknown as (number | boolean);
+    return { [keys.join('.')]: rf === true ? 1 : rf } as Record<string, number>;
   }
 
   static uuid(val: string) {
     return new mongo.Binary(Buffer.from(val.replace(/-/g, ''), 'hex'), mongo.Binary.SUBTYPE_UUID);
   }
 
-  static idToString(id: string | mongo.ObjectID | mongo.Binary) {
+  static idToString(id: string | mongo.ObjectId | mongo.Binary) {
     if (typeof id === 'string') {
       return id;
-    } else if (id instanceof mongo.ObjectID) {
+    } else if (id instanceof mongo.ObjectId) {
       return id.toHexString();
     } else {
       return id.buffer.toString('hex');

package/src/service.ts

@@ -33,7 +33,9 @@ import { MongoModelConfig } from './config';
 
 const IdxFieldsⲐ = Symbol.for('@trv:model-mongo/idx');
 
-const asFielded = <T extends ModelType>(cfg: IndexConfig<T>) => (cfg as unknown as { [IdxFieldsⲐ]: mongo.SortOptionObject<T> });
+const asFielded = <T extends ModelType>(cfg: IndexConfig<T>) => (cfg as unknown as { [IdxFieldsⲐ]: mongo.Sort });
+
+type IdxCfg = mongo.CreateIndexesOptions;
 
 /**
  * Mongo-based model source
@@ -53,7 +55,7 @@ export class MongoModelService implements
   constructor(public readonly config: MongoModelConfig) { }
 
   async #describeStreamRaw(location: string) {
-    const files = (await this.#bucket.find({ filename: location }, { limit: 1 }).toArray()) as [{ _id: mongo.ObjectID, metadata: StreamMeta }];
+    const files = (await this.#bucket.find({ filename: location }, { limit: 1 }).toArray()) as (mongo.GridFSFile & { metadata: StreamMeta })[];
 
     if (!files?.length) {
       throw new NotFoundError(STREAMS, location);
@@ -92,11 +94,11 @@ export class MongoModelService implements
     await this.#db.dropDatabase();
   }
 
-  getGeoIndices<T extends ModelType>(cls: Class<T>, path: FieldConfig[] = [], root = cls): Record<string, '2d'>[] {
+  getGeoIndices<T extends ModelType>(cls: Class<T>, path: FieldConfig[] = [], root = cls): mongo.IndexSpecification[] {
     const fields = SchemaRegistry.has(cls) ?
       Object.values(SchemaRegistry.get(cls).views[AllViewⲐ].schema) :
       [];
-    const out: Record<string, '2d'>[] = [];
+    const out: mongo.IndexSpecification[] = [];
     for (const field of fields) {
       if (SchemaRegistry.has(field.type)) {
         // Recurse
@@ -115,7 +117,10 @@ export class MongoModelService implements
     return [
       ...indices.map(idx => {
         const combined = asFielded(idx)[IdxFieldsⲐ] ??= Object.assign({}, ...idx.fields.map(x => MongoUtil.toIndex(x as IndexField<T>)));
-        return [combined, (idx.type === 'unique' ? { unique: true } : {}) as mongo.IndexOptions] as const;
+        return [
+          combined as mongo.IndexSpecification,
+          (idx.type === 'unique' ? { unique: true } : {}) as IdxCfg
+        ] as const;
       }),
       ...this.getGeoIndices(cls).map(x => [x] as const)
     ];
@@ -127,7 +132,7 @@ export class MongoModelService implements
     if (creating.length) {
       console.debug('Creating indexes', { indices: creating });
       for (const el of creating) {
-        await col.createIndex(el[0], el[1]);
+        await col.createIndex(el[0], el[1] ?? {});
       }
     }
   }
@@ -177,7 +182,7 @@ export class MongoModelService implements
 
     const store = await this.getStore(cls);
     const result = await store.insertOne(cleaned);
-    if (result.insertedCount === 0) {
+    if (!result.insertedId) {
       throw new ExistsError(cls, cleaned.id);
     }
     delete (cleaned as { _id?: unknown })._id;
@@ -239,7 +244,11 @@ export class MongoModelService implements
     }, {} as Record<string, unknown>);
 
     const id = item.id;
-    const res = await store.findOneAndUpdate(this.getWhere<ModelType>(cls, { id }), final, { returnOriginal: false });
+    const res = await store.findOneAndUpdate(
+      this.getWhere<ModelType>(cls, { id }),
+      final,
+      { returnDocument: 'after' }
+    );
 
     if (!res.value) {
       new NotFoundError(cls, id);
@@ -258,8 +267,7 @@ export class MongoModelService implements
 
   async * list<T extends ModelType>(cls: Class<T>) {
     const store = await this.getStore(cls);
-    const cursor = store.find(this.getWhere(cls, {})).batchSize(100);
-    cursor.timeout = true;
+    const cursor = store.find(this.getWhere(cls, {}), { timeout: true }).batchSize(100);
     for await (const el of cursor) {
       try {
         yield MongoUtil.postLoadId(await ModelCrudUtil.load(cls, el));
@@ -323,7 +331,7 @@ export class MongoModelService implements
     }
 
     const store = await this.getStore(cls);
-    const bulk = store.initializeUnorderedBulkOp({ w: 1 });
+    const bulk = store.initializeUnorderedBulkOp({ writeConcern: { w: 1 } });
     const { upsertedIds, insertedIds } = await ModelBulkUtil.preStore(cls, operations, this);
 
     out.insertedIds = new Map([...upsertedIds.entries(), ...insertedIds.entries()]);
@@ -336,7 +344,7 @@ export class MongoModelService implements
       } else if (op.update) {
         bulk.find({ _id: MongoUtil.uuid(op.update.id) }).update({ $set: op.update });
       } else if (op.delete) {
-        bulk.find({ _id: MongoUtil.uuid(op.delete.id) }).removeOne();
+        bulk.find({ _id: MongoUtil.uuid(op.delete.id) }).deleteOne();
       }
     }
 
@@ -347,7 +355,7 @@ export class MongoModelService implements
         MongoUtil.postLoadId(op.insert as T);
       }
     }
-    for (const { index, _id } of res.getUpsertedIds() as { index: number, _id: mongo.ObjectID }[]) {
+    for (const { index, _id } of res.getUpsertedIds() as { index: number, _id: mongo.ObjectId }[]) {
       out.insertedIds.set(index, MongoUtil.idToString(_id));
     }
 
@@ -422,10 +430,9 @@ export class MongoModelService implements
     const where = this.getWhere(
       cls,
       ModelIndexedUtil.projectIndex(cls, idx, body, { emptySortValue: { $exists: true } }) as WhereClause<T>
-    ) as mongo.FilterQuery<T>;
+    ) as mongo.Filter<T>;
 
-    const cursor = store.find(where).batchSize(100).sort(asFielded(idxCfg)[IdxFieldsⲐ]);
-    cursor.timeout = true;
+    const cursor = store.find(where, { timeout: true }).batchSize(100).sort(asFielded(idxCfg)[IdxFieldsⲐ]);
 
     for await (const el of cursor) {
       yield (await MongoUtil.postLoadId(await ModelCrudUtil.load(cls, el))) as T;
@@ -522,10 +529,10 @@ export class MongoModelService implements
 
     pipeline.unshift({ $match: q });
 
-    const result = await col.aggregate(pipeline).toArray();
+    const result = (await col.aggregate(pipeline).toArray()) as { _id: mongo.ObjectId, count: number }[];
 
-    return result.map((val: ({ _id: string, count: number })) => ({
-      key: val._id,
+    return result.map(val => ({
+      key: MongoUtil.idToString(val._id),
       count: val.count
     })).sort((a, b) => b.count - a.count);
   }