@finos/legend-query-builder 0.6.19 → 0.6.21

package/src/components/QueryBuilderResultPanel.tsx

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { AgGridColumn, AgGridReact } from '@ag-grid-community/react';
+import { AgGridReact } from '@ag-grid-community/react';
 import { ClientSideRowModelModule } from '@ag-grid-community/client-side-row-model';
 import {
   BlankPanelContent,
@@ -59,6 +59,7 @@ import {
   guaranteeNonNullable,
   isBoolean,
   type PlainObject,
+  prettyDuration,
 } from '@finos/legend-shared';
 import { forwardRef, useState } from 'react';
 import type { CellMouseOverEvent } from '@ag-grid-community/core';
@@ -362,18 +363,14 @@ const QueryBuilderGridResult = observer(
           onCellMouseOver={(event): void => {
             setCellDoubleClickedEvent(event);
           }}
-        >
-          {columns.map((colName) => (
-            <AgGridColumn
-              minWidth={50}
-              sortable={true}
-              resizable={true}
-              field={colName}
-              key={colName}
-              flex={1}
-            />
-          ))}
-        </AgGridReact>
+          columnDefs={columns.map((colName) => ({
+            minWidth: 50,
+            sortable: true,
+            resizable: true,
+            field: colName,
+            flex: 1,
+          }))}
+        />
       </ContextMenu>
     );
   },
@@ -498,15 +495,29 @@ export const QueryBuilderResultPanel = observer(
       );
     };
     const allowSettingPreviewLimit = queryBuilderState.isQuerySupported;
-    const resultSetSize = (result: ExecutionResult | undefined): string =>
-      result
-        ? result instanceof TDSExecutionResult
-          ? `${
-              result.result.rows.length
-            } row(s) in ${resultState.executionDuration?.toString()} ms`
-          : `run in ${resultState.executionDuration?.toString()} ms`
-        : '';
 
+    const getResultSetDescription = (
+      _executionResult: ExecutionResult,
+    ): string | undefined => {
+      const queryDuration = resultState.executionDuration
+        ? prettyDuration(resultState.executionDuration, {
+            ms: true,
+          })
+        : undefined;
+      if (_executionResult instanceof TDSExecutionResult) {
+        const rowLength = _executionResult.result.rows.length;
+        return `${rowLength} row(s)${
+          queryDuration ? ` in ${queryDuration}` : ''
+        }`;
+      }
+      if (!queryDuration) {
+        return undefined;
+      }
+      return `query ran in ${queryDuration}`;
+    };
+    const resultDescription = executionResult
+      ? getResultSetDescription(executionResult)
+      : undefined;
     return (
       <div
         data-testid={QUERY_BUILDER_TEST_ID.QUERY_BUILDER_RESULT_PANEL}
@@ -516,7 +527,7 @@ export const QueryBuilderResultPanel = observer(
           <div className="panel__header__title">
             <div className="panel__header__title__label">result</div>
             <div className="query-builder__result__analytics">
-              {resultSetSize(executionResult)}
+              {resultDescription ?? ''}
             </div>
             {executionResult && resultState.checkForStaleResults && (
               <div className="query-builder__result__stale-status">

package/src/components/QueryBuilder_LegendApplicationPlugin.ts

@@ -22,6 +22,11 @@ import {
 } from '@finos/legend-application';
 import packageJson from '../../package.json';
 import { QUERY_BUILDER_COMMAND_CONFIG } from '../stores/QueryBuilderCommand.js';
+import type { QueryBuilderState } from '../stores/QueryBuilderState.js';
+
+export type CheckEntitlementEditorRender = (
+  queryBuilderState: QueryBuilderState,
+) => React.ReactNode | undefined;
 
 export class QueryBuilder_LegendApplicationPlugin extends LegendApplicationPlugin {
   static NAME = packageJson.extensions.applicationPlugin;
@@ -41,4 +46,8 @@ export class QueryBuilder_LegendApplicationPlugin extends LegendApplicationPlugi
       QUERY_BUILDER_COMMAND_CONFIG,
     );
   }
+
+  getCheckEntitlementsEditorRender(): CheckEntitlementEditorRender | undefined {
+    return undefined;
+  }
 }

package/src/components/explorer/QueryBuilderExplorerPanel.tsx

@@ -803,7 +803,6 @@ export const QueryBuilderExplorerPanel = observer(
         applicationStore.alertUnhandledError,
       );
     }, [applicationStore, explorerState, queryBuilderState.mapping]);
