@finos/legend-extension-dsl-data-space 10.2.0 → 10.2.1

package/src/components/query/DSL_DataSpace_LegendQueryApplicationPlugin.tsx

@@ -16,15 +16,17 @@
 
 import packageJson from '../../../package.json' assert { type: 'json' };
 import {
-  type QuerySetupActionConfiguration,
   type ExistingQueryEditorStateBuilder,
-  type ExistingQueryEditorStore,
+  type QueryEditorStore,
+  type QuerySetupActionConfiguration,
+  ExistingQueryEditorStore,
   LegendQueryApplicationPlugin,
   LEGEND_QUERY_APP_EVENT,
   createViewProjectHandler,
   createViewSDLCProjectHandler,
+  type QueryEditorActionConfiguration,
 } from '@finos/legend-application-query';
-import { SquareIcon } from '@finos/legend-art';
+import { ArrowCircleUpIcon, SquareIcon } from '@finos/legend-art';
 import {
   ActionAlertActionType,
   ActionAlertType,
@@ -34,6 +36,7 @@ import {
   DATA_SPACE_QUERY_ROUTE_PATTERN,
   generateDataSpaceQueryCreatorRoute,
   generateDataSpaceQuerySetupRoute,
+  generateDataSpaceTemplateQueryPromotionRoute,
 } from '../../__lib__/query/DSL_DataSpace_LegendQueryNavigation.js';
 import { DataSpaceQueryCreator } from './DataSpaceQueryCreator.js';
 import {
@@ -54,6 +57,7 @@ import type { DataSpaceInfo } from '../../stores/query/DataSpaceInfo.js';
 import { getOwnDataSpace } from '../../graph-manager/DSL_DataSpace_GraphManagerHelper.js';
 import {
   assertErrorThrown,
+  buildUrl,
   guaranteeNonNullable,
   LogEvent,
 } from '@finos/legend-shared';
@@ -71,6 +75,8 @@ import type {
   DataSpaceExecutionContext,
 } from '../../graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.js';
 import { DataSpaceTemplateQueryCreator } from './DataSpaceTemplateQueryCreator.js';
+import { DataSpaceTemplateQueryCreatorStore } from '../../stores/query/DataSpaceTemplateQueryCreatorStore.js';
+import { parseProjectIdentifier } from '@finos/legend-storage';
 
 const resolveExecutionContext = (
   dataSpace: DataSpace,
@@ -305,4 +311,112 @@ export class DSL_DataSpace_LegendQueryApplicationPlugin extends LegendQueryAppli
       },
     ];
   }
