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

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.3",
   "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.3",
+    "@travetto/config": "^7.0.0-rc.3",
+    "@travetto/model": "^7.0.0-rc.3",
+    "@travetto/model-query": "^7.0.0-rc.3",
     "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';
@@ -212,4 +213,33 @@ export class MongoUtil {
 
     return castTo(cursor);
   }
+
+  static isIndexChanged(existing: IndexDescriptionInfo, [pendingKey, pendingOptions]: [BasicIdx, CreateIndexesOptions]): boolean {
+    // Config changed
+    if (
+      !!existing.unique !== !!pendingOptions.unique ||
+      !!existing.sparse !== !!pendingOptions.sparse ||
+      existing.expireAfterSeconds !== pendingOptions.expireAfterSeconds ||
+      existing.bucketSize !== pendingOptions.bucketSize
+    ) {
+      return true;
+    }
+    const pendingKeySet = new Set(Object.keys(pendingKey));
+    const existingKeySet = new Set(Object.keys(existing.key));
+
+    if (pendingKeySet.size !== existingKeySet.size) {
+      return true;
+    }
+
+    const overlap = pendingKeySet.intersection(existingKeySet);
+    if (overlap.size !== pendingKeySet.size) {
+      return true;
+    }
+    for (const key of overlap) {
+      if (existing.key[key] !== pendingKey[key]) {
+        return false;
+      }
+    }
+    return false;
+  }
 }

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