@finos/legend-query-builder 4.19.12 → 4.19.14

package/src/components/QueryBuilder.tsx

@@ -71,6 +71,7 @@ import {
 import { QueryBuilderParametersPanel } from './QueryBuilderParametersPanel.js';
 import { QueryBuilderFunctionsExplorerPanel } from './explorer/QueryBuilderFunctionsExplorerPanel.js';
 import { QueryBuilderTDSState } from '../stores/fetch-structure/tds/QueryBuilderTDSState.js';
+import { DataProductQueryBuilderState } from '../stores/workflows/dataProduct/DataProductQueryBuilderState.js';
 import { QueryBuilderDiffViewPanelDiaglog } from './QueryBuilderDiffPanel.js';
 import { guaranteeType, returnUndefOnError } from '@finos/legend-shared';
 import { QueryBuilderGraphFetchTreeState } from '../stores/fetch-structure/graph-fetch/QueryBuilderGraphFetchTreeState.js';
@@ -265,18 +266,36 @@ export const QueryBuilder = observer(
       );
     };
     const toggleShowParameterPanel = (): void => {
-      queryBuilderState.setShowParametersPanel(
-        !queryBuilderState.showParametersPanel,
+      const nextEnabled = !queryBuilderState.showParametersPanel;
+      queryBuilderState.setShowParametersPanel(nextEnabled);
+      QueryBuilderTelemetryHelper.logEvent_TogglePanelParameter(
+        applicationStore.telemetryService,
+        {
+          ...queryBuilderState.safeGetTelemetryContext(),
+          enabled: nextEnabled,
+        },
       );
     };
     const toggleConstantPanel = (): void => {
-      queryBuilderState.constantState.setShowConstantPanel(
-        !queryBuilderState.constantState.showConstantPanel,
+      const nextEnabled = !queryBuilderState.constantState.showConstantPanel;
+      queryBuilderState.constantState.setShowConstantPanel(nextEnabled);
+      QueryBuilderTelemetryHelper.logEvent_TogglePanelConstant(
+        applicationStore.telemetryService,
+        {
+          ...queryBuilderState.safeGetTelemetryContext(),
+          enabled: nextEnabled,
+        },
       );
     };
     const toggleShowFilterPanel = (): void => {
-      queryBuilderState.filterState.setShowPanel(
-        !queryBuilderState.filterState.showPanel,
+      const nextEnabled = !queryBuilderState.filterState.showPanel;
+      queryBuilderState.filterState.setShowPanel(nextEnabled);
+      QueryBuilderTelemetryHelper.logEvent_TogglePanelFilter(
+        applicationStore.telemetryService,
+        {
+          ...queryBuilderState.safeGetTelemetryContext(),
+          enabled: nextEnabled,
+        },
       );
     };
     const toggleShowPostFilterPanel = (): void => {
@@ -290,6 +309,13 @@ export const QueryBuilder = observer(
           QUERY_BUILDER_SETTING_KEY.SHOW_POST_FILTER_PANEL,
           tdsState.showPostFilterPanel,
         );
+        QueryBuilderTelemetryHelper.logEvent_TogglePanelPostFilter(
+          applicationStore.telemetryService,
+          {
+            ...queryBuilderState.safeGetTelemetryContext(),
+            enabled: tdsState.showPostFilterPanel,
+          },
+        );
       }
     };
 
@@ -311,6 +337,13 @@ export const QueryBuilder = observer(
                 ) {
                   queryBuilderState.fetchStructureState.implementation.aggregationState.disableCalendar();
                 }
+                QueryBuilderTelemetryHelper.logEvent_ToggleCalendar(
+                  applicationStore.telemetryService,
+                  {
+                    ...queryBuilderState.safeGetTelemetryContext(),
+                    enabled: false,
+                  },
+                );
               },
             },
             {
@@ -330,7 +363,16 @@ export const QueryBuilder = observer(
             {
               label: 'Proceed',
               type: ActionAlertActionType.PROCEED_WITH_CAUTION,
-              handler: (): void => queryBuilderState.setIsCalendarEnabled(true),
+              handler: (): void => {
+                queryBuilderState.setIsCalendarEnabled(true);
+                QueryBuilderTelemetryHelper.logEvent_ToggleCalendar(
+                  applicationStore.telemetryService,
+                  {
+                    ...queryBuilderState.safeGetTelemetryContext(),
+                    enabled: true,
+                  },
+                );
+              },
             },
             {
               label: 'Cancel',
@@ -347,6 +389,13 @@ export const QueryBuilder = observer(
         queryBuilderState.setLambdaWriteMode(
           QUERY_BUILDER_LAMBDA_WRITER_MODE.STANDARD,
         );
+        QueryBuilderTelemetryHelper.logEvent_ToggleTypedTDS(
+          applicationStore.telemetryService,
+          {
+            ...queryBuilderState.safeGetTelemetryContext(),
+            enabled: false,
+          },
+        );
       } else {
         queryBuilderState.applicationStore.alertService.setActionAlertInfo({
           message:
@@ -357,10 +406,18 @@ export const QueryBuilder = observer(
             {
               label: 'Proceed',
               type: ActionAlertActionType.PROCEED_WITH_CAUTION,
-              handler: (): void =>
+              handler: (): void => {
                 queryBuilderState.setLambdaWriteMode(
                   QUERY_BUILDER_LAMBDA_WRITER_MODE.TYPED_FETCH_STRUCTURE,
-                ),
+                );
+                QueryBuilderTelemetryHelper.logEvent_ToggleTypedTDS(
+                  applicationStore.telemetryService,
+                  {
+                    ...queryBuilderState.safeGetTelemetryContext(),
+                    enabled: true,
+                  },
+                );
+              },
             },
             {
               label: 'Cancel',
@@ -373,16 +430,32 @@ export const QueryBuilder = observer(
     };
 
     const editPure = (): void => {
+      QueryBuilderTelemetryHelper.logEvent_EditPureLaunched(
+        applicationStore.telemetryService,
+        queryBuilderState.safeGetTelemetryContext(),
+      );
       openLambdaEditor(QueryBuilderTextEditorMode.TEXT);
     };
     const showPure = (): void => {
+      QueryBuilderTelemetryHelper.logEvent_ShowPureLaunched(
+        applicationStore.telemetryService,
+        queryBuilderState.safeGetTelemetryContext(),
+      );
       openPure();
     };
     const showProtocol = (): void => {
+      QueryBuilderTelemetryHelper.logEvent_ShowProtocolLaunched(
+        applicationStore.telemetryService,
+        queryBuilderState.safeGetTelemetryContext(),
+      );
       openLambdaEditor(QueryBuilderTextEditorMode.JSON);
     };
 
     const openCheckEntitlmentsEditor = (): void => {
+      QueryBuilderTelemetryHelper.logEvent_CheckEntitlementsLaunched(
+        applicationStore.telemetryService,
+        queryBuilderState.safeGetTelemetryContext(),
+      );
       queryBuilderState.checkEntitlementsState.setShowCheckEntitlementsViewer(
         true,
       );
@@ -399,7 +472,15 @@ export const QueryBuilder = observer(
           queryBuilderState.fetchStructureState.implementation,
           QueryBuilderTDSState,
         );
-        tdsState.setShowWindowFuncPanel(!tdsState.showWindowFuncPanel);
+        const nextEnabled = !tdsState.showWindowFuncPanel;
+        tdsState.setShowWindowFuncPanel(nextEnabled);
+        QueryBuilderTelemetryHelper.logEvent_TogglePanelWindow(
+          applicationStore.telemetryService,
+          {
+            ...queryBuilderState.safeGetTelemetryContext(),
+            enabled: nextEnabled,
+          },
+        );
       }
     };
     const showPostFetchStructurePanel =
@@ -446,6 +527,10 @@ export const QueryBuilder = observer(
       );
     const openQueryTutorial = (): void => {
       if (queryDocEntry?.url) {
+        QueryBuilderTelemetryHelper.logEvent_OpenDocumentationLaunched(
+          applicationStore.telemetryService,
+          queryBuilderState.safeGetTelemetryContext(),
+        );
         applicationStore.navigationService.navigator.visitAddress(
           queryDocEntry.url,
         );
@@ -453,6 +538,10 @@ export const QueryBuilder = observer(
     };
     const openFrequentlyAskedQuestions = (): void => {
       if (frequentlyAskedQuestionEntry?.url) {
+        QueryBuilderTelemetryHelper.logEvent_OpenFAQLaunched(
+          applicationStore.telemetryService,
+          queryBuilderState.safeGetTelemetryContext(),
+        );
         applicationStore.navigationService.navigator.visitAddress(
           frequentlyAskedQuestionEntry.url,
         );
@@ -460,14 +549,28 @@ export const QueryBuilder = observer(
     };
     const openSupportTickets = (): void => {
       if (supportTicketsEntry?.url) {
+        QueryBuilderTelemetryHelper.logEvent_OpenSupportTicketsLaunched(
+          applicationStore.telemetryService,
+          queryBuilderState.safeGetTelemetryContext(),
+        );
         applicationStore.navigationService.navigator.visitAddress(
           supportTicketsEntry.url,
         );
       }
     };
 
-    const toggleAssistant = (): void =>
+    const toggleAssistant = (): void => {
       applicationStore.assistantService.toggleAssistant();
+      // Read the post-toggle state directly rather than pre-computing it —
+      // avoids drifting if `toggleAssistant()` ever becomes non-symmetric.
+      QueryBuilderTelemetryHelper.logEvent_ToggleVirtualAssistant(
+        applicationStore.telemetryService,
+        {
+          ...queryBuilderState.safeGetTelemetryContext(),
+          enabled: !applicationStore.assistantService.isHidden,
+        },
+      );
+    };
 
     const extraHelpMenuContentItems = applicationStore.pluginManager
       .getApplicationPlugins()
@@ -490,11 +593,20 @@ export const QueryBuilder = observer(
         </MenuContentItem>
       ));
 
-    const compileQuery = applicationStore.guardUnhandledError(() =>
-      flowResult(queryBuilderState.compileQuery()),
-    );
-    const showDiff = (): void =>
+    const compileQuery = applicationStore.guardUnhandledError(() => {
+      QueryBuilderTelemetryHelper.logEvent_CompileQueryLaunched(
+        applicationStore.telemetryService,
+        queryBuilderState.safeGetTelemetryContext(),
+      );
+      return flowResult(queryBuilderState.compileQuery());
+    });
+    const showDiff = (): void => {
+      QueryBuilderTelemetryHelper.logEvent_ShowQueryDiffLaunched(
+        applicationStore.telemetryService,
+        queryBuilderState.safeGetTelemetryContext(),
+      );
       queryBuilderState.changeDetectionState.showDiffViewPanel();
+    };
 
     useEffect(() => {
       // this condition is for passing all exisitng tests because when we initialize a queryBuilderState for a test,
@@ -778,29 +890,36 @@ export const QueryBuilder = observer(
                         </MenuContentItemLabel>
                       </MenuContentItem>
                       <MenuContentDivider />
-                      <MenuContentItem
-                        onClick={openCheckEntitlmentsEditor}
-                        disabled={
-                          (queryBuilderState.isQuerySupported &&
-                            queryBuilderState.fetchStructureState
-                              .implementation instanceof QueryBuilderTDSState &&
-                            queryBuilderState.fetchStructureState.implementation
-                              .projectionColumns.length === 0) ||
-                          !queryBuilderState.canBuildQuery
-                        }
-                        title={
-                          !queryBuilderState.canBuildQuery
-                            ? 'Please fix query errors to check entitlements'
-                            : ''
-                        }
-                      >
-                        <MenuContentItemIcon>
-                          <DataAccessIcon />
-                        </MenuContentItemIcon>
-                        <MenuContentItemLabel>
-                          Check Entitlements
-                        </MenuContentItemLabel>
-                      </MenuContentItem>
+                      {!(
+                        queryBuilderState instanceof
+                        DataProductQueryBuilderState
+                      ) && (
+                        <MenuContentItem
+                          onClick={openCheckEntitlmentsEditor}
+                          disabled={
+                            (queryBuilderState.isQuerySupported &&
+                              queryBuilderState.fetchStructureState
+                                .implementation instanceof
+                                QueryBuilderTDSState &&
+                              queryBuilderState.fetchStructureState
+                                .implementation.projectionColumns.length ===
+                                0) ||
+                            !queryBuilderState.canBuildQuery
+                          }
+                          title={
+                            !queryBuilderState.canBuildQuery
+                              ? 'Please fix query errors to check entitlements'
+                              : ''
+                          }
+                        >
+                          <MenuContentItemIcon>
+                            <DataAccessIcon />
+                          </MenuContentItemIcon>
+                          <MenuContentItemLabel>
+                            Check Entitlements
+                          </MenuContentItemLabel>
+                        </MenuContentItem>
+                      )}
                       <MenuContentItem
                         onClick={editPure}
                         disabled={!queryBuilderState.canBuildQuery}

package/src/components/QueryBuilderConstantExpressionPanel.tsx

@@ -58,6 +58,7 @@ import {
 import { BasicValueSpecificationEditor } from './shared/BasicValueSpecificationEditor.js';
 import { QUERY_BUILDER_TEST_ID } from '../__lib__/QueryBuilderTesting.js';
 import { QUERY_BUILDER_DOCUMENTATION_KEY } from '../__lib__/QueryBuilderDocumentation.js';
+import { QueryBuilderTelemetryHelper } from '../__lib__/QueryBuilderTelemetryHelper.js';
 import React, { useCallback, useEffect, useMemo, useState } from 'react';
 import { variableExpression_setName } from '../stores/shared/ValueSpecificationModifierHelper.js';
 import { LambdaEditor } from './shared/LambdaEditor.js';
@@ -175,6 +176,16 @@ const QueryBuilderSimpleConstantExpressionEditor = observer(
       if (isCreating) {
         variableState.addConstant(constantState);
       }
+      QueryBuilderTelemetryHelper.logEvent_ConstantChanged(
+        applicationStore.telemetryService,
+        {
+          ...queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: isCreating ? 'add' : 'edit',
+            constantCount: variableState.constants.length,
+          },
+        },
+      );
       handleCancel();
     };
 
@@ -547,8 +558,19 @@ export const QueryBuilderConstantExpressionPanel = observer(
                   actions={{
                     editVariable: () =>
                       constantState.setSelectedConstant(constState),
-                    deleteVariable: () =>
-                      constantState.removeConstant(constState),
+                    deleteVariable: () => {
+                      constantState.removeConstant(constState);
+                      QueryBuilderTelemetryHelper.logEvent_ConstantChanged(
+                        queryBuilderState.applicationStore.telemetryService,
+                        {
+                          ...queryBuilderState.safeGetTelemetryContext(),
+                          change: {
+                            action: 'remove',
+                            constantCount: constantState.constants.length,
+                          },
+                        },
+                      );
+                    },
                   }}
                   extraContextMenuActions={getExtraContextMenu(constState)}
                   isReadOnly={isReadOnly}

package/src/components/QueryBuilderParametersPanel.tsx

@@ -50,6 +50,7 @@ import { LambdaParameterValuesEditor } from './shared/LambdaParameterValuesEdito
 import { VariableViewer } from './shared/QueryBuilderVariableSelector.js';
 import { QUERY_BUILDER_TEST_ID } from '../__lib__/QueryBuilderTesting.js';
 import { QUERY_BUILDER_DOCUMENTATION_KEY } from '../__lib__/QueryBuilderDocumentation.js';
+import { QueryBuilderTelemetryHelper } from '../__lib__/QueryBuilderTelemetryHelper.js';
 import { useCallback, useState } from 'react';
 import {
   buildElementOption,
@@ -166,6 +167,16 @@ const VariableExpressionEditor = observer(
           defaultMilestoningValue,
         );
       }
+      QueryBuilderTelemetryHelper.logEvent_ParameterChanged(
+        applicationStore.telemetryService,
+        {
+          ...queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: isCreating ? 'add' : 'edit',
+            parameterCount: queryParametersState.parameterStates.length,
+          },
+        },
+      );
 
       handleCancel();
     };
@@ -390,8 +401,20 @@ export const QueryBuilderParametersPanel = observer(
                     actions={{
                       editVariable: () =>
                         queryParameterState.setSelectedParameter(pState),
-                      deleteVariable: () =>
-                        queryParameterState.removeParameter(pState),
+                      deleteVariable: () => {
+                        queryParameterState.removeParameter(pState);
+                        QueryBuilderTelemetryHelper.logEvent_ParameterChanged(
+                          queryBuilderState.applicationStore.telemetryService,
+                          {
+                            ...queryBuilderState.safeGetTelemetryContext(),
+                            change: {
+                              action: 'remove',
+                              parameterCount:
+                                queryParameterState.parameterStates.length,
+                            },
+                          },
+                        );
+                      },
                     }}
                   />
                 ))}

package/src/components/QueryBuilderSideBar.tsx

@@ -47,6 +47,7 @@ import {
   type PackageableElementOption,
 } from '@finos/legend-lego/graph-editor';
 import type { QueryBuilder_LegendApplicationPlugin_Extension } from '../stores/QueryBuilder_LegendApplicationPlugin_Extension.js';
+import { QueryBuilderTelemetryHelper } from '../__lib__/QueryBuilderTelemetryHelper.js';
 
 export const getParameterValue = (
   parameter: ValueSpecification | undefined,
@@ -130,6 +131,15 @@ export const QueryBuilderClassSelector = observer(
         return;
       }
       queryBuilderState.changeSourceElement(val.value);
+      QueryBuilderTelemetryHelper.logEvent_ExecutionContextChanged(
+        applicationStore.telemetryService,
+        {
+          ...queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            subtype: 'class',
+          },
+        },
+      );
       onClassChange?.(val.value);
     };
 
@@ -256,6 +266,15 @@ const BasicQueryBuilderSetup = observer(
         return;
       }
       queryBuilderState.changeMapping(val.value);
+      QueryBuilderTelemetryHelper.logEvent_ExecutionContextChanged(
+        applicationStore.telemetryService,
+        {
+          ...queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            subtype: 'mapping',
+          },
+        },
+      );
     };
     const mappingFilterOption = createFilter({
       ignoreCase: true,
@@ -287,6 +306,15 @@ const BasicQueryBuilderSetup = observer(
         return;
       }
       queryBuilderState.changeRuntime(val.value);
+      QueryBuilderTelemetryHelper.logEvent_ExecutionContextChanged(
+        applicationStore.telemetryService,
+        {
+          ...queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            subtype: 'runtime',
+          },
+        },
+      );
     };
     const runtimeFilterOption = createFilter({
       ignoreCase: true,

package/src/components/fetch-structure/QueryBuilderGraphFetchTreePanel.tsx

@@ -409,6 +409,17 @@ export const QueryBuilderGraphFetchExternalConfig = observer(
       } else {
         removeNodeRecursively(serializationTreeData, node);
         serializationState.setGraphFetchTree({ ...serializationTreeData });
+        QueryBuilderTelemetryHelper.logEvent_GraphFetchChanged(
+          graphFetchState.queryBuilderState.applicationStore.telemetryService,
+          {
+            ...graphFetchState.queryBuilderState.safeGetTelemetryContext(),
+            change: {
+              action: 'remove',
+              nodeCount: serializationTreeData.nodes.size,
+              serializationType: serializationState.getLabel(),
+            },
+          },
+        );
       }
     };
 
@@ -533,10 +544,31 @@ export const QueryBuilderGraphFetchTreeExplorer = observer(
         updateTreeData({ ...serializationState.treeData });
       }
       updateTreeData({ ...treeData });
+      QueryBuilderTelemetryHelper.logEvent_GraphFetchChanged(
+        graphFetchState.queryBuilderState.applicationStore.telemetryService,
+        {
+          ...graphFetchState.queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: 'remove',
+            nodeCount: treeData.nodes.size,
+          },
+        },
+      );
     };
 
-    const toggleChecked = (): void =>
+    const toggleChecked = (): void => {
       graphFetchState.setChecked(!graphFetchState.isChecked);
+      QueryBuilderTelemetryHelper.logEvent_GraphFetchChanged(
+        graphFetchState.queryBuilderState.applicationStore.telemetryService,
+        {
+          ...graphFetchState.queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: 'check-toggle',
+            nodeCount: treeData.nodes.size,
+          },
+        },
+      );
+    };
 
     const openConfigModal = (): void => {
       if (serializationState instanceof GraphFetchPureSerializationState) {
@@ -594,6 +626,18 @@ export const QueryBuilderGraphFetchTreeExplorer = observer(
                             );
                             break;
                         }
+                        QueryBuilderTelemetryHelper.logEvent_GraphFetchChanged(
+                          graphFetchState.queryBuilderState.applicationStore
+                            .telemetryService,
+                          {
+                            ...graphFetchState.queryBuilderState.safeGetTelemetryContext(),
+                            change: {
+                              action: 'serialization-change',
+                              nodeCount: treeData.nodes.size,
+                              serializationType: implementationType,
+                            },
+                          },
+                        );
                       },
                     ),
                 },
@@ -769,6 +813,17 @@ const QueryBuilderGraphFetchTreePanel = observer(
             refreshTreeData: true,
           });
         }