+
+  override getExtraQueryHeaders(): ((
+    editorStore: QueryEditorStore,
+  ) => React.ReactNode | undefined)[] {
+    return [
+      (editorStore: QueryEditorStore): React.ReactNode | undefined => {
+        if (editorStore instanceof DataSpaceTemplateQueryCreatorStore) {
+          return (
+            <div className="query-editor__dataspace__header">
+              <div className="query-editor__header__content__main query-editor__header__content__title__text query-editor__dataspace__header__title__text">
+                {editorStore.templateQueryTitle}
+              </div>
+              <div className="query-editor__dataspace__header__title__tag">
+                template
+              </div>
+            </div>
+          );
+        }
+        return undefined;
+      },
+    ];
+  }
+
+  override getExtraQueryEditorActionConfigurations(): QueryEditorActionConfiguration[] {
+    return [
+      {
+        key: 'promote-as-curated-template-query',
+        renderer: (editorStore, queryBuilderState) => {
+          const proceedCuratedTemplateQueryPromotion =
+            async (): Promise<void> => {
+              if (
+                !(
+                  editorStore instanceof ExistingQueryEditorStore &&
+                  queryBuilderState instanceof DataSpaceQueryBuilderState
+                )
+              ) {
+                return;
+              }
+              // fetch project data
+              const project = StoreProjectData.serialization.fromJson(
+                await editorStore.depotServerClient.getProject(
+                  editorStore.lightQuery.groupId,
+                  editorStore.lightQuery.artifactId,
+                ),
+              );
+
+              // find the matching SDLC instance
+              const projectIDPrefix = parseProjectIdentifier(
+                project.projectId,
+              ).prefix;
+              const matchingSDLCEntry =
+                editorStore.applicationStore.config.studioInstances.find(
+                  (entry) => entry.sdlcProjectIDPrefix === projectIDPrefix,
+                );
+              if (matchingSDLCEntry) {
+                editorStore.applicationStore.navigationService.navigator.visitAddress(
+                  buildUrl([
+                    editorStore.applicationStore.config.studioApplicationUrl,
+                    generateDataSpaceTemplateQueryPromotionRoute(
+                      editorStore.lightQuery.groupId,
+                      editorStore.lightQuery.artifactId,
+                      editorStore.lightQuery.versionId,
+                      queryBuilderState.dataSpace.path,
+                      editorStore.lightQuery.id,
+                    ),
+                  ]),
+                );
+              } else {
+                editorStore.applicationStore.notificationService.notifyWarning(
+                  `Can't find the corresponding SDLC instance to productionize the query`,
+                );
+              }
+            };
+
+          const proceed = (): void => {
+            queryBuilderState.changeDetectionState.alertUnsavedChanges(() => {
+              proceedCuratedTemplateQueryPromotion().catch(
+                editorStore.applicationStore.alertUnhandledError,
+              );
+            });
+          };
+
+          return (
+            <>
+              {editorStore instanceof ExistingQueryEditorStore &&
+                queryBuilderState instanceof DataSpaceQueryBuilderState && (
+                  <button
+                    className="query-editor__header__action btn--dark"
+                    tabIndex={-1}
+                    onClick={proceed}
+                    title={
+                      !(editorStore instanceof ExistingQueryEditorStore)
+                        ? 'Please save your query first before promoting'
+                        : 'Promote Curated Template query...'
+                    }
+                  >
+                    <ArrowCircleUpIcon className="query-editor__header__action__icon--productionize" />
+                    <div className="query-editor__header__action__label">
+                      Promote as Template Query
+                    </div>
+                  </button>
+                )}
+            </>
+          );
+        },
+      },
+    ];
+  }
 }

package/src/components/query/DataSpaceQueryBuilderTemplateQueryPanelContent.tsx

@@ -100,7 +100,7 @@ const DataSpaceTemplateQueryDialog = observer(
               queryBuilderState.projectInfo.artifactId,
               queryBuilderState.projectInfo.versionId,
               queryBuilderState.dataSpace.path,
-              template.title,
+              template.id,
             ),
           ),
         );

package/src/components/query/DataSpaceTemplateQueryCreator.tsx

