@finos/legend-query-builder 4.17.81 → 4.17.84

package/src/stores/workflows/dataProduct/DataProductQueryBuilderState.ts

@@ -0,0 +1,235 @@
+/**
+ * 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 GraphManagerState,
+  type Class,
+  DataProduct,
+  type V1_DataProductArtifact,
+  ModelAccessPointGroup,
+  type NativeModelExecutionContext,
+  CORE_PURE_PATH,
+  type NativeModelAccess,
+  resolveUsableDataProductClasses,
+} from '@finos/legend-graph';
+import { QueryBuilderState } from '../../QueryBuilderState.js';
+import { type GenericLegendApplicationStore } from '@finos/legend-application';
+import type {
+  QueryBuilderActionConfig,
+  QueryBuilderWorkflowState,
+} from '../../query-workflow/QueryBuilderWorkFlowState.js';
+import type { QueryBuilderConfig } from '../../../graph-manager/QueryBuilderConfig.js';
+import { renderDataProductQueryBuilderSetupPanelContent } from '../../../components/workflows/DataProductQueryBuilder.js';
+import {
+  ActionState,
+  filterByType,
+  type GeneratorFn,
+} from '@finos/legend-shared';
+import { action, computed, flow, makeObservable, observable } from 'mobx';
+import {
+  DepotEntityWithOrigin,
+  type QueryableSourceInfo,
+} from '@finos/legend-storage';
+import { compareLabelFn } from '@finos/legend-art';
+
+export type DataProductOption = {
+  label: string;
+  value: DepotEntityWithOrigin;
+};
+
+export const buildDataProductOption = (
+  value: DepotEntityWithOrigin,
+): DataProductOption => ({
+  label: value.name,
+  value,
+});
+
+export const buildExecOptions = (
+  val: NativeModelExecutionContext,
+): {
+  label: string;
+  value: NativeModelExecutionContext;
+} => {
+  return {
+    label: val.key,
+    value: val,
+  };
+};
+
+export class DataProductQueryBuilderState extends QueryBuilderState {
+  readonly onClassChange?: ((val: Class) => void) | undefined;
+  readonly onDataProductChange?: (val: DepotEntityWithOrigin) => Promise<void>;
+  readonly onExecutionContextChange?:
+    | ((val: NativeModelExecutionContext) => void)
+    | undefined;
+
+  loadDataProductModelState = ActionState.create();
+  nativeModelAccess: NativeModelAccess;
+  dataProduct: DataProduct;
+  dataProductArtifact: V1_DataProductArtifact | undefined;
+  selectedExecContext: NativeModelExecutionContext;
+  entities: DepotEntityWithOrigin[] | undefined;
+
+  prioritizeEntityFunc?: ((val: DepotEntityWithOrigin) => boolean) | undefined;
+
+  override TEMPORARY__setupPanelContentRenderer = (): React.ReactNode =>
+    renderDataProductQueryBuilderSetupPanelContent(this);
+
+  constructor(
+    applicationStore: GenericLegendApplicationStore,
+    graphManagerState: GraphManagerState,
+    workflow: QueryBuilderWorkflowState,
+    dataProduct: DataProduct,
+    artifact: V1_DataProductArtifact | undefined,
+    actionConfig: QueryBuilderActionConfig,
+    nativeNativeModelAccess: NativeModelAccess,
+    nativeModelExecContext: NativeModelExecutionContext,
+    prioritizeEntityFunc: ((val: DepotEntityWithOrigin) => boolean) | undefined,
+    onDataProductChange: (val: DepotEntityWithOrigin) => Promise<void>,
+    onExecutionContextChange?:
+      | ((val: NativeModelExecutionContext) => void)
+      | undefined,
+    onClassChange?: ((val: Class) => void) | undefined,
+    config?: QueryBuilderConfig | undefined,
+    sourceInfo?: QueryableSourceInfo | undefined,
+  ) {
+    super(applicationStore, graphManagerState, workflow, config, sourceInfo);
+    makeObservable(this, {
+      selectedExecContext: observable,
+      dataProduct: observable,
+      setExecOptions: action,
+      selectedDataProductOption: computed,
+      isProductLinkable: computed,
+      loadEntities: flow,
+      entities: observable,
+    });
+    this.workflowState.updateActionConfig(actionConfig);
+    this.dataProduct = dataProduct;
+    this.dataProductArtifact = artifact;
+    this.nativeModelAccess = nativeNativeModelAccess;
+    this.selectedExecContext = nativeModelExecContext;
+    this.prioritizeEntityFunc = prioritizeEntityFunc;
+    this.onDataProductChange = onDataProductChange;
+    this.onExecutionContextChange = onExecutionContextChange;
+    this.onClassChange = onClassChange;
+  }
+
+  get isProductLinkable(): boolean {
+    return false;
+  }
+
+  copyDataProductLinkToClipBoard(): void {
+    if (!this.isProductLinkable) {
+      this.applicationStore.notificationService.notifyError(
+        'Data Product link is not available.',
+      );
+    }
+  }
+
+  protected getElementType(): typeof DataProduct {
+    return DataProduct;
+  }
+
+  setExecOptions(exec: NativeModelExecutionContext): void {
+    this.selectedExecContext = exec;
+  }
+
+  *loadEntities(): GeneratorFn<void> {
+    this.loadDataProductModelState.inProgress();
+    this.entities = this.graphManagerState.graph.allOwnElements
+      .filter(filterByType(this.getElementType()))
+      .map((element) => this.transformElement(element));
+    this.loadDataProductModelState.complete();
+  }
+
+  protected transformElement(element: DataProduct): DepotEntityWithOrigin {
+    return new DepotEntityWithOrigin(
+      undefined,
+      element.name,
+      element.path,
+      CORE_PURE_PATH.DATA_PRODUCT,
+    );
+  }
+
+  get dataProductOptions(): DataProductOption[] {
+    const sortedAllOptions = (this.entities ?? [])
+      .map(buildDataProductOption)
+      .sort(compareLabelFn);
+
+    return this.prioritizeEntityFunc
+      ? [
+          ...sortedAllOptions.filter((val) =>
+            this.prioritizeEntityFunc?.(val.value),
+          ),
+          ...sortedAllOptions.filter(
+            (val) => !this.prioritizeEntityFunc?.(val.value),
+          ),
+        ]
+      : sortedAllOptions;
+  }
+
+  get selectedDataProductOption(): DataProductOption {
+    return {
+      label: this.dataProduct.title ?? this.dataProduct.name,
+      value: new DepotEntityWithOrigin(
+        undefined,
+        this.dataProduct.name,
+        this.dataProduct.path,
+        CORE_PURE_PATH.DATA_PRODUCT,
+      ),
+    };
+  }
+
+  get isSupported(): boolean {
+    return (
+      this.dataProduct.nativeModelAccess !== undefined ||
+      // contains model access point group
+      this.dataProduct.accessPointGroups.filter(
+        filterByType(ModelAccessPointGroup),
+      ).length > 0
+    );
+  }
+
+  // includes model access point group if more than one group
+  get execOptions(): { label: string; value: NativeModelExecutionContext }[] {
+    return (
+      this.dataProduct.nativeModelAccess?.nativeModelExecutionContexts.map(
+        buildExecOptions,
+      ) ?? []
+    ).sort(compareLabelFn);
+  }
+
+  override async propagateExecutionContextChange(
+    requireReBuildingGraph?: boolean | undefined,
+  ): Promise<void> {
+    const currentMapping = this.executionContextState.mapping;
+    const execMapping = this.selectedExecContext.mapping.value;
+    if (execMapping !== currentMapping) {
+      this.changeMapping(execMapping, {
+        keepQueryContent: true,
+      });
+      const classes = resolveUsableDataProductClasses(
+        this.nativeModelAccess.featuredElements,
+        this.selectedExecContext.mapping.value,
+        this.graphManagerState,
+        undefined,
+      );
+      if (this.class && !classes.includes(this.class)) {
+        this.setClass(classes[0]);
+      }
+    }
+  }
+}

package/tsconfig.json

@@ -219,6 +219,7 @@
     "./src/stores/workflows/FunctionQueryBuilderState.ts",
     "./src/stores/workflows/MappingQueryBuilderState.ts",
     "./src/stores/workflows/ServiceQueryBuilderState.ts",
+    "./src/stores/workflows/dataProduct/DataProductQueryBuilderState.ts",
     "./src/components/QueryBuilder.tsx",
     "./src/components/QueryBuilderConstantExpressionPanel.tsx",
     "./src/components/QueryBuilderDiffPanel.tsx",
@@ -282,6 +283,7 @@
     "./src/components/shared/QueryBuilderVariableSelector.tsx",
     "./src/components/shared/V1_BasicValueSpecificationEditor.tsx",
     "./src/components/workflows/ClassQueryBuilder.tsx",
+    "./src/components/workflows/DataProductQueryBuilder.tsx",
     "./src/components/workflows/MappingQueryBuilder.tsx",
     "./src/components/workflows/ServiceQueryBuilder.tsx"
   ],