@finos/legend-application-query 13.8.28 → 13.8.30

package/src/__lib__/LegendQueryNavigation.ts

@@ -47,6 +47,12 @@ export enum DATA_PRODUCT_SAMPLE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN {
   SAMPLE_QUERY_ID = 'sampleQueryId',
 }
 
+export enum INGEST_QUERY_CREATOR_ROUTE_PATTERN_TOKEN {
+  GAV = 'gav',
+  INGEST_DEFINITION_PATH = 'ingestDefinitionPath',
+  DATA_SET = 'dataSet',
+}
+
 export const LEGEND_QUERY_ROUTE_PATTERN = Object.freeze({
   DEFAULT: '/',
   SETUP: '/setup',
@@ -62,6 +68,7 @@ export const LEGEND_QUERY_ROUTE_PATTERN = Object.freeze({
   DATA_CUBE_EXISTING_QUERY: `/edit/:${LEGEND_QUERY_ROUTE_PATTERN_TOKEN.QUERY_ID}/cube`,
   DATA_PRODUCT: `/data-product/:${DATA_PRODUCT_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_ACCESS_TYPE}/:${DATA_PRODUCT_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.GAV}/:${DATA_PRODUCT_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_PATH}/:${DATA_PRODUCT_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_ACCESS_ID}`,
   DATA_PRODUCT_SAMPLE_QUERY: `/data-product/native/sample-query/:${DATA_PRODUCT_SAMPLE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.GAV}/:${DATA_PRODUCT_SAMPLE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_PATH}/:${DATA_PRODUCT_SAMPLE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.SAMPLE_QUERY_ID}`,
+  INGEST_QUERY: `/ingest/:${INGEST_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.GAV}/:${INGEST_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.INGEST_DEFINITION_PATH}/:${INGEST_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.DATA_SET}`,
   // Developer-only diagnostic page for inspecting depot DataSpace
   // analytics artifact sizes. See `DataSpaceArtifactInspector`.
   DEV_DATA_SPACE_INSPECTOR: '/dev/dataspace-inspector',
@@ -82,6 +89,12 @@ export type DataProductSampleQueryPathParams = {
   [DATA_PRODUCT_SAMPLE_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.SAMPLE_QUERY_ID]: string;
 };
 
+export type IngestQueryCreatorPathParams = {
+  [INGEST_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.GAV]: string;
+  [INGEST_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.INGEST_DEFINITION_PATH]: string;
+  [INGEST_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.DATA_SET]: string;
+};
+
 /**
  * Generates a data product route for the given access type.
  */
@@ -168,6 +181,28 @@ export const generateDataProductSampleQueryRoute = (
       sampleQueryId,
   });
 
+// TODO: figure out where this URL should be generated from. Candidates:
+//   - a "create ingest query" entry point in the query setup landing page
+//   - a deep-link from the ingest definition page in Legend Studio
+// Once decided, wire callers here.
+export const generateIngestQueryCreatorRoute = (
+  groupId: string,
+  artifactId: string,
+  versionId: string,
+  ingestDefinitionPath: string,
+  dataSet: string,
+): string =>
+  generatePath(LEGEND_QUERY_ROUTE_PATTERN.INGEST_QUERY, {
+    [INGEST_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.GAV]: generateGAVCoordinates(
+      groupId,
+      artifactId,
+      versionId,
+    ),
+    [INGEST_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.INGEST_DEFINITION_PATH]:
+      ingestDefinitionPath,
+    [INGEST_QUERY_CREATOR_ROUTE_PATTERN_TOKEN.DATA_SET]: dataSet,
+  });
+
 // setup
 
 export enum LEGEND_QUERY_SETUP_QUERY_PARAM_TOKEN {

package/src/components/Core_LegendQueryApplicationPlugin.tsx

@@ -135,6 +135,7 @@ import { useQueryEditorStore } from './QueryEditorStoreProvider.js';
 import { useLegendQueryApplicationStore } from './LegendQueryFrameworkProvider.js';
 import { LegendQueryDataSpaceQueryBuilderState } from '../stores/data-space/query-builder/LegendQueryDataSpaceQueryBuilderState.js';
 import { LegendQueryDataProductQueryBuilderState } from '../stores/data-product/query-builder/LegendQueryDataProductQueryBuilderState.js';
+import { IngestLegendQueryBuilderState } from '../stores/ingest/IngestLegendQueryBuilderState.js';
 import { renderDataProductSampleQueryPanelContent } from './data-product/DataProductSampleQueryPanel.js';
 
 export const QUERY_DATACUBE_USAGE_TITLE = 'Legend DataCube';
@@ -647,6 +648,25 @@ export class Core_LegendQueryApplicationPlugin extends LegendQueryApplicationPlu
         },
         icon: <InfoCircleIcon />,
       },
+      {
+        key: 'about-ingest',
+        title: 'About Ingest',
+        label: 'About Ingestion Data Set',
+        disableFunc: (queryBuilderState): boolean =>
+          !(queryBuilderState instanceof IngestLegendQueryBuilderState),
+        onClick: (queryBuilderState): void => {
+          if (
+            queryBuilderState.workflowState.actionConfig instanceof
+              QueryBuilderActionConfig_QueryApplication &&
+            queryBuilderState instanceof IngestLegendQueryBuilderState
+          ) {
+            queryBuilderState.workflowState.actionConfig.editorStore.setShowIngestInfo(
+              true,
+            );
+          }
+        },
+        icon: <InfoCircleIcon />,
+      },
     ];
   }
 

