@travetto/model-elasticsearch 5.0.0-rc.1 → 5.0.0-rc.11

package/README.md

@@ -13,7 +13,7 @@ npm install @travetto/model-elasticsearch
 yarn add @travetto/model-elasticsearch
 ```
 
-This module provides an [elasticsearch](https://elastic.co)-based implementation of the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.").  This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and query against [elasticsearch](https://elastic.co). In development mode, [ElasticsearchModelService](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch/src/service.ts#L43) will also modify the [elasticsearch](https://elastic.co) schema in real time to minimize impact to development. 
+This module provides an [elasticsearch](https://elastic.co)-based implementation of the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.").  This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and query against [elasticsearch](https://elastic.co). In development mode, [ElasticsearchModelService](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch/src/service.ts#L42) will also modify the [elasticsearch](https://elastic.co) schema in real time to minimize impact to development. 
 
 Supported features:
    *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/crud.ts#L11)
@@ -45,7 +45,7 @@ where the [ElasticsearchModelConfig](https://github.com/travetto/travetto/tree/m
 
 **Code: Structure of ElasticsearchModelConfig**
 ```typescript
-import { TimeSpan } from '@travetto/base';
+import { TimeSpan } from '@travetto/runtime';
 import { Config } from '@travetto/config';
 import { Field } from '@travetto/schema';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-elasticsearch",
-  "version": "5.0.0-rc.1",
+  "version": "5.0.0-rc.11",
   "description": "Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.",
   "keywords": [
     "elasticsearch",
@@ -27,13 +27,13 @@
     "directory": "module/model-elasticsearch"
   },
   "dependencies": {
-    "@elastic/elasticsearch": "^8.14.0",
-    "@travetto/config": "^5.0.0-rc.1",
-    "@travetto/model": "^5.0.0-rc.1",
-    "@travetto/model-query": "^5.0.0-rc.1"
+    "@elastic/elasticsearch": "^8.15.0",
+    "@travetto/config": "^5.0.0-rc.11",
+    "@travetto/model": "^5.0.0-rc.11",
+    "@travetto/model-query": "^5.0.0-rc.11"
   },
   "peerDependencies": {
-    "@travetto/command": "^5.0.0-rc.1"
+    "@travetto/command": "^5.0.0-rc.10"
   },
   "peerDependenciesMeta": {
     "@travetto/command": {

package/src/config.ts

@@ -1,4 +1,4 @@
-import { TimeSpan } from '@travetto/base';
+import { TimeSpan } from '@travetto/runtime';
 import { Config } from '@travetto/config';
 import { Field } from '@travetto/schema';
 

package/src/index-manager.ts

@@ -1,7 +1,7 @@
 import { Client } from '@elastic/elasticsearch';
 import { ReindexRequest } from '@elastic/elasticsearch/lib/api/types';
 
-import { Class } from '@travetto/base';
+import { Class } from '@travetto/runtime';
 import { ModelRegistry, ModelType } from '@travetto/model';
 import { ModelStorageSupport } from '@travetto/model/src/service/storage';
 import { SchemaChange } from '@travetto/schema';

package/src/internal/query.ts

@@ -1,9 +1,7 @@
-import { QueryDslQueryContainer, SearchRequest, SearchResponse, Sort, SortOptions } from '@elastic/elasticsearch/lib/api/types';
+import { DeleteByQueryRequest, QueryDslQueryContainer, SearchRequest, SearchResponse, Sort, SortOptions } from '@elastic/elasticsearch/lib/api/types';
 
-import { Class } from '@travetto/base';
+import { castTo, Class, TypedObject } from '@travetto/runtime';
 import { WhereClause, SelectClause, SortClause, Query } from '@travetto/model-query';
-import { QueryLanguageParser } from '@travetto/model-query/src/internal/query/parser';
-import { QueryVerifier } from '@travetto/model-query/src/internal/query/verifier';
 import { ModelQueryUtil } from '@travetto/model-query/src/internal/service/query';
 import { ModelRegistry } from '@travetto/model/src/registry/model';
 import { IndexConfig } from '@travetto/model/src/registry/types';
@@ -12,13 +10,6 @@ import { DataUtil, SchemaRegistry } from '@travetto/schema';
 
 import { EsSchemaConfig } from './types';
 
-// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-const has$And = (o: unknown): o is ({ $and: WhereClause<unknown>[] }) => !!o && '$and' in (o as object);
-// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-const has$Or = (o: unknown): o is ({ $or: WhereClause<unknown>[] }) => !!o && '$or' in (o as object);
-// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-const has$Not = (o: unknown): o is ({ $not: WhereClause<unknown> }) => !!o && '$not' in (o as object);
-
 /**
  * Support tools for dealing with elasticsearch specific requirements
  */
@@ -29,16 +20,13 @@ export class ElasticsearchQueryUtil {
    */
   static extractSimple<T>(o: T, path: string = ''): Record<string, unknown> {
     const out: Record<string, unknown> = {};
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const sub = o as Record<string, unknown>;
-    const keys = Object.keys(sub);
+    const keys = TypedObject.keys(o);
     for (const key of keys) {
       const subPath = `${path}${key}`;
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      if (DataUtil.isPlainObject(sub[key]) && !Object.keys(sub[key] as Record<string, unknown>)[0].startsWith('$')) {
-        Object.assign(out, this.extractSimple(sub[key], `${subPath}.`));
+      if (DataUtil.isPlainObject(o[key]) && !Object.keys(o[key])[0].startsWith('$')) {
+        Object.assign(out, this.extractSimple(o[key], `${subPath}.`));
       } else {
-        out[subPath] = sub[key];
+        out[subPath] = o[key];
       }
     }
     return out;
@@ -53,8 +41,7 @@ export class ElasticsearchQueryUtil {
     const exclude: string[] = [];
     for (const k of Object.keys(simp)) {
       const nk = k === 'id' ? '_id' : k;
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      const v = simp[k] as (1 | 0 | boolean);
+      const v: 1 | 0 | boolean = castTo(simp[k]);
       if (v === 0 || v === false) {
         exclude.push(nk);
       } else {
@@ -71,8 +58,7 @@ export class ElasticsearchQueryUtil {
     return sort.map<SortOptions>(x => {
       const o = this.extractSimple(x);
       const k = Object.keys(o)[0];
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      const v = o[k] as (boolean | -1 | 1);
+      const v: boolean | -1 | 1 = castTo(o[k]);
       return { [k]: { order: v === 1 || v === true ? 'asc' : 'desc' } };
     });
   }
@@ -84,8 +70,7 @@ export class ElasticsearchQueryUtil {
     const items = [];
     const schema = SchemaRegistry.getViewSchema(cls).schema;
 
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    for (const key of Object.keys(o) as (keyof typeof o)[]) {
+    for (const key of TypedObject.keys(o)) {
       const top = o[key];
       const declaredSchema = schema[key];
       const declaredType = declaredSchema.type;
@@ -157,8 +142,7 @@ export class ElasticsearchQueryUtil {
               break;
             }
             case '$regex': {
-              // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-              const pattern = DataUtil.toRegex(v as string);
+              const pattern = DataUtil.toRegex(castTo(v));
               if (pattern.source.startsWith('\\b') && pattern.source.endsWith('.*')) {
                 const textField = !pattern.flags.includes('i') && config && config.caseSensitive ?
                   `${sPath}.text_cs` :
@@ -183,9 +167,8 @@ export class ElasticsearchQueryUtil {
             case '$near': {
               let dist = top.$maxDistance;
               let unit = top.$unit ?? 'm';
-              if (unit === 'rad') {
-                // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-                dist = 6378.1 * (dist as number);
+              if (unit === 'rad' && typeof dist === 'number') {
+                dist = 6378.1 * dist;
                 unit = 'km';
               }
               items.push({
@@ -218,11 +201,11 @@ export class ElasticsearchQueryUtil {
    * Build query from the where clause
    */
   static extractWhereQuery<T>(cls: Class<T>, o: WhereClause<T>, config?: EsSchemaConfig): Record<string, unknown> {
-    if (has$And(o)) {
+    if (ModelQueryUtil.has$And(o)) {
       return { bool: { must: o.$and.map(x => this.extractWhereQuery<T>(cls, x, config)) } };
-    } else if (has$Or(o)) {
+    } else if (ModelQueryUtil.has$Or(o)) {
       return { bool: { should: o.$or.map(x => this.extractWhereQuery<T>(cls, x, config)), ['minimum_should_match']: 1 } };
-    } else if (has$Not(o)) {
+    } else if (ModelQueryUtil.has$Not(o)) {
       return { bool: { ['must_not']: this.extractWhereQuery<T>(cls, o.$not, config) } };
     } else {
       return this.extractWhereTermQuery(cls, o, config);
@@ -265,13 +248,11 @@ export class ElasticsearchQueryUtil {
   /**
    * Build a base search object from a class and a query
    */
-  static getSearchObject<T extends ModelType>(cls: Class<T>, query: Query<T>, config?: EsSchemaConfig, checkExpiry = true): SearchRequest {
-    query.where = query.where ? (typeof query.where === 'string' ? QueryLanguageParser.parseToQuery(query.where) : query.where) : {};
-    QueryVerifier.verify(cls, query); // Verify
-
-    const search: SearchRequest = {
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      query: this.getSearchQuery(cls, this.extractWhereQuery(cls, query.where as WhereClause<T>, config), checkExpiry)
+  static getSearchObject<T extends ModelType>(
+    cls: Class<T>, query: Query<T>, config?: EsSchemaConfig, checkExpiry = true
+  ): SearchRequest & Omit<DeleteByQueryRequest, 'index' | 'sort'> {
+    const search: (SearchRequest & Omit<DeleteByQueryRequest, 'index' | 'sort'>) = {
+      query: this.getSearchQuery(cls, this.extractWhereQuery(cls, query.where ?? {}, config), checkExpiry)
     };
 
     const sort = query.sort;
@@ -320,8 +301,7 @@ export class ElasticsearchQueryUtil {
     for (const r of results.hits.hits) {
       const obj = r._source!;
       if (includeId) {
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        (obj as unknown as { _id: string })._id = r._id!;
+        castTo<{ _id: string }>(obj)._id = r._id!;
       }
       out.push(obj);
     }

package/src/internal/schema.ts

@@ -1,6 +1,6 @@
 import { InlineScript, MappingProperty, MappingTypeMapping } from '@elastic/elasticsearch/lib/api/types';
 
-import { Class } from '@travetto/base';
+import { Class } from '@travetto/runtime';
 import { ModelRegistry } from '@travetto/model';
 import { PointImpl } from '@travetto/model-query/src/internal/model/point';
 import { DataUtil, SchemaRegistry } from '@travetto/schema';

package/src/service.ts

@@ -1,19 +1,18 @@
 import { Client, errors } from '@elastic/elasticsearch';
-import {
-  AggregationsStringTermsAggregate, AggregationsStringTermsBucket, DeleteByQueryRequest, SearchRequest, SearchResponse, UpdateByQueryResponse
-} from '@elastic/elasticsearch/lib/api/types';
+import { AggregationsStringTermsAggregate, SearchRequest, SearchResponse } from '@elastic/elasticsearch/lib/api/types';
 
 import {
   ModelCrudSupport, BulkOp, BulkResponse, ModelBulkSupport, ModelExpirySupport,
   ModelIndexedSupport, ModelType, ModelStorageSupport, NotFoundError, ModelRegistry,
   OptionalId
 } from '@travetto/model';
-import { ShutdownManager, type Class, AppError } from '@travetto/base';
-import { SchemaChange, DeepPartial, BindUtil } from '@travetto/schema';
+import { ShutdownManager, type DeepPartial, type Class, AppError, castTo, asFull, TypedObject, asConstructable } from '@travetto/runtime';
+import { SchemaChange, BindUtil } from '@travetto/schema';
 import { Injectable } from '@travetto/di';
 import {
   ModelQuery, ModelQueryCrudSupport, ModelQueryFacetSupport,
-  ModelQuerySupport, PageableModelQuery, Query, SelectClause, ValidStringFields
+  ModelQuerySupport, PageableModelQuery, Query, ValidStringFields,
+  QueryVerifier
 } from '@travetto/model-query';
 
 import { ModelCrudUtil } from '@travetto/model/src/internal/service/crud';
@@ -107,8 +106,7 @@ export class ElasticsearchModelService implements
     await this.client.cluster.health({});
     this.manager = new IndexManager(this.config, this.client);
 
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    await ModelStorageUtil.registerModelChangeListener(this.manager, this.constructor as Class);
+    await ModelStorageUtil.registerModelChangeListener(this.manager);
     ShutdownManager.onGracefulShutdown(() => this.client.close(), this);
     ModelExpiryUtil.registerCull(this);
   }
@@ -124,8 +122,7 @@ export class ElasticsearchModelService implements
   async get<T extends ModelType>(cls: Class<T>, id: string): Promise<T> {
     try {
       const res = await this.client.get({ ...this.manager.getIdentity(cls), id });
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      return this.postLoad(cls, res._source as T);
+      return this.postLoad(cls, castTo(res._source));
     } catch {
       throw new NotFoundError(cls, id);
     }
@@ -270,18 +267,15 @@ export class ElasticsearchModelService implements
 
     const body = operations.reduce<(T | Partial<Record<'delete' | 'create' | 'index' | 'update', { _index: string, _id?: string }>> | { doc: T })[]>((acc, op) => {
 
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      const esIdent = this.manager.getIdentity((op.upsert ?? op.delete ?? op.insert ?? op.update ?? { constructor: cls }).constructor as Class);
+      const esIdent = this.manager.getIdentity(asConstructable<T>((op.upsert ?? op.delete ?? op.insert ?? op.update ?? { constructor: cls })).constructor);
       const ident: { _index: string, _type?: unknown } = { _index: esIdent.index };
 
       if (op.delete) {
         acc.push({ delete: { ...ident, _id: op.delete.id } });
       } else if (op.insert) {
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        acc.push({ create: { ...ident, _id: op.insert.id } }, op.insert as T);
+        acc.push({ create: { ...ident, _id: op.insert.id } }, castTo(op.insert));
       } else if (op.upsert) {
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        acc.push({ index: { ...ident, _id: op.upsert.id } }, op.upsert as T);
+        acc.push({ index: { ...ident, _id: op.upsert.id } }, castTo(op.upsert));
       } else if (op.update) {
         acc.push({ update: { ...ident, _id: op.update.id } }, { doc: op.update });
       }
@@ -309,10 +303,9 @@ export class ElasticsearchModelService implements
 
     for (let i = 0; i < res.items.length; i++) {
       const item = res.items[i];
-      const [k] = Object.keys(item);
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      const v = item[k as keyof typeof item]!;
-      if (k === 'error') {
+      const [k] = TypedObject.keys(item);
+      const v = item[k]!;
+      if (v.error) {
         out.errors.push({
           reason: v.error!.reason!,
           type: v.error!.type
@@ -320,13 +313,13 @@ export class ElasticsearchModelService implements
         out.counts.error += 1;
       } else {
         let sk: Count;
-        if (k === 'create') {
-          sk = 'insert';
-        } else if (k === 'index') {
-          sk = operations[i].insert ? 'insert' : 'upsert';
-        } else {
-          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-          sk = k as Count;
+        switch (k) {
+          case 'create': sk = 'insert'; break;
+          case 'index': sk = operations[i].insert ? 'insert' : 'upsert'; break;
+          case 'delete': case 'update': sk = k; break;
+          default: {
+            throw new Error(`Unknown response key: ${k}`);
+          }
         }
 
         if (v.result === 'created') {
@@ -415,6 +408,8 @@ export class ElasticsearchModelService implements
 
   // Query
   async query<T extends ModelType>(cls: Class<T>, query: PageableModelQuery<T>): Promise<T[]> {
+    await QueryVerifier.verify(cls, query);
+
     const req = ElasticsearchQueryUtil.getSearchObject(cls, query, this.config.schemaConfig);
     const results = await this.execSearch(cls, req);
     const items = ElasticsearchQueryUtil.cleanIdRemoval(req, results);
@@ -422,10 +417,14 @@ export class ElasticsearchModelService implements
   }
 
   async queryOne<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, failOnMany?: boolean): Promise<T> {
+    await QueryVerifier.verify(cls, query);
+
     return ModelQueryUtil.verifyGetSingleCounts(cls, await this.query<T>(cls, { ...query, limit: failOnMany ? 2 : 1 }));
   }
 
   async queryCount<T extends ModelType>(cls: Class<T>, query: Query<T>): Promise<number> {
+    await QueryVerifier.verify(cls, query);
+
     const req = ElasticsearchQueryUtil.getSearchObject(cls, { ...query, limit: 0 }, this.config.schemaConfig);
     const res: number | { value: number } = (await this.execSearch(cls, req)).hits.total || { value: 0 };
     return typeof res !== 'number' ? res.value : res;
@@ -434,11 +433,14 @@ export class ElasticsearchModelService implements
   // Query Crud
   async updateOneWithQuery<T extends ModelType>(cls: Class<T>, data: T, query: ModelQuery<T>): Promise<T> {
     ModelCrudUtil.ensureNotSubType(cls);
+    await QueryVerifier.verify(cls, query);
 
     const item = await ModelCrudUtil.preStore(cls, data, this);
     const id = item.id;
 
-    query = ModelQueryUtil.getQueryWithId(cls, data, query);
+    const where = ModelQueryUtil.getWhereClause(cls, query.where);
+    where.id = item.id;
+    query.where = where;
 
     if (ModelRegistry.get(cls).expiresAt) {
       await this.get(cls, id);
@@ -446,8 +448,7 @@ export class ElasticsearchModelService implements
 
     const search = ElasticsearchQueryUtil.getSearchObject(cls, query, this.config.schemaConfig);
 
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const copy = BindUtil.bindSchemaToObject(cls, {} as T, item);
+    const copy = BindUtil.bindSchemaToObject(cls, asFull<T>({}), item);
 
     try {
       const res = await this.client.updateByQuery({
@@ -455,16 +456,14 @@ export class ElasticsearchModelService implements
         refresh: true,
         query: search.query,
         max_docs: 1,
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        script: ElasticsearchSchemaUtil.generateReplaceScript(copy as {})
+        script: ElasticsearchSchemaUtil.generateReplaceScript(castTo(copy))
       });
 
       if (res.version_conflicts || res.updated === undefined || res.updated === 0) {
         throw new NotFoundError(cls, id);
       }
     } catch (err) {
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      if (err instanceof errors.ResponseError && (err.body as UpdateByQueryResponse).version_conflicts) {
+      if (err instanceof errors.ResponseError && 'version_conflicts' in err.body) {
         throw new NotFoundError(cls, id);
       } else {
         throw err;
@@ -475,16 +474,19 @@ export class ElasticsearchModelService implements
   }
 
   async deleteByQuery<T extends ModelType>(cls: Class<T>, query: ModelQuery<T> = {}): Promise<number> {
+    await QueryVerifier.verify(cls, query);
+
+    const { sort: _, ...q } = ElasticsearchQueryUtil.getSearchObject(cls, query, this.config.schemaConfig, false);
     const res = await this.client.deleteByQuery({
       ...this.manager.getIdentity(cls),
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      ...ElasticsearchQueryUtil.getSearchObject(cls, query, this.config.schemaConfig, false) as DeleteByQueryRequest,
+      ...q,
       refresh: true,
     });
     return res.deleted ?? 0;
   }
 
   async updateByQuery<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, data: Partial<T>): Promise<number> {
+    await QueryVerifier.verify(cls, query);
 
     const script = ElasticsearchSchemaUtil.generateUpdateScript(data);
 
@@ -501,6 +503,8 @@ export class ElasticsearchModelService implements
 
   // Query Facet
   async suggest<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, prefix?: string, query?: PageableModelQuery<T>): Promise<T[]> {
+    await QueryVerifier.verify(cls, query);
+
     const q = ModelQuerySuggestUtil.getSuggestQuery<T>(cls, field, prefix, query);
     const search = ElasticsearchQueryUtil.getSearchObject(cls, q);
     const res = await this.execSearch(cls, search);
@@ -510,11 +514,10 @@ export class ElasticsearchModelService implements
   }
 
   async suggestValues<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, prefix?: string, query?: PageableModelQuery<T>): Promise<string[]> {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const select: SelectClause<T> = { [field]: 1 } as SelectClause<T>;
+    await QueryVerifier.verify(cls, query);
 
     const q = ModelQuerySuggestUtil.getSuggestQuery<T>(cls, field, prefix, {
-      select,
+      select: castTo({ [field]: 1 }),
       ...query
     });
     const search = ElasticsearchQueryUtil.getSearchObject(cls, q);
@@ -525,6 +528,8 @@ export class ElasticsearchModelService implements
 
   // Facet
   async facet<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, query?: ModelQuery<T>): Promise<{ key: string, count: number }[]> {
+    await QueryVerifier.verify(cls, query);
+
     const q = ElasticsearchQueryUtil.getSearchObject(cls, query ?? {}, this.config.schemaConfig);
 
     const search = {
@@ -536,10 +541,8 @@ export class ElasticsearchModelService implements
     };
 
     const res = await this.execSearch(cls, search);
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const { buckets } = res.aggregations![field] as AggregationsStringTermsAggregate;
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const out = (buckets as AggregationsStringTermsBucket[]).map(b => ({ key: b.key, count: b.doc_count }));
+    const { buckets } = castTo<AggregationsStringTermsAggregate>('buckets' in res.aggregations![field] ? res.aggregations![field] : { buckets: [] });
+    const out = Array.isArray(buckets) ? buckets.map(b => ({ key: b.key, count: b.doc_count })) : [];
     return out;
   }
 }