@travetto/model 4.1.2 → 4.1.4

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": "4.1.2",
+  "version": "4.1.4",
   "description": "Datastore abstraction for core operations.",
   "keywords": [
     "datastore",
@@ -26,14 +26,14 @@
     "directory": "module/model"
   },
   "dependencies": {
-    "@travetto/config": "^4.1.0",
-    "@travetto/di": "^4.1.0",
-    "@travetto/registry": "^4.1.0",
-    "@travetto/schema": "^4.1.0"
+    "@travetto/config": "^4.1.1",
+    "@travetto/di": "^4.1.1",
+    "@travetto/registry": "^4.1.1",
+    "@travetto/schema": "^4.1.1"
   },
   "peerDependencies": {
-    "@travetto/cli": "^4.1.0",
-    "@travetto/test": "^4.1.0"
+    "@travetto/cli": "^4.1.1",
+    "@travetto/test": "^4.1.1"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/internal/service/crud.ts

@@ -8,7 +8,7 @@ import { ModelIdSource, ModelType, OptionalId } from '../../types/model';
 import { NotFoundError } from '../../error/not-found';
 import { ExistsError } from '../../error/exists';
 import { SubTypeNotSupportedError } from '../../error/invalid-sub-type';
-import { DataHandler } from '../../registry/types';
+import { DataHandler, PrePersistScope } from '../../registry/types';
 
 export type ModelCrudProvider = {
   idSource: ModelIdSource;
@@ -72,7 +72,7 @@ export class ModelCrudUtil {
    * @param cls Type to store for
    * @param item Item to store
    */
-  static async preStore<T extends ModelType>(cls: Class<T>, item: Partial<OptionalId<T>>, provider: ModelCrudProvider): Promise<T> {
+  static async preStore<T extends ModelType>(cls: Class<T>, item: Partial<OptionalId<T>>, provider: ModelCrudProvider, scope: PrePersistScope = 'all'): Promise<T> {
     if (!item.id) {
       item.id = provider.idSource.create();
     }
@@ -88,7 +88,7 @@ export class ModelCrudUtil {
       SchemaRegistry.ensureInstanceTypeField(cls, item);
     }
 
-    item = await this.prePersist(cls, item);
+    item = await this.prePersist(cls, item, scope);
 
     let errors: ValidationError[] = [];
     try {
@@ -137,7 +137,7 @@ export class ModelCrudUtil {
 
     item = Object.assign(existing, item);
 
-    item = await this.prePersist(cls, item);
+    item = await this.prePersist(cls, item, 'partial');
 
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return item as T;
@@ -155,11 +155,14 @@ export class ModelCrudUtil {
   /**
    * Pre persist behavior
    */
-  static async prePersist<T>(cls: Class<T>, item: T): Promise<T> {
+  static async prePersist<T>(cls: Class<T>, item: T, scope: PrePersistScope): Promise<T> {
     const config = ModelRegistry.get(cls);
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    for (const handler of (config.prePersist ?? []) as unknown as DataHandler<T>[]) {
-      item = await handler(item) ?? item;
+    for (const state of (config.prePersist ?? [])) {
+      if (state.scope === scope || scope === 'all' || state.scope === 'all') {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        const handler = state.handler as unknown as DataHandler<T>;
+        item = await handler(item) ?? item;
+      }
     }
     if (typeof item === 'object' && item && 'prePersist' in item && typeof item['prePersist'] === 'function') {
       item = await item.prePersist() ?? item;

package/src/provider/file.ts

@@ -221,7 +221,17 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
 
   // Expiry
   async deleteExpired<T extends ModelType>(cls: Class<T>): Promise<number> {
-    return ModelExpiryUtil.naiveDeleteExpired(this, cls);
+    let deleted = 0;
+    for await (const [_id, file] of FileModelService.scanFolder(await this.#resolveName(cls, '.json'), '.json')) {
+      try {
+        const res = await ModelCrudUtil.load(cls, await fs.readFile(file));
+        if (ModelExpiryUtil.getExpiryState(cls, res).expired) {
+          await fs.rm(file, { force: true });
+          deleted += 1;
+        }
+      } catch { } // Don't let a single failure stop the process
+    }
+    return deleted;
   }
 
   // Storage management

package/src/provider/memory.ts

@@ -281,7 +281,18 @@ export class MemoryModelService implements ModelCrudSupport, ModelStreamSupport,
 
   // Expiry
   async deleteExpired<T extends ModelType>(cls: Class<T>): Promise<number> {
-    return ModelExpiryUtil.naiveDeleteExpired(this, cls);
+    const store = this.#getStore(cls);
+    let deleted = 0;
+    for (const key of [...store.keys()]) {
+      try {
+        const res = await ModelCrudUtil.load(cls, store.get(key)!);
+        if (ModelExpiryUtil.getExpiryState(cls, res).expired) {
+          store.delete(key);
+          deleted += 1;
+        }
+      } catch { } // Do not let a single error stop the process
+    }
+    return deleted;
   }
 
   // Storage Support

package/src/registry/decorator.ts

@@ -3,7 +3,7 @@ import { SchemaRegistry } from '@travetto/schema';
 
 import { ModelType } from '../types/model';
 import { ModelRegistry } from './model';
-import { DataHandler, IndexConfig, ModelOptions } from './types';
+import { DataHandler, IndexConfig, ModelOptions, PrePersistScope } from './types';
 
 /**
  * Model decorator, extends `@Schema`
@@ -45,27 +45,33 @@ export function ExpiresAt() {
 /**
  * Model class decorator for pre-persist behavior
  */
-export function PrePersist<T>(handler: DataHandler<T>) {
+export function PrePersist<T>(handler: DataHandler<T>, scope: PrePersistScope = 'all') {
   return function (tgt: Class<T>): void {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    ModelRegistry.registerDataHandlers(tgt, { prePersist: [handler as DataHandler] });
+    ModelRegistry.registerDataHandlers(tgt, {
+      prePersist: [{
+        scope,
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        handler: handler as DataHandler
+      }]
+    });
   };
 }
 
 /**
  * Model field decorator for pre-persist value setting
  */
-export function PersistValue<T>(handler: (curr: T | undefined) => T) {
+export function PersistValue<T>(handler: (curr: T | undefined) => T, scope: PrePersistScope = 'all') {
   return function <K extends string, C extends Partial<Record<K, T>>>(tgt: C, prop: K): void {
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     ModelRegistry.registerDataHandlers(tgt.constructor as Class<C>, {
-      prePersist: [
-        (inst): void => {
+      prePersist: [{
+        scope,
+        handler: (inst): void => {
           // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
           const cInst = (inst as unknown as Record<K, T>);
           cInst[prop] = handler(cInst[prop]);
         }
-      ]
+      }]
     });
   };
 }

package/src/registry/types.ts

@@ -23,6 +23,8 @@ type IndexClauseRaw<T> = {
 
 export type DataHandler<T = unknown> = (inst: T) => (Promise<T | void> | T | void);
 
+export type PrePersistScope = 'full' | 'partial' | 'all';
+
 /**
  * Model options
  */
@@ -62,7 +64,7 @@ export class ModelOptions<T extends ModelType = ModelType> {
   /**
    * Pre-persist handlers
    */
-  prePersist?: DataHandler<unknown>[];
+  prePersist?: { scope: PrePersistScope, handler: DataHandler<unknown> }[];
   /**
    * Post-load handlers
    */

package/support/test/crud.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert';
 
 import { Suite, Test } from '@travetto/test';
-import { Schema, Text, Precision, } from '@travetto/schema';
-import { ModelCrudSupport, Model, NotFoundError } from '@travetto/model';
+import { Schema, Text, Precision, Required, } from '@travetto/schema';
+import { ModelCrudSupport, Model, NotFoundError, PersistValue } from '@travetto/model';
 
 import { BaseModelSuite } from './base';
 
@@ -55,7 +55,14 @@ class User2 {
 @Model()
 class Dated {
   id: string;
-  time?: Date;
+
+  @PersistValue(v => v ?? new Date(), 'full')
+  @Required(false)
+  createdDate: Date;
+
+  @PersistValue(v => new Date())
+  @Required(false)
+  updatedDate: Date;
 }
 
 @Suite()
@@ -204,11 +211,29 @@ export abstract class ModelCrudSuite extends BaseModelSuite<ModelCrudSupport> {
   @Test('verify dates')
   async testDates() {
     const service = await this.service;
-    const res = await service.create(Dated, Dated.from({ time: new Date() }));
+    const res = await service.create(Dated, Dated.from({ createdDate: new Date() }));
+
+    assert(res.createdDate instanceof Date);
+  }
 
-    assert(res.time instanceof Date);
+  @Test('verify prepersist on create/update')
+  async testPrePersist() {
+    const service = await this.service;
+    const res = await service.create(Dated, Dated.from({}));
+    const created = res.createdDate;
+    assert(res.createdDate instanceof Date);
+    assert(res.updatedDate instanceof Date);
+
+    await new Promise(r => setTimeout(r, 100));
+
+    const final = await service.updatePartial(Dated, { id: res.id });
+    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;