@travetto/model-mongo 3.0.0-rc.2 → 3.0.0-rc.20

package/README.md

@@ -1,5 +1,5 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-mongo/doc.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-mongo/DOC.ts and execute "npx trv doc" to rebuild -->
 # MongoDB Model Support
 ## Mongo backing for the travetto model module.
 
@@ -15,7 +15,7 @@ Supported features:
    *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/crud.ts#L11)
    *  [Streaming](https://github.com/travetto/travetto/tree/main/module/model/src/service/stream.ts#L3)
    *  [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11)
-   *  [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/service/bulk.ts#L23)
+   *  [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/service/bulk.ts#L19)
    *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model/src/service/indexed.ts#L12)
    *  [Query Crud](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/crud.ts#L11)
    *  [Facet](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/facet.ts#L12)
@@ -41,15 +41,14 @@ export class Init {
 }
 ```
 
-  where the [MongoModelConfig](https://github.com/travetto/travetto/tree/main/module/model-mongo/src/config.ts#L12) is defined by:
+  where the [MongoModelConfig](https://github.com/travetto/travetto/tree/main/module/model-mongo/src/config.ts#L11) is defined by:
 
   
 **Code: Structure of MongoModelConfig**
 ```typescript
-import * as mongo from 'mongodb';
-import { promises as fs } from 'fs';
+import type mongo from 'mongodb';
 
-import { TimeSpan, ResourceManager } from '@travetto/base';
+import { FileResourceProvider, TimeSpan } from '@travetto/base';
 import { Config } from '@travetto/config';
 import { Field } from '@travetto/schema';
 
@@ -104,35 +103,26 @@ export class MongoModelConfig {
    */
   cullRate?: number | TimeSpan;
 
-  /**
-   * Load a resource
-   */
-  async fetch(val: string): Promise<string> {
-    return ResourceManager.read(val)
-      .then(res => typeof res === 'string' ? res : res.toString('utf8'))
-      .catch(() => fs.readFile(val)
-        .then(res => typeof res === 'string' ? res : res.toString('utf8'))
-      )
-      .catch(() => val);
-  }
-
   /**
    * Load all the ssl certs as needed
    */
   async postConstruct(): Promise<void> {
+    const resources = new FileResourceProvider({ includeCommon: true });
+    const resolve = (file: string): Promise<string> => resources.describe(file).then(({ path }) => path, () => file);
+
     const opts = this.options;
     if (opts.ssl) {
       if (opts.sslCert) {
-        opts.tlsCertificateFile = await this.fetch(opts.sslCert);
+        opts.tlsCertificateFile = await resolve(opts.sslCert);
       }
       if (opts.sslKey) {
-        opts.sslKey = await this.fetch(opts.sslKey);
+        opts.sslKey = await resolve(opts.sslKey);
       }
       if (opts.sslCA) {
-        opts.sslCA = await this.fetch(opts.sslCA);
+        opts.sslCA = await resolve(opts.sslCA);
       }
       if (opts.sslCRL) {
-        opts.sslCRL = await this.fetch(opts.sslCRL);
+        opts.sslCRL = await resolve(opts.sslCRL);
       }
     }
   }
@@ -155,8 +145,8 @@ export class MongoModelConfig {
 }
 ```
 
-  Additionally, you can see that the class is registered with the [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L9) annotation, and so these values can be overridden using the 
-  standard [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Environment-aware config management using yaml files")resolution paths. 
+  Additionally, you can see that the class is registered with the [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) annotation, and so these values can be overridden using the 
+  standard [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Configuration support")resolution paths. 
   
 
-The SSL file options in `clientOptions` will automatically be resolved to files when given a path.  This path can be a [ResourceManager](https://github.com/travetto/travetto/tree/main/module/base/src/resource.ts#L16) path or just a standard file path.
+The SSL file options in `clientOptions` will automatically be resolved to files when given a path.  This path can be a [FileResourceProvider](https://github.com/travetto/travetto/tree/main/module/base/src/resource.ts#L46) path or just a standard file path.

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@travetto/model-mongo",
-  "displayName": "MongoDB Model Support",
-  "version": "3.0.0-rc.2",
+  "version": "3.0.0-rc.20",
   "description": "Mongo backing for the travetto model module.",
   "keywords": [
     "mongo",
@@ -16,20 +15,31 @@
     "name": "Travetto Framework"
   },
   "files": [
-    "index.ts",
+    "__index__.ts",
     "src",
     "support"
   ],
-  "main": "index.ts",
+  "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/model-mongo"
   },
   "dependencies": {
-    "@travetto/config": "^3.0.0-rc.2",
-    "@travetto/model": "^3.0.0-rc.2",
-    "@travetto/model-query": "3.0.0-rc.2",
-    "mongodb": "^4.9.0"
+    "@travetto/config": "^3.0.0-rc.20",
+    "@travetto/model": "^3.0.0-rc.20",
+    "@travetto/model-query": "^3.0.0-rc.20",
+    "mongodb": "^5.0.1"
+  },
+  "peerDependencies": {
+    "@travetto/command": "^3.0.0-rc.16"
+  },
+  "peerDependenciesMeta": {
+    "@travetto/command": {
+      "optional": true
+    }
+  },
+  "travetto": {
+    "displayName": "MongoDB Model Support"
   },
   "publishConfig": {
     "access": "public"

package/src/config.ts

@@ -1,7 +1,6 @@
-import * as mongo from 'mongodb';
-import { promises as fs } from 'fs';
+import type mongo from 'mongodb';
 
-import { TimeSpan, ResourceManager } from '@travetto/base';
+import { FileResourceProvider, TimeSpan } from '@travetto/base';
 import { Config } from '@travetto/config';
 import { Field } from '@travetto/schema';
 
@@ -43,8 +42,7 @@ export class MongoModelConfig {
    * Mongo client options
    */
   @Field(Object)
-  options: mongo.MongoClientOptions = {
-  };
+  options: mongo.MongoClientOptions = {};
 
   /**
    * Should we auto create the db
@@ -56,35 +54,26 @@ export class MongoModelConfig {
    */
   cullRate?: number | TimeSpan;
 
-  /**
-   * Load a resource
-   */
-  async fetch(val: string): Promise<string> {
-    return ResourceManager.read(val)
-      .then(res => typeof res === 'string' ? res : res.toString('utf8'))
-      .catch(() => fs.readFile(val)
-        .then(res => typeof res === 'string' ? res : res.toString('utf8'))
-      )
-      .catch(() => val);
-  }
-
   /**
    * Load all the ssl certs as needed
    */
   async postConstruct(): Promise<void> {
+    const resources = new FileResourceProvider({ includeCommon: true });
+    const resolve = (file: string): Promise<string> => resources.describe(file).then(({ path }) => path, () => file);
+
     const opts = this.options;
     if (opts.ssl) {
       if (opts.sslCert) {
-        opts.tlsCertificateFile = await this.fetch(opts.sslCert);
+        opts.tlsCertificateFile = await resolve(opts.sslCert);
       }
       if (opts.sslKey) {
-        opts.sslKey = await this.fetch(opts.sslKey);
+        opts.sslKey = await resolve(opts.sslKey);
       }
       if (opts.sslCA) {
-        opts.sslCA = await this.fetch(opts.sslCA);
+        opts.sslCA = await resolve(opts.sslCA);
       }
       if (opts.sslCRL) {
-        opts.sslCRL = await this.fetch(opts.sslCRL);
+        opts.sslCRL = await resolve(opts.sslCRL);
       }
     }
   }

package/src/internal/util.ts

@@ -1,10 +1,9 @@
 import * as mongo from 'mongodb';
 
-import { Class, Util } from '@travetto/base';
+import { Class, DataUtil, ObjectUtil } from '@travetto/base';
 import { DistanceUnit, ModelQuery, Query, WhereClause } from '@travetto/model-query';
-import { ModelType } from '@travetto/model';
+import type { ModelType, IndexField } from '@travetto/model';
 import { ModelQueryUtil } from '@travetto/model-query/src/internal/service/query';
-import { IndexField } from '@travetto/model/src/registry/types';
 
 /**
  * Converting units to various radians
@@ -20,7 +19,6 @@ const RADIANS_TO: Record<DistanceUnit, number> = {
 export type WithId<T> = T & { _id?: mongo.Binary };
 const isWithId = <T extends ModelType>(o: T): o is WithId<T> => o && '_id' in o;
 
-
 /**
  * Basic mongo utils for conforming to the model module
  */
@@ -51,7 +49,7 @@ export class MongoUtil {
     } else if (id instanceof mongo.ObjectId) {
       return id.toHexString();
     } else {
-      return id.buffer.toString('hex');
+      return Buffer.from(id.buffer).toString('hex');
     }
   }
 
@@ -119,7 +117,7 @@ export class MongoUtil {
       return this.uuid(v);
     } else if (Array.isArray(v)) {
       return v.map(x => this.replaceId(x));
-    } else if (Util.isPlainObject(v)) {
+    } else if (ObjectUtil.isPlainObject(v)) {
       const out: Record<string, mongo.Binary> = {};
       for (const [k, el] of Object.entries(v)) {
         const found = this.replaceId(el);
@@ -149,9 +147,9 @@ export class MongoUtil {
       if (subpath === 'id') { // Handle ids directly
         out._id = this.replaceId(v);
       } else {
-        const isPlain = v && Util.isPlainObject(v);
+        const isPlain = v && ObjectUtil.isPlainObject(v);
         const firstKey = isPlain ? Object.keys(v)[0] : '';
-        if ((isPlain && !firstKey.startsWith('$')) || v?.constructor?.ᚕid) {
+        if ((isPlain && !firstKey.startsWith('$')) || v?.constructor?.Ⲑid) {
           Object.assign(out, this.extractSimple(v, `${subpath}.`));
         } else {
           if (firstKey === '$gt' || firstKey === '$lt' || firstKey === '$gte' || firstKey === '$lte') {
@@ -160,7 +158,7 @@ export class MongoUtil {
             }
           } else if (firstKey === '$regex') {
             // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-            v.$regex = Util.toRegex(v.$regex as string | RegExp);
+            v.$regex = DataUtil.toRegex(v.$regex as string | RegExp);
           } else if (firstKey && '$near' in v) {
             // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
             const dist = v.$maxDistance as number;

package/src/service.ts

@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/consistent-type-assertions */
+// Wildcard import needed here due to packaging issues
 import * as mongo from 'mongodb';
 import { Readable } from 'stream';
 
@@ -14,7 +14,7 @@ import {
   PageableModelQuery, ValidStringFields, WhereClause, ModelQuerySuggestSupport
 } from '@travetto/model-query';
 
-import { ShutdownManager, Util, Class, AppError } from '@travetto/base';
+import { ShutdownManager, type Class, AppError } from '@travetto/base';
 import { Injectable } from '@travetto/di';
 import { DeepPartial, FieldConfig, SchemaRegistry, SchemaValidator } from '@travetto/schema';
 
@@ -29,11 +29,12 @@ import { ModelExpiryUtil } from '@travetto/model/src/internal/service/expiry';
 import { StreamModel, STREAMS } from '@travetto/model/src/internal/service/stream';
 import { AllViewⲐ } from '@travetto/schema/src/internal/types';
 import { ModelBulkUtil } from '@travetto/model/src/internal/service/bulk';
+import { ModelUtil } from '@travetto/model/src/internal/util';
 
 import { MongoUtil, WithId } from './internal/util';
 import { MongoModelConfig } from './config';
 
-const IdxFieldsⲐ = Symbol.for('@trv:model-mongo/idx');
+const IdxFieldsⲐ = Symbol.for('@travetto/model-mongo:idx');
 
 // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
 const asFielded = <T extends ModelType>(cfg: IndexConfig<T>): { [IdxFieldsⲐ]: mongo.Sort } => (cfg as unknown as { [IdxFieldsⲐ]: mongo.Sort });
@@ -78,7 +79,7 @@ export class MongoModelService implements
       writeConcern: { w: 1 }
     });
     await ModelStorageUtil.registerModelChangeListener(this);
-    ShutdownManager.onShutdown(this.constructor.ᚕid, () => this.client.close());
+    ShutdownManager.onShutdown(this, () => this.client.close());
     ModelExpiryUtil.registerCull(this);
   }
 
@@ -90,7 +91,7 @@ export class MongoModelService implements
    * Build a mongo identifier
    */
   uuid(): string {
-    return Util.uuid();
+    return ModelUtil.uuid();
   }
 
   // Storage
@@ -111,7 +112,7 @@ export class MongoModelService implements
         out.push(...this.getGeoIndices(field.type, [...path, field], root));
       } else if (field.type === PointImpl) {
         const name = [...path, field].map(x => x.name).join('.');
-        console.debug('Preparing geo-index', { cls: root.ᚕid, name });
+        console.debug('Preparing geo-index', { cls: root.Ⲑid, name });
         out.push({ [name]: '2d' });
       }
     }
@@ -193,6 +194,7 @@ export class MongoModelService implements
     if (!result.insertedId) {
       throw new ExistsError(cls, cleaned.id);
     }
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     delete (cleaned as { _id?: unknown })._id;
     return cleaned;
   }
@@ -244,9 +246,11 @@ export class MongoModelService implements
       .entries(items)
       .reduce<Record<string, unknown>>((acc, [k, v]) => {
         if (v === null || v === undefined) {
+          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
           const o = (acc.$unset ??= {}) as Record<string, unknown>;
           o[k] = v;
         } else {
+          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
           const o = (acc.$set ??= {}) as Record<string, unknown>;
           o[k] = v;
         }
@@ -297,9 +301,7 @@ export class MongoModelService implements
     });
 
     await new Promise<unknown>((resolve, reject) => {
-      input.pipe(writeStream);
-      input.on('error', reject);
-      writeStream.once('finish', resolve);
+      input.pipe(writeStream).on('finish', resolve).on('error', reject);
     });
   }
 
@@ -348,6 +350,7 @@ export class MongoModelService implements
 
     for (const op of operations) {
       if (op.insert) {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         bulk.insert(MongoUtil.preInsertId(op.insert as T));
       } else if (op.upsert) {
         bulk.find({ _id: MongoUtil.uuid(op.upsert.id!) }).upsert().updateOne({ $set: op.upsert });
@@ -362,9 +365,11 @@ export class MongoModelService implements
 
     for (const op of operations) {
       if (op.insert) {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         MongoUtil.postLoadId(op.insert as T);
       }
     }
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     for (const { index, _id } of res.getUpsertedIds() as { index: number, _id: mongo.ObjectId }[]) {
       out.insertedIds.set(index, MongoUtil.idToString(_id));
     }
@@ -380,6 +385,7 @@ export class MongoModelService implements
       out.errors = res.getWriteErrors();
       for (const err of out.errors) {
         const op = operations[err.index];
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         const k = Object.keys(op)[0] as keyof BulkResponse['counts'];
         out.counts[k] -= 1;
       }
@@ -401,6 +407,7 @@ export class MongoModelService implements
     const result = await store.findOne(
       this.getWhere(
         cls,
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         ModelIndexedUtil.projectIndex(cls, idx, body) as WhereClause<T>
       )
     );
@@ -416,6 +423,7 @@ export class MongoModelService implements
     const result = await store.deleteOne(
       this.getWhere(
         cls,
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         ModelIndexedUtil.projectIndex(cls, idx, body) as WhereClause<T>
       )
     );
@@ -437,14 +445,17 @@ export class MongoModelService implements
       throw new AppError('Cannot list on unique indices', 'data');
     }
 
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     const where = this.getWhere(
       cls,
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       ModelIndexedUtil.projectIndex(cls, idx, body, { emptySortValue: { $exists: true } }) as WhereClause<T>
-    ) as mongo.Filter<T>;
+    ) as mongo.Filter<Document>;
 
     const cursor = store.find(where, { timeout: true }).batchSize(100).sort(asFielded(idxCfg)[IdxFieldsⲐ]);
 
     for await (const el of cursor) {
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       yield (await MongoUtil.postLoadId(await ModelCrudUtil.load(cls, el))) as T;
     }
   }
@@ -506,9 +517,11 @@ export class MongoModelService implements
     const items = MongoUtil.extractSimple(data);
     const final = Object.entries(items).reduce<Record<string, unknown>>((acc, [k, v]) => {
       if (v === null || v === undefined) {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         const o = (acc.$unset = acc.$unset ?? {}) as Record<string, unknown>;
         o[k] = v;
       } else {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         const o = (acc.$set = acc.$set ?? {}) as Record<string, unknown>;
         o[k] = v;
       }
@@ -525,6 +538,7 @@ export class MongoModelService implements
     const col = await this.getStore(cls);
     const pipeline: object[] = [{
       $group: {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         _id: `$${field as string}`,
         count: {
           $sum: 1
@@ -540,6 +554,7 @@ export class MongoModelService implements
 
     pipeline.unshift({ $match: q });
 
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     const result = (await col.aggregate(pipeline).toArray()) as { _id: mongo.ObjectId, count: number }[];
 
     return result.map(val => ({

package/support/service.mongo.ts

@@ -1,9 +1,9 @@
-import { EnvUtil } from '@travetto/boot';
-import type { Service } from '@travetto/command/bin/lib/service';
+import { Env } from '@travetto/base';
+import type { CommandService } from '@travetto/command';
 
-const version = EnvUtil.get('TRV_SERVICE_MONGO', '4.4');
+const version = Env.get('MONGO_VERSION', '6.0');
 
-export const service: Service = {
+export const service: CommandService = {
   name: 'mongodb',
   version,
   port: 27017,