@travetto/model 5.0.14 → 5.0.16

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 ArcSine Technologies
+Copyright (c) 2020 ArcSine Technologies
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model",
-  "version": "5.0.14",
+  "version": "5.0.16",
   "description": "Datastore abstraction for core operations.",
   "keywords": [
     "datastore",
@@ -26,14 +26,14 @@
     "directory": "module/model"
   },
   "dependencies": {
-    "@travetto/config": "^5.0.13",
-    "@travetto/di": "^5.0.13",
-    "@travetto/registry": "^5.0.13",
-    "@travetto/schema": "^5.0.13"
+    "@travetto/config": "^5.0.15",
+    "@travetto/di": "^5.0.15",
+    "@travetto/registry": "^5.0.15",
+    "@travetto/schema": "^5.0.15"
   },
   "peerDependencies": {
-    "@travetto/cli": "^5.0.16",
-    "@travetto/test": "^5.0.15"
+    "@travetto/cli": "^5.0.18",
+    "@travetto/test": "^5.0.17"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/error/not-found.ts

@@ -4,7 +4,7 @@ import { Class, AppError } from '@travetto/runtime';
  * Represents when a model of cls and id cannot be found
  */
 export class NotFoundError extends AppError {
-  constructor(cls: Class | string, id: string, details?: Record<string, unknown>) {
+  constructor(cls: Class | string, id: string, details: Record<string, unknown> = {}) {
     super(`${typeof cls === 'string' ? cls : cls.name} with id ${id} not found`, { category: 'notfound', details });
   }
 }

package/src/internal/service/crud.ts

@@ -142,6 +142,13 @@ export class ModelCrudUtil {
     if (!DataUtil.isPlainObject(item)) {
       throw new AppError(`A partial update requires a plain object, not an instance of ${castTo<Function>(item).constructor.name}`, { category: 'data' });
     }
+    const keys = Object.keys(item);
+    if ((keys.length === 1 && item.id) || keys.length === 0) {
+      throw new AppError('No fields to update');
+    } else {
+      item = { ...item };
+      delete item.id;
+    }
     const res = await this.prePersist(cls, castTo(item), 'partial');
     await SchemaValidator.validatePartial(cls, item, view);
     return res;

package/src/internal/service/expiry.ts

@@ -3,7 +3,6 @@ import { ShutdownManager, Class, TimeSpan, TimeUtil, Util, castTo } from '@trave
 import { ModelRegistry } from '../../registry/model';
 import { ModelExpirySupport } from '../../service/expiry';
 import { ModelType } from '../../types/model';
-import { NotFoundError } from '../../error/not-found';
 
 /**
  * Utils for model expiry
@@ -44,22 +43,4 @@ export class ModelExpiryUtil {
       })();
     }
   }
-
-  /**
-   * Simple cull operation for a given model type
-   * @param svc
-   */
-  static async naiveDeleteExpired<T extends ModelType>(svc: ModelExpirySupport, cls: Class<T>, suppressErrors = false): Promise<number> {
-    const deleting = [];
-    for await (const el of svc.list(cls)) {
-      if (this.getExpiryState(cls, el).expired) {
-        deleting.push(svc.delete(cls, el.id).catch(err => {
-          if (!suppressErrors && !(err instanceof NotFoundError)) {
-            throw err;
-          }
-        }));
-      }
-    }
-    return (await Promise.all(deleting)).length;
-  }
 }

package/src/internal/service/indexed.ts

@@ -17,6 +17,8 @@ type ComputeConfig = {
 type IndexFieldPart = { path: string[], value: (string | boolean | Date | number) };
 type IndexSortPart = { path: string[], dir: number, value: number | Date };
 
+const DEFAULT_SEP = '\u8203';
+
 /**
  * Utils for working with indexed model services
  */
@@ -107,7 +109,7 @@ export class ModelIndexedUtil {
     opts?: ComputeConfig & { sep?: string }
   ): { type: string, key: string, sort?: number | Date } {
     const { fields, sorted } = this.computeIndexParts(cls, idx, item, { ...(opts ?? {}), includeSortInFields: false });
-    const key = fields.map(({ value }) => value).map(x => `${x}`).join(opts?.sep ?? 'Ⲑ');
+    const key = fields.map(({ value }) => value).map(x => `${x}`).join(opts?.sep ?? DEFAULT_SEP);
     const cfg = typeof idx === 'string' ? ModelRegistry.getIndex(cls, idx) : idx;
     return !sorted ? { type: cfg.type, key } : { type: cfg.type, key, sort: sorted.value };
   }

package/src/registry/decorator.ts

@@ -1,4 +1,4 @@
-import { asConstructable, castTo, Class } from '@travetto/runtime';
+import { AppError, asConstructable, castTo, Class } from '@travetto/runtime';
 import { SchemaRegistry } from '@travetto/schema';
 
 import { ModelType } from '../types/model';
@@ -25,6 +25,9 @@ export function Model(conf: Partial<ModelOptions<ModelType>> | string = {}) {
  * Defines an index on a model
  */
 export function Index<T extends ModelType>(...indices: IndexConfig<T>[]) {
+  if (indices.some(x => x.fields.some(f => f === 'id'))) {
+    throw new AppError('Cannot create an index with the id field');
+  }
   return function (target: Class<T>): void {
     ModelRegistry.getOrCreatePending(target).indices!.push(...indices);
   };
@@ -71,7 +74,6 @@ export function PersistValue<T>(handler: (curr: T | undefined) => T, scope: PreP
   };
 }
 
-
 /**
  * Model class decorator for post-load behavior
  */

package/src/registry/model.ts

@@ -2,7 +2,7 @@ import { SchemaRegistry } from '@travetto/schema';
 import { MetadataRegistry } from '@travetto/registry';
 import { DependencyRegistry } from '@travetto/di';
 import { AppError, castTo, Class, describeFunction, asFull } from '@travetto/runtime';
-import { AllViewⲐ } from '@travetto/schema/src/internal/types';
+import { AllViewSymbol } from '@travetto/schema/src/internal/types';
 
 import { IndexConfig, IndexType, ModelOptions } from './types';
 import { NotFoundError } from '../error/not-found';
@@ -74,7 +74,7 @@ class $ModelRegistry extends MetadataRegistry<ModelOptions<ModelType>> {
     const config = asFull(this.pending.get(cls.Ⲑid)!);
 
     const schema = SchemaRegistry.get(cls);
-    const view = schema.views[AllViewⲐ].schema;
+    const view = schema.views[AllViewSymbol].schema;
     delete view.id.required; // Allow ids to be optional
 
     if (schema.subTypeField in view && this.getBaseModel(cls) !== cls) {

package/support/test/basic.ts

@@ -44,7 +44,6 @@ export abstract class ModelBasicSuite extends BaseModelSuite<ModelCrudSupport> {
     }, NotFoundError);
   }
 
-
   @Test('create, read, delete')
   async createRaw() {
     const service = await this.service;

package/support/test/blob.ts

@@ -119,7 +119,6 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
     await assert.rejects(() => service.getBlob(id, { start: 30, end: 37 }));
   }
 
-
   @Test()
   async writeAndGet() {
     const service = await this.service;
@@ -134,7 +133,6 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
     assert(undefined === savedMeta.hash);
   }
 
-
   @Test()
   async metadataUpdate() {
     const service = await this.service;
@@ -153,13 +151,11 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
     assert(undefined === savedMeta.hash);
   }
 
-
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
   @Test({ skip: (x: unknown) => !(x as ModelBlobSuite).serviceClass.prototype.getBlobWriteUrl })
   async signedUrl() {
     const service = await this.service;
 
-
     const buffer = Buffer.alloc(1.5 * 10000);
     for (let i = 0; i < buffer.length; i++) {
       buffer.writeUInt8(Math.trunc(Math.random() * 255), i);

package/support/test/crud.ts

@@ -34,7 +34,6 @@ class SimpleItem {
   name: string;
 }
 
-
 @Model()
 class SimpleList {
   id: string;
@@ -57,6 +56,8 @@ class User2 {
 class Dated {
   id: string;
 
+  value?: string;
+
   @PersistValue(v => v ?? new Date(), 'full')
   @Required(false)
   createdDate: Date;
@@ -154,7 +155,7 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
   @Test('Verify update partial on missing item fails')
   async testMissingUpdatePartial() {
     const service = await this.service;
-    await assert.rejects(() => service.updatePartial(User2, { id: '-1' }), NotFoundError);
+    await assert.rejects(() => service.updatePartial(User2, { id: '-1', name: 'bob' }), NotFoundError);
   }
 
   @Test('Verify partial update with field removal and lists')
@@ -227,14 +228,13 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
 
     await timers.setTimeout(100);
 
-    const final = await service.updatePartial(Dated, { id: res.id });
+    const final = await service.updatePartial(Dated, { id: res.id, value: 'random' });
     assert(final.createdDate instanceof Date);
     assert(final.createdDate.getTime() === created?.getTime());
     assert(final.updatedDate instanceof Date);
     assert(final.createdDate.getTime() < final.updatedDate?.getTime());
   }
 
-
   @Test('verify list')
   async list() {
     const service = await this.service;
@@ -282,7 +282,6 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
     assert(single.age === 23);
   }
 
-
   @Test('Verify update')
   async testRawUpdate() {
     const service = await this.service;

package/support/test/expiry.ts

@@ -11,10 +11,11 @@ import { NotFoundError } from '../../src/error/not-found';
 import { BaseModelSuite } from './base';
 
 @Model('expiry-user')
-class User {
+export class ExpiryUser {
   id: string;
   @ExpiresAt()
   expiresAt?: Date;
+  payload?: string;
 }
 
 @Suite()
@@ -33,63 +34,63 @@ export abstract class ModelExpirySuite extends BaseModelSuite<ModelExpirySupport
   @Test()
   async basic() {
     const service = await this.service;
-    const res = await service.upsert(User, User.from({
+    const res = await service.upsert(ExpiryUser, ExpiryUser.from({
       expiresAt: this.timeFromNow('2s')
     }));
-    assert(res instanceof User);
+    assert(res instanceof ExpiryUser);
 
-    const expiry = ModelExpiryUtil.getExpiryState(User, await service.get(User, res.id));
+    const expiry = ModelExpiryUtil.getExpiryState(ExpiryUser, await service.get(ExpiryUser, res.id));
     assert(!expiry.expired);
   }
 
   @Test()
   async aging() {
     const service = await this.service;
-    const res = await service.upsert(User, User.from({
+    const res = await service.upsert(ExpiryUser, ExpiryUser.from({
       expiresAt: this.timeFromNow(100)
     }));
 
-    assert(res instanceof User);
+    assert(res instanceof ExpiryUser);
 
     await this.wait(200);
 
-    await assert.rejects(() => service.get(User, res.id), NotFoundError);
+    await assert.rejects(() => service.get(ExpiryUser, res.id), NotFoundError);
   }
 
   @Test()
   async updateExpired() {
     const service = await this.service;
-    const res = await service.upsert(User, User.from({
+    const res = await service.upsert(ExpiryUser, ExpiryUser.from({
       expiresAt: this.timeFromNow(100)
     }));
 
-    assert(res instanceof User);
+    assert(res instanceof ExpiryUser);
 
     await this.wait(200);
 
-    await assert.rejects(() => service.update(User, User.from({ id: res.id })), NotFoundError);
+    await assert.rejects(() => service.update(ExpiryUser, ExpiryUser.from({ id: res.id })), NotFoundError);
   }
 
   @Test()
   async ageWithExtension() {
     const service = await this.service;
-    const res = await service.upsert(User, User.from({
+    const res = await service.upsert(ExpiryUser, ExpiryUser.from({
       expiresAt: this.timeFromNow('2s')
     }));
-    assert(res instanceof User);
+    assert(res instanceof ExpiryUser);
 
     await this.wait(50);
 
-    assert(!ModelExpiryUtil.getExpiryState(User, (await service.get(User, res.id))).expired);
+    assert(!ModelExpiryUtil.getExpiryState(ExpiryUser, (await service.get(ExpiryUser, res.id))).expired);
 
-    await service.updatePartial(User, {
+    await service.updatePartial(ExpiryUser, {
       id: res.id,
       expiresAt: this.timeFromNow(100)
     });
 
     await this.wait(200);
 
-    await assert.rejects(() => service.get(User, res.id), NotFoundError);
+    await assert.rejects(() => service.get(ExpiryUser, res.id), NotFoundError);
   }
 
   @Test()
@@ -98,29 +99,29 @@ export abstract class ModelExpirySuite extends BaseModelSuite<ModelExpirySupport
 
     let total;
 
-    total = await this.getSize(User);
+    total = await this.getSize(ExpiryUser);
     assert(total === 0);
 
     // Create
     await Promise.all(
-      Array(10).fill(0).map((x, i) => service.upsert(User, User.from({
-        expiresAt: this.timeFromNow(1000 + i * this.delayFactor)
+      Array(10).fill(0).map((x, i) => service.upsert(ExpiryUser, ExpiryUser.from({
+        expiresAt: this.timeFromNow(300 + i * this.delayFactor)
       })))
     );
 
     // Let expire
     await this.wait(1);
 
-    total = await this.getSize(User);
+    total = await this.getSize(ExpiryUser);
     assert(total === 10);
 
     // Let expire
-    await this.wait(1100);
+    await this.wait(400);
 
-    total = await this.getSize(User);
+    total = await this.getSize(ExpiryUser);
     assert(total === 0);
 
-    total = await this.getSize(User);
+    total = await this.getSize(ExpiryUser);
     assert(total === 0);
   }
 }

package/support/test/indexed.ts

@@ -111,7 +111,6 @@ export abstract class ModelIndexedSuite extends BaseModelSuite<ModelIndexedSuppo
     await assert.rejects(() => service.getByIndex(User3, 'userAge', { name: 'bob' }));
   }
 
-
   @Test()
   async queryList() {
     const service = await this.service;

package/support/test/suite.ts

@@ -51,23 +51,15 @@ export function ModelSuite<T extends { configClass: Class<{ autoCreate?: boolean
       async function (this: T) {
         const service = await DependencyRegistry.getInstance(this.serviceClass, qualifier);
         if (isStorageSupported(service)) {
-          if (service.truncateModel || service.deleteModel) {
-            for (const m of ModelRegistry.getClasses()) {
-              if (m === ModelRegistry.getBaseModel(m)) {
-                if (service.truncateModel) {
-                  await service.truncateModel(m);
-                } else if (service.deleteModel) {
-                  await service.deleteModel(m);
-                }
-              }
-            }
-            if (isBlobSupported(service)) {
-              if (service.truncateModel) {
-                await service.truncateModel(MODEL_BLOB);
-              } else if (service.deleteModel) {
-                await service.deleteModel(MODEL_BLOB);
-              }
-            }
+          const models = ModelRegistry.getClasses().filter(m => m === ModelRegistry.getBaseModel(m));
+          if (isBlobSupported(service)) {
+            models.push(MODEL_BLOB);
+          }
+
+          if (service.truncateModel) {
+            await Promise.all(models.map(x => service.truncateModel!(x)));
+          } else if (service.deleteModel) {
+            await Promise.all(models.map(x => service.deleteModel!(x)));
           } else {
             await service.deleteStorage(); // Purge it all
           }