-
     return (
       <div
         data-testid={QUERY_BUILDER_TEST_ID.QUERY_BUILDER_EXPLORER}

package/src/graphManager/QueryBuilderHashUtils.ts

@@ -113,4 +113,6 @@ export enum QUERY_BUILDER_HASH_STRUCTURE {
   MILESTONING_STATE = 'MILESTONING_STATE',
   UNSUPPORTED_QUERY_STATE = 'UNSUPPORTED_QUERY_STATE',
   QUERY_BUILDER_STATE = 'QUERY_BUILDER_STATE',
+
+  CHECK_ENTITLEMENTS_STATE = 'CHECK_ENTITLEMENTS_STATE',
 }

package/src/index.ts

@@ -18,7 +18,10 @@ export * from './stores/QueryBuilderBootstraper.js';
 export { QueryBuilder_GraphManagerPreset } from './graphManager/QueryBuilder_GraphManagerPreset.js';
 
 export { QUERY_BUILDER_TEST_ID } from './components/QueryBuilder_TestID.js';
-export { QueryBuilder_LegendApplicationPlugin } from './components/QueryBuilder_LegendApplicationPlugin.js';
+export {
+  type CheckEntitlementEditorRender,
+  QueryBuilder_LegendApplicationPlugin,
+} from './components/QueryBuilder_LegendApplicationPlugin.js';
 export { QueryBuilderNavigationBlocker } from './components/QueryBuilderNavigationBlocker.js';
 export {
   QueryBuilder,

package/src/stores/QueryBuilderResultState.ts

@@ -210,6 +210,10 @@ export class QueryBuilderResultState {
         `Runtime is required to execute query`,
       );
       const query = this.buildExecutionRawLambda();
+      const parameterValues = buildExecutionParameterValues(
+        this.queryBuilderState.parametersState.parameterStates,
+        this.queryBuilderState.graphManagerState,
+      );
       const startTime = Date.now();
       const promise =
         this.queryBuilderState.graphManagerState.graphManager.runQuery(
@@ -218,10 +222,7 @@ export class QueryBuilderResultState {
           runtime,
           this.queryBuilderState.graphManagerState.graph,
           {
-            parameterValues: buildExecutionParameterValues(
-              this.queryBuilderState.parametersState.parameterStates,
-              this.queryBuilderState.graphManagerState,
-            ),
+            parameterValues,
           },
         );
       this.setQueryRunPromise(promise);

package/src/stores/QueryBuilderState.ts

@@ -77,6 +77,7 @@ import { QUERY_BUILDER_HASH_STRUCTURE } from '../graphManager/QueryBuilderHashUt
 import { QUERY_BUILDER_COMMAND_KEY } from './QueryBuilderCommand.js';
 import { QueryBuilderWatermarkState } from './watermark/QueryBuilderWatermarkState.js';
 import { QueryBuilderConstantsState } from './QueryBuilderConstantsState.js';
+import { QueryBuilderCheckEntitlementsState } from './entitlements/QueryBuilderCheckEntitlementsState.js';
 
 export abstract class QueryBuilderState implements CommandRegistrar {
   applicationStore: GenericLegendApplicationStore;
@@ -91,6 +92,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
   fetchStructureState: QueryBuilderFetchStructureState;
   filterState: QueryBuilderFilterState;
   watermarkState: QueryBuilderWatermarkState;
+  checkEntitlementsState: QueryBuilderCheckEntitlementsState;
   filterOperators: QueryBuilderFilterOperator[] =
     getQueryBuilderCoreFilterOperators();
   resultState: QueryBuilderResultState;
@@ -102,6 +104,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
   showFunctionsExplorerPanel = false;
   showParametersPanel = false;
   isEditingWatermark = false;
+  isCheckingEntitlments = false;
 
   class?: Class | undefined;
   mapping?: Mapping | undefined;
@@ -123,12 +126,14 @@ export abstract class QueryBuilderState implements CommandRegistrar {
       fetchStructureState: observable,
       filterState: observable,
       watermarkState: observable,
+      checkEntitlementsState: observable,
       resultState: observable,
       textEditorState: observable,
       unsupportedQueryState: observable,
       showFunctionsExplorerPanel: observable,
       showParametersPanel: observable,
       isEditingWatermark: observable,
+      isCheckingEntitlments: observable,
       changeDetectionState: observable,
       class: observable,
       mapping: observable,
@@ -141,6 +146,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
       setShowFunctionsExplorerPanel: action,
       setShowParametersPanel: action,
       setIsEditingWatermark: action,
+      setIsCheckingEntitlments: action,
       setClass: action,
       setMapping: action,
       setRuntimeValue: action,
@@ -167,6 +173,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     this.fetchStructureState = new QueryBuilderFetchStructureState(this);
     this.filterState = new QueryBuilderFilterState(this, this.filterOperators);
     this.watermarkState = new QueryBuilderWatermarkState(this);
+    this.checkEntitlementsState = new QueryBuilderCheckEntitlementsState(this);
     this.resultState = new QueryBuilderResultState(this);
     this.textEditorState = new QueryBuilderTextEditorState(this);
     this.unsupportedQueryState = new QueryBuilderUnsupportedQueryState(this);
@@ -230,6 +237,10 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     this.isEditingWatermark = val;
   }
 
+  setIsCheckingEntitlments(val: boolean): void {
+    this.isCheckingEntitlments = val;
+  }
+
   setClass(val: Class | undefined): void {
     this.class = val;
   }
@@ -284,13 +295,20 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     this.textEditorState = new QueryBuilderTextEditorState(this);
     this.unsupportedQueryState = new QueryBuilderUnsupportedQueryState(this);
     this.milestoningState = new QueryBuilderMilestoningState(this);
+    const mappingModelCoverageAnalysisResult =
+      this.explorerState.mappingModelCoverageAnalysisResult;
     this.explorerState = new QueryBuilderExplorerState(this);
+    if (mappingModelCoverageAnalysisResult) {
+      this.explorerState.mappingModelCoverageAnalysisResult =
+        mappingModelCoverageAnalysisResult;
+    }
     this.explorerState.refreshTreeData();
     this.parametersState = new QueryBuilderParametersState(this);
     this.constantState = new QueryBuilderConstantsState(this);
     this.functionsExplorerState = new QueryFunctionsExplorerState(this);
     this.filterState = new QueryBuilderFilterState(this, this.filterOperators);
     this.watermarkState = new QueryBuilderWatermarkState(this);
+    this.checkEntitlementsState = new QueryBuilderCheckEntitlementsState(this);
 
     const currentFetchStructureImplementationType =
       this.fetchStructureState.implementation.type;
@@ -528,6 +546,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
       this.parametersState,
       this.filterState,
       this.watermarkState,
+      this.checkEntitlementsState,
       this.fetchStructureState.implementation,
     ]);
   }

package/src/stores/QueryBuilderStateTestUtils.ts

@@ -74,13 +74,15 @@ export const TEST__setUpQueryBuilderState = async (
     }
   }
 