package/src/components/LegendQueryWebApplication.tsx

@@ -42,6 +42,7 @@ import { LEGACY_DATA_SPACE_QUERY_ROUTE_PATTERN } from '../__lib__/DSL_DataSpace_
 import { DataSpaceTemplateQueryCreator } from './data-space/DataSpaceTemplateQueryCreator.js';
 import { QueryCreator } from './data-space/DataProductQueryCreator.js';
 import { DataProductSampleQueryCreator } from './data-product/DataProductSampleQueryCreator.js';
+import { IngestQueryCreator } from './ingest/IngestQueryCreator.js';
 import { ExistingQueryDataCubeViewer } from './data-cube/ExistingQueryDataCubeViewer.js';
 import { DataSpaceArtifactInspector } from './DataSpaceArtifactInspector.js';
 import {
@@ -113,6 +114,19 @@ const LegendQueryWebApplicationRouter = observer(() => {
             path={LEGEND_QUERY_ROUTE_PATTERN.DATA_PRODUCT}
             element={<QueryCreator />}
           />
+          {/*
+            Ingest query creator. Resolves `ingestDefinitionPath` and
+            `dataSet` from the route, fetches only the ingest definition
+            entity from Depot (no full graph build), and opens the editor
+            with a `QueryIngestExecutionContext`. The creator store builds
+            an adhoc lakehouse runtime (user env + consumer warehouse) and
+            selects it on the query builder state so execution works without
+            a packaged runtime.
+          */}
+          <Route
+            path={LEGEND_QUERY_ROUTE_PATTERN.INGEST_QUERY}
+            element={<IngestQueryCreator />}
+          />
           <Route
             path={LEGEND_QUERY_ROUTE_PATTERN.CREATE_FROM_SERVICE_QUERY}
             element={<ServiceQueryCreator />}

package/src/components/QueryEditor.tsx

@@ -98,6 +98,8 @@ import {
 import { LegendQueryInfo } from './LegendQueryAppInfo.js';
 import { QueryEditorDataspaceInfoModal } from './data-space/DataSpaceInfo.js';
 import { QueryEditorDataProductInfoModal } from './data-product/DataProductInfo.js';
+import { QueryEditorIngestInfoModal } from './ingest/IngestInfo.js';
+import { IngestLegendQueryBuilderState } from '../stores/ingest/IngestLegendQueryBuilderState.js';
 import { DataSpaceQueryBuilderState } from '@finos/legend-extension-dsl-data-space/application';
 import { LegendQueryBareQueryBuilderState } from '../stores/data-space/LegendQueryBareQueryBuilderState.js';
 import { extractQueryParams } from './utils/QueryParameterUtils.js';
@@ -1210,6 +1212,16 @@ export const QueryEditor = observer(() => {
             closeModal={() => editorStore.setShowDataProductInfo(false)}
           />
         )}
+      {editorStore.showIngestInfo &&
+        editorStore.queryBuilderState instanceof
+          IngestLegendQueryBuilderState && (
+          <QueryEditorIngestInfoModal
+            editorStore={editorStore}
+            queryBuilderState={editorStore.queryBuilderState}
+            open={editorStore.showIngestInfo}
+            closeModal={() => editorStore.setShowIngestInfo(false)}
+          />
+        )}
       {isExistingQuery &&
         editorStore.updateState.showQueryInfo &&
         editorStore.query && (

package/src/components/data-product/LegendQueryDataProductQueryBuilder.tsx

@@ -24,150 +24,25 @@ import {
   AnchorLinkIcon,
   CogIcon,
   ControlledDropdownMenu,
-  Dialog,
   MenuContent,
   MenuContentItem,
   MenuContentItemIcon,
   MenuContentItemLabel,
-  Modal,
-  ModalBody,
-  ModalFooter,
-  ModalFooterButton,
-  ModalHeader,
-  ModalHeaderActions,
-  ModalTitle,
   MoreVerticalIcon,
   PanelHeader,
   PanelHeaderActionItem,
   PanelHeaderActions,
-  TimesIcon,
 } from '@finos/legend-art';
 import { observer } from 'mobx-react-lite';
 import { LakehouseRuntime } from '@finos/legend-graph';
 import { useEffect, useState } from 'react';
 import type { LegendQueryDataProductQueryBuilderState } from '../../stores/data-product/query-builder/LegendQueryDataProductQueryBuilderState.js';
 import { formatDataProductOptionLabel } from '../shared/LegendQueryDataProductOptionLabel.js';
-import { LegendQueryUserDataHelper } from '../../__lib__/LegendQueryUserDataHelper.js';
+import { LakehouseRuntimeConfigModal } from '../shared/LakehouseRuntimeConfigModal.js';
 
 /**
  * Modal for editing LakehouseRuntime configuration (environment and warehouse).
  */
-const LakehouseRuntimeConfigModal = observer(
-  (props: {
-    executionState:
-      | ModelAccessPointDataProductExecutionState
-      | LakehouseDataProductExecutionState;
-    open: boolean;
-    onClose: () => void;
-    darkMode: boolean;
-  }) => {
-    const { executionState, open, onClose, darkMode } = props;
-    const lakehouseRuntime =
-      executionState.selectedRuntime?.runtimeValue instanceof LakehouseRuntime
-        ? executionState.selectedRuntime.runtimeValue
-        : undefined;
-    const [env, setEnv] = useState(lakehouseRuntime?.environment ?? '');
-    const [warehouse, setWarehouse] = useState(
-      lakehouseRuntime?.warehouse ?? '',
-    );
-
-    // sync local state when the modal opens or the runtime changes
-    useEffect(() => {
-      if (open && lakehouseRuntime) {
-        setEnv(lakehouseRuntime.environment ?? '');
-        setWarehouse(lakehouseRuntime.warehouse ?? '');
-      }
-    }, [open, lakehouseRuntime]);
-
-    const applicationStore = useApplicationStore();
-
-    const handleApply = (): void => {
-      if (lakehouseRuntime) {
-        const newEnv = env || undefined;
-        const newWarehouse = warehouse || undefined;
-        const hasChanged =
-          newEnv !== lakehouseRuntime.environment ||
-          newWarehouse !== lakehouseRuntime.warehouse;
-        lakehouseRuntime.environment = newEnv;
-        lakehouseRuntime.warehouse = newWarehouse;
-        if (hasChanged) {
-          LegendQueryUserDataHelper.persistLakehouseUserInfo(
-            applicationStore.userDataService,
-            {
-              env: newEnv,
-              snowflakeWarehouse: newWarehouse,
-            },
-          );
-        }
-      }
-      onClose();
-    };
-
-    if (!lakehouseRuntime) {
-      return null;
-    }
-
-    return (
-      <Dialog onClose={onClose} open={open}>
-        <Modal darkMode={darkMode}>
-          <ModalHeader>
-            <ModalTitle
-              icon={<CogIcon />}
-              title="Lakehouse Runtime Configuration"
-            />
-            <ModalHeaderActions>
-              <button
-                className="modal__header__action"
-                tabIndex={-1}
-                onClick={onClose}
-              >
-                <TimesIcon />
-              </button>
-            </ModalHeaderActions>
-          </ModalHeader>
-          <ModalBody>
-            <div className="panel__content__form__section">
-              <div className="panel__content__form__section__header__label">
-                Environment
-              </div>
-              <input
-                className="panel__content__form__section__input input--dark input--small"
-                spellCheck={false}
-                value={env}
-                placeholder="(optional)"
-                onChange={(e) => setEnv(e.target.value)}
-              />
-            </div>
-            <div className="panel__content__form__section">
-              <div className="panel__content__form__section__header__label">
-                Warehouse
-              </div>
-              <input
-                className="panel__content__form__section__input input--dark input--small"
-                spellCheck={false}
-                value={warehouse}
-                placeholder="(optional)"
-                onChange={(e) => setWarehouse(e.target.value)}
-              />
-            </div>
-          </ModalBody>
-          <ModalFooter>
-            <ModalFooterButton
-              text="Apply"
-              onClick={handleApply}
-              type="primary"
-            />
-            <ModalFooterButton
-              text="Cancel"
-              onClick={onClose}
-              type="secondary"
-            />
-          </ModalFooter>
-        </Modal>
-      </Dialog>
-    );
-  },
-);
 
 const LegendDataProductQueryBuilderSetupPanelContent = observer(
   (props: { queryBuilderState: LegendQueryDataProductQueryBuilderState }) => {
@@ -256,7 +131,12 @@ const LegendDataProductQueryBuilderSetupPanelContent = observer(
         {(executionState instanceof ModelAccessPointDataProductExecutionState ||
           executionState instanceof LakehouseDataProductExecutionState) && (
           <LakehouseRuntimeConfigModal
-            executionState={executionState}
+            lakehouseRuntime={
+              executionState.selectedRuntime?.runtimeValue instanceof
+              LakehouseRuntime
+                ? executionState.selectedRuntime.runtimeValue
+                : undefined
+            }
             open={isLakehouseConfigModalOpen}
             onClose={() => setIsLakehouseConfigModalOpen(false)}
             darkMode={

package/src/components/ingest/IngestInfo.tsx

@@ -0,0 +1,197 @@
+/**
+ * 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 {
+  Dialog,
+  Modal,
+  ModalTitle,
+  Panel,
+  PanelFullContent,
+} from '@finos/legend-art';
+import {
+  LATEST_VERSION_ALIAS,
+  StoreProjectData,
+  VersionedProjectData,
+} from '@finos/legend-server-depot';
+import { observer } from 'mobx-react-lite';
+import { flowResult } from 'mobx';
+import { assertErrorThrown } from '@finos/legend-shared';
+import { LakehouseRuntime } from '@finos/legend-graph';
+import type { QueryEditorStore } from '../../stores/QueryEditorStore.js';
+import type { IngestLegendQueryBuilderState } from '../../stores/ingest/IngestLegendQueryBuilderState.js';
+import { EXTERNAL_APPLICATION_NAVIGATION__generateStudioSDLCProjectViewUrl } from '../../__lib__/LegendQueryNavigation.js';
+
+/**
+ * "About Ingest" info modal, mirroring `QueryEditorDataProductInfoModal`.
+ * Surfaces the project GAV, the ingest name + currently selected data set,
+ * the adhoc lakehouse runtime (environment + warehouse), and a link to the
+ * ingest definition's configuration in Studio.
+ */
+export const QueryEditorIngestInfoModal = observer(
+  (props: {
+    editorStore: QueryEditorStore;
+    queryBuilderState: IngestLegendQueryBuilderState;
+    open: boolean;
+    closeModal: () => void;
+  }) => {
+    const { editorStore, queryBuilderState, open, closeModal } = props;
+    const projectInfo = editorStore.getProjectInfo();
+    const ingestDefinition = queryBuilderState.ingestDefinition;
+    const lakehouseRuntime = queryBuilderState.lakehouseRuntime;
+
+    /**
+     * Open the given element path (or the project root if `undefined`) in
+     * Studio's SDLC project view. Mirrors `DataProductInfo.visitElement`.
+     */
+    const visitElement = async (path: string | undefined): Promise<void> => {
+      try {
+        if (projectInfo) {
+          const project = StoreProjectData.serialization.fromJson(
+            await editorStore.depotServerClient.getProject(
+              projectInfo.groupId,
+              projectInfo.artifactId,
+            ),
+          );
+          const versionId =
+            projectInfo.versionId === LATEST_VERSION_ALIAS
+              ? VersionedProjectData.serialization.fromJson(
+                  await editorStore.depotServerClient.getLatestVersion(
+                    projectInfo.groupId,
+                    projectInfo.artifactId,
+                  ),
+                ).versionId
+              : projectInfo.versionId;
+          editorStore.applicationStore.navigationService.navigator.visitAddress(
+            EXTERNAL_APPLICATION_NAVIGATION__generateStudioSDLCProjectViewUrl(
+              editorStore.applicationStore.config.studioApplicationUrl,
+              project.projectId,
+              versionId,
+              path,
+            ),
+          );
+        }
+      } catch (error) {
+        assertErrorThrown(error);
+        editorStore.applicationStore.notificationService.notifyError(
+          path
+            ? `Can't visit element of path: '${path}'`
+            : `Can't visit project`,
+        );
+      }
+    };
+
+    return (
+      <Dialog
+        open={open}
+        onClose={closeModal}
+        classes={{ container: 'dataspace-info-modal__container' }}
+        slotProps={{
+          paper: {
+            classes: { root: 'dataspace-info-modal__inner-container' },
+          },
+        }}
+      >
+        <Modal
+          darkMode={
+            !editorStore.applicationStore.layoutService
+              .TEMPORARY__isLightColorThemeEnabled
+          }
+          className="dataspace-info-modal"
+        >
+          <div className="dataspace-info-modal__header">
+            <ModalTitle title="About Ingest" />
+          </div>
+          <Panel>
+            <PanelFullContent>
+              {projectInfo && (
+                <div className="dataspace-info-modal__field">
+                  <div className="dataspace-info-modal__field__label">
+                    Project
+                  </div>
+                  <div
+                    className="dataspace-info-modal__field__value dataspace-info-modal__field__value--linkable"
+                    onClick={() => flowResult(visitElement(undefined))}
+                  >
+                    {`${projectInfo.groupId}:${projectInfo.artifactId}:${projectInfo.versionId}`}
+                  </div>
+                </div>
+              )}
+              <div className="dataspace-info-modal__field">
+                <div className="dataspace-info-modal__field__label">Name</div>
+                <div className="dataspace-info-modal__field__value">
+                  {ingestDefinition.name}
+                </div>
+              </div>
+              <div className="dataspace-info-modal__field">
+                <div className="dataspace-info-modal__field__label">Path</div>
+                <div className="dataspace-info-modal__field__value">
+                  {ingestDefinition.path}
+                </div>
+              </div>
+              {queryBuilderState.dataSet && (
+                <div className="dataspace-info-modal__field">
+                  <div className="dataspace-info-modal__field__label">
+                    Data Set
+                  </div>
+                  <div className="dataspace-info-modal__field__value">
+                    {queryBuilderState.dataSet}
+                  </div>
+                </div>
+              )}
+              {lakehouseRuntime instanceof LakehouseRuntime && (
+                <>
+                  {lakehouseRuntime.environment && (
+                    <div className="dataspace-info-modal__field">
+                      <div className="dataspace-info-modal__field__label">
+                        Environment
+                      </div>
+                      <div className="dataspace-info-modal__field__value">
+                        {lakehouseRuntime.environment}
+                      </div>
+                    </div>
+                  )}
+                  {lakehouseRuntime.warehouse && (
+                    <div className="dataspace-info-modal__field">
+                      <div className="dataspace-info-modal__field__label">
+                        Warehouse
+                      </div>
+                      <div className="dataspace-info-modal__field__value">
+                        {lakehouseRuntime.warehouse}
+                      </div>
+                    </div>
+                  )}
+                </>
+              )}
+              <div className="dataspace-info-modal__field">
+                <div className="dataspace-info-modal__field__label">
+                  Configuration
+                </div>
+                <div
+                  className="dataspace-info-modal__field__value dataspace-info-modal__field__value--linkable"
+                  onClick={() =>
+                    flowResult(visitElement(ingestDefinition.path))
+                  }
+                >
+                  Show Ingest Configuration
+                </div>
+              </div>
+            </PanelFullContent>
+          </Panel>
+        </Modal>
+      </Dialog>
+    );
+  },
+);