first stab at fix for formula mocks errors

nickofthyme · Feb 1, 2024 · a20a96c · a20a96c
1 parent 89cf00e
commit a20a96c
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 28 deletions.
diff --git a/x-pack/plugins/lens/public/datasources/form_based/operations/definitions/column_types.ts b/x-pack/plugins/lens/public/datasources/form_based/operations/definitions/column_types.ts
@@ -35,6 +35,7 @@ export interface ValueFormatConfig {
 // Formatting can optionally be added to any column
 export interface FormattedIndexPatternColumn extends BaseIndexPatternColumn {
   params?: {
+    window?: number;
     format?: ValueFormatConfig;
   };
 }

diff --git a/...lugins/lens/public/datasources/form_based/operations/definitions/formula/formula.test.tsx b/...lugins/lens/public/datasources/form_based/operations/definitions/formula/formula.test.tsx
@@ -49,19 +49,17 @@ const operationDefinitionMap: Record<string, GenericOperationDefinition> = {
       dataType: type === 'string' ? type : 'number',
     })),
   }),
-  max: createOperationDefinitionMock('max'),
+  max: createOperationDefinitionMock('max', {}),
   count: createOperationDefinitionMock('count', {
     filterable: true,
     canReduceTimeRange: true,
   }),
   derivative: createOperationDefinitionMock('derivative', { input: 'fullReference' }),
   moving_average: createOperationDefinitionMock('moving_average', {
-    // @ts-expect-error upgrade typescript v4.9.5
     input: 'fullReference',
     operationParams: [{ name: 'window', type: 'number', required: true }],
     filterable: true,
     getErrorMessage: jest.fn(() => ['mock error']),
-    // @ts-expect-error upgrade typescript v4.9.5
     buildColumn: ({ referenceIds }, columnsParams) => ({
       label: 'moving_average',
       dataType: 'number',

diff --git a/...ens/public/datasources/form_based/operations/definitions/formula/mocks/operation_mocks.ts b/...ens/public/datasources/form_based/operations/definitions/formula/mocks/operation_mocks.ts
@@ -5,8 +5,12 @@
  * 2.0.
  */
 
-import type { GenericOperationDefinition } from '../..';
-import type { GenericIndexPatternColumn } from '../../column_types';
+import type {
+  GenericOperationDefinition,
+  OperationDefinition,
+  OperationDefinitionMap,
+} from '../..';
+import type { BaseIndexPatternColumn, GenericIndexPatternColumn } from '../../column_types';
 import { getFilter } from '../../helpers';
 
 interface PartialColumnParams {
@@ -16,27 +20,22 @@ interface PartialColumnParams {
   reducedTimeRange?: string;
 }
 
-type OperationByInputType<Input extends GenericOperationDefinition['input']> = Extract<
-  GenericOperationDefinition,
-  { input: Input }
->;
-
-export function createOperationDefinitionMock(
+export function createOperationDefinitionMock<
+  T extends keyof OperationDefinitionMap<BaseIndexPatternColumn>
+>(
   operation: string,
-  {
-    input = 'field',
-    getErrorMessage,
-    buildColumn,
-    ...params
-  }: Partial<GenericOperationDefinition> = {},
+  column: T extends keyof OperationDefinitionMap<BaseIndexPatternColumn>
+    ? Partial<OperationDefinition<BaseIndexPatternColumn, T>>
+    : Partial<OperationDefinition<BaseIndexPatternColumn, 'field'>>,
   {
     label = operation,
     dataType = 'number',
     isBucketed = false,
     scale = 'ratio',
     timeScale,
   }: Partial<GenericIndexPatternColumn> = {}
-): OperationByInputType<typeof input> {
+): GenericOperationDefinition {
+  const { input = 'field', getErrorMessage, buildColumn, ...params } = column;
   const sharedColumnParams = {
     label,
     dataType,
@@ -67,15 +66,16 @@ export function createOperationDefinitionMock(
       onFieldChange: jest.fn(),
       toEsAggsFn: jest.fn(),
       getPossibleOperationForField:
-        (params as OperationByInputType<typeof input>).getPossibleOperationForField ??
+        (params as unknown as OperationDefinition<BaseIndexPatternColumn, 'field'>)
+          ?.getPossibleOperationForField ??
         jest.fn((arg) => ({
           scale,
           dataType,
           isBucketed,
         })),
       ...sharedDefinitionParams,
       ...params,
-    } as OperationByInputType<typeof input>;
+    } as OperationDefinition<BaseIndexPatternColumn, 'field'>;
   }
   if (input === 'fullReference') {
     return {
@@ -102,7 +102,7 @@ export function createOperationDefinitionMock(
       selectionStyle: 'field',
       ...sharedDefinitionParams,
       ...params,
-    } as OperationByInputType<typeof input>;
+    } as OperationDefinition<BaseIndexPatternColumn, 'fullReference'>;
   }
   return {
     buildColumn:
@@ -116,5 +116,5 @@ export function createOperationDefinitionMock(
     createCopy: jest.fn(),
     ...sharedDefinitionParams,
     ...params,
-  } as OperationByInputType<typeof input>;
+  } as OperationDefinition<BaseIndexPatternColumn, 'none' | 'managedReference'>;
 }
diff --git a/x-pack/plugins/lens/public/datasources/form_based/operations/definitions/index.ts b/x-pack/plugins/lens/public/datasources/form_based/operations/definitions/index.ts
@@ -702,7 +702,7 @@ interface ManagedReferenceOperationDefinition<C extends BaseIndexPatternColumn>
   selectionStyle?: 'hidden';
 }
 
-interface OperationDefinitionMap<C extends BaseIndexPatternColumn, P = {}> {
+export interface OperationDefinitionMap<C extends BaseIndexPatternColumn, P = {}> {
   field: FieldBasedOperationDefinition<C, P>;
   none: FieldlessOperationDefinition<C, P>;
   fullReference: FullReferenceOperationDefinition<C>;
@@ -731,11 +731,11 @@ export type OperationType = string;
  * This is an operation definition of an unspecified column out of all possible
  * column types.
  */
-export type GenericOperationDefinition =
-  | OperationDefinition<BaseIndexPatternColumn, 'field'>
-  | OperationDefinition<BaseIndexPatternColumn, 'none'>
-  | OperationDefinition<BaseIndexPatternColumn, 'fullReference'>
-  | OperationDefinition<BaseIndexPatternColumn, 'managedReference'>;
+export type GenericOperationDefinition<
+  C extends BaseIndexPatternColumn = BaseIndexPatternColumn,
+  P = {},
+  AR extends boolean = false
+> = OperationDefinition<BaseIndexPatternColumn, keyof OperationDefinitionMap<C>, P, AR>;
 
 /**
  * List of all available operation definitions