@travetto/model-mongo 7.1.4 → 8.0.0-alpha.1

package/README.md

@@ -43,7 +43,7 @@ export class Init {
 }
 ```
 
-where the [MongoModelConfig](https://github.com/travetto/travetto/tree/main/module/model-mongo/src/config.ts#L10) is defined by:
+where the [MongoModelConfig](https://github.com/travetto/travetto/tree/main/module/model-mongo/src/config.ts#L24) is defined by:
 
 **Code: Structure of MongoModelConfig**
 ```typescript
@@ -80,7 +80,10 @@ export class MongoModelConfig {
   /**
    * Mongo client options
    */
-  options: mongo.MongoClientOptions = {};
+  @Field({ type: Object })
+  options: Omit<mongo.MongoClientOptions, 'cert'> & {
+    cert?: | Buffer | string | BinaryType | (BinaryType | Buffer | string)[];
+  } = {};
   /**
    * Allow storage modification at runtime
    */
@@ -101,9 +104,8 @@ export class MongoModelConfig {
   /**
    * Load all the ssl certs as needed
    */
-  async postConstruct(): Promise<void> {
-    const resolve = (file: string): Promise<string> => RuntimeResources.resolve(file).catch(() => file);
-
+  @PostConstruct()
+  async finalizeConfig(): Promise<void> {
     if (this.connectionString) {
       const details = new URL(this.connectionString);
       this.hosts ??= details.hostname.split(',').filter(host => !!host);
@@ -129,22 +131,23 @@ export class MongoModelConfig {
     const options = this.options;
     if (options.ssl) {
       if (options.cert) {
-        options.cert = await Promise.all([options.cert].flat(2).map(data => Buffer.isBuffer(data) ? data : resolve(data)));
+        options.cert = (await Promise.all([options.cert].flat(2).map(readCert)))
+          .map(BinaryUtil.binaryArrayToUint8Array);
       }
       if (options.tlsCertificateKeyFile) {
-        options.tlsCertificateKeyFile = await resolve(options.tlsCertificateKeyFile);
+        options.tlsCertificateKeyFile = await RuntimeResources.resolve(options.tlsCertificateKeyFile);
       }
       if (options.tlsCAFile) {
-        options.tlsCAFile = await resolve(options.tlsCAFile);
+        options.tlsCAFile = await RuntimeResources.resolve(options.tlsCAFile);
       }
       if (options.tlsCRLFile) {
-        options.tlsCRLFile = await resolve(options.tlsCRLFile);
+        options.tlsCRLFile = await RuntimeResources.resolve(options.tlsCRLFile);
       }
     }
 
     if (!Runtime.production) {
       options.waitQueueTimeoutMS = 0;
-      options.serverSelectionTimeoutMS = TimeUtil.asMillis(1, 's');
+      options.serverSelectionTimeoutMS = 1000;
     }
   }
 
@@ -155,7 +158,12 @@ export class MongoModelConfig {
     const hosts = this.hosts!
       .map(host => (this.srvRecord || host.includes(':')) ? host : `${host}:${this.port ?? 27017}`)
       .join(',');
-    const optionString = new URLSearchParams(Object.entries(this.options)).toString();
+    const optionString = new URLSearchParams(
+      Object.entries(this.options)
+        .filter((pair): pair is [string, string | number | boolean] => ['string', 'number', 'boolean'].includes(typeof pair[1]))
+        .map(([k, v]) => [k, `${v}`])
+    )
+      .toString();
     let creds = '';
     if (this.username) {
       creds = `${[this.username, this.password].filter(part => !!part).join(':')}@`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-mongo",
-  "version": "7.1.4",
+  "version": "8.0.0-alpha.1",
   "type": "module",
   "description": "Mongo backing for the travetto model module.",
   "keywords": [
@@ -26,13 +26,13 @@
     "directory": "module/model-mongo"
   },
   "dependencies": {
-    "@travetto/config": "^7.1.4",
-    "@travetto/model": "^7.1.4",
-    "@travetto/model-query": "^7.1.4",
-    "mongodb": "^7.0.0"
+    "@travetto/config": "^8.0.0-alpha.1",
+    "@travetto/model": "^8.0.0-alpha.1",
+    "@travetto/model-query": "^8.0.0-alpha.1",
+    "mongodb": "^7.1.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^7.1.4"
+    "@travetto/cli": "^8.0.0-alpha.1"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/config.ts

@@ -1,7 +1,21 @@
 import type mongo from 'mongodb';
 
-import { type TimeSpan, TimeUtil, RuntimeResources, Runtime } from '@travetto/runtime';
+import { type TimeSpan, Runtime, RuntimeResources, BinaryUtil, CodecUtil, type BinaryType, type BinaryArray } from '@travetto/runtime';
 import { Config } from '@travetto/config';
+import { Field } from '@travetto/schema';
+import { PostConstruct } from '@travetto/di';
+
+const readCert = async (input: BinaryType | string): Promise<BinaryArray> => {
+  if (BinaryUtil.isBinaryType(input)) {
+    return BinaryUtil.toBinaryArray(input);
+  } else {
+    try {
+      return await RuntimeResources.readBinaryArray(input);
+    } catch {
+      return CodecUtil.fromUTF8String(input);
+    }
+  }
+};
 
 /**
  * Mongo model config
@@ -39,7 +53,10 @@ export class MongoModelConfig {
   /**
    * Mongo client options
    */
-  options: mongo.MongoClientOptions = {};
+  @Field({ type: Object })
+  options: Omit<mongo.MongoClientOptions, 'cert'> & {
+    cert?: | Buffer | string | BinaryType | (BinaryType | Buffer | string)[];
+  } = {};
   /**
    * Allow storage modification at runtime
    */
@@ -60,9 +77,8 @@ export class MongoModelConfig {
   /**
    * Load all the ssl certs as needed
    */
-  async postConstruct(): Promise<void> {
-    const resolve = (file: string): Promise<string> => RuntimeResources.resolve(file).catch(() => file);
-
+  @PostConstruct()
+  async finalizeConfig(): Promise<void> {
     if (this.connectionString) {
       const details = new URL(this.connectionString);
       this.hosts ??= details.hostname.split(',').filter(host => !!host);
@@ -88,22 +104,23 @@ export class MongoModelConfig {
     const options = this.options;
     if (options.ssl) {
       if (options.cert) {
-        options.cert = await Promise.all([options.cert].flat(2).map(data => Buffer.isBuffer(data) ? data : resolve(data)));
+        options.cert = (await Promise.all([options.cert].flat(2).map(readCert)))
+          .map(BinaryUtil.binaryArrayToUint8Array);
       }
       if (options.tlsCertificateKeyFile) {
-        options.tlsCertificateKeyFile = await resolve(options.tlsCertificateKeyFile);
+        options.tlsCertificateKeyFile = await RuntimeResources.resolve(options.tlsCertificateKeyFile);
       }
       if (options.tlsCAFile) {
-        options.tlsCAFile = await resolve(options.tlsCAFile);
+        options.tlsCAFile = await RuntimeResources.resolve(options.tlsCAFile);
       }
       if (options.tlsCRLFile) {
-        options.tlsCRLFile = await resolve(options.tlsCRLFile);
+        options.tlsCRLFile = await RuntimeResources.resolve(options.tlsCRLFile);
       }
     }
 
     if (!Runtime.production) {
       options.waitQueueTimeoutMS = 0;
-      options.serverSelectionTimeoutMS = TimeUtil.asMillis(1, 's');
+      options.serverSelectionTimeoutMS = 1000;
     }
   }
 
@@ -114,7 +131,12 @@ export class MongoModelConfig {
     const hosts = this.hosts!
       .map(host => (this.srvRecord || host.includes(':')) ? host : `${host}:${this.port ?? 27017}`)
       .join(',');
-    const optionString = new URLSearchParams(Object.entries(this.options)).toString();
+    const optionString = new URLSearchParams(
+      Object.entries(this.options)
+        .filter((pair): pair is [string, string | number | boolean] => ['string', 'number', 'boolean'].includes(typeof pair[1]))
+        .map(([k, v]) => [k, `${v}`])
+    )
+      .toString();
     let creds = '';
     if (this.username) {
       creds = `${[this.username, this.password].filter(part => !!part).join(':')}@`;

package/src/internal/util.ts

@@ -3,7 +3,7 @@ import {
   type IndexDescriptionInfo
 } from 'mongodb';
 
-import { AppError, castTo, type Class, toConcrete, TypedObject } from '@travetto/runtime';
+import { RuntimeError, CodecUtil, castTo, type Class, toConcrete, TypedObject, BinaryUtil } from '@travetto/runtime';
 import { type DistanceUnit, type PageableModelQuery, type WhereClause, ModelQueryUtil } from '@travetto/model-query';
 import type { ModelType, IndexField, IndexConfig } from '@travetto/model';
 import { DataUtil, SchemaRegistryIndex, type Point } from '@travetto/schema';
@@ -50,7 +50,19 @@ export class MongoUtil {
   }
 
   static uuid(value: string): Binary {
-    return new Binary(Buffer.from(value.replaceAll('-', ''), 'hex'), Binary.SUBTYPE_UUID);
+    try {
+      return new Binary(
+        BinaryUtil.binaryArrayToUint8Array(
+          CodecUtil.fromHexString(value.replaceAll('-', ''))
+        ),
+        Binary.SUBTYPE_UUID
+      );
+    } catch (err) {
+      if (err instanceof RuntimeError && err.message === 'Invalid hex string') {
+        return null!;
+      }
+      throw err;
+    }
   }
 
   static idToString(id: string | ObjectId | Binary): string {
@@ -59,7 +71,7 @@ export class MongoUtil {
     } else if (id instanceof ObjectId) {
       return id.toHexString();
     } else {
-      return Buffer.from(id.buffer).toString('hex');
+      return CodecUtil.toHexString(id.buffer);
     }
   }
 
@@ -104,7 +116,7 @@ export class MongoUtil {
           const temp = value[firstKey];
           out._id = { [firstKey]: Array.isArray(temp) ? temp.map(subValue => this.uuid(subValue)) : this.uuid(`${temp}`) };
         } else {
-          throw new AppError('Invalid id query');
+          throw new RuntimeError('Invalid id query');
         }
       } else if ((isPlain && !firstKey.startsWith('$')) || value?.constructor?.Ⲑid) {
         if (recursive) {

package/src/service.ts

@@ -1,8 +1,7 @@
-import { pipeline } from 'node:stream/promises';
-
 import {
+  type Binary,
   type Db, GridFSBucket, MongoClient, type GridFSFile, type Collection,
-  type ObjectId, type Binary, type RootFilterOperators, type Filter,
+  type ObjectId, type RootFilterOperators, type Filter,
   type WithId as MongoWithId,
 } from 'mongodb';
 
@@ -10,7 +9,7 @@ import {
   ModelRegistryIndex, type ModelType, type OptionalId, type ModelCrudSupport, type ModelStorageSupport,
   type ModelExpirySupport, type ModelBulkSupport, type ModelIndexedSupport, type BulkOperation, type BulkResponse,
   NotFoundError, ExistsError, type ModelBlobSupport,
-  ModelCrudUtil, ModelIndexedUtil, ModelStorageUtil, ModelExpiryUtil, ModelBulkUtil, ModelBlobUtil
+  ModelCrudUtil, ModelIndexedUtil, ModelStorageUtil, ModelExpiryUtil, ModelBulkUtil
 } from '@travetto/model';
 import {
   type ModelQuery, type ModelQueryCrudSupport, type ModelQueryFacetSupport, type ModelQuerySupport,
@@ -21,16 +20,16 @@ import {
 
 import {
   ShutdownManager, type Class, type DeepPartial, TypedObject,
-  castTo, asFull, type BlobMeta, type ByteRange, type BinaryInput, BinaryUtil
+  castTo, asFull, type BinaryMetadata, type ByteRange, type BinaryType, BinaryUtil, BinaryMetadataUtil,
 } from '@travetto/runtime';
-import { Injectable } from '@travetto/di';
+import { Injectable, PostConstruct } from '@travetto/di';
 
 import { MongoUtil, type PlainIdx, type WithId } from './internal/util.ts';
 import type { MongoModelConfig } from './config.ts';
 
 const ListIndexSymbol = Symbol();
 
-type BlobRaw = GridFSFile & { metadata?: BlobMeta };
+type BlobRaw = GridFSFile & { metadata?: BinaryMetadata };
 
 type MongoTextSearch = RootFilterOperators<unknown>['$text'];
 
@@ -99,8 +98,12 @@ export class MongoModelService implements
     return files[0];
   }
 
-  async postConstruct(): Promise<void> {
-    this.client = await MongoClient.connect(this.config.url, this.config.connectionOptions);
+  @PostConstruct()
+  async initializeClient(): Promise<void> {
+    this.client = await MongoClient.connect(this.config.url, {
+      ...this.config.connectionOptions,
+      useBigInt64: true,
+    });
     this.#db = this.client.db(this.config.namespace);
     this.#bucket = new GridFSBucket(this.#db, {
       bucketName: ModelBlobNamespace,
@@ -284,14 +287,14 @@ export class MongoModelService implements
   }
 
   // Blob
-  async upsertBlob(location: string, input: BinaryInput, meta?: BlobMeta, overwrite = true): Promise<void> {
-    const existing = await this.getBlobMeta(location).then(() => true, () => false);
+  async upsertBlob(location: string, input: BinaryType, metadata?: BinaryMetadata, overwrite = true): Promise<void> {
+    const existing = await this.getBlobMetadata(location).then(() => true, () => false);
     if (!overwrite && existing) {
       return;
     }
-    const [stream, blobMeta] = await ModelBlobUtil.getInput(input, meta);
-    const writeStream = this.#bucket.openUploadStream(location, { metadata: blobMeta });
-    await pipeline(stream, writeStream);
+    const resolved = await BinaryMetadataUtil.compute(input, metadata);
+    const writeStream = this.#bucket.openUploadStream(location, { metadata: resolved });
+    await BinaryUtil.pipeline(input, writeStream);
 
     if (existing) {
       const [read] = await this.#bucket.find({ filename: location, _id: { $ne: writeStream.id } }).toArray();
@@ -300,14 +303,14 @@ export class MongoModelService implements
   }
 
   async getBlob(location: string, range?: ByteRange): Promise<Blob> {
-    const meta = await this.getBlobMeta(location);
-    const final = range ? ModelBlobUtil.enforceRange(range, meta.size!) : undefined;
+    const metadata = await this.getBlobMetadata(location);
+    const final = range ? BinaryMetadataUtil.enforceRange(range, metadata) : undefined;
     const mongoRange = final ? { start: final.start, end: final.end + 1 } : undefined;
-    return BinaryUtil.readableBlob(() => this.#bucket.openDownloadStreamByName(location, mongoRange), { ...meta, range: final });
+    return BinaryMetadataUtil.makeBlob(() => this.#bucket.openDownloadStreamByName(location, mongoRange), { ...metadata, range: final });
   }
 
-  async getBlobMeta(location: string): Promise<BlobMeta> {
-    const result = await this.#db.collection<{ metadata: BlobMeta }>(`${ModelBlobNamespace}.files`).findOne({ filename: location });
+  async getBlobMetadata(location: string): Promise<BinaryMetadata> {
+    const result = await this.#db.collection<{ metadata: BinaryMetadata }>(`${ModelBlobNamespace}.files`).findOne({ filename: location });
     return result!.metadata;
   }
 
@@ -316,10 +319,10 @@ export class MongoModelService implements
     await this.#bucket.delete(fileId);
   }
 
-  async updateBlobMeta(location: string, meta: BlobMeta): Promise<void> {
-    await this.#db.collection<{ metadata: BlobMeta }>(`${ModelBlobNamespace}.files`).findOneAndUpdate(
+  async updateBlobMetadata(location: string, metadata: BinaryMetadata): Promise<void> {
+    await this.#db.collection<{ metadata: BinaryMetadata }>(`${ModelBlobNamespace}.files`).findOneAndUpdate(
       { filename: location },
-      { $set: { metadata: meta, contentType: meta.contentType! } },
+      { $set: { metadata, contentType: metadata.contentType! } },
     );
   }