@finos/legend-application-query 8.1.2 → 9.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finos/legend-application-query",
-  "version": "8.1.2",
+  "version": "9.0.0",
   "description": "Legend Query application core",
   "keywords": [
     "legend",
@@ -43,13 +43,13 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@finos/legend-application": "9.0.0",
-    "@finos/legend-art": "4.0.0",
-    "@finos/legend-graph": "18.0.0",
-    "@finos/legend-query-builder": "0.2.0",
-    "@finos/legend-server-depot": "4.1.1",
-    "@finos/legend-shared": "6.1.4",
-    "@finos/legend-storage": "3.0.13",
+    "@finos/legend-application": "10.0.0",
+    "@finos/legend-art": "4.1.0",
+    "@finos/legend-graph": "19.0.0",
+    "@finos/legend-query-builder": "0.2.2",
+    "@finos/legend-server-depot": "4.1.2",
+    "@finos/legend-shared": "6.1.5",
+    "@finos/legend-storage": "3.0.14",
     "@testing-library/react": "13.4.0",
     "@types/react": "18.0.21",
     "@types/react-dom": "18.0.6",
@@ -57,15 +57,14 @@
     "mobx-react-lite": "3.4.0",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "react-hotkeys": "2.0.0",
-    "serializr": "2.0.5"
+    "serializr": "3.0.1"
   },
   "devDependencies": {
-    "@finos/legend-dev-utils": "2.0.20",
-    "@jest/globals": "29.1.2",
+    "@finos/legend-dev-utils": "2.0.21",
+    "@jest/globals": "29.2.1",
     "cross-env": "7.0.3",
     "eslint": "8.25.0",
-    "jest": "29.1.2",
+    "jest": "29.2.1",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
     "sass": "1.55.0",
@@ -78,9 +77,7 @@
     "directory": "build/publishContent"
   },
   "extensions": {
-    "graphManagerPreset": "@finos/legend-graph-manager-preset-query-builder",
-    "pureProtocolProcessorPlugin": "@finos/legend-pure-protocol-processor-plugin-query-builder",
-    "pureGraphManagerPlugin": "@finos/legend-pure-graph-manager-plugin-query-builder"
+    "applicationQueryPlugin": "@finos/legend-application-query-plugin-core"
   },
   "typedoc": {
     "entryPoint": "./src/index.ts",

package/src/application/LegendQuery.tsx

@@ -24,7 +24,6 @@ import {
   type LegendApplicationConfigurationInput,
   BrowserRouter,
 } from '@finos/legend-application';
-import { configure as configureReactHotkeys } from 'react-hotkeys';
 import { LegendQueryApplication } from '../components/LegendQueryApplication.js';
 import { LegendQueryPluginManager } from './LegendQueryPluginManager.js';
 import { getRootElement } from '@finos/legend-art';
@@ -35,17 +34,13 @@ import {
 } from './LegendQueryApplicationConfig.js';
 import {
   QueryBuilder_GraphManagerPreset,
+  QueryBuilder_LegendApplicationPlugin,
   setupQueryBuilderUILibrary,
 } from '@finos/legend-query-builder';
+import { Core_LegendQueryApplicationPlugin } from '../components/Core_LegendQueryApplicationPlugin.js';
 
 export const setupLegendQueryUILibrary = async (): Promise<void> => {
   await setupQueryBuilderUILibrary();
-  configureReactHotkeys({
-    // By default, `react-hotkeys` will avoid capturing keys from input tags like <input>, <textarea>, <select>
-    // We want to listen to hotkey from every where in the app so we disable that
-    // See https://github.com/greena13/react-hotkeys#ignoring-events
-    ignoreTags: [],
-  });
 };
 
 export class LegendQuery extends LegendApplication {
@@ -54,8 +49,12 @@ export class LegendQuery extends LegendApplication {
 
   static create(): LegendQuery {
     const application = new LegendQuery(LegendQueryPluginManager.create());
-    application.withBasePlugins([new Core_PureGraphManagerPlugin()]);
     application.withBasePresets([new QueryBuilder_GraphManagerPreset()]);
+    application.withBasePlugins([
+      new Core_PureGraphManagerPlugin(),
+      new Core_LegendQueryApplicationPlugin(),
+      new QueryBuilder_LegendApplicationPlugin(),
+    ]);
     return application;
   }
 

package/src/application/LegendQueryApplicationConfig.ts

@@ -70,6 +70,9 @@ export interface LegendQueryApplicationConfigurationData
     url: string;
     instances: LegendStudioApplicationInstanceConfigurationData[];
   };
+  taxonomy: {
+    url: string;
+  };
 }
 
 export class LegendQueryApplicationConfig extends LegendApplicationConfig {
@@ -81,6 +84,7 @@ export class LegendQueryApplicationConfig extends LegendApplicationConfig {
   readonly studioUrl: string;
   readonly studioInstances: LegendStudioApplicationInstanceConfigurationData[] =
     [];
+  readonly taxonomyUrl: string;
 
   constructor(
     input: LegendApplicationConfigurationInput<LegendQueryApplicationConfigurationData>,
@@ -122,6 +126,16 @@ export class LegendQueryApplicationConfig extends LegendApplicationConfig {
       `Can't configure application: 'studio.instances' field is missing`,
     );
 
+    // taxonomy
+    assertNonNullable(
+      input.configData.taxonomy,
+      `Can't configure application: 'taxonomy' field is missing`,
+    );
+    this.taxonomyUrl = guaranteeNonEmptyString(
+      input.configData.taxonomy.url,
+      `Can't configure application: 'taxonomy.url' field is missing or empty`,
+    );
+
     // options
     this.options = LegendQueryApplicationCoreOptions.create(
       (input.configData.extensions?.core ??

package/src/components/CloneQueryServiceSetup.tsx

@@ -0,0 +1,312 @@
+/**
+ * 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 {
+  ArrowLeftIcon,
+  ArrowRightIcon,
+  BlankPanelContent,
+  clsx,
+  CustomSelectorInput,
+  PanelLoadingIndicator,
+} from '@finos/legend-art';
+import { guaranteeType } from '@finos/legend-shared';
+import { flowResult } from 'mobx';
+import { observer, useLocalObservable } from 'mobx-react-lite';
+import { useContext, useEffect } from 'react';
+import {
+  generateQuerySetupRoute,
+  generateServiceQueryCreatorRoute,
+} from '../stores/LegendQueryRouter.js';
+import {
+  LATEST_VERSION_ALIAS,
+  SNAPSHOT_VERSION_ALIAS,
+  useDepotServerClient,
+} from '@finos/legend-server-depot';
+import { useApplicationStore } from '@finos/legend-application';
+import { useLegendQueryApplicationStore } from './LegendQueryBaseStoreProvider.js';
+import {
+  CloneServiceQuerySetupStore,
+  type ServiceExecutionOption,
+} from '../stores/CloneServiceQuerySetupStore.js';
+import {
+  BaseQuerySetup,
+  BaseQuerySetupStoreContext,
+  buildProjectOption,
+  buildVersionOption,
+  type ProjectOption,
+  type VersionOption,
+} from './QuerySetup.js';
+import { compareSemVerVersions } from '@finos/legend-storage';
+
+const CloneServiceQuerySetupStoreProvider: React.FC<{
+  children: React.ReactNode;
+}> = ({ children }) => {
+  const applicationStore = useLegendQueryApplicationStore();
+  const depotServerClient = useDepotServerClient();
+  const store = useLocalObservable(
+    () => new CloneServiceQuerySetupStore(applicationStore, depotServerClient),
+  );
+  return (
+    <BaseQuerySetupStoreContext.Provider value={store}>
+      {children}
+    </BaseQuerySetupStoreContext.Provider>
+  );
+};
+
+const useCloneServiceQuerySetupStore = (): CloneServiceQuerySetupStore =>
+  guaranteeType(
+    useContext(BaseQuerySetupStoreContext),
+    CloneServiceQuerySetupStore,
+    `Can't find query setup store in context`,
+  );
+
+const CloneQueryServiceSetupContent = observer(() => {
+  const applicationStore = useApplicationStore();
+  const querySetupState = useCloneServiceQuerySetupStore();
+
+  // actions
+  const back = (): void => {
+    applicationStore.navigator.goToLocation(generateQuerySetupRoute());
+  };
+  const next = (): void => {
+    if (
+      querySetupState.currentProject &&
+      querySetupState.currentVersionId &&
+      querySetupState.currentServiceExecutionOption
+    ) {
+      applicationStore.navigator.goToLocation(
+        generateServiceQueryCreatorRoute(
+          querySetupState.currentProject.groupId,
+          querySetupState.currentProject.artifactId,
+          querySetupState.currentVersionId,
+          querySetupState.currentServiceExecutionOption.service.path,
+          querySetupState.currentServiceExecutionOption.key,
+        ),
+      );
+    }
+  };
+  const canProceed =
+    querySetupState.currentProject &&
+    querySetupState.currentVersionId &&
+    querySetupState.currentServiceExecutionOption;
+
+  // project
+  const projectOptions = querySetupState.projects.map(buildProjectOption);
+  const selectedProjectOption = querySetupState.currentProject
+    ? buildProjectOption(querySetupState.currentProject)
+    : null;
+  const projectSelectorPlaceholder = querySetupState.loadProjectsState
+    .isInProgress
+    ? 'Loading projects'
+    : querySetupState.loadProjectsState.hasFailed
+    ? 'Error fetching projects'
+    : querySetupState.projects.length
+    ? 'Choose a project'
+    : 'You have no projects, please create or acquire access for at least one';
+  const onProjectOptionChange = (option: ProjectOption | null): void => {
+    if (option?.value !== querySetupState.currentProject) {
+      querySetupState.setCurrentProject(option?.value);
+      // cascade
+      querySetupState.setCurrentVersionId(undefined);
+      querySetupState.setCurrentServiceExecutionOption(undefined);
+    }
+  };
+
+  // version
+  const versionOptions = [
+    LATEST_VERSION_ALIAS,
+    SNAPSHOT_VERSION_ALIAS,
+    ...(querySetupState.currentProject?.versions ?? []),
+  ]
+    .slice()
+    .sort((v1, v2) => compareSemVerVersions(v2, v1))
+    .map(buildVersionOption);
+  const selectedVersionOption = querySetupState.currentVersionId
+    ? buildVersionOption(querySetupState.currentVersionId)
+    : null;
+  const versionSelectorPlaceholder = !querySetupState.currentProject
+    ? 'No project selected'
+    : 'Choose a version';
+  const onVersionOptionChange = async (
+    option: VersionOption | null,
+  ): Promise<void> => {
+    if (option?.value !== querySetupState.currentVersionId) {
+      querySetupState.setCurrentVersionId(option?.value);
+      // cascade
+      querySetupState.setCurrentServiceExecutionOption(undefined);
+      if (querySetupState.currentProject && querySetupState.currentVersionId) {
+        await flowResult(
+          querySetupState.loadServiceExecutionOptions(
+            querySetupState.currentProject,
+            querySetupState.currentVersionId,
+          ),
+        ).catch(applicationStore.alertUnhandledError);
+      }
+    }
+  };
+
+  // service and key
+  const serviceExecutionOptions = querySetupState.serviceExecutionOptions.map(
+    (option) => ({
+      label: `${option.service.name}${option.key ? ` [${option.key}]` : ''}`,
+      value: option,
+    }),
+  );
+  const selectedServiceExecutionOption =
+    querySetupState.currentServiceExecutionOption
+      ? {
+          label: `${
+            querySetupState.currentServiceExecutionOption.service.name
+          }${
+            querySetupState.currentServiceExecutionOption.key
+              ? ` [${querySetupState.currentServiceExecutionOption.key}]`
+              : ''
+          }`,
+          value: querySetupState.currentServiceExecutionOption,
+        }
+      : null;
+  const serviceExecutionSelectorPlaceholder = serviceExecutionOptions.length
+    ? 'Choose a service'
+    : 'No service available';
+  const onServiceExecutionOptionChange = (
+    option: { value: ServiceExecutionOption } | null,
+  ): void => {
+    querySetupState.setCurrentServiceExecutionOption(
+      option?.value ?? undefined,
+    );
+  };
+
+  useEffect(() => {
+    flowResult(querySetupState.loadProjects()).catch(
+      applicationStore.alertUnhandledError,
+    );
+  }, [querySetupState, applicationStore]);
+
+  return (
+    <div className="query-setup__wizard query-setup__service-query">
+      <div className="query-setup__wizard__header query-setup__service-query__header">
+        <button
+          className="query-setup__wizard__header__btn"
+          onClick={back}
+          title="Back to Main Menu"
+        >
+          <ArrowLeftIcon />
+        </button>
+        <div className="query-setup__wizard__header__title">
+          Clone an existing service query...
+        </div>
+        <button
+          className={clsx('query-setup__wizard__header__btn', {
+            'query-setup__wizard__header__btn--ready': canProceed,
+          })}
+          onClick={next}
+          disabled={!canProceed}
+          title="Create a new query"
+        >
+          <ArrowRightIcon />
+        </button>
+      </div>
+      <div className="query-setup__wizard__content">
+        <div className="query-setup__service-query__project">
+          <div className="query-setup__wizard__group">
+            <div className="query-setup__wizard__group__title">Project</div>
+            <CustomSelectorInput
+              className="query-setup__wizard__selector"
+              options={projectOptions}
+              disabled={
+                querySetupState.loadProjectsState.isInProgress ||
+                !projectOptions.length
+              }
+              isLoading={querySetupState.loadProjectsState.isInProgress}
+              onChange={onProjectOptionChange}
+              value={selectedProjectOption}
+              placeholder={projectSelectorPlaceholder}
+              isClearable={true}
+              escapeClearsValue={true}
+              darkMode={true}
+            />
+          </div>
+          <div className="query-setup__wizard__group">
+            <div className="query-setup__wizard__group__title">Version</div>
+            <CustomSelectorInput
+              className="query-setup__wizard__selector"
+              options={versionOptions}
+              disabled={!querySetupState.currentProject}
+              onChange={onVersionOptionChange}
+              value={selectedVersionOption}
+              placeholder={versionSelectorPlaceholder}
+              isClearable={true}
+              escapeClearsValue={true}
+              darkMode={true}
+            />
+          </div>
+        </div>
+        <div className="query-setup__service-query__graph">
+          {(!querySetupState.currentProject ||
+            !querySetupState.currentVersionId ||
+            !querySetupState.loadServiceExecutionsState.hasSucceeded) && (
+            <div className="query-setup__service-query__graph__loader">
+              <PanelLoadingIndicator
+                isLoading={
+                  Boolean(querySetupState.currentProject) &&
+                  Boolean(querySetupState.currentVersionId) &&
+                  !querySetupState.loadServiceExecutionsState.isInProgress
+                }
+              />
+              <BlankPanelContent>
+                {querySetupState.loadServiceExecutionsState.isInProgress
+                  ? `Surveying service executions...`
+                  : querySetupState.loadServiceExecutionsState.hasFailed
+                  ? `Can't load service executions`
+                  : 'Project and version must be specified'}
+              </BlankPanelContent>
+            </div>
+          )}
+          {querySetupState.currentProject &&
+            querySetupState.currentVersionId &&
+            querySetupState.loadServiceExecutionsState.hasSucceeded && (
+              <>
+                <div className="query-setup__wizard__group">
+                  <div className="query-setup__wizard__group__title">
+                    Service
+                  </div>
+                  <CustomSelectorInput
+                    className="query-setup__wizard__selector"
+                    options={serviceExecutionOptions}
+                    disabled={!serviceExecutionOptions.length}
+                    onChange={onServiceExecutionOptionChange}
+                    value={selectedServiceExecutionOption}
+                    placeholder={serviceExecutionSelectorPlaceholder}
+                    isClearable={true}
+                    escapeClearsValue={true}
+                    darkMode={true}
+                  />
+                </div>
+              </>
+            )}
+        </div>
+      </div>
+    </div>
+  );
+});
+
+export const CloneQueryServiceSetup: React.FC = () => (
+  <CloneServiceQuerySetupStoreProvider>
+    <BaseQuerySetup>
+      <CloneQueryServiceSetupContent />
+    </BaseQuerySetup>
+  </CloneServiceQuerySetupStoreProvider>
+);

package/src/components/Core_LegendQueryApplicationPlugin.tsx

@@ -0,0 +1,184 @@
+/**
+ * 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 {
+  LegendQueryApplicationPlugin,
+  QuerySetupActionTag,
+  type QuerySetupActionConfiguration,
+} from '../stores/LegendQueryApplicationPlugin.js';
+import packageJson from '../../package.json';
+import type { QuerySetupLandingPageStore } from '../stores/QuerySetupStore.js';
+import {
+  ArrowCirceUpIcon,
+  BrainIcon,
+  DroidIcon,
+  ManageSearchIcon,
+  PlusIcon,
+  RobotIcon,
+} from '@finos/legend-art';
+import {
+  generateCloneServiceQuerySetupRoute,
+  generateCreateMappingQuerySetupRoute,
+  generateEditExistingQuerySetupRoute,
+  generateLoadProjectServiceQuerySetup,
+  generateQueryProductionizerSetupRoute,
+  generateUpdateExistingServiceQuerySetup,
+  LEGEND_QUERY_ROUTE_PATTERN,
+} from '../stores/LegendQueryRouter.js';
+import type { ApplicationPageEntry } from '@finos/legend-application';
+import { CloneQueryServiceSetup } from './CloneQueryServiceSetup.js';
+import { QueryProductionizerSetup } from './QueryProductionizerSetup.js';
+import { UpdateExistingServiceQuerySetup } from './UpdateExistingServiceQuerySetup.js';
+import { LoadProjectServiceQuerySetup } from './LoadProjectServiceQuerySetup.js';
+
+export class Core_LegendQueryApplicationPlugin extends LegendQueryApplicationPlugin {
+  static NAME = packageJson.extensions.applicationQueryPlugin;
+
+  constructor() {
+    super(Core_LegendQueryApplicationPlugin.NAME, packageJson.version);
+  }
+
+  override getExtraApplicationPageEntries(): ApplicationPageEntry[] {
+    return [
+      {
+        key: 'clone-service-query-setup-application-page',
+        urlPatterns: [LEGEND_QUERY_ROUTE_PATTERN.CLONE_SERVICE_QUERY_SETUP],
+        renderer: CloneQueryServiceSetup,
+      },
+      {
+        key: 'query-productionizer-setup-application-page',
+        urlPatterns: [LEGEND_QUERY_ROUTE_PATTERN.QUERY_PRODUCTIONIZER_SETUP],
+        renderer: QueryProductionizerSetup,
+      },
+      {
+        key: 'update-existing-service-query-setup-application-page',
+        urlPatterns: [
+          LEGEND_QUERY_ROUTE_PATTERN.UPDATE_EXISTING_SERVICE_QUERY_SETUP,
+        ],
+        renderer: UpdateExistingServiceQuerySetup,
+      },
+      {
+        key: 'load-project-service-query-setup-application-page',
+        urlPatterns: [
+          LEGEND_QUERY_ROUTE_PATTERN.LOAD_PROJECT_SERVICE_QUERY_SETUP,
+        ],
+        renderer: LoadProjectServiceQuerySetup,
+      },
+    ];
+  }
+
+  override getExtraQuerySetupActionConfigurations(): QuerySetupActionConfiguration[] {
+    return [
+      {
+        key: 'open-existing-query',
+        isAdvanced: false,
+        isCreateAction: false,
+        action: async (setupStore: QuerySetupLandingPageStore) => {
+          setupStore.applicationStore.navigator.goToLocation(
+            generateEditExistingQuerySetupRoute(),
+          );
+        },
+        label: 'Open an existing query',
+        className: 'query-setup__landing-page__action--existing-query',
+        icon: (
+          <ManageSearchIcon className="query-setup__landing-page__icon--search" />
+        ),
+      },
+      {
+        key: 'create-query-from-taxonomy',
+        isAdvanced: false,
+        isCreateAction: true,
+        action: async (setupStore: QuerySetupLandingPageStore) => {
+          setupStore.applicationStore.navigator.goToAddress(
+            setupStore.applicationStore.config.taxonomyUrl,
+          );
+        },
+        label: 'Create query from taxonomy',
+        className: 'query-setup__landing-page__action--taxonomy-query',
+        icon: <BrainIcon />,
+      },
+      {
+        key: 'create-mapping-query',
+        isAdvanced: true,
+        isCreateAction: true,
+        action: async (setupStore: QuerySetupLandingPageStore) => {
+          setupStore.applicationStore.navigator.goToLocation(
+            generateCreateMappingQuerySetupRoute(),
+          );
+        },
+        label: 'Create new query on a mapping',
+        className: 'query-setup__landing-page__action--create-mapping-query',
+        icon: <PlusIcon />,
+      },
+      {
+        key: 'clone-service-query',
+        isAdvanced: true,
+        isCreateAction: true,
+        action: async (setupStore: QuerySetupLandingPageStore) => {
+          setupStore.applicationStore.navigator.goToLocation(
+            generateCloneServiceQuerySetupRoute(),
+          );
+        },
+        label: 'Clone an existing service query',
+        className: 'query-setup__landing-page__action--service-query',
+        icon: <RobotIcon />,
+      },
+      // sdlc
+      {
+        key: 'update-existing-service-query',
+        isAdvanced: false,
+        isCreateAction: false,
+        tag: QuerySetupActionTag.PRODUCTIONIZATION,
+        action: async (setupStore: QuerySetupLandingPageStore) => {
+          setupStore.applicationStore.navigator.goToLocation(
+            generateUpdateExistingServiceQuerySetup(),
+          );
+        },
+        label: 'Update an existing service query',
+        className: 'query-setup__landing-page__action--service-query',
+        icon: <DroidIcon />,
+      },
+      {
+        key: 'open-project-service-query',
+        isAdvanced: true,
+        isCreateAction: false,
+        tag: QuerySetupActionTag.PRODUCTIONIZATION,
+        action: async (setupStore: QuerySetupLandingPageStore) => {
+          setupStore.applicationStore.navigator.goToLocation(
+            generateLoadProjectServiceQuerySetup(),
+          );
+        },
+        label: 'Open service query from a project',
+        className: 'query-setup__landing-page__action--service-query',
+        icon: <DroidIcon />,
+      },
+      {
+        key: 'productionize-query',
+        isAdvanced: false,
+        isCreateAction: true,
+        tag: QuerySetupActionTag.PRODUCTIONIZATION,
+        action: async (setupStore: QuerySetupLandingPageStore) => {
+          setupStore.applicationStore.navigator.goToLocation(
+            generateQueryProductionizerSetupRoute(),
+          );
+        },
+        label: 'Productionize an existing query',
+        className: 'query-setup__landing-page__action--productionize-query',
+        icon: <ArrowCirceUpIcon />,
+      },
+    ];
+  }
+}