+        QueryBuilderTelemetryHelper.logEvent_GraphFetchChanged(
+          graphFetchTreeState.queryBuilderState.applicationStore
+            .telemetryService,
+          {
+            ...graphFetchTreeState.queryBuilderState.safeGetTelemetryContext(),
+            change: {
+              action: 'add',
+              nodeCount: graphFetchTreeState.treeData?.nodes.size ?? 0,
+            },
+          },
+        );
       },
       [graphFetchTreeState, serializationState],
     );

package/src/components/fetch-structure/QueryBuilderPostFilterPanel.tsx

@@ -144,8 +144,19 @@ const QueryBuilderPostFilterConditionContextMenu = observer(
   >(function QueryBuilderPostFilterConditionContextMenu(props, ref) {
     const { tdsState, node } = props;
     const postFilterState = tdsState.postFilterState;
-    const removeNode = (): void =>
+    const applicationStore = useApplicationStore();
+    const removeNode = (): void => {
       postFilterState.removeNodeAndPruneBranch(node);
+      QueryBuilderTelemetryHelper.logEvent_PostFilterChanged(
+        applicationStore.telemetryService,
+        {
+          ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: 'remove',
+          },
+        },
+      );
+    };
     const createCondition = (): void => {
       postFilterState.addNodeFromNode(
         new QueryBuilderPostFilterTreeBlankConditionNodeData(undefined),
@@ -184,19 +195,34 @@ const QueryBuilderPostFilterConditionContextMenu = observer(
 
 const QueryBuilderPostFilterGroupConditionEditor = observer(
   (props: {
+    tdsState: QueryBuilderTDSState;
     node: QueryBuilderPostFilterTreeGroupNodeData;
     isDragOver: boolean;
     isDroppable: boolean;
   }) => {
-    const { node, isDragOver, isDroppable } = props;
+    const { tdsState, node, isDragOver, isDroppable } = props;
+    const applicationStore = useApplicationStore();
     const switchOperation: React.MouseEventHandler<HTMLDivElement> = (
       event,
     ): void => {
       event.stopPropagation(); // prevent triggering selecting the node
-      node.setGroupOperation(
+      const nextOperation =
         node.groupOperation === QUERY_BUILDER_GROUP_OPERATION.AND
           ? QUERY_BUILDER_GROUP_OPERATION.OR
-          : QUERY_BUILDER_GROUP_OPERATION.AND,
+          : QUERY_BUILDER_GROUP_OPERATION.AND;
+      node.setGroupOperation(nextOperation);
+      QueryBuilderTelemetryHelper.logEvent_PostFilterChanged(
+        applicationStore.telemetryService,
+        {
+          ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: 'group-operation-change',
+            groupOperation:
+              nextOperation === QUERY_BUILDER_GROUP_OPERATION.AND
+                ? 'and'
+                : 'or',
+          },
+        },
       );
     };
 
@@ -771,6 +797,7 @@ const QueryBuilderPostFilterTreeNodeContainer = observer(
           >
             {node instanceof QueryBuilderPostFilterTreeGroupNodeData && (
               <QueryBuilderPostFilterGroupConditionEditor
+                tdsState={tdsState}
                 node={node}
                 isDroppable={isDroppable}
                 isDragOver={isDragOver}