@finos/legend-extension-dsl-data-quality 1.0.60 → 2.0.0

package/src/components/states/DataQualityRelationValidationConfigurationState.ts

@@ -0,0 +1,429 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  type EditorStore,
+  ElementEditorState,
+} from '@finos/legend-application-studio';
+
+import {
+  type DataQualityRelationValidation,
+  DataQualityRelationValidationConfiguration,
+  RelationValidationType,
+} from '../../graph/metamodel/pure/packageableElements/data-quality/DataQualityValidationConfiguration.js';
+import {
+  type GeneratorFn,
+  assertErrorThrown,
+  assertType,
+  guaranteeNonNullable,
+  guaranteeType,
+  hashArray,
+  LogEvent,
+  filterByType,
+} from '@finos/legend-shared';
+import {
+  type ExecutionResult,
+  type ExecutionResultWithMetadata,
+  buildSourceInformationSourceId,
+  GRAPH_MANAGER_EVENT,
+  isStubbed_PackageableElement,
+  isStubbed_RawLambda,
+  ParserError,
+  RawLambda,
+  buildLambdaVariableExpressions,
+  observe_ValueSpecification,
+  VariableExpression,
+} from '@finos/legend-graph';
+import {
+  action,
+  computed,
+  flow,
+  flowResult,
+  makeObservable,
+  observable,
+} from 'mobx';
+import {
+  LambdaEditorState,
+  LambdaParametersState,
+  LambdaParameterState,
+  PARAMETER_SUBMIT_ACTION,
+} from '@finos/legend-query-builder';
+import { DataQualityRelationValidationState } from './DataQualityRelationValidationState.js';
+import { DataQualityRelationResultState } from './DataQualityRelationResultState.js';
+import { DATA_QUALITY_HASH_STRUCTURE } from '../../graph/metamodel/DSL_DataQuality_HashUtils.js';
+import type { SelectOption } from '@finos/legend-art';
+
+export enum DATA_QUALITY_RELATION_VALIDATION_EDITOR_TAB {
+  DEFINITION = 'Definition',
+  TRIAL_RUN = 'Trial Run',
+}
+
+export class RelationFunctionDefinitionEditorState extends LambdaEditorState {
+  readonly editorStore: EditorStore;
+  readonly relationValidationElement: DataQualityRelationValidationConfiguration;
+
+  isConvertingFunctionBodyToString = false;
+
+  constructor(
+    relationValidationElement: DataQualityRelationValidationConfiguration,
+    editorStore: EditorStore,
+  ) {
+    super('', '|');
+
+    makeObservable(this, {
+      relationValidationElement: observable,
+      isConvertingFunctionBodyToString: observable,
+    });
+
+    this.relationValidationElement = relationValidationElement;
+    this.editorStore = editorStore;
+  }
+
+  get lambdaId(): string {
+    return buildSourceInformationSourceId([
+      this.relationValidationElement.path,
+    ]);
+  }
+
+  *convertLambdaGrammarStringToObject(): GeneratorFn<void> {
+    if (this.lambdaString) {
+      try {
+        const lambda =
+          (yield this.editorStore.graphManagerState.graphManager.pureCodeToLambda(
+            this.fullLambdaString,
+            this.lambdaId,
+          )) as RawLambda;
+        this.setParserError(undefined);
+        this.relationValidationElement.query.body = lambda.body;
+      } catch (error) {
+        assertErrorThrown(error);
+        if (error instanceof ParserError) {
+          this.setParserError(error);
+        }
+        this.editorStore.applicationStore.logService.error(
+          LogEvent.create(GRAPH_MANAGER_EVENT.PARSING_FAILURE),
+          error,
+        );
+      }
+    } else {
+      this.clearErrors();
+      this.relationValidationElement.query.body = new RawLambda(
+        undefined,
+        undefined,
+      ).body;
+      this.relationValidationElement.query.parameters = [];
+    }
+  }
+
+  *convertLambdaObjectToGrammarString(options?: {
+    pretty?: boolean | undefined;
+    preserveCompilationError?: boolean | undefined;
+    firstLoad?: boolean | undefined;
+  }): GeneratorFn<void> {
+    if (!isStubbed_PackageableElement(this.relationValidationElement)) {
+      this.isConvertingFunctionBodyToString = true;
+      try {
+        const lambdas = new Map<string, RawLambda>();
+        const functionLamba = new RawLambda(
+          [],
+          this.relationValidationElement.query.body,
+        );
+        lambdas.set(this.lambdaId, functionLamba);
+        const isolatedLambdas =
+          (yield this.editorStore.graphManagerState.graphManager.lambdasToPureCode(
+            lambdas,
+            options?.pretty,
+          )) as Map<string, string>;
+        const grammarText = isolatedLambdas.get(this.lambdaId);
+        if (grammarText) {
+          this.setLambdaString(this.extractLambdaString(grammarText));
+        } else {
+          this.setLambdaString('');
+        }
+        // `firstLoad` flag is used in the first rendering of the function editor (in a `useEffect`)
+        // This flag helps block editing while the JSON is converting to text and to avoid reseting parser/compiler error in reveal error
+        if (!options?.firstLoad) {
+          this.clearErrors({
+            preserveCompilationError: options?.preserveCompilationError,
+          });
+        }
+        this.isConvertingFunctionBodyToString = false;
+      } catch (error) {
+        assertErrorThrown(error);
+        this.editorStore.applicationStore.logService.error(
+          LogEvent.create(GRAPH_MANAGER_EVENT.PARSING_FAILURE),
+          error,
+        );
+        this.isConvertingFunctionBodyToString = false;
+      }
+    } else {
+      this.clearErrors();
+      this.setLambdaString('');
+    }
+  }
+
+  get hashCode(): string {
+    return hashArray([
+      DATA_QUALITY_HASH_STRUCTURE.DATA_QUALITY_RELATION_FUNCTION_DEFINITION,
+      this.lambdaString,
+    ]);
+  }
+}
+
+export class RelationDefinitionParameterState extends LambdaParametersState {
+  readonly relationValidationConfigurationState: DataQualityRelationValidationConfigurationState;
+
+  constructor(
+    relationValidationConfigurationState: DataQualityRelationValidationConfigurationState,
+  ) {
+    super();
+    makeObservable(this, {
+      parameterValuesEditorState: observable,
+      parameterStates: observable,
+      addParameter: action,
+      removeParameter: action,
+      openModal: action,
+      build: action,
+      setParameters: action,
+    });
+    this.relationValidationConfigurationState =
+      relationValidationConfigurationState;
+  }
+
+  openModal(lambda: RawLambda): void {
+    this.parameterStates = this.build(lambda);
+    this.parameterValuesEditorState.open(
+      (): Promise<void> =>
+        flowResult(
+          this.relationValidationConfigurationState.resultState.runValidation(),
+        )
+          .catch(
+            this.relationValidationConfigurationState.editorStore
+              .applicationStore.alertUnhandledError,
+          )
+          .catch(
+            this.relationValidationConfigurationState.editorStore
+              .applicationStore.alertUnhandledError,
+          ),
+      PARAMETER_SUBMIT_ACTION.RUN,
+    );
+  }
+
+  build(lambda: RawLambda): LambdaParameterState[] {
+    const parameters = buildLambdaVariableExpressions(
+      lambda,
+      this.relationValidationConfigurationState.editorStore.graphManagerState,
+    )
+      .map((parameter) =>
+        observe_ValueSpecification(
+          parameter,
+          this.relationValidationConfigurationState.editorStore
+            .changeDetectionState.observerContext,
+        ),
+      )
+      .filter(filterByType(VariableExpression));
+    const states = parameters.map((variable) => {
+      const parmeterState = new LambdaParameterState(
+        variable,
+        this.relationValidationConfigurationState.editorStore.changeDetectionState.observerContext,
+        this.relationValidationConfigurationState.editorStore.graphManagerState.graph,
+      );
+      parmeterState.mockParameterValue();
+      return parmeterState;
+    });
+    return states;
+  }
+}
+
+export class DataQualityRelationValidationConfigurationState extends ElementEditorState {
+  readonly relationFunctionDefinitionEditorState: RelationFunctionDefinitionEditorState;
+  selectedTab: DATA_QUALITY_RELATION_VALIDATION_EDITOR_TAB;
+
+  isRunningFunc = false;
+  funcRunPromise: Promise<ExecutionResultWithMetadata> | undefined = undefined;
+  executionResult?: ExecutionResult | undefined; // NOTE: stored as lossless JSON string
+  validationStates: DataQualityRelationValidationState[] = [];
+  parametersState: RelationDefinitionParameterState;
+  isConvertingValidationLambdaObjects = false;
+  resultState: DataQualityRelationResultState;
+
+  constructor(
+    editorStore: EditorStore,
+    element: DataQualityRelationValidationConfiguration,
+  ) {
+    super(editorStore, element);
+
+    makeObservable(this, {
+      selectedTab: observable,
+      isRunningFunc: observable,
+      funcRunPromise: observable,
+      executionResult: observable,
+      setSelectedTab: action,
+      setFuncRunPromise: action,
+      setExecutionResult: action,
+      addValidationState: action,
+      validationElement: computed,
+      relationValidationOptions: computed,
+      convertValidationLambdaObjects: flow,
+    });
+    assertType(
+      element,
+      DataQualityRelationValidationConfiguration,
+      'Element inside data quality relation validation editor state must be a data quality relation validation element',
+    );
+    this.relationFunctionDefinitionEditorState =
+      new RelationFunctionDefinitionEditorState(element, this.editorStore);
+    this.selectedTab = DATA_QUALITY_RELATION_VALIDATION_EDITOR_TAB.DEFINITION;
+    this.validationElement.validations.forEach((validation) => {
+      this.validationStates.push(
+        new DataQualityRelationValidationState(validation, editorStore),
+      );
+    });
+    this.parametersState = new RelationDefinitionParameterState(this);
+    this.resultState = new DataQualityRelationResultState(this);
+  }
+
+  reprocess(
+    newElement: DataQualityRelationValidationConfiguration,
+    editorStore: EditorStore,
+  ): DataQualityRelationValidationConfigurationState {
+    return new DataQualityRelationValidationConfigurationState(
+      editorStore,
+      newElement,
+    );
+  }
+
+  get validationElement(): DataQualityRelationValidationConfiguration {
+    return guaranteeType(
+      this.element,
+      DataQualityRelationValidationConfiguration,
+      'Element inside data quality relation validation state must be a data quality relation validation configuration element',
+    );
+  }
+
+  getNullableValidationState = (
+    relationValidation: DataQualityRelationValidation,
+  ): DataQualityRelationValidationState | undefined =>
+    this.validationStates.find(
+      (validationState) =>
+        validationState.relationValidation === relationValidation,
+    );
+
+  getValidationState = (
+    validation: DataQualityRelationValidation,
+  ): DataQualityRelationValidationState =>
+    guaranteeNonNullable(
+      this.getNullableValidationState(validation),
+      `Can't find validation state for validation ${validation}`,
+    );
+
+  get relationValidationOptions(): SelectOption[] {
+    return Object.values(RelationValidationType).map((type) => ({
+      label: type,
+      value: type,
+    }));
+  }
+  addValidationState(validation: DataQualityRelationValidation): void {
+    if (
+      !this.validationStates.find(
+        (validationState) => validationState.relationValidation === validation,
+      )
+    ) {
+      this.validationStates.push(
+        new DataQualityRelationValidationState(validation, this.editorStore),
+      );
+    }
+  }
+
+  deleteValidationState(validation: DataQualityRelationValidation): void {
+    const idx = this.validationStates.findIndex(
+      (validationState) => validationState.relationValidation === validation,
+    );
+    if (idx !== -1) {
+      this.validationStates.splice(idx, 1);
+    }
+  }
+
+  setFuncRunPromise = (
+    promise: Promise<ExecutionResultWithMetadata> | undefined,
+  ): void => {
+    this.funcRunPromise = promise;
+  };
+
+  setSelectedTab(tab: DATA_QUALITY_RELATION_VALIDATION_EDITOR_TAB): void {
+    this.selectedTab = tab;
+  }
+
+  setExecutionResult = (executionResult: ExecutionResult | undefined): void => {
+    this.executionResult = executionResult;
+  };
+
+  *convertValidationLambdaObjects(): GeneratorFn<void> {
+    const lambdas = new Map<string, RawLambda>();
+    const index = new Map<string, DataQualityRelationValidationState>();
+    this.validationStates.forEach((validationState) => {
+      if (!isStubbed_RawLambda(validationState.relationValidation.assertion)) {
+        lambdas.set(
+          validationState.lambdaId,
+          validationState.relationValidation.assertion,
+        );
+        index.set(validationState.lambdaId, validationState);
+      }
+    });
+    if (lambdas.size) {
+      this.isConvertingValidationLambdaObjects = true;
+      try {
+        const isolatedLambdas =
+          (yield this.editorStore.graphManagerState.graphManager.lambdasToPureCode(
+            lambdas,
+          )) as Map<string, string>;
+        isolatedLambdas.forEach((grammarText, key) => {
+          const validationState = index.get(key);
+          validationState?.setLambdaString(
+            validationState.extractLambdaString(grammarText),
+          );
+        });
+      } catch (error) {
+        assertErrorThrown(error);
+        this.editorStore.applicationStore.logService.error(
+          LogEvent.create(GRAPH_MANAGER_EVENT.PARSING_FAILURE),
+          error,
+        );
+      } finally {
+        this.isConvertingValidationLambdaObjects = false;
+      }
+    }
+  }
+
+  get bodyExpressionSequence(): RawLambda {
+    return new RawLambda(
+      this.validationElement.query.parameters.map((parameter) =>
+        this.editorStore.graphManagerState.graphManager.serializeRawValueSpecification(
+          parameter,
+        ),
+      ),
+      this.validationElement.query.body,
+    );
+  }
+
+  get hashCode(): string {
+    return hashArray([
+      DATA_QUALITY_HASH_STRUCTURE.DATA_QUALITY_RELATION_VALIDATION,
+      this.relationFunctionDefinitionEditorState,
+      hashArray(this.validationStates),
+    ]);
+  }
+}

package/src/components/states/DataQualityRelationValidationLambdaEditorState.ts

@@ -0,0 +1,138 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { DataQualityRelationValidation } from '../../graph/metamodel/pure/packageableElements/data-quality/DataQualityValidationConfiguration.js';
+import type { EditorStore } from '@finos/legend-application-studio';
+import { makeObservable, observable } from 'mobx';
+import {
+  type GeneratorFn,
+  assertErrorThrown,
+  hashArray,
+  LogEvent,
+} from '@finos/legend-shared';
+import {
+  type RawLambda,
+  buildSourceInformationSourceId,
+  GRAPH_MANAGER_EVENT,
+  isStubbed_RawLambda,
+  ParserError,
+  stub_RawLambda,
+} from '@finos/legend-graph';
+import { LambdaEditorState } from '@finos/legend-query-builder';
+import { VALIDATION_ROW_MAP_ID_LABEL } from './ConstraintState.js';
+import { dataQualityRelationValidation_setRowMapFunction } from '../../graph-manager/DSL_DataQuality_GraphModifierHelper.js';
+import { DATA_QUALITY_HASH_STRUCTURE } from '../../graph/metamodel/DSL_DataQuality_HashUtils.js';
+
+export class DataQualityRelationValidationLambdaEditorState extends LambdaEditorState {
+  relationValidation: DataQualityRelationValidation;
+  editorStore: EditorStore;
+  constructor(
+    relationValidation: DataQualityRelationValidation,
+    editorStore: EditorStore,
+  ) {
+    super('true', '|');
+
+    makeObservable(this, {
+      relationValidation: observable,
+      editorStore: observable,
+    });
+
+    this.relationValidation = relationValidation;
+    this.editorStore = editorStore;
+  }
+
+  get lambdaId(): string {
+    return buildSourceInformationSourceId([
+      VALIDATION_ROW_MAP_ID_LABEL,
+      this.relationValidation.name,
+      this.uuid, // in case of duplications
+    ]);
+  }
+
+  *convertLambdaGrammarStringToObject(): GeneratorFn<void> {
+    const emptyFunctionDefinition = stub_RawLambda();
+    if (this.lambdaString) {
+      try {
+        const lambda =
+          (yield this.editorStore.graphManagerState.graphManager.pureCodeToLambda(
+            this.fullLambdaString,
+            this.lambdaId,
+          )) as RawLambda;
+        this.setParserError(undefined);
+        dataQualityRelationValidation_setRowMapFunction(
+          this.relationValidation,
+          lambda,
+        );
+      } catch (error) {
+        assertErrorThrown(error);
+        if (error instanceof ParserError) {
+          this.setParserError(error);
+        }
+        this.editorStore.applicationStore.logService.error(
+          LogEvent.create(GRAPH_MANAGER_EVENT.PARSING_FAILURE),
+          error,
+        );
+      }
+    } else {
+      this.clearErrors();
+      dataQualityRelationValidation_setRowMapFunction(
+        this.relationValidation,
+        emptyFunctionDefinition,
+      );
+    }
+  }
+
+  *convertLambdaObjectToGrammarString(options?: {
+    pretty?: boolean | undefined;
+    preserveCompilationError?: boolean | undefined;
+  }): GeneratorFn<void> {
+    if (!isStubbed_RawLambda(this.relationValidation.rowMapFunction!)) {
+      try {
+        const lambdas = new Map<string, RawLambda>();
+        lambdas.set(this.lambdaId, this.relationValidation.rowMapFunction!);
+        const isolatedLambdas =
+          (yield this.editorStore.graphManagerState.graphManager.lambdasToPureCode(
+            lambdas,
+            options?.pretty,
+          )) as Map<string, string>;
+        const grammarText = isolatedLambdas.get(this.lambdaId);
+        this.setLambdaString(
+          grammarText !== undefined
+            ? this.extractLambdaString(grammarText)
+            : '',
+        );
+        this.clearErrors({
+          preserveCompilationError: options?.preserveCompilationError,
+        });
+      } catch (error) {
+        assertErrorThrown(error);
+        this.editorStore.applicationStore.logService.error(
+          LogEvent.create(GRAPH_MANAGER_EVENT.PARSING_FAILURE),
+          error,
+        );
+      }
+    } else {
+      this.clearErrors();
+      this.setLambdaString('');
+    }
+  }
+
+  get hashCode(): string {
+    return hashArray([
+      DATA_QUALITY_HASH_STRUCTURE.DATA_QUALITY_RELATION_VALIDATION,
+      this.lambdaString,
+    ]);
+  }
+}