@finos/legend-application-query 7.0.1 → 8.1.0

package/src/stores/LegendQueryApplicationPlugin.ts

@@ -19,7 +19,10 @@ import type { Query } from '@finos/legend-graph';
 import type { QueryBuilderState } from '@finos/legend-query-builder';
 import type React from 'react';
 import type { LegendQueryPluginManager } from '../application/LegendQueryPluginManager.js';
-import type { QueryEditorStore } from './QueryEditorStore.js';
+import type {
+  ExistingQueryEditorStore,
+  QueryEditorStore,
+} from './QueryEditorStore.js';
 import type { QuerySetupState, QuerySetupStore } from './QuerySetupStore.js';
 
 export type QuerySetupOptionRendererConfiguration = {
@@ -37,9 +40,17 @@ export type QueryEditorHeaderLabeler = (
 
 export type ExistingQueryEditorStateBuilder = (
   query: Query,
-  editorStore: QueryEditorStore,
+  editorStore: ExistingQueryEditorStore,
 ) => QueryBuilderState | undefined;
 
+export type ExistingQueryEditorActionRendererConfiguration = {
+  key: string;
+  renderer: (
+    editorStore: ExistingQueryEditorStore,
+    queryBuilderState: QueryBuilderState,
+  ) => React.ReactNode | undefined;
+};
+
 export abstract class LegendQueryApplicationPlugin extends LegendApplicationPlugin {
   /**
    * This helps to better type-check for this empty abtract type
@@ -70,4 +81,9 @@ export abstract class LegendQueryApplicationPlugin extends LegendApplicationPlug
    * Get the list of existing query editor state builders.
    */
   getExtraExistingQueryEditorStateBuilders?(): ExistingQueryEditorStateBuilder[];
+
+  /**
+   * Get the list of renderer configurations for existing query editor actions.
+   */
+  getExtraExistingQueryActionRendererConfiguration?(): ExistingQueryEditorActionRendererConfiguration[];
 }

package/src/stores/LegendQueryBaseStore.ts

@@ -18,11 +18,10 @@ import type { DepotServerClient } from '@finos/legend-server-depot';
 import type { ApplicationStore } from '@finos/legend-application';
 import type { LegendQueryPluginManager } from '../application/LegendQueryPluginManager.js';
 import type { LegendQueryApplicationConfig } from '../application/LegendQueryApplicationConfig.js';
-import type { LegendQueryApplicationPlugin } from './LegendQueryApplicationPlugin.js';
 
 export type LegendQueryApplicationStore = ApplicationStore<
   LegendQueryApplicationConfig,
-  LegendQueryApplicationPlugin
+  LegendQueryPluginManager
 >;
 
 export class LegendQueryBaseStore {
@@ -33,11 +32,10 @@ export class LegendQueryBaseStore {
   constructor(
     applicationStore: LegendQueryApplicationStore,
     depotServerClient: DepotServerClient,
-    pluginManager: LegendQueryPluginManager,
   ) {
     this.applicationStore = applicationStore;
     this.depotServerClient = depotServerClient;
-    this.pluginManager = pluginManager;
+    this.pluginManager = applicationStore.pluginManager;
 
     // Register plugins
     this.depotServerClient.setTracerService(

package/src/stores/LegendQueryRouter.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { generateGAVCoordinates } from '@finos/legend-server-depot';
+import { generateGAVCoordinates } from '@finos/legend-storage';
 import { generatePath } from 'react-router';
 
 export enum LEGEND_QUERY_PATH_PARAM_TOKEN {
@@ -95,7 +95,10 @@ export interface ExistingQueryEditorPathParams {
   [LEGEND_QUERY_PATH_PARAM_TOKEN.QUERY_ID]: string;
 }
 
-export const generateStudioProjectViewUrl = (
+/**
+ * @external_application_navigation This depends on Legend Studio routing and is hardcoded so it's potentially brittle
+ */
+export const EXTERNAL_APPLICATION_NAVIGATION__generateStudioProjectViewUrl = (
   studioUrl: string,
   groupId: string,
   artifactId: string,
@@ -107,3 +110,33 @@ export const generateStudioProjectViewUrl = (
     artifactId,
     versionId,
   )}${entityPath ? `/entity/${entityPath}` : ''}`;
+
+/**
+ * @external_application_navigation This depends on Legend Studio routing and is hardcoded so it's potentially brittle
+ */
+export const EXTERNAL_APPLICATION_NAVIGATION__generateStudioUpdateExistingServiceQueryUrl =
+  (
+    studioUrl: string,
+    groupId: string,
+    artifactId: string,
+    servicePath: string,
+  ): string =>
+    `${studioUrl}/extensions/update-service-query/${servicePath}@${generateGAVCoordinates(
+      groupId,
+      artifactId,
+      undefined,
+    )}`;
+
+/**
+ * @external_application_navigation This depends on Legend Studio routing and is hardcoded so it's potentially brittle
+ */
+export const EXTERNAL_APPLICATION_NAVIGATION__generateStudioUpdateProjectServiceQueryUrl =
+  (studioUrl: string, projectId: string): string =>
+    `${studioUrl}/extensions/update-project-service-query/${projectId}`;
+
+/**
+ * @external_application_navigation This depends on Legend Studio routing and is hardcoded so it's potentially brittle
+ */
+export const EXTERNAL_APPLICATION_NAVIGATION__generateStudioProductionizeQueryUrl =
+  (studioUrl: string, queryId: string): string =>
+    `${studioUrl}/extensions/productionize-query/${queryId}`;

package/src/stores/QueryEditorStore.ts

@@ -57,13 +57,17 @@ import {
   generateServiceQueryCreatorRoute,
 } from './LegendQueryRouter.js';
 import { LEGEND_QUERY_APP_EVENT } from '../LegendQueryAppEvent.js';
-import type { Entity } from '@finos/legend-storage';
+import type { Entity, ProjectGAVCoordinates } from '@finos/legend-storage';
 import {
   type DepotServerClient,
-  type ProjectGAVCoordinates,
   ProjectData,
 } from '@finos/legend-server-depot';
-import { TAB_SIZE, APPLICATION_EVENT } from '@finos/legend-application';
+import {
+  TAB_SIZE,
+  APPLICATION_EVENT,
+  DEFAULT_TYPEAHEAD_SEARCH_MINIMUM_SEARCH_LENGTH,
+  DEFAULT_TYPEAHEAD_SEARCH_LIMIT,
+} from '@finos/legend-application';
 import type { LegendQueryPluginManager } from '../application/LegendQueryPluginManager.js';
 import { LegendQueryEventService } from './LegendQueryEventService.js';
 import type { LegendQueryApplicationStore } from './LegendQueryBaseStore.js';
@@ -75,9 +79,6 @@ import {
   ServiceQueryBuilderState,
 } from '@finos/legend-query-builder';
 
-const QUERY_BUILDER_SEARCH_TEXT_MIN_LENGTH = 3;
-const QUERY_BUILDER_QUERY_LOAD_MAX_AMOUNT = 10;
-
 export interface QueryExportConfiguration {
   defaultName?: string | undefined;
   allowUpdate?: boolean | undefined;
@@ -151,7 +152,7 @@ export class QueryExportState {
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.log.error(
-        LogEvent.create(LEGEND_QUERY_APP_EVENT.QUERY_PROBLEM),
+        LogEvent.create(LEGEND_QUERY_APP_EVENT.GENERIC_FAILURE),
         error,
       );
       this.editorStore.applicationStore.notifyError(error);
@@ -192,7 +193,7 @@ export class QueryExportState {
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.log.error(
-        LogEvent.create(LEGEND_QUERY_APP_EVENT.QUERY_PROBLEM),
+        LogEvent.create(LEGEND_QUERY_APP_EVENT.GENERIC_FAILURE),
         error,
       );
       this.editorStore.applicationStore.notifyError(error);
@@ -204,18 +205,20 @@ export class QueryExportState {
 }
 
 export class QueryLoaderState {
-  editorStore: QueryEditorStore;
-  isQueryLoaderOpen = false;
+  readonly editorStore: QueryEditorStore;
   loadQueriesState = ActionState.create();
   queries: LightQuery[] = [];
+  isQueryLoaderOpen = false;
+  showCurrentUserQueriesOnly = false;
 
   constructor(editorStore: QueryEditorStore) {
     makeObservable(this, {
       isQueryLoaderOpen: observable,
       queries: observable,
-      loadQueriesState: observable,
+      showCurrentUserQueriesOnly: observable,
       setIsQueryLoaderOpen: action,
       setQueries: action,
+      setShowCurrentUserQueriesOnly: action,
       loadQueries: flow,
     });
     this.editorStore = editorStore;
@@ -229,16 +232,22 @@ export class QueryLoaderState {
     this.queries = val;
   }
 
+  setShowCurrentUserQueriesOnly(val: boolean): void {
+    this.showCurrentUserQueriesOnly = val;
+  }
+
   *loadQueries(searchText: string): GeneratorFn<void> {
     const isValidSearchString =
-      searchText.length >= QUERY_BUILDER_SEARCH_TEXT_MIN_LENGTH;
+      searchText.length >= DEFAULT_TYPEAHEAD_SEARCH_MINIMUM_SEARCH_LENGTH;
     this.loadQueriesState.inProgress();
     try {
       const searchSpecification = new QuerySearchSpecification();
       searchSpecification.searchTerm = isValidSearchString
         ? searchText
         : undefined;
-      searchSpecification.limit = QUERY_BUILDER_QUERY_LOAD_MAX_AMOUNT;
+      searchSpecification.limit = DEFAULT_TYPEAHEAD_SEARCH_LIMIT;
+      searchSpecification.showCurrentUserQueriesOnly =
+        this.showCurrentUserQueriesOnly;
       this.queries =
         (yield this.editorStore.graphManagerState.graphManager.searchQueries(
           searchSpecification,
@@ -253,12 +262,12 @@ export class QueryLoaderState {
 }
 
 export abstract class QueryEditorStore {
-  applicationStore: LegendQueryApplicationStore;
-  depotServerClient: DepotServerClient;
-  pluginManager: LegendQueryPluginManager;
-  graphManagerState: GraphManagerState;
+  readonly applicationStore: LegendQueryApplicationStore;
+  readonly depotServerClient: DepotServerClient;
+  readonly pluginManager: LegendQueryPluginManager;
+  readonly graphManagerState: GraphManagerState;
 
-  initState = ActionState.create();
+  readonly initState = ActionState.create();
   queryBuilderState?: QueryBuilderState | undefined;
   exportState?: QueryExportState | undefined;
   queryLoaderState: QueryLoaderState;
@@ -266,7 +275,6 @@ export abstract class QueryEditorStore {
   constructor(
     applicationStore: LegendQueryApplicationStore,
     depotServerClient: DepotServerClient,
-    pluginManager: LegendQueryPluginManager,
   ) {
     makeObservable(this, {
       exportState: observable,
@@ -278,10 +286,10 @@ export abstract class QueryEditorStore {
 
     this.applicationStore = applicationStore;
     this.depotServerClient = depotServerClient;
-    this.pluginManager = pluginManager;
+    this.pluginManager = applicationStore.pluginManager;
     this.graphManagerState = new GraphManagerState(
-      this.pluginManager,
-      this.applicationStore.log,
+      applicationStore.pluginManager,
+      applicationStore.log,
     );
     this.queryLoaderState = new QueryLoaderState(this);
   }
@@ -350,7 +358,7 @@ export abstract class QueryEditorStore {
     } catch (error) {
       assertErrorThrown(error);
       this.applicationStore.log.error(
-        LogEvent.create(LEGEND_QUERY_APP_EVENT.QUERY_PROBLEM),
+        LogEvent.create(LEGEND_QUERY_APP_EVENT.GENERIC_FAILURE),
         error,
       );
       this.applicationStore.notifyError(error);
@@ -458,14 +466,13 @@ export class MappingQueryCreatorStore extends QueryEditorStore {
   constructor(
     applicationStore: LegendQueryApplicationStore,
     depotServerClient: DepotServerClient,
-    pluginManager: LegendQueryPluginManager,
     groupId: string,
     artifactId: string,
     versionId: string,
     mappingPath: string,
     runtimePath: string,
   ) {
-    super(applicationStore, depotServerClient, pluginManager);
+    super(applicationStore, depotServerClient);
 
     this.groupId = groupId;
     this.artifactId = artifactId;
@@ -521,7 +528,6 @@ export class MappingQueryCreatorStore extends QueryEditorStore {
         ),
       ),
     );
-
     return queryBuilderState;
   }
 
@@ -547,14 +553,13 @@ export class ServiceQueryCreatorStore extends QueryEditorStore {
   constructor(
     applicationStore: LegendQueryApplicationStore,
     depotServerClient: DepotServerClient,
-    pluginManager: LegendQueryPluginManager,
     groupId: string,
     artifactId: string,
     versionId: string,
     servicePath: string,
     executionKey: string | undefined,
   ) {
-    super(applicationStore, depotServerClient, pluginManager);
+    super(applicationStore, depotServerClient);
 
     this.groupId = groupId;
     this.artifactId = artifactId;
@@ -625,10 +630,9 @@ export class ExistingQueryEditorStore extends QueryEditorStore {
   constructor(
     applicationStore: LegendQueryApplicationStore,
     depotServerClient: DepotServerClient,
-    pluginManager: LegendQueryPluginManager,
     queryId: string,
   ) {
-    super(applicationStore, depotServerClient, pluginManager);
+    super(applicationStore, depotServerClient);
 
     makeObservable<ExistingQueryEditorStore, '_query'>(this, {
       _query: observable,

package/src/stores/QueryEditorStoreTestUtils.ts

@@ -28,6 +28,7 @@ const TEST_DATA__appConfig = {
   },
   studio: {
     url: 'http://testStudioUrl',
+    instances: [],
   },
 };