@@ -33,8 +33,8 @@ const DataSpaceTemplateQueryCreatorStoreProvider: React.FC<{
   children: React.ReactNode;
   gav: string;
   dataSpacePath: string;
-  templateQueryTitle: string;
-}> = ({ children, gav, dataSpacePath, templateQueryTitle }) => {
+  templateQueryId: string;
+}> = ({ children, gav, dataSpacePath, templateQueryId }) => {
   const { groupId, artifactId, versionId } = parseGAVCoordinates(gav);
   const applicationStore = useLegendQueryApplicationStore();
   const baseStore = useLegendQueryBaseStore();
@@ -47,7 +47,7 @@ const DataSpaceTemplateQueryCreatorStoreProvider: React.FC<{
         artifactId,
         versionId,
         dataSpacePath,
-        templateQueryTitle,
+        templateQueryId,
       ),
   );
   return (
@@ -65,16 +65,16 @@ export const DataSpaceTemplateQueryCreator = observer(() => {
     parameters[
       DATA_SPACE_TEMPLATE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.DATA_SPACE_PATH
     ];
-  const templateQueryTitle =
+  const templateQueryId =
     parameters[
-      DATA_SPACE_TEMPLATE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.TEMPLATE_QUERY_TITLE
+      DATA_SPACE_TEMPLATE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.TEMPLATE_QUERY_ID
     ];
 
   return (
     <DataSpaceTemplateQueryCreatorStoreProvider
       gav={gav}
       dataSpacePath={dataSpacePath}
-      templateQueryTitle={templateQueryTitle}
+      templateQueryId={templateQueryId}
     >
       <QueryEditor />
     </DataSpaceTemplateQueryCreatorStoreProvider>

package/src/components/studio/DSL_DataSpace_LegendStudioApplicationPlugin.tsx

@@ -48,7 +48,10 @@ import {
 } from '../../graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.js';
 import { DSL_DATA_SPACE_LEGEND_STUDIO_DOCUMENTATION_KEY } from '../../__lib__/studio/DSL_DataSpace_LegendStudioDocumentation.js';
 import { SIMPLE_DATA_SPACE_SNIPPET } from '../../__lib__/studio/DSL_DataSpace_LegendStudioCodeSnippet.js';
-import type { DocumentationEntry } from '@finos/legend-application';
+import type {
+  ApplicationPageEntry,
+  DocumentationEntry,
+} from '@finos/legend-application';
 import { DataSpaceIcon } from '../DSL_DataSpace_Icon.js';
 import { DataSpacePreviewState } from '../../stores/studio/DataSpacePreviewState.js';
 import {
@@ -57,6 +60,8 @@ import {
 } from './DataSpacePreviewAction.js';
 import type { PureGrammarTextSuggestion } from '@finos/legend-lego/code-editor';
 import { DataSpaceQueryAction } from './DataSpaceQueryAction.js';
+import { DataSpaceTemplateQueryPromotionReviewer } from './DataSpaceTemplateQueryPromoteReview.js';
+import { DATA_SPACE_QUERY_ROUTE_PATTERN } from '../../__lib__/query/DSL_DataSpace_LegendQueryNavigation.js';
 
 const DATA_SPACE_ELEMENT_TYPE = 'DATA SPACE';
 const DATA_SPACE_ELEMENT_PROJECT_EXPLORER_DND_TYPE =
@@ -80,6 +85,18 @@ export class DSL_DataSpace_LegendStudioApplicationPlugin
     ];
   }
 
+  override getExtraApplicationPageEntries(): ApplicationPageEntry[] {
+    return [
+      {
+        key: 'promote-as-curated-template-query-page',
+        addressPatterns: [
+          DATA_SPACE_QUERY_ROUTE_PATTERN.PROMOTE_TEMPLATE_QUERY,
+        ],
+        renderer: DataSpaceTemplateQueryPromotionReviewer,
+      },
+    ];
+  }
+
   override getExtraExplorerContextMenuItemRendererConfigurations(): ExplorerContextMenuItemRendererConfiguration[] {
     return [
       {

package/src/components/studio/DataSpaceTemplateQueryPromoteReview.tsx

@@ -0,0 +1,285 @@
+/**
+ * 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 { BlankPanelContent, GitBranchIcon, clsx } from '@finos/legend-art';
+import { observer, useLocalObservable } from 'mobx-react-lite';
+import { useApplicationStore } from '@finos/legend-application';
+import { DataSpaceTemplateQueryPromotionReviewerStore } from '../../stores/query/DataSpaceTemplateQueryPromotionReviewerStore.js';
+import {
+  DATA_SPACE_TEMPLATE_QUERY_PROMOTION_ROUTE_PATTERN_TOKEN,
+  type DataSpaceTemplateQueryPromotionReviewerPathParams,
+} from '../../__lib__/query/DSL_DataSpace_LegendQueryNavigation.js';
+import { useParams } from '@finos/legend-application/browser';
+import {
+  ActivityBarMenu,
+  LEGEND_STUDIO_TEST_ID,
+  useLegendStudioApplicationStore,
+  useLegendStudioBaseStore,
+} from '@finos/legend-application-studio';
+import { createContext, useContext } from 'react';
+import { guaranteeNonNullable } from '@finos/legend-shared';
+import { flowResult } from 'mobx';
+
+const TemplateQueryPromotionReviewerStoreContext = createContext<
+  DataSpaceTemplateQueryPromotionReviewerStore | undefined
+>(undefined);
+
+const DataSpaceTemplateQueryPromotionReviewerStoreProvider: React.FC<{
+  children: React.ReactNode;
+  dataSpacePath: string;
+  queryId: string;
+}> = ({ children, dataSpacePath, queryId }) => {
+  const applicationStore = useLegendStudioApplicationStore();
+  const baseStore = useLegendStudioBaseStore();
+  const store = useLocalObservable(
+    () =>
+      new DataSpaceTemplateQueryPromotionReviewerStore(
+        applicationStore,
+        baseStore.sdlcServerClient,
+        baseStore.depotServerClient,
+      ),
+  );
+  store.initialize(queryId, dataSpacePath);
+  return (
+    <TemplateQueryPromotionReviewerStoreContext.Provider value={store}>
+      {children}
+    </TemplateQueryPromotionReviewerStoreContext.Provider>
+  );
+};
+
+const useTemplateQueryPromotionReviewerStore =
+  (): DataSpaceTemplateQueryPromotionReviewerStore =>
+    guaranteeNonNullable(
+      useContext(TemplateQueryPromotionReviewerStoreContext),
+      `Can't find query productionizer store in context`,
+    );
+
+const TemplateQueryPromotionReviewerContent = observer(() => {
+  const applicationStore = useApplicationStore();
+  const queryPromotionReviewerStore = useTemplateQueryPromotionReviewerStore();
+  const isLoadingEditor = !queryPromotionReviewerStore.initState.hasCompleted;
+
+  // workspace name
+  const changeWorkspaceName: React.ChangeEventHandler<HTMLInputElement> = (
+    event,
+  ) => queryPromotionReviewerStore.setWorkspaceName(event.target.value);
+
+  // template query
+  const onChangeTemplateQueryId: React.ChangeEventHandler<HTMLInputElement> = (
+    event,
+  ) => queryPromotionReviewerStore.setTemplateQueryId(event.target.value);
+
+  const onChangeTemplateQueryTitle: React.ChangeEventHandler<
+    HTMLInputElement
+  > = (event) =>
+    queryPromotionReviewerStore.setTemplateQueryTitle(event.target.value);
+
+  const onChangeTemplateQueryDescription: React.ChangeEventHandler<
+    HTMLInputElement
+  > = (event) =>
+    queryPromotionReviewerStore.setTemplateQueryDescription(event.target.value);
+
+  // actions
+  const promoteTemplateQuery = (): void => {
+    flowResult(queryPromotionReviewerStore.promoteAsTemplateQuery()).catch(
+      applicationStore.alertUnhandledError,
+    );
+  };
+
+  return (
+    <div className="app__page">
+      {isLoadingEditor && (
+        <BlankPanelContent>
+          {queryPromotionReviewerStore.initState.message ??
+            queryPromotionReviewerStore.graphManagerState.systemBuildState
+              .message ??
+            queryPromotionReviewerStore.graphManagerState.dependenciesBuildState
+              .message ??
+            queryPromotionReviewerStore.graphManagerState.generationsBuildState
+              .message ??
+            queryPromotionReviewerStore.graphManagerState.graphBuildState
+              .message}
+        </BlankPanelContent>
+      )}
+      <div className="template-query-promotor">
+        <div className="template-query-promotor__body">
+          <div className="activity-bar">
+            <ActivityBarMenu />
+          </div>
+          <div
+            className="template-query-promotor__content"
+            data-testid={LEGEND_STUDIO_TEST_ID.SETUP__CONTENT}
+          >
+            <div className="template-query-promotor__content__main">
+              <div className="template-query-promotor__title">
+                Promote as Curated Template Query
+              </div>
+              <div className="template-query-promotor__title__prompt">
+                We will promote this query as a curated template query in
+                dataspace. This automated process will generate a code review
+                and workspace. Please get the generated code review reviewed and
+                approved.
+              </div>
+              <div className="template-query-promotor__group template-query-promotor__group--workspace">
+                <div className="template-query-promotor__group__header">
+                  workspace
+                </div>
+                <div className="template-query-promotor__group__content">
+                  <div className="template-query-promotor__input">
+                    <div
+                      className="template-query-promotor__input__icon"
+                      title="workspace"
+                    >
+                      <GitBranchIcon className="template-query-promotor__input__icon--workspce" />
+                    </div>
+                    <div className="input-group template-query-promotor__input__input">
+                      <input
+                        className={clsx(
+                          'input input--dark input-group__input',
+                          {
+                            'input-group__input--error':
+                              !queryPromotionReviewerStore.isWorkspaceNameValid,
+                          },
+                        )}
+                        spellCheck={false}
+                        value={queryPromotionReviewerStore.workspaceName}
+                        placeholder="Enter a name for your workspace"
+                        onChange={changeWorkspaceName}
+                      />
+                      {!queryPromotionReviewerStore.isWorkspaceNameValid && (
+                        <div className="input-group__error-message">
+                          Workspace already existed
+                        </div>
+                      )}
+                    </div>
+                  </div>
+                </div>
+              </div>
+              <div className="template-query-promotor__group template-query-promotor__group--template">
+                <div className="template-query-promotor__group__header">
+                  template query
+                </div>
+                <div className="template-query-promotor__group__content">
+                  <div className="template-query-promotor__input">
+                    <div className="template-query-promotor__input__label">
+                      id
+                    </div>
+                    <div className="input-group template-query-promotor__input__input">
+                      <input
+                        className={clsx(
+                          'input input--dark input-group__input',
+                          {
+                            'input-group__input--error':
+                              !queryPromotionReviewerStore.isTemplateQueryIdValid,
+                          },
+                        )}
+                        spellCheck={false}
+                        placeholder="Create an id for your template query"
+                        value={queryPromotionReviewerStore.templateQueryId}
+                        onChange={onChangeTemplateQueryId}
+                      />
+                      {!queryPromotionReviewerStore.isTemplateQueryIdValid && (
+                        <div className="input-group__error-message">
+                          Invalid template query id
+                        </div>
+                      )}
+                    </div>
+                  </div>
+                  <div className="template-query-promotor__input">
+                    <div className="template-query-promotor__input__label">
+                      title
+                    </div>
+                    <div className="input-group template-query-promotor__input__input">
+                      <input
+                        className="input input--dark input-group__input"
+                        spellCheck={false}
+                        placeholder="Create a title for your template query"
+                        value={queryPromotionReviewerStore.templateQueryTitle}
+                        onChange={onChangeTemplateQueryTitle}
+                      />
+                    </div>
+                  </div>
+                  <div className="template-query-promotor__input">
+                    <div className="template-query-promotor__input__label">
+                      description
+                    </div>
+                    <div className="input-group template-query-promotor__input__input">
+                      <input
+                        className="input input--dark input-group__input"
+                        spellCheck={false}
+                        placeholder="Add some descriptions for your template query"
+                        value={
+                          queryPromotionReviewerStore.templateQueryDescription
+                        }
+                        onChange={onChangeTemplateQueryDescription}
+                      />
+                    </div>
+                  </div>
+                </div>
+              </div>
+              <div className="template-query-promotor__actions">
+                <button
+                  className="template-query-promotor__next-btn btn--dark"
+                  onClick={promoteTemplateQuery}
+                  disabled={
+                    queryPromotionReviewerStore.promoteState.isInProgress ||
+                    !queryPromotionReviewerStore.currentQuery ||
+                    !queryPromotionReviewerStore.currentQueryInfo ||
+                    !queryPromotionReviewerStore.currentProject ||
+                    !queryPromotionReviewerStore
+                      .currentProjectConfigurationStatus?.isConfigured ||
+                    !queryPromotionReviewerStore.workspaceName ||
+                    !queryPromotionReviewerStore.templateQueryTitle ||
+                    !queryPromotionReviewerStore.isWorkspaceNameValid ||
+                    !queryPromotionReviewerStore.isTemplateQueryIdValid
+                  }
+                >
+                  Promote Query
+                </button>
+              </div>
+            </div>
+          </div>
+        </div>
+        <div
+          data-testid={LEGEND_STUDIO_TEST_ID.STATUS_BAR}
+          className="editor__status-bar"
+        />
+      </div>
+    </div>
+  );
+});
+
+export const DataSpaceTemplateQueryPromotionReviewer = observer(() => {
+  const parameters =
+    useParams<DataSpaceTemplateQueryPromotionReviewerPathParams>();
+  const dataSpacePath =
+    parameters[
+      DATA_SPACE_TEMPLATE_QUERY_PROMOTION_ROUTE_PATTERN_TOKEN.DATA_SPACE_PATH
+    ];
+  const queryId =
+    parameters[
+      DATA_SPACE_TEMPLATE_QUERY_PROMOTION_ROUTE_PATTERN_TOKEN.QUERY_ID
+    ];
+
+  return (
+    <DataSpaceTemplateQueryPromotionReviewerStoreProvider
+      dataSpacePath={dataSpacePath}
+      queryId={queryId}
+    >
+      <TemplateQueryPromotionReviewerContent />
+    </DataSpaceTemplateQueryPromotionReviewerStoreProvider>
+  );
+});

package/src/graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.ts

@@ -100,12 +100,14 @@ export class DataSpaceExecutableTemplate
   extends DataSpaceExecutable
   implements Hashable
 {
+  id!: string;
   query!: RawLambda;
   executionContextKey?: string;
 
   override get hashCode(): string {
     return hashArray([
       DATA_SPACE_HASH_STRUCTURE.DATA_SPACE_TEMPLATE_EXECUTABLE,
+      this.id,
       this.title,
       this.description ?? '',
       this.query,

package/src/graph-manager/action/analytics/DataSpaceAnalysis.ts

@@ -130,6 +130,7 @@ export abstract class DataSpaceExecutableInfo {
 }
 
 export class DataSpaceTemplateExecutableInfo extends DataSpaceExecutableInfo {
+  id!: string;
   executionContextKey!: string;
 }
 

package/src/graph-manager/protocol/pure/DSL_DataSpace_PureGraphManagerExtension.ts

@@ -16,6 +16,7 @@
 
 import {
   type AbstractPureGraphManager,
+  type RawLambda,
   AbstractPureGraphManagerExtension,
 } from '@finos/legend-graph';
 import type { Entity } from '@finos/legend-storage';
@@ -38,6 +39,20 @@ export abstract class DSL_DataSpace_PureGraphManagerExtension extends AbstractPu
     cacheRetriever: () => Promise<PlainObject<DataSpaceAnalysisResult>>,
     actionState?: ActionState,
   ): Promise<DataSpaceAnalysisResult | undefined>;
+
+  abstract addNewExecutableToDataSpaceEntity(
+    dataSpaceEntity: Entity,
+    executable: {
+      id: string;
+      title: string;
+      mapping: string;
+      runtime: string;
+      query: RawLambda;
+      description?: string;
+    },
+  ): Promise<Entity>;
+
+  abstract IsTemplateQueryIdValid(dataSpaceEntity: Entity, id: string): boolean;
 }
 
 export const DSL_DataSpace_getGraphManagerExtension = (

package/src/graph-manager/protocol/pure/DSL_DataSpace_PureProtocolProcessorPlugin.ts

@@ -229,6 +229,7 @@ export class DSL_DataSpace_PureProtocolProcessorPlugin
                   executableProtocol instanceof V1_DataSpaceTemplateExecutable
                 ) {
                   const executable = new DataSpaceExecutableTemplate();
+                  executable.id = executableProtocol.id;
                   executable.title = executableProtocol.title;
                   executable.description = executableProtocol.description;
                   executable.query = V1_buildRawLambdaWithResolvedPaths(
@@ -418,6 +419,7 @@ export class DSL_DataSpace_PureProtocolProcessorPlugin
           protocol.executables = metamodel.executables?.map((executable) => {
             if (executable instanceof DataSpaceExecutableTemplate) {
               const executableProtocol = new V1_DataSpaceTemplateExecutable();
+              executableProtocol.id = executable.id;
               executableProtocol.title = executable.title;
               executableProtocol.description = executable.description;
               if (executable.executionContextKey) {