@finos/legend-application-query 13.4.16 → 13.4.18

package/src/__lib__/LegendQueryUserDataSpaceHelper.ts

@@ -0,0 +1,98 @@
+/**
+ * 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 { DataSpaceInfo } from '@finos/legend-extension-dsl-data-space/application';
+import { GAV_DELIMITER, generateGAVCoordinates } from '@finos/legend-storage';
+
+export interface VisitedDataspace {
+  id: string;
+  groupId: string;
+  artifactId: string;
+  path: string;
+  versionId: string | undefined;
+  execContext?: string | undefined;
+}
+
+export type SavedVisitedDataSpaces = VisitedDataspace[];
+
+export const createVisitedDataSpaceId = (
+  groupId: string,
+  artifactId: string,
+  dataSpace: string,
+): string =>
+  // we will consider unique dataSpace if it belongs to the same project. i.e we will not save 2 dataspaces visited for 2 different versionss
+  generateGAVCoordinates(groupId, artifactId, undefined) +
+  GAV_DELIMITER +
+  dataSpace;
+
+export const createIdFromDataSpaceInfo = (
+  info: DataSpaceInfo,
+): string | undefined => {
+  const groupId = info.groupId;
+  const artifactId = info.artifactId;
+  if (groupId && artifactId) {
+    return createVisitedDataSpaceId(groupId, artifactId, info.path);
+  }
+  return undefined;
+};
+
+export const createSimpleVisitedDataspace = (
+  groupId: string,
+  artifactId: string,
+  versionId: string | undefined,
+  path: string,
+  exec: string | undefined,
+): VisitedDataspace => ({
+  id: createVisitedDataSpaceId(groupId, artifactId, path),
+  groupId,
+  artifactId,
+  versionId,
+  path,
+  execContext: exec,
+});
+
+export const createVisitedDataspaceFromInfo = (
+  info: DataSpaceInfo,
+  execContext: string | undefined,
+): VisitedDataspace | undefined => {
+  const groupId = info.groupId;
+  const artifactId = info.artifactId;
+  const versionId = info.versionId;
+  const path = info.path;
+  if (groupId && artifactId) {
+    return createSimpleVisitedDataspace(
+      groupId,
+      artifactId,
+      versionId,
+      path,
+      execContext,
+    );
+  }
+  return undefined;
+};
+
+export const hasDataSpaceInfoBeenVisited = (
+  val: DataSpaceInfo,
+  visited: SavedVisitedDataSpaces,
+): boolean =>
+  Boolean(
+    visited.find((_visit) => {
+      if (_visit.id === createIdFromDataSpaceInfo(val)) {
+        return true;
+      }
+      return false;
+    }),
+  );

package/src/components/Core_LegendQueryApplicationPlugin.tsx

@@ -74,7 +74,6 @@ import {
 import {
   ExistingQueryEditorStore,
   QueryBuilderActionConfig_QueryApplication,
-  createViewProjectHandler,
   createViewSDLCProjectHandler,
 } from '../stores/QueryEditorStore.js';
 import {
@@ -318,6 +317,19 @@ export class Core_LegendQueryApplicationPlugin extends LegendQueryApplicationPlu
         key: 'about-query-info',
         title: 'Get Query Info',
         label: 'About Query Info',
+        disableFunc: (queryBuilderState): boolean => {
+          if (
+            queryBuilderState.workflowState.actionConfig instanceof
+            QueryBuilderActionConfig_QueryApplication
+          ) {
+            const editorStore =
+              queryBuilderState.workflowState.actionConfig.editorStore;
+            if (editorStore instanceof ExistingQueryEditorStore) {
+              return false;
+            }
+          }
+          return true;
+        },
         onClick: (queryBuilderState): void => {
           if (
             queryBuilderState.workflowState.actionConfig instanceof
@@ -333,35 +345,22 @@ export class Core_LegendQueryApplicationPlugin extends LegendQueryApplicationPlu
         icon: <InfoCircleIcon />,
       },
       {
-        key: 'about-query-project',
+        key: 'about-query-sdlc-project',
         title: 'Go to Project',
         label: 'Go to Project',
-        onClick: (queryBuilderState): void => {
+        disableFunc: (queryBuilderState): boolean => {
           if (
             queryBuilderState.workflowState.actionConfig instanceof
             QueryBuilderActionConfig_QueryApplication
           ) {
             const editorStore =
               queryBuilderState.workflowState.actionConfig.editorStore;
-            LegendQueryTelemetryHelper.logEvent_QueryViewProjectLaunched(
-              editorStore.applicationStore.telemetryService,
-            );
-            const { groupId, artifactId, versionId } =
-              editorStore.getProjectInfo();
-            createViewProjectHandler(editorStore.applicationStore)(
-              groupId,
-              artifactId,
-              versionId,
-              undefined,
-            );
+            if (editorStore instanceof ExistingQueryEditorStore) {
+              return false;
+            }
           }
+          return true;
         },
-        icon: <InfoCircleIcon />,
-      },
-      {
-        key: 'about-query-sdlc-project',
-        title: 'Go to SDLC Project',
-        label: 'Go to SDLC Project',
         onClick: (queryBuilderState): void => {
           if (
             queryBuilderState.workflowState.actionConfig instanceof
@@ -383,6 +382,22 @@ export class Core_LegendQueryApplicationPlugin extends LegendQueryApplicationPlu
         },
         icon: <InfoCircleIcon />,
       },
+      {
+        key: 'about-legend-query',
+        title: 'About Legend Query',
+        label: 'About Legend Query',
+        onClick: (queryBuilderState): void => {
+          if (
+            queryBuilderState.workflowState.actionConfig instanceof
+            QueryBuilderActionConfig_QueryApplication
+          ) {
+            const editorStore =
+              queryBuilderState.workflowState.actionConfig.editorStore;
+            editorStore.setShowAppInfo(true);
+          }
+        },
+        icon: <InfoCircleIcon />,
+      },
     ];
   }
 

package/src/components/LegendQueryAppInfo.tsx

@@ -0,0 +1,153 @@
+/**
+ * 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 {
+  CopyIcon,
+  Dialog,
+  InfoCircleIcon,
+  Modal,
+  ModalBody,
+  ModalHeader,
+  ModalHeaderActions,
+  ModalTitle,
+  TimesIcon,
+} from '@finos/legend-art';
+import { isNonNullable } from '@finos/legend-shared';
+import { useQueryEditorStore } from './QueryEditorStoreProvider.js';
+
+export const LegendQueryInfo: React.FC<{
+  open: boolean;
+  closeModal: () => void;
+}> = (props) => {
+  const { open, closeModal } = props;
+  const editorStore = useQueryEditorStore();
+  const applicationStore = editorStore.applicationStore;
+  const config = applicationStore.config;
+  const copyInfo = (): void => {
+    applicationStore.clipboardService
+      .copyTextToClipboard(
+        [
+          `Environment: ${config.env}`,
+          `Version: ${config.appVersion}`,
+          `Revision: ${config.appVersionCommitId}`,
+          `Build Time: ${config.appVersionBuildTime}`,
+          `Engine Server: ${config.engineServerUrl}`,
+          `Depot Server: ${config.depotServerUrl}`,
+        ]
+          .filter(isNonNullable)
+          .join('\n'),
+      )
+      .then(() =>
+        applicationStore.notificationService.notifySuccess(
+          'Copied application info to clipboard',
+        ),
+      )
+      .catch(applicationStore.alertUnhandledError);
+  };
+
+  const goToReleaseLog = (): void => {
+    closeModal();
+    applicationStore.releaseNotesService.setReleaseLog(true);
+  };
+
+  return (
+    <Dialog onClose={closeModal} open={open}>
+      <Modal
+        darkMode={
+          !applicationStore.layoutService.TEMPORARY__isLightColorThemeEnabled
+        }
+        className="modal--scrollable app__info"
+      >
+        <ModalHeader>
+          <ModalTitle icon={<InfoCircleIcon />} title="About Legend Query" />
+          <ModalHeaderActions>
+            <button
+              className="modal__header__action"
+              tabIndex={-1}
+              onClick={copyInfo}
+              title="Copy application info"
+            >
+              <CopyIcon />
+            </button>
+            <button
+              className="modal__header__action"
+              tabIndex={-1}
+              onClick={closeModal}
+            >
+              <TimesIcon />
+            </button>
+          </ModalHeaderActions>
+        </ModalHeader>
+        <ModalBody>
+          <div className="app__info__entry">
+            <div className="app__info__entry__title">Environment:</div>
+            <div className="app__info__entry__value">{config.env}</div>
+          </div>
+          <div className="app__info__entry">
+            <div className="app__info__entry__title">Version:</div>
+            <div className="app__info__entry__value">{config.appVersion}</div>
+          </div>
+          <div className="app__info__entry">
+            <div className="app__info__entry__title">Revision:</div>
+            <div className="app__info__entry__value">
+              {config.appVersionCommitId}
+            </div>
+          </div>
+          <div className="app__info__entry">
+            <div className="app__info__entry__title">Build Time:</div>
+            <div className="app__info__entry__value">
+              {config.appVersionBuildTime}
+            </div>
+          </div>
+          <div className="app__info__entry">
+            <div
+              onClick={goToReleaseLog}
+              className="app__info__entry__value app__info__entry__value__action"
+            >
+              Details of Released Versions
+            </div>
+          </div>
+          <div className="app__info__group">
+            <div className="app__info__entry">
+              <div className="app__info__entry__title">Engine Server:</div>
+              <div className="app__info__entry__value">
+                <a
+                  href={config.engineServerUrl}
+                  target="_blank"
+                  rel="noopener noreferrer"
+                >
+                  {config.engineServerUrl}
+                </a>
+              </div>
+            </div>
+            <div className="app__info__entry">
+              <div className="app__info__entry__title">Depot Server:</div>
+              <div className="app__info__entry__value">
+                <a
+                  href={config.depotServerUrl}
+                  target="_blank"
+                  rel="noopener noreferrer"
+                >
+                  {config.depotServerUrl}
+                </a>
+              </div>
+            </div>
+          </div>
+        </ModalBody>
+      </Modal>
+    </Dialog>
+  );
+};

package/src/components/QueryEditor.tsx

@@ -45,7 +45,7 @@ import {
   SunIcon,
 } from '@finos/legend-art';
 import { observer } from 'mobx-react-lite';
-import { Fragment, useEffect, useMemo, useRef, useState } from 'react';
+import { useEffect, useMemo, useRef, useState } from 'react';
 import {
   type MappingQueryCreatorPathParams,
   type ExistingQueryEditorPathParams,
@@ -58,6 +58,8 @@ import {
 import { ExistingQueryEditorStore } from '../stores/QueryEditorStore.js';
 import {
   LEGEND_APPLICATION_COLOR_THEME,
+  ReleaseLogManager,
+  ReleaseNotesManager,
   useApplicationStore,
 } from '@finos/legend-application';
 import { useParams } from '@finos/legend-application/browser';
@@ -86,6 +88,7 @@ import { LATEST_VERSION_ALIAS } from '@finos/legend-server-depot';
 import { buildVersionOption, type VersionOption } from './QuerySetup.js';
 import { QueryEditorExistingQueryVersionRevertModal } from './QueryEdtiorExistingQueryVersionRevertModal.js';
 import { debounce, compareSemVerVersions } from '@finos/legend-shared';
+import { LegendQueryInfo } from './LegendQueryAppInfo.js';
 
 const CreateQueryDialog = observer(() => {
   const editorStore = useQueryEditorStore();
@@ -361,12 +364,14 @@ export const QueryEditorExistingQueryHeader = observer(
         ) : (
           <div
             onDoubleClick={enableRename}
-            className="query-editor__header__content__main query-editor__header__content__title query-editor__header__content__title__text"
+            className="query-editor__header__content__main query-editor__header__content__title"
             title="Double-click to rename query"
           >
-            {existingEditorStore.lightQuery.name}
+            <div className="query-editor__header__content__title__text">
+              {existingEditorStore.lightQuery.name}
+            </div>
             <button
-              className="panel__content__form__section__list__item__edit-btn"
+              className="query-editor__header__conten__title__btn panel__content__form__section__list__item__edit-btn"
               onClick={enableRename}
             >
               <PencilIcon />
@@ -585,8 +590,6 @@ export const QueryEditor = observer(() => {
         generateQuerySetupRoute(),
       ),
     );
-  const goToReleaseLog = (): void =>
-    applicationStore.releaseNotesService.setReleaseLog(true);
   // settings
   // NOTE: this is temporary until we find a better home for these settings in query builder
   const engineConfig =
@@ -609,6 +612,7 @@ export const QueryEditor = observer(() => {
     flowResult(editorStore.initialize()).catch(
       applicationStore.alertUnhandledError,
     );
+    applicationStore.releaseNotesService.updateViewedVersion();
   }, [editorStore, applicationStore]);
 
   return (
@@ -628,9 +632,6 @@ export const QueryEditor = observer(() => {
                   <MenuContentItem onClick={goToQuerySetup}>
                     Back to query setup
                   </MenuContentItem>
-                  <MenuContentItem onClick={goToReleaseLog}>
-                    Legend Query Release Log
-                  </MenuContentItem>
                   <MenuContentItem
                     disabled={!appDocUrl}
                     onClick={goToDocumentation}
@@ -721,6 +722,12 @@ export const QueryEditor = observer(() => {
         />
       )}
       {editorStore.queryCreatorState.showCreateModal && <CreateQueryDialog />}
+      {editorStore.showAppInfo && (
+        <LegendQueryInfo
+          open={editorStore.showAppInfo}
+          closeModal={() => editorStore.setShowAppInfo(false)}
+        />
+      )}
       {isExistingQuery &&
         editorStore.updateState.showQueryInfo &&
         editorStore.query && (
@@ -729,6 +736,8 @@ export const QueryEditor = observer(() => {
             query={editorStore.query}
           />
         )}
+      <ReleaseLogManager />
+      <ReleaseNotesManager />
     </div>
   );
 });

package/src/components/data-space/DataSpaceQuerySetup.tsx

@@ -95,7 +95,7 @@ const DataSpaceQuerySetupSetupPanelContent = observer(
       queryBuilderState.showAdvancedSearchPanel();
 
     useEffect(() => {
-      flowResult(queryBuilderState.loadDataSpaces()).catch(
+      flowResult(queryBuilderState.initializeDataSpaceSetup()).catch(
         applicationStore.alertUnhandledError,
       );
     }, [queryBuilderState, applicationStore]);

package/src/stores/QueryEditorStore.ts

@@ -123,6 +123,7 @@ import {
   retrieveAnalyticsResultCache,
 } from '@finos/legend-extension-dsl-data-space/graph';
 import { generateDataSpaceQueryCreatorRoute } from '../__lib__/DSL_DataSpace_LegendQueryNavigation.js';
+import { hasDataSpaceInfoBeenVisited } from '../__lib__/LegendQueryUserDataSpaceHelper.js';
 
 export const createViewProjectHandler =
   (applicationStore: LegendQueryApplicationStore) =>
@@ -314,6 +315,7 @@ export abstract class QueryEditorStore {
   queryCreatorState: QueryCreatorState;
   existingQueryName: string | undefined;
   showRegisterServiceModal = false;
+  showAppInfo = false;
 
   constructor(
     applicationStore: LegendQueryApplicationStore,
@@ -324,10 +326,12 @@ export abstract class QueryEditorStore {
       queryLoaderState: observable,
       existingQueryName: observable,
       showRegisterServiceModal: observable,
+      showAppInfo: observable,
       queryBuilderState: observable,
       isPerformingBlockingAction: computed,
       setExistingQueryName: action,
       setShowRegisterServiceModal: action,
+      setShowAppInfo: action,
       initialize: flow,
       buildGraph: flow,
       searchExistingQueryName: flow,
@@ -405,6 +409,10 @@ export abstract class QueryEditorStore {
     this.existingQueryName = val;
   }
 
+  setShowAppInfo(val: boolean): void {
+    this.showAppInfo = val;
+  }
+
   setShowRegisterServiceModal(val: boolean): void {
     this.showRegisterServiceModal = val;
   }
@@ -534,10 +542,15 @@ export abstract class QueryEditorStore {
         error,
       );
       this.applicationStore.notificationService.notifyError(error);
+      this.onInitializeFailure();
       this.initState.fail();
     }
   }
 
+  onInitializeFailure(): void {
+    // Do Nothing
+  }
+
   *searchExistingQueryName(searchText: string): GeneratorFn<void> {
     const isValidSearchString =
       searchText.length >= DEFAULT_TYPEAHEAD_SEARCH_MINIMUM_SEARCH_LENGTH;
@@ -1234,6 +1247,10 @@ export class ExistingQueryEditorStore extends QueryEditorStore {
           versionId: projectInfo.versionId,
           dataSpace: dataSpace.path,
         };
+        const visitedDataSpaces =
+          LegendQueryUserDataHelper.getRecentlyVisitedDataSpaces(
+            this.applicationStore.userDataService,
+          );
         const dataSpaceQueryBuilderState = new DataSpaceQueryBuilderState(
           this.applicationStore,
           this.graphManagerState,
@@ -1313,6 +1330,8 @@ export class ExistingQueryEditorStore extends QueryEditorStore {
           projectInfo,
           this.applicationStore.config.options.queryBuilderConfig,
           sourceInfo,
+          (dataSpaceInfo: DataSpaceInfo) =>
+            hasDataSpaceInfoBeenVisited(dataSpaceInfo, visitedDataSpaces),
         );
         const mappingModelCoverageAnalysisResult =
           dataSpaceAnalysisResult?.executionContextsIndex.get(

package/src/stores/data-space/DataSpaceQueryCreatorStore.ts

@@ -29,8 +29,11 @@ import {
   LATEST_VERSION_ALIAS,
 } from '@finos/legend-server-depot';
 import {
+  LogEvent,
+  assertErrorThrown,
   guaranteeNonNullable,
   guaranteeType,
+  returnUndefOnError,
   uuid,
 } from '@finos/legend-shared';
 import {
@@ -59,6 +62,13 @@ import {
   type DataSpaceInfo,
 } from '@finos/legend-extension-dsl-data-space/application';
 import { generateDataSpaceQueryCreatorRoute } from '../../__lib__/DSL_DataSpace_LegendQueryNavigation.js';
+import { LegendQueryUserDataHelper } from '../../__lib__/LegendQueryUserDataHelper.js';
+import {
+  createVisitedDataSpaceId,
+  hasDataSpaceInfoBeenVisited,
+  createSimpleVisitedDataspace,
+} from '../../__lib__/LegendQueryUserDataSpaceHelper.js';
+import { LEGEND_QUERY_APP_EVENT } from '../../__lib__/LegendQueryEvent.js';
 
 export class DataSpaceQueryCreatorStore extends QueryEditorStore {
   readonly groupId: string;
@@ -144,6 +154,10 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
       versionId: projectInfo.versionId,
       dataSpace: dataSpace.path,
     };
+    const visitedDataSpaces =
+      LegendQueryUserDataHelper.getRecentlyVisitedDataSpaces(
+        this.applicationStore.userDataService,
+      );
     const queryBuilderState = new DataSpaceQueryBuilderState(
       this.applicationStore,
       this.graphManagerState,
@@ -193,6 +207,15 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
             queryBuilderState.class?.path,
           ),
         );
+        returnUndefOnError(() =>
+          LegendQueryUserDataHelper.updateVisitedDataSpaceExecContext(
+            this.applicationStore.userDataService,
+            this.groupId,
+            this.artifactId,
+            dataSpace.path,
+            ec.name,
+          ),
+        );
       },
       (runtimeValue: Runtime) => {
         const runtimePointer = guaranteeType(runtimeValue, RuntimePointer);
@@ -235,6 +258,8 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
       projectInfo,
       this.applicationStore.config.options.queryBuilderConfig,
       sourceInfo,
+      (dataSpaceInfo: DataSpaceInfo) =>
+        hasDataSpaceInfoBeenVisited(dataSpaceInfo, visitedDataSpaces),
     );
     queryBuilderState.setExecutionContext(executionContext);
     queryBuilderState.propagateExecutionContextChange(executionContext);
@@ -257,9 +282,32 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
       );
     }
 
+    // add to visited dataspaces
+    this.addVisitedDataSpace(executionContext.name);
     return queryBuilderState;
   }
 
+  addVisitedDataSpace(execName: string | undefined): void {
+    try {
+      LegendQueryUserDataHelper.addVisitedDatspace(
+        this.applicationStore.userDataService,
+        createSimpleVisitedDataspace(
+          this.groupId,
+          this.artifactId,
+          this.versionId,
+          this.dataSpacePath,
+          execName,
+        ),
+      );
+    } catch (error) {
+      assertErrorThrown(error);
+      this.applicationStore.logService.warn(
+        LogEvent.create(LEGEND_QUERY_APP_EVENT.LOCAL_STORAGE_PERSIST_ERROR),
+        error.message,
+      );
+    }
+  }
+
   getPersistConfiguration(
     lambda: RawLambda,
     options?: { update?: boolean | undefined },
@@ -283,4 +331,15 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
       },
     };
   }
+
+  override onInitializeFailure(): void {
+    LegendQueryUserDataHelper.removeRecentlyViewedDataSpace(
+      this.applicationStore.userDataService,
+      createVisitedDataSpaceId(
+        this.groupId,
+        this.artifactId,
+        this.dataSpacePath,
+      ),
+    );
+  }
 }