-  if (rawMappingModelCoverageAnalysisResult) {
+  if (rawMappingModelCoverageAnalysisResult && executionContext) {
+    const graph = queryBuilderState.graphManagerState.graph;
     createSpy(
       queryBuilderState.graphManagerState.graphManager,
       'analyzeMappingModelCoverage',
     ).mockResolvedValue(
       queryBuilderState.graphManagerState.graphManager.buildMappingModelCoverageAnalysisResult(
         rawMappingModelCoverageAnalysisResult,
+        graph.getMapping(executionContext.mapping),
       ),
     );
   }

package/src/stores/entitlements/QueryBuilderCheckEntitlementsState.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 Hashable, hashArray } from '@finos/legend-shared';
+import { makeObservable, observable, action, computed } from 'mobx';
+import { QUERY_BUILDER_HASH_STRUCTURE } from '../../graphManager/QueryBuilderHashUtils.js';
+import type { QueryBuilderState } from '../QueryBuilderState.js';
+
+export class QueryBuilderCheckEntitlementsState implements Hashable {
+  readonly queryBuilderState: QueryBuilderState;
+  isCheckingEntitlements = false;
+
+  constructor(queryBuilderState: QueryBuilderState) {
+    makeObservable(this, {
+      isCheckingEntitlements: observable,
+      setIsCheckingEntitlements: action,
+      hashCode: computed,
+    });
+
+    this.queryBuilderState = queryBuilderState;
+  }
+
+  setIsCheckingEntitlements(val: boolean): void {
+    this.isCheckingEntitlements = val;
+  }
+
+  get hashCode(): string {
+    return hashArray([
+      QUERY_BUILDER_HASH_STRUCTURE.CHECK_ENTITLEMENTS_STATE,
+      this.isCheckingEntitlements,
+    ]);
+  }
+}

package/src/stores/explorer/QueryBuilderExplorerState.ts

@@ -660,7 +660,13 @@ export class QueryBuilderExplorerState {
   }
 
   *analyzeMappingModelCoverage(): GeneratorFn<void> {
-    if (this.queryBuilderState.mapping) {
+    // We will only refetch if the analysis result's mapping has changed.
+    // This makes the assumption that the mapping has not been edited, which is a valid assumption since query is not for editing mappings
+    if (
+      this.queryBuilderState.mapping &&
+      this.queryBuilderState.mapping !==
+        this.mappingModelCoverageAnalysisResult?.mapping
+    ) {
       this.mappingModelCoverageAnalysisState.inProgress();
       this.mappingModelCoverageAnalysisState.setMessage('Analyzing Mapping...');
       try {

package/tsconfig.json

@@ -68,6 +68,7 @@
     "./src/stores/QueryBuilderValueSpecificationBuilderHelper.ts",
     "./src/stores/QueryBuilderValueSpecificationHelper.ts",
     "./src/stores/ServiceInfo.ts",
+    "./src/stores/entitlements/QueryBuilderCheckEntitlementsState.ts",
     "./src/stores/explorer/QueryBuilderExplorerState.ts",
     "./src/stores/explorer/QueryBuilderPropertySearchState.ts",
     "./src/stores/explorer/QueryFunctionsExplorerState.ts",