Merge pull request #3506 from terascope/datatype-indexed-required-con…

…stant add constant for index required field types
terascope · Dec 20, 2023 · 37cacb5 · 37cacb5
2 parents f02b3a4 + b25c02d
commit 37cacb5
Show file tree

Hide file tree

Showing 54 changed files with 141 additions and 107 deletions.
diff --git a/e2e/package.json b/e2e/package.json
@@ -39,7 +39,7 @@
     },
     "devDependencies": {
         "bunyan": "^1.8.15",
-        "elasticsearch-store": "^0.75.0",
+        "elasticsearch-store": "^0.75.1",
         "fs-extra": "^11.1.1",
         "ms": "^2.1.3",
         "nanoid": "^3.3.4",

diff --git a/packages/data-mate/package.json b/packages/data-mate/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@terascope/data-mate",
     "displayName": "Data-Mate",
-    "version": "0.49.0",
+    "version": "0.49.1",
     "description": "Library of data validations/transformations",
     "homepage": "https://github.com/terascope/teraslice/tree/master/packages/data-mate#readme",
     "repository": {
@@ -29,9 +29,9 @@
         "test:watch": "ts-scripts test --watch . --"
     },
     "dependencies": {
-        "@terascope/data-types": "^0.43.0",
-        "@terascope/types": "^0.12.0",
-        "@terascope/utils": "^0.52.0",
+        "@terascope/data-types": "^0.43.1",
+        "@terascope/types": "^0.12.1",
+        "@terascope/utils": "^0.52.1",
         "@types/validator": "^13.11.7",
         "awesome-phonenumber": "^2.70.0",
         "date-fns": "^2.30.0",
@@ -46,7 +46,7 @@
         "uuid": "^9.0.0",
         "valid-url": "^1.0.9",
         "validator": "^13.11.0",
-        "xlucene-parser": "^0.51.0"
+        "xlucene-parser": "^0.51.1"
     },
     "devDependencies": {
         "@types/ip6addr": "^0.2.2",

diff --git a/packages/data-types/package.json b/packages/data-types/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@terascope/data-types",
     "displayName": "Data Types",
-    "version": "0.43.0",
+    "version": "0.43.1",
     "description": "A library for defining the data structures and mapping",
     "homepage": "https://github.com/terascope/teraslice/tree/master/packages/data-types#readme",
     "bugs": {
@@ -26,8 +26,8 @@
         "test:watch": "ts-scripts test --watch . --"
     },
     "dependencies": {
-        "@terascope/types": "^0.12.0",
-        "@terascope/utils": "^0.52.0",
+        "@terascope/types": "^0.12.1",
+        "@terascope/utils": "^0.52.1",
         "graphql": "^14.7.0",
         "lodash": "^4.17.21",
         "yargs": "^17.7.2"

diff --git a/packages/data-types/src/types/base-type.ts b/packages/data-types/src/types/base-type.ts
@@ -1,8 +1,8 @@
-import { ClientMetadata, DataTypeFieldConfig, xLuceneTypeConfig } from '@terascope/types';
-import * as ts from '@terascope/utils';
 import {
-    GraphQLType, TypeESMapping
-} from '../interfaces';
+    ClientMetadata, DataTypeFieldConfig, xLuceneTypeConfig, indexedRequiredFieldTypes
+} from '@terascope/types';
+import { castArray } from '@terascope/utils';
+import { GraphQLType, TypeESMapping } from '../interfaces';
 import { formatGQLComment } from '../graphql-helper';
 
 export interface IBaseType {
@@ -27,6 +27,13 @@ export default abstract class BaseType {
         this.config = config;
     }
 
+    protected _validateESMapping() {
+        if (this.config.indexed === false) {
+            if (this.config.type in indexedRequiredFieldTypes) {
+                throw new Error(`${this.config.type} is required to be indexed`);
+            }
+        }
+    }
     abstract toESMapping(config: ClientMetadata): TypeESMapping;
     abstract toGraphQL(options?: ToGraphQLOptions): GraphQLType;
     abstract toXlucene(): xLuceneTypeConfig;
@@ -60,7 +67,7 @@ export default abstract class BaseType {
 
 function makeCustomTypes(customType?: string|(string[])): string[] {
     if (!customType?.length) return [];
-    return ts.castArray(customType);
+    return castArray(customType);
 }
 
 export function formatGQLType(type: string, desc?: string):string {

diff --git a/packages/data-types/src/types/v1/any.ts b/packages/data-types/src/types/v1/any.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class AnyType extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: { [this.field]: { enabled: false } }
         };

diff --git a/packages/data-types/src/types/v1/boolean.ts b/packages/data-types/src/types/v1/boolean.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class BooleanType extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/boundary.ts b/packages/data-types/src/types/v1/boundary.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class Boundary extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/byte.ts b/packages/data-types/src/types/v1/byte.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class Byte extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/date.ts b/packages/data-types/src/types/v1/date.ts
@@ -7,6 +7,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class DateType extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         let format: string|undefined;
 
         if (this.config.format && (

diff --git a/packages/data-types/src/types/v1/domain.ts b/packages/data-types/src/types/v1/domain.ts
@@ -3,10 +3,8 @@ import BaseType from '../base-type';
 import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class Domain extends BaseType {
-    toESMapping(): TypeESMapping {
-        if (this.config.indexed === false) {
-            throw new Error(`${this.constructor.name} is required to be indexed`);
-        }
+    override toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: {

diff --git a/packages/data-types/src/types/v1/double.ts b/packages/data-types/src/types/v1/double.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class Double extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/float.ts b/packages/data-types/src/types/v1/float.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class Float extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/geo-json.ts b/packages/data-types/src/types/v1/geo-json.ts
@@ -9,9 +9,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class GeoJSON extends BaseType {
     toESMapping(clientMetaData: ClientMetadata): TypeESMapping {
-        if (this.config.indexed === false) {
-            throw new Error(`${this.constructor.name} is required to be indexed`);
-        }
+        this._validateESMapping();
         // we need to used deprecated quadtree and strategy because CONTAINS is
         // not yet supported in 6.X or 7.X as of now
         return {

diff --git a/packages/data-types/src/types/v1/geo-point.ts b/packages/data-types/src/types/v1/geo-point.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class GeoPointType extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/geo.ts b/packages/data-types/src/types/v1/geo.ts
@@ -5,6 +5,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 // TODO: This type is deprecated, not sure how to properly indicate it.
 export default class GeoType extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/hostname.ts b/packages/data-types/src/types/v1/hostname.ts
@@ -4,9 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class Hostname extends BaseType {
     toESMapping(): TypeESMapping {
-        if (this.config.indexed === false) {
-            throw new Error(`${this.constructor.name} is required to be indexed`);
-        }
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: {

diff --git a/packages/data-types/src/types/v1/integer.ts b/packages/data-types/src/types/v1/integer.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class Integer extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/ip-range.ts b/packages/data-types/src/types/v1/ip-range.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class IpRangeType extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/ip.ts b/packages/data-types/src/types/v1/ip.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class IPType extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/keyword-case-insensitive.ts b/packages/data-types/src/types/v1/keyword-case-insensitive.ts
@@ -4,9 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class KeywordCaseInsensitive extends BaseType {
     toESMapping(): TypeESMapping {
-        if (this.config.indexed === false) {
-            throw new Error(`${this.constructor.name} is required to be indexed`);
-        }
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.use_fields_hack ? {

diff --git a/packages/data-types/src/types/v1/keyword-path-analyzer.ts b/packages/data-types/src/types/v1/keyword-path-analyzer.ts
@@ -4,9 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class KeywordPathAnalyzer extends BaseType {
     toESMapping(): TypeESMapping {
-        if (this.config.indexed === false) {
-            throw new Error(`${this.constructor.name} is required to be indexed`);
-        }
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: {

diff --git a/packages/data-types/src/types/v1/keyword-tokens-case-insensitive.ts b/packages/data-types/src/types/v1/keyword-tokens-case-insensitive.ts
@@ -4,9 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class KeywordTokensCaseInsensitive extends BaseType {
     toESMapping(): TypeESMapping {
-        if (this.config.indexed === false) {
-            throw new Error(`${this.constructor.name} is required to be indexed`);
-        }
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: {

diff --git a/packages/data-types/src/types/v1/keyword-tokens.ts b/packages/data-types/src/types/v1/keyword-tokens.ts
@@ -4,9 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class KeywordTokens extends BaseType {
     toESMapping(): TypeESMapping {
-        if (this.config.indexed === false) {
-            throw new Error(`${this.constructor.name} is required to be indexed`);
-        }
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: {

diff --git a/packages/data-types/src/types/v1/keyword.ts b/packages/data-types/src/types/v1/keyword.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class Keyword extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/long.ts b/packages/data-types/src/types/v1/long.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class Long extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/ngram-tokens.ts b/packages/data-types/src/types/v1/ngram-tokens.ts
@@ -4,9 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class NgramTokens extends BaseType {
     toESMapping(): TypeESMapping {
-        if (this.config.indexed === false) {
-            throw new Error(`${this.constructor.name} is required to be indexed`);
-        }
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: {

diff --git a/packages/data-types/src/types/v1/number.ts b/packages/data-types/src/types/v1/number.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class NumberClass extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/object.ts b/packages/data-types/src/types/v1/object.ts
@@ -4,8 +4,9 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class ObjectType extends BaseType {
     toESMapping(): TypeESMapping {
-        const type = this.config.array ? 'nested' : 'object';
+        this._validateESMapping();
 
+        const type = this.config.array ? 'nested' : 'object';
         const typeConfig: ESTypeMapping = { type };
 
         if (this.config.indexed === false) {

diff --git a/packages/data-types/src/types/v1/short.ts b/packages/data-types/src/types/v1/short.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class Short extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/string.ts b/packages/data-types/src/types/v1/string.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class StringClass extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {

diff --git a/packages/data-types/src/types/v1/text.ts b/packages/data-types/src/types/v1/text.ts
@@ -4,6 +4,7 @@ import { GraphQLType, TypeESMapping } from '../../interfaces';
 
 export default class Text extends BaseType {
     toESMapping(): TypeESMapping {
+        this._validateESMapping();
         return {
             mapping: {
                 [this.field]: this.config.indexed === false ? {