@travetto/model-mongo 7.0.0-rc.2 → 7.0.0-rc.4

package/README.md

@@ -84,9 +84,9 @@ export class MongoModelConfig {
   options: mongo.MongoClientOptions = {};
 
   /**
-   * Should we auto create the db
+   * Allow storage modification at runtime
    */
-  autoCreate?: boolean;
+  modifyStorage?: boolean;
 
   /**
    * Frequency of culling for cullable content

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-mongo",
-  "version": "7.0.0-rc.2",
+  "version": "7.0.0-rc.4",
   "description": "Mongo backing for the travetto model module.",
   "keywords": [
     "mongo",
@@ -25,10 +25,10 @@
     "directory": "module/model-mongo"
   },
   "dependencies": {
-    "@travetto/cli": "^7.0.0-rc.2",
-    "@travetto/config": "^7.0.0-rc.2",
-    "@travetto/model": "^7.0.0-rc.2",
-    "@travetto/model-query": "^7.0.0-rc.2",
+    "@travetto/cli": "^7.0.0-rc.4",
+    "@travetto/config": "^7.0.0-rc.4",
+    "@travetto/model": "^7.0.0-rc.4",
+    "@travetto/model-query": "^7.0.0-rc.4",
     "mongodb": "^7.0.0"
   },
   "travetto": {

package/src/config.ts

@@ -43,9 +43,9 @@ export class MongoModelConfig {
   options: mongo.MongoClientOptions = {};
 
   /**
-   * Should we auto create the db
+   * Allow storage modification at runtime
    */
-  autoCreate?: boolean;
+  modifyStorage?: boolean;
 
   /**
    * Frequency of culling for cullable content

package/src/internal/util.ts

@@ -1,5 +1,6 @@
 import {
-  Binary, type CreateIndexesOptions, type Filter, type FindCursor, type IndexDirection, ObjectId, type WithId as MongoWithId
+  Binary, type CreateIndexesOptions, type Filter, type FindCursor, type IndexDirection, ObjectId, type WithId as MongoWithId,
+  type IndexDescriptionInfo
 } from 'mongodb';
 
 import { AppError, castTo, Class, toConcrete, TypedObject } from '@travetto/runtime';
@@ -31,6 +32,10 @@ export type PlainIdx = Record<string, -1 | 0 | 1>;
  */
 export class MongoUtil {
 
+  static namespaceIndex(cls: Class, name: string): string {
+    return `${cls.Ⲑid}__${name}`.replace(/[^a-zA-Z0-9_]+/g, '_');
+  }
+
   static toIndex<T extends ModelType>(field: IndexField<T>): PlainIdx {
     const keys = [];
     while (typeof field !== 'number' && typeof field !== 'boolean' && Object.keys(field)) {
@@ -149,24 +154,21 @@ export class MongoUtil {
     return out;
   }
 
-  static getExtraIndices<T extends ModelType>(cls: Class<T>): BasicIdx[] {
-    const out: BasicIdx[] = [];
+  static getExtraIndices<T extends ModelType>(cls: Class<T>): [BasicIdx, IdxConfig][] {
+    const out: [BasicIdx, IdxConfig][] = [];
     const textFields: string[] = [];
     SchemaRegistryIndex.visitFields(cls, (field, path) => {
       if (field.type === PointConcrete) {
         const name = [...path, field].map(schema => schema.name).join('.');
-        out.push({ [name]: '2d' });
+        out.push([{ [name]: '2d' }, { name: this.namespaceIndex(cls, name) }]);
       } else if (field.specifiers?.includes('text') && (field.specifiers?.includes('long') || field.specifiers.includes('search'))) {
         const name = [...path, field].map(schema => schema.name).join('.');
         textFields.push(name);
       }
     });
     if (textFields.length) {
-      const text: BasicIdx = {};
-      for (const field of textFields) {
-        text[field] = 'text';
-      }
-      out.push(text);
+      const text: BasicIdx = Object.fromEntries(textFields.map(field => [field, 'text']));
+      out.push([text, { name: this.namespaceIndex(cls, 'text_search') }]);
     }
     return out;
   }
@@ -181,8 +183,8 @@ export class MongoUtil {
 
   static getIndices<T extends ModelType>(cls: Class<T>, indices: IndexConfig<ModelType>[] = []): [BasicIdx, IdxConfig][] {
     return [
-      ...indices.map(idx => [this.getPlainIndex(idx), (idx.type === 'unique' ? { unique: true } : {})] as const),
-      ...this.getExtraIndices(cls).map((idx) => [idx, {}] as const)
+      ...indices.map(idx => [this.getPlainIndex(idx), { ...(idx.type === 'unique' ? { unique: true } : {}), name: this.namespaceIndex(cls, idx.name) }] as const),
+      ...this.getExtraIndices(cls)
     ].map(idx => [...idx]);
   }
 
@@ -212,4 +214,32 @@ export class MongoUtil {
 
     return castTo(cursor);
   }
+
+  static isIndexChanged(existing: IndexDescriptionInfo, [pendingKey, pendingOptions]: [BasicIdx, CreateIndexesOptions]): boolean {
+    let changed = false;
+    // Config changed
+    changed ||=
+      !!existing.unique !== !!pendingOptions.unique ||
+      !!existing.sparse !== !!pendingOptions.sparse ||
+      existing.expireAfterSeconds !== pendingOptions.expireAfterSeconds ||
+      existing.bucketSize !== pendingOptions.bucketSize;
+
+    const existingFields = existing.textIndexVersion ?
+      Object.fromEntries(Object.entries(existing.weights ?? {}).map(([key]) => [key, 'text'])) :
+      existing.key;
+
+    const pendingKeySet = new Set(Object.keys(pendingKey));
+    const existingKeySet = new Set(Object.keys(existingFields));
+
+    changed ||= pendingKeySet.size !== existingKeySet.size;
+
+    const overlap = [...pendingKeySet.intersection(existingKeySet)];
+    changed ||= overlap.length !== pendingKeySet.size;
+
+    for (let i = 0; i < overlap.length && !changed; i++) {
+      changed ||= existingFields[overlap[i]] !== pendingKey[overlap[i]];
+    }
+
+    return changed;
+  }
 }

package/src/service.ts

@@ -3,7 +3,7 @@ import { pipeline } from 'node:stream/promises';
 import {
   type Db, GridFSBucket, MongoClient, type GridFSFile, type Collection,
   type ObjectId, type Binary, type RootFilterOperators, type Filter,
-  type WithId as MongoWithId
+  type WithId as MongoWithId,
 } from 'mongodb';
 
 import {
@@ -106,7 +106,7 @@ export class MongoModelService implements
       bucketName: ModelBlobNamespace,
       writeConcern: { w: 1 }
     });
-    await ModelStorageUtil.registerModelChangeListener(this);
+    await ModelStorageUtil.storageInitialization(this);
     ShutdownManager.onGracefulShutdown(() => this.client.close());
     ModelExpiryUtil.registerCull(this);
   }
@@ -126,23 +126,34 @@ export class MongoModelService implements
     await this.#db.dropDatabase();
   }
 
-  async establishIndices<T extends ModelType>(cls: Class<T>): Promise<void> {
+  async upsertModel(cls: Class): Promise<void> {
     const col = await this.getStore(cls);
-    const creating = MongoUtil.getIndices(cls, ModelRegistryIndex.getConfig(cls).indices);
-    if (creating.length) {
-      console.debug('Creating indexes', { indices: creating });
-      for (const toCreate of creating) {
-        await col.createIndex(...toCreate);
-      }
-    }
-  }
+    const indices = MongoUtil.getIndices(cls, ModelRegistryIndex.getConfig(cls).indices);
+    const existingIndices = (await col.indexes().catch(() => [])).filter(idx => idx.name !== '_id_');
 
-  async createModel(cls: Class): Promise<void> {
-    await this.establishIndices(cls);
-  }
+    const pendingMap = Object.fromEntries(indices.map(pair => [pair[1].name!, pair]));
+    const existingMap = Object.fromEntries(existingIndices.map(idx => [idx.name!, idx.key]));
 
-  async changeModel(cls: Class): Promise<void> {
-    await this.establishIndices(cls);
+    for (const idx of existingIndices) {
+      if (!idx.name) {
+        continue;
+      }
+      const pending = pendingMap[idx.name];
+      if (!pending) {
+        console.debug('Deleting index', { indices: idx.name });
+        await col.dropIndex(idx.name);
+      } else if (MongoUtil.isIndexChanged(idx, pending)) {
+        console.debug('Updating index', { indices: idx.name });
+        await col.dropIndex(idx.name);
+        await col.createIndex(...pending);
+      }
+    }
+    for (const [name, idx] of Object.entries(pendingMap)) {
+      if (!existingMap[name]) {
+        console.debug('Creating index', { indices: name });
+        await col.createIndex(...idx);
+      }
+    }
   }
 
   async truncateModel<T extends ModelType>(cls: Class<T>): Promise<void> {
@@ -158,7 +169,7 @@ export class MongoModelService implements
    * Get mongo collection
    */
   async getStore<T extends ModelType>(cls: Class<T>): Promise<Collection<T>> {
-    return this.#db.collection(ModelRegistryIndex.getStoreName(cls).toLowerCase().replace(/[^A-Za-z0-9_]+/g, '_'));
+    return this.#db.collection(ModelRegistryIndex.getStoreName(cls));
   }
 
   // Crud