@travetto/model-query 3.1.3 → 3.1.5

package/README.md

@@ -51,6 +51,13 @@ Reinforcing the complexity provided in these contracts, the [Query Crud](https:/
 **Code: Query Crud**
 ```typescript
 export interface ModelQueryCrudSupport extends ModelCrudSupport, ModelQuerySupport {
+  /**
+   * A standard update operation, but ensures the data matches the query before the update is finalized
+   * @param cls The model class
+   * @param data The data
+   * @param query The additional query to validate
+  */
+  updateOneWithQuery<T extends ModelType>(cls: Class<T>, data: T, query: ModelQuery<T>): Promise<T>;
   /**
    * Update/replace all with partial data, by query
    * @param cls The model class

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-query",
-  "version": "3.1.3",
+  "version": "3.1.5",
   "description": "Datastore abstraction for advanced query support.",
   "keywords": [
     "datastore",
@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@travetto/di": "^3.1.1",
-    "@travetto/model": "^3.1.5",
+    "@travetto/model": "^3.1.7",
     "@travetto/schema": "^3.1.2"
   },
   "peerDependencies": {

package/src/internal/service/query.ts

@@ -78,4 +78,19 @@ export class ModelQueryUtil {
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return query as U & { where: WhereClause<T> };
   }
+
+  /**
+   * Get query with an id enforced
+   */
+  static getQueryWithId<T extends ModelType, U extends Query<T> | ModelQuery<T>>(
+    cls: Class<T>,
+    item: T,
+    query: U
+  ): U & { where: WhereClause<T> & { id: string } } {
+    query.where = this.getWhereClause(cls, query.where);
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    (query.where as WhereClauseRaw<ModelType>).id = item.id;
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    return query as U & { where: WhereClause<T> & { id: string } };
+  }
 }

package/src/service/crud.ts

@@ -9,6 +9,13 @@ import { ModelQuery } from '../model/query';
  * @concrete ../internal/service/common:ModelQueryCrudSupportTarget
  */
 export interface ModelQueryCrudSupport extends ModelCrudSupport, ModelQuerySupport {
+  /**
+   * A standard update operation, but ensures the data matches the query before the update is finalized
+   * @param cls The model class
+   * @param data The data
+   * @param query The additional query to validate
+  */
+  updateOneWithQuery<T extends ModelType>(cls: Class<T>, data: T, query: ModelQuery<T>): Promise<T>;
   /**
    * Update/replace all with partial data, by query
    * @param cls The model class

package/support/test/crud.ts

@@ -3,12 +3,92 @@ import assert from 'assert';
 import { Suite, Test } from '@travetto/test';
 import { BaseModelSuite } from '@travetto/model/support/test/base';
 import { ModelCrudSupport } from '@travetto/model/src/service/crud';
+import { NotFoundError } from '@travetto/model';
 
-import { Address, Person } from './types';
+import { Address, Person, Todo } from './types';
 import { ModelQueryCrudSupport } from '../../src/service/crud';
 
 @Suite()
 export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudSupport & ModelCrudSupport> {
+  @Test()
+  async testUpdateOneWithQuery() {
+    const svc = await this.service;
+
+    const todo1 = await svc.create(Todo, Todo.from({ text: 'bob' }));
+
+    assert(todo1.id);
+    assert(todo1.version === 0);
+
+    const todo1v2 = await svc.updateOneWithQuery(Todo, Todo.from({
+      id: todo1.id,
+      text: `${todo1.text}!!`,
+      version: todo1.version + 1
+    }), { where: { id: todo1.id, version: todo1.version } },);
+
+    assert(todo1v2.id === todo1.id);
+    assert(todo1v2.version > todo1.version);
+
+    await assert.rejects(
+      () => svc.updateOneWithQuery(Todo, Todo.from({
+        id: todo1.id,
+        text: `${todo1.text}!!`,
+        version: todo1.version + 1
+      }), { where: { id: todo1.id, version: todo1.version } }),
+      NotFoundError
+    );
+
+
+    const todo2 = await svc.create(Todo, Todo.from({ text: 'bob2' }));
+
+    const result = await svc.updateOneWithQuery(Todo, Todo.from({
+      id: todo2.id,
+      text: `${todo1.text}!!`,
+      version: todo1.version + 1
+    }), { where: { id: todo2.id, text: 'bob2' } });
+
+    assert(result.id === todo2.id);
+  }
+
+  @Test()
+  async testUpdateOneWithQueryMultiple() {
+    const svc = await this.service;
+
+    const todo1 = await svc.create(Todo, Todo.from({ text: 'bob', version: 1 }));
+
+    assert(todo1.id);
+    assert(todo1.version === 1);
+
+    const todo1v = ['a', 'b', 'c', 'd', 'e'].map(x => Todo.from({ ...todo1, text: `${todo1.text}-${x}`, version: todo1.version + 1 }));
+
+    const promises = todo1v.map(x => svc.updateOneWithQuery(Todo, x, { where: { version: todo1.version } }));
+
+    const results = await Promise.allSettled(promises);
+    const rejected = results.filter((x): x is PromiseRejectedResult => x.status === 'rejected');
+    const fulfilled = results.filter((x): x is PromiseFulfilledResult<Todo> => x.status === 'fulfilled');
+
+    for (const el of rejected) {
+      assert(el.reason instanceof NotFoundError);
+    }
+    assert(fulfilled.length === 1);
+    assert(rejected.length === todo1v.length - 1);
+
+    const succeeded = fulfilled[0];
+    assert(succeeded.value.id === todo1.id);
+    assert(succeeded.value.version === todo1.version + 1);
+    assert(succeeded.value.text !== todo1.text);
+
+    const todo2 = await svc.get(Todo, todo1.id);
+    assert.deepStrictEqual(todo2, succeeded.value);
+
+    const promises2 = ['a', 'b', 'c', 'd', 'e'].map(x => Todo.from({ ...todo2, text: `${todo2.text}-${x}`, version: todo2.version + 2 }));
+    const results2 = await Promise.allSettled(promises2.map(x => svc.updateOneWithQuery(Todo, x, { where: { version: todo2.version + 1 } })));
+    for (const el of results2) {
+      assert(el.status === 'rejected');
+      assert(el.reason instanceof NotFoundError);
+    }
+  }
+
+
   @Test()
   async testDeleteByQuery() {
     const svc = await this.service;

package/support/test/types.ts

@@ -9,6 +9,13 @@ export class Address {
   @Text() street2?: string;
 }
 
+@Model('query-todo-version')
+export class Todo {
+  version = 0;
+  id: string;
+  @Text() text: string;
+}
+
 @Model('query-person')
 export class Person {
   id: string;