@travetto/model-elasticsearch 6.0.1 → 7.0.0-rc.0

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#L30) 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#L29) 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/types/crud.ts#L11)
@@ -42,7 +42,7 @@ export class Init {
 }
 ```
 
-where the [ElasticsearchModelConfig](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch/src/config.ts#L11) is defined by:
+where the [ElasticsearchModelConfig](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch/src/config.ts#L10) is defined by:
 
 **Code: Structure of ElasticsearchModelConfig**
 ```typescript
@@ -76,7 +76,6 @@ export class ElasticsearchModelConfig {
   /**
    * Base schema config for elasticsearch
    */
-  @Field(Object)
   schemaConfig: EsSchemaConfig = {
     caseSensitive: false
   };
@@ -84,7 +83,6 @@ export class ElasticsearchModelConfig {
   /**
    * Base index create settings
    */
-  @Field(Object)
   indexCreate = {
     ['number_of_replicas']: 0,
     ['number_of_shards']: 1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-elasticsearch",
-  "version": "6.0.1",
+  "version": "7.0.0-rc.0",
   "description": "Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.",
   "keywords": [
     "elasticsearch",
@@ -27,11 +27,11 @@
     "directory": "module/model-elasticsearch"
   },
   "dependencies": {
-    "@elastic/elasticsearch": "^9.1.1",
-    "@travetto/cli": "^6.0.1",
-    "@travetto/config": "^6.0.1",
-    "@travetto/model": "^6.0.1",
-    "@travetto/model-query": "^6.0.1"
+    "@elastic/elasticsearch": "^9.2.0",
+    "@travetto/cli": "^7.0.0-rc.0",
+    "@travetto/config": "^7.0.0-rc.0",
+    "@travetto/model": "^7.0.0-rc.0",
+    "@travetto/model-query": "^7.0.0-rc.0"
   },
   "travetto": {
     "displayName": "Elasticsearch Model Source"

package/src/config.ts

@@ -1,6 +1,5 @@
 import { TimeSpan } from '@travetto/runtime';
 import { Config } from '@travetto/config';
-import { Field } from '@travetto/schema';
 
 import { EsSchemaConfig } from './internal/types.ts';
 
@@ -37,7 +36,6 @@ export class ElasticsearchModelConfig {
   /**
    * Base schema config for elasticsearch
    */
-  @Field(Object)
   schemaConfig: EsSchemaConfig = {
     caseSensitive: false
   };
@@ -45,7 +43,6 @@ export class ElasticsearchModelConfig {
   /**
    * Base index create settings
    */
-  @Field(Object)
   indexCreate = {
     ['number_of_replicas']: 0,
     ['number_of_shards']: 1

package/src/index-manager.ts

@@ -1,8 +1,8 @@
 import { Client, estypes } from '@elastic/elasticsearch';
 
 import { Class } from '@travetto/runtime';
-import { ModelRegistry, ModelType, ModelStorageSupport } from '@travetto/model';
-import { SchemaChange } from '@travetto/schema';
+import { ModelRegistryIndex, ModelType, ModelStorageSupport } from '@travetto/model';
+import { SchemaChange, SchemaRegistryIndex } from '@travetto/schema';
 
 import { ElasticsearchModelConfig } from './config.ts';
 import { ElasticsearchSchemaUtil } from './internal/schema.ts';
@@ -24,7 +24,7 @@ export class IndexManager implements ModelStorageSupport {
   }
 
   getStore(cls: Class): string {
-    return ModelRegistry.getStore(cls).toLowerCase().replace(/[^A-Za-z0-9_]+/g, '_');
+    return ModelRegistryIndex.getStoreName(cls).toLowerCase().replace(/[^A-Za-z0-9_]+/g, '_');
   }
 
   /**
@@ -98,13 +98,12 @@ export class IndexManager implements ModelStorageSupport {
    * Build an index if missing
    */
   async createIndexIfMissing(cls: Class): Promise<void> {
-    cls = ModelRegistry.getBaseModel(cls);
-    const ident = this.getIdentity(cls);
+    const baseCls = SchemaRegistryIndex.getBaseClass(cls);
+    const ident = this.getIdentity(baseCls);
     try {
       await this.#client.search(ident);
-      console.debug('Index already exists, not creating', ident);
     } catch {
-      await this.createIndex(cls);
+      await this.createIndex(baseCls);
     }
   }
 
@@ -186,7 +185,7 @@ export class IndexManager implements ModelStorageSupport {
 
       await this.#client.indices.putMapping({
         index,
-        body: schema
+        ...schema,
       });
     }
   }

package/src/internal/query.ts

@@ -2,8 +2,8 @@ import { estypes } from '@elastic/elasticsearch';
 
 import { castTo, Class, TypedObject } from '@travetto/runtime';
 import { WhereClause, SelectClause, SortClause, Query, ModelQueryUtil } from '@travetto/model-query';
-import { IndexConfig, ModelType, ModelRegistry } from '@travetto/model';
-import { DataUtil, SchemaRegistry } from '@travetto/schema';
+import { IndexConfig, ModelType, ModelRegistryIndex } from '@travetto/model';
+import { DataUtil, SchemaRegistryIndex } from '@travetto/schema';
 
 import { EsSchemaConfig } from './types.ts';
 
@@ -65,11 +65,11 @@ export class ElasticsearchQueryUtil {
    */
   static extractWhereTermQuery<T>(cls: Class<T>, o: Record<string, unknown>, config?: EsSchemaConfig, path: string = ''): Record<string, unknown> {
     const items = [];
-    const schema = SchemaRegistry.getViewSchema(cls).schema;
+    const fields = SchemaRegistryIndex.getFieldMap(cls);
 
     for (const key of TypedObject.keys(o)) {
       const top = o[key];
-      const declaredSchema = schema[key];
+      const declaredSchema = fields[key];
       const declaredType = declaredSchema.type;
       const sPath = declaredType === String ?
         ((key === 'id' && !path) ? '_id' : `${path}${key}`) :
@@ -205,11 +205,11 @@ export class ElasticsearchQueryUtil {
    * @param search
    */
   static getSearchQuery<T extends ModelType>(cls: Class<T>, search: Record<string, unknown>, checkExpiry = true): estypes.QueryDslQueryContainer {
-    const clauses = [];
+    const clauses: estypes.QueryDslQueryContainer[] = [];
     if (search && Object.keys(search).length) {
       clauses.push(search);
     }
-    const { expiresAt, subType } = ModelRegistry.get(cls);
+    const { expiresAt } = ModelRegistryIndex.getConfig(cls);
     if (checkExpiry && expiresAt) {
       clauses.push({
         bool: {
@@ -221,11 +221,13 @@ export class ElasticsearchQueryUtil {
         },
       });
     }
-    if (subType) {
-      const { subTypeField, subTypeName } = SchemaRegistry.get(cls);
-      clauses.push({
-        term: { [subTypeField]: { value: subTypeName } }
-      });
+    const polymorphicConfig = SchemaRegistryIndex.getDiscriminatedConfig(cls);
+    if (polymorphicConfig) {
+      if (polymorphicConfig.discriminatedBase) {
+        clauses.push({ terms: { [polymorphicConfig.discriminatedField]: SchemaRegistryIndex.getDiscriminatedTypes(cls)! } });
+      } else {
+        clauses.push({ term: { [polymorphicConfig.discriminatedField]: { value: polymorphicConfig.discriminatedType } } });
+      }
     }
     return clauses.length === 0 ? {} :
       clauses.length === 1 ? clauses[0] :

package/src/internal/schema.ts

@@ -1,8 +1,7 @@
 import { estypes } from '@elastic/elasticsearch';
 
 import { Class, toConcrete } from '@travetto/runtime';
-import { ModelRegistry } from '@travetto/model';
-import { Point, DataUtil, SchemaRegistry } from '@travetto/schema';
+import { Point, DataUtil, SchemaRegistryIndex } from '@travetto/schema';
 
 import { EsSchemaConfig } from './types.ts';
 
@@ -55,7 +54,7 @@ export class ElasticsearchSchemaUtil {
    * Build one or more mappings depending on the polymorphic state
    */
   static generateSchemaMapping(cls: Class, config?: EsSchemaConfig): estypes.MappingTypeMapping {
-    return ModelRegistry.get(cls).baseType ?
+    return SchemaRegistryIndex.getConfig(cls).discriminatedBase ?
       this.generateAllMapping(cls, config) :
       this.generateSingleMapping(cls, config);
   }
@@ -64,7 +63,7 @@ export class ElasticsearchSchemaUtil {
    * Generate all mappings
    */
   static generateAllMapping(cls: Class, config?: EsSchemaConfig): estypes.MappingTypeMapping {
-    const allTypes = ModelRegistry.getClassesByBaseType(cls);
+    const allTypes = SchemaRegistryIndex.getDiscriminatedClasses(cls);
     return allTypes.reduce<estypes.MappingTypeMapping>((acc, schemaCls) => {
       DataUtil.deepAssign(acc, this.generateSingleMapping(schemaCls, config));
       return acc;
@@ -75,13 +74,11 @@ export class ElasticsearchSchemaUtil {
    * Build a mapping for a given class
    */
   static generateSingleMapping<T>(cls: Class<T>, config?: EsSchemaConfig): estypes.MappingTypeMapping {
-    const schema = SchemaRegistry.getViewSchema(cls);
+    const fields = SchemaRegistryIndex.getFieldMap(cls);
 
     const props: Record<string, estypes.MappingProperty> = {};
 
-    for (const field of schema.fields) {
-      const conf = schema.schema[field];
-
+    for (const [field, conf] of Object.entries(fields)) {
       if (conf.type === PointImpl) {
         props[field] = { type: 'geo_point' };
       } else if (conf.type === Number) {
@@ -136,7 +133,7 @@ export class ElasticsearchSchemaUtil {
         props[field] = { type: 'keyword', ...text };
       } else if (conf.type === Object) {
         props[field] = { type: 'object', dynamic: true };
-      } else if (SchemaRegistry.has(conf.type)) {
+      } else if (SchemaRegistryIndex.has(conf.type)) {
         props[field] = {
           type: conf.array ? 'nested' : 'object',
           ...this.generateSingleMapping(conf.type, config)

package/src/service.ts

@@ -2,8 +2,8 @@ import { Client, errors, estypes } from '@elastic/elasticsearch';
 
 import {
   ModelCrudSupport, BulkOp, BulkResponse, ModelBulkSupport, ModelExpirySupport,
-  ModelIndexedSupport, ModelType, ModelStorageSupport, NotFoundError, ModelRegistry, OptionalId,
-  ModelCrudUtil, ModelIndexedUtil, ModelStorageUtil, ModelExpiryUtil, ModelBulkUtil
+  ModelIndexedSupport, ModelType, ModelStorageSupport, NotFoundError, ModelRegistryIndex, OptionalId,
+  ModelCrudUtil, ModelIndexedUtil, ModelStorageUtil, ModelExpiryUtil, ModelBulkUtil,
 } from '@travetto/model';
 import { ShutdownManager, type DeepPartial, type Class, castTo, asFull, TypedObject, asConstructable } from '@travetto/runtime';
 import { SchemaChange, BindUtil } from '@travetto/schema';
@@ -16,7 +16,6 @@ import {
   ModelQueryFacet,
 } from '@travetto/model-query';
 
-
 import { ElasticsearchModelConfig } from './config.ts';
 import { EsBulkError } from './internal/types.ts';
 import { ElasticsearchQueryUtil } from './internal/query.ts';
@@ -95,7 +94,7 @@ export class ElasticsearchModelService implements
 
     item = await ModelCrudUtil.load(cls, item);
 
-    const { expiresAt } = ModelRegistry.get(cls);
+    const { expiresAt } = ModelRegistryIndex.getConfig(cls);
 
     if (expiresAt) {
       const expiry = ModelExpiryUtil.getExpiryState(cls, item);
@@ -167,7 +166,7 @@ export class ElasticsearchModelService implements
         ...this.manager.getIdentity(cls),
         id,
         refresh: true,
-        body: clean
+        body: castTo<T & { id: never }>(clean)
       });
 
       return this.postUpdate(clean, id);
@@ -184,7 +183,7 @@ export class ElasticsearchModelService implements
 
     const id = this.preUpdate(o);
 
-    if (ModelRegistry.get(cls).expiresAt) {
+    if (ModelRegistryIndex.getConfig(cls).expiresAt) {
       await this.get(cls, id);
     }
 
@@ -193,7 +192,7 @@ export class ElasticsearchModelService implements
       id,
       op_type: 'index',
       refresh: true,
-      body: o
+      body: castTo<T & { id: never }>(o)
     });
 
     return this.postUpdate(o, id);
@@ -209,10 +208,8 @@ export class ElasticsearchModelService implements
       ...this.manager.getIdentity(cls),
       id,
       refresh: true,
-      body: {
-        doc: item,
-        doc_as_upsert: true
-      }
+      doc: item,
+      doc_as_upsert: true
     });
 
     return this.postUpdate(item, id);
@@ -230,9 +227,7 @@ export class ElasticsearchModelService implements
         ...this.manager.getIdentity(cls),
         id,
         refresh: true,
-        body: {
-          script
-        }
+        script,
       });
     } catch (err) {
       if (err instanceof Error && /document_missing_exception/.test(err.message)) {
@@ -385,7 +380,7 @@ export class ElasticsearchModelService implements
   }
 
   async * listByIndex<T extends ModelType>(cls: Class<T>, idx: string, body?: DeepPartial<T>): AsyncIterable<T> {
-    const cfg = ModelRegistry.getIndex(cls, idx, ['sorted', 'unsorted']);
+    const cfg = ModelRegistryIndex.getIndex(cls, idx, ['sorted', 'unsorted']);
     let search = await this.execSearch<T>(cls, {
       scroll: '2m',
       size: 100,
@@ -455,7 +450,7 @@ export class ElasticsearchModelService implements
     }
     query.where = where;
 
-    if (ModelRegistry.get(cls).expiresAt) {
+    if (ModelRegistryIndex.getConfig(cls).expiresAt) {
       await this.get(cls, id);
     }
 
@@ -545,17 +540,15 @@ export class ElasticsearchModelService implements
 
     const q = ElasticsearchQueryUtil.getSearchObject(cls, query ?? {}, this.config.schemaConfig);
 
-    const search = {
-      body: {
-        query: q.query ?? { ['match_all']: {} },
-        aggs: { [field]: { terms: { field, size: 100 } } }
-      },
+    const search: estypes.SearchRequest = {
+      query: q.query ?? { ['match_all']: {} },
+      aggs: { [field]: { terms: { field, size: 100 } } },
       size: 0
     };
 
     const result = await this.execSearch(cls, search);
     const { buckets } = castTo<estypes.AggregationsStringTermsAggregate>('buckets' in result.aggregations![field] ? result.aggregations![field] : { buckets: [] });
-    const out = Array.isArray(buckets) ? buckets.map(b => ({ key: b.key, count: b.doc_count })) : [];
+    const out = Array.isArray(buckets) ? buckets.map(b => ({ key: b.key!.toString(), count: b.doc_count })) : [];
     return out;
   }
 }

package/support/service.elasticsearch.ts

@@ -1,6 +1,6 @@
 import type { ServiceDescriptor } from '@travetto/cli';
 
-const version = '9.1.0';
+const version = '9.2.1';
 
 const port = 9200;