@finos/legend-extension-dsl-data-space 10.1.90 → 10.1.93

package/src/stores/query/DataSpaceTemplateQueryCreatorStore.ts

@@ -0,0 +1,219 @@
+/**
+ * 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 {
+  extractElementNameFromPath,
+  type Query,
+  type RawLambda,
+} from '@finos/legend-graph';
+import {
+  QueryEditorStore,
+  type QueryPersistConfiguration,
+  type LegendQueryApplicationStore,
+  createViewProjectHandler,
+  createViewSDLCProjectHandler,
+} from '@finos/legend-application-query';
+import {
+  type DepotServerClient,
+  StoreProjectData,
+  LATEST_VERSION_ALIAS,
+} from '@finos/legend-server-depot';
+import { filterByType, guaranteeNonNullable, uuid } from '@finos/legend-shared';
+
+import { getDataSpace } from '../../graph-manager/DSL_DataSpace_GraphManagerHelper.js';
+import {
+  DataSpaceQueryBuilderState,
+  DataSpaceProjectInfo,
+} from './DataSpaceQueryBuilderState.js';
+import type { DataSpaceInfo } from './DataSpaceInfo.js';
+import { generateDataSpaceTemplateQueryViewerRoute } from '../../__lib__/query/DSL_DataSpace_LegendQueryNavigation.js';
+import {
+  DataSpaceExecutableTemplate,
+  type DataSpaceExecutionContext,
+} from '../../graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.js';
+import type { QueryBuilderState } from '@finos/legend-query-builder';
+import type { ProjectGAVCoordinates } from '@finos/legend-storage';
+import { DSL_DataSpace_getGraphManagerExtension } from '../../graph-manager/protocol/pure/DSL_DataSpace_PureGraphManagerExtension.js';
+import { retrieveAnalyticsResultCache } from '../../graph-manager/action/analytics/DataSpaceAnalysisHelper.js';
+import {
+  createQueryDataSpaceTaggedValue,
+  createQueryClassTaggedValue,
+} from './DataSpaceQueryCreatorStore.js';
+
+export class DataSpaceTemplateQueryCreatorStore extends QueryEditorStore {
+  readonly groupId: string;
+  readonly artifactId: string;
+  readonly versionId: string;
+  readonly dataSpacePath: string;
+  readonly templateQueryTitle: string;
+
+  constructor(
+    applicationStore: LegendQueryApplicationStore,
+    depotServerClient: DepotServerClient,
+    groupId: string,
+    artifactId: string,
+    versionId: string,
+    dataSpacePath: string,
+    templateQueryTitle: string,
+  ) {
+    super(applicationStore, depotServerClient);
+
+    this.groupId = groupId;
+    this.artifactId = artifactId;
+    this.versionId = versionId;
+    this.dataSpacePath = dataSpacePath;
+    this.templateQueryTitle = templateQueryTitle;
+  }
+
+  getProjectInfo(): ProjectGAVCoordinates {
+    return {
+      groupId: this.groupId,
+      artifactId: this.artifactId,
+      versionId: this.versionId,
+    };
+  }
+
+  async initializeQueryBuilderState(): Promise<QueryBuilderState> {
+    const dataSpace = getDataSpace(
+      this.dataSpacePath,
+      this.graphManagerState.graph,
+    );
+    const dataSpaceExecutableTemplate = guaranteeNonNullable(
+      dataSpace.executables
+        ?.filter(filterByType(DataSpaceExecutableTemplate))
+        .find((executable) => executable.title === this.templateQueryTitle),
+      `Can't find template query with title '${this.templateQueryTitle}'`,
+    );
+    const executionContext = guaranteeNonNullable(
+      dataSpaceExecutableTemplate.executionContextKey
+        ? dataSpace.executionContexts.filter(
+            (ec) => ec.name === dataSpaceExecutableTemplate.executionContextKey,
+          )[0]
+        : dataSpace.defaultExecutionContext,
+      `Can't find execution context '${dataSpaceExecutableTemplate.executionContextKey}'`,
+    );
+
+    let dataSpaceAnalysisResult;
+    try {
+      const project = StoreProjectData.serialization.fromJson(
+        await this.depotServerClient.getProject(this.groupId, this.artifactId),
+      );
+      dataSpaceAnalysisResult = await DSL_DataSpace_getGraphManagerExtension(
+        this.graphManagerState.graphManager,
+      ).retrieveDataSpaceAnalysisFromCache(() =>
+        retrieveAnalyticsResultCache(
+          project,
+          this.versionId,
+          dataSpace.path,
+          this.depotServerClient,
+        ),
+      );
+    } catch {
+      // do nothing
+    }
+    const projectInfo = new DataSpaceProjectInfo(
+      this.groupId,
+      this.artifactId,
+      this.versionId,
+      createViewProjectHandler(this.applicationStore),
+      createViewSDLCProjectHandler(
+        this.applicationStore,
+        this.depotServerClient,
+      ),
+    );
+    const sourceInfo = {
+      groupId: projectInfo.groupId,
+      artifactId: projectInfo.artifactId,
+      versionId: projectInfo.versionId,
+      dataSpace: dataSpace.path,
+    };
+    const queryBuilderState = new DataSpaceQueryBuilderState(
+      this.applicationStore,
+      this.graphManagerState,
+      this.depotServerClient,
+      dataSpace,
+      executionContext,
+      (dataSpaceInfo: DataSpaceInfo) => {
+        if (dataSpaceInfo.defaultExecutionContext) {
+          this.applicationStore.navigationService.navigator.goToLocation(
+            generateDataSpaceTemplateQueryViewerRoute(
+              guaranteeNonNullable(dataSpaceInfo.groupId),
+              guaranteeNonNullable(dataSpaceInfo.artifactId),
+              LATEST_VERSION_ALIAS, //always default to latest
+              dataSpaceInfo.path,
+              this.templateQueryTitle,
+            ),
+          );
+        } else {
+          this.applicationStore.notificationService.notifyWarning(
+            `Can't switch data space: default execution context not specified`,
+          );
+        }
+      },
+      true,
+      dataSpaceAnalysisResult,
+      (ec: DataSpaceExecutionContext) => {
+        this.applicationStore.navigationService.navigator.updateCurrentLocation(
+          generateDataSpaceTemplateQueryViewerRoute(
+            this.groupId,
+            this.artifactId,
+            this.versionId,
+            dataSpace.path,
+            this.templateQueryTitle,
+          ),
+        );
+      },
+      undefined,
+      undefined,
+      projectInfo,
+      this.applicationStore.config.options.queryBuilderConfig,
+      sourceInfo,
+    );
+    queryBuilderState.setExecutionContext(executionContext);
+    queryBuilderState.propagateExecutionContextChange(executionContext);
+    queryBuilderState.initializeWithQuery(dataSpaceExecutableTemplate.query);
+    return queryBuilderState;
+  }
+
+  getPersistConfiguration(
+    lambda: RawLambda,
+    options?: { update?: boolean | undefined },
+  ): QueryPersistConfiguration {
+    return {
+      defaultName: options?.update
+        ? `${extractElementNameFromPath(this.dataSpacePath)}`
+        : `New Query for ${extractElementNameFromPath(this.dataSpacePath)}[${
+            this.templateQueryTitle
+          }]`,
+      decorator: (query: Query): void => {
+        query.id = uuid();
+        query.groupId = this.groupId;
+        query.artifactId = this.artifactId;
+        query.versionId = this.versionId;
+        if (this.queryBuilderState?.class) {
+          query.taggedValues = [
+            createQueryDataSpaceTaggedValue(this.dataSpacePath),
+            createQueryClassTaggedValue(this.queryBuilderState.class.path),
+          ];
+        } else {
+          query.taggedValues = [
+            createQueryDataSpaceTaggedValue(this.dataSpacePath),
+          ];
+        }
+      },
+    };
+  }
+}

package/tsconfig.json

@@ -73,6 +73,7 @@
     "./src/stores/query/DataSpaceQueryBuilderState.ts",
     "./src/stores/query/DataSpaceQueryCreatorStore.ts",
     "./src/stores/query/DataSpaceQuerySetupStore.ts",
+    "./src/stores/query/DataSpaceTemplateQueryCreatorStore.ts",
     "./src/stores/studio/DataSpacePreviewState.ts",
     "./src/components/DSL_DataSpace_Icon.tsx",
     "./src/components/DSL_DataSpace_LegendApplicationPlugin.tsx",
@@ -94,6 +95,7 @@
     "./src/components/query/DataSpaceQueryBuilder.tsx",
     "./src/components/query/DataSpaceQueryCreator.tsx",
     "./src/components/query/DataSpaceQuerySetup.tsx",
+    "./src/components/query/DataSpaceTemplateQueryCreator.tsx",
     "./src/components/studio/DSL_DataSpace_LegendStudioApplicationPlugin.tsx",
     "./src/components/studio/DataSpacePreviewAction.tsx",
     "./src/components/studio/DataSpaceQueryAction.tsx",