@travetto/model-query 5.0.4 → 5.0.6

package/README.md

@@ -33,7 +33,7 @@ export interface ModelQuerySupport {
    * Find one by query, fail if not found
    * @param cls The model class
    * @param query The query to search for
-   * @param failOnMany Should the query fail on more than one result found
+   * @param failOnMany Should the query fail on more than one result found, defaults to true
    */
   queryOne<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, failOnMany?: boolean): Promise<T>;
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-query",
-  "version": "5.0.4",
+  "version": "5.0.6",
   "description": "Datastore abstraction for advanced query support.",
   "keywords": [
     "datastore",
@@ -26,12 +26,12 @@
     "directory": "module/model-query"
   },
   "dependencies": {
-    "@travetto/di": "^5.0.4",
-    "@travetto/model": "^5.0.4",
-    "@travetto/schema": "^5.0.4"
+    "@travetto/di": "^5.0.6",
+    "@travetto/model": "^5.0.6",
+    "@travetto/schema": "^5.0.6"
   },
   "peerDependencies": {
-    "@travetto/test": "^5.0.4"
+    "@travetto/test": "^5.0.6"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/internal/service/query.ts

@@ -26,12 +26,13 @@ export class ModelQueryUtil {
   /**
    * Verify result set is singular, and decide if failing on many should happen
    */
-  static verifyGetSingleCounts<T>(cls: Class<T>, res?: T[], failOnMany = true): T {
+  static verifyGetSingleCounts<T extends ModelType>(cls: Class<T>, failOnMany: boolean, res?: T[], where?: WhereClause<T>): T {
     res = res ?? [];
     if (res.length === 1 || res.length > 1 && !failOnMany) {
       return res[0]!;
     }
-    throw res.length === 0 ? new NotFoundError(cls, 'none') : new AppError(`Invalid number of results for find by id: ${res.length}`, 'data');
+    const requestedId = ((where && 'id' in where && typeof where.id === 'string') ? where.id : undefined) ?? 'unknown';
+    throw res.length === 0 ? new NotFoundError(cls, requestedId, { where }) : new AppError(`Invalid number of results for find by id: ${res.length}`, 'data');
   }
 
   /**

package/src/service/query.ts

@@ -18,7 +18,7 @@ export interface ModelQuerySupport {
    * Find one by query, fail if not found
    * @param cls The model class
    * @param query The query to search for
-   * @param failOnMany Should the query fail on more than one result found
+   * @param failOnMany Should the query fail on more than one result found, defaults to true
    */
   queryOne<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, failOnMany?: boolean): Promise<T>;
   /**

package/support/test/query.ts

@@ -4,6 +4,7 @@ import { Suite, Test } from '@travetto/test';
 import { BaseModelSuite } from '@travetto/model/support/test/base';
 import { ModelCrudSupport } from '@travetto/model/src/service/crud';
 import { TimeUtil } from '@travetto/runtime';
+import { NotFoundError } from '@travetto/model';
 
 import { Aged, Location, Names, Note, Person, SimpleList, WithNestedLists, WithNestedNestedLists } from './types';
 
@@ -37,6 +38,33 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
     assert(results3.length === 0);
   }
 
+
+  @Test('verify query one behavior')
+  async testQueryOne() {
+    const service = await this.service;
+    await this.saveAll(Person, [1, 2, 3, 8].map(x => Person.from({
+      name: 'Bob Omber',
+      age: 20 + x,
+      gender: 'm',
+      address: {
+        street1: 'a',
+        ...(x === 1 ? { street2: 'b' } : {})
+      }
+    })));
+
+    await assert.rejects(() => service.queryOne(Person, { where: { gender: 'm' } }), /Invalid number of results/);
+    await assert.rejects(() => service.queryOne(Person, { where: { gender: 'z' } }), NotFoundError);
+    await assert.rejects(() => service.queryOne(Person, { where: { gender: 'z' } }), /unknown/);
+    assert.deepStrictEqual(
+      (await service.queryOne(Person, { where: { gender: 'z' } }).catch(e => e)).details.where,
+      {
+        gender: 'z'
+      }
+    );
+    await assert.rejects(() => service.queryOne(Person, { where: { id: 'orange' } }), NotFoundError);
+    await assert.rejects(() => service.queryOne(Person, { where: { id: 'orange' } }), /orange/);
+  }
+
   @Test('Verify array $in queries work properly')
   async testArrayContains() {
     const svc = await this.service;