@finos/legend-query-builder 4.19.12 → 4.19.14

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

@@ -37,6 +37,7 @@ import {
   PanelFormListItems,
 } from '@finos/legend-art';
 import { SortColumnState } from '../../stores/fetch-structure/tds/QueryResultSetModifierState.js';
+import { QueryBuilderTelemetryHelper } from '../../__lib__/QueryBuilderTelemetryHelper.js';
 import {
   addUniqueEntry,
   clone,
@@ -646,6 +647,12 @@ export const QueryResultModifierModal = observer(
     };
 
     const applyChanges = (): void => {
+      const previousWatermarkValue = watermarkState.value;
+      const previousBusinessDate = milestoningState.businessDate;
+      const previousProcessingDate = milestoningState.processingDate;
+      const wasAllVersionsEnabled = milestoningState.isAllVersionsEnabled;
+      const wasAllVersionsInRangeEnabled =
+        milestoningState.isAllVersionsInRangeEnabled;
       resultSetModifierState.setSortColumns(sortColumns);
       resultSetModifierState.setDistinct(distinct);
       resultSetModifierState.setLimit(limitResults);
@@ -655,7 +662,30 @@ export const QueryResultModifierModal = observer(
         resultSetModifierState.setSlice(undefined);
       }
       resultSetModifierState.setShowModal(false);
+      QueryBuilderTelemetryHelper.logEvent_ResultModifierChanged(
+        applicationStore.telemetryService,
+        {
+          ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            limitSet: resultSetModifierState.limit !== undefined,
+            distinctOn: resultSetModifierState.distinct,
+            sortColumnCount: resultSetModifierState.sortColumns.length,
+            sliceSet: resultSetModifierState.slice !== undefined,
+          },
+        },
+      );
       watermarkState.setValue(watermarkValue);
+      if (watermarkValue !== previousWatermarkValue) {
+        QueryBuilderTelemetryHelper.logEvent_WatermarkChanged(
+          applicationStore.telemetryService,
+          {
+            ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+            change: {
+              enabled: watermarkValue !== undefined,
+            },
+          },
+        );
+      }
       milestoningState.queryBuilderState.parametersState.setParameters(
         parameterStates,
       );
@@ -671,11 +701,33 @@ export const QueryResultModifierModal = observer(
           startDateValue,
         );
         milestoningState.updateMilestoningParameterValue(endDate, endDateValue);
+        if (!wasAllVersionsInRangeEnabled) {
+          QueryBuilderTelemetryHelper.logEvent_MilestoningChanged(
+            applicationStore.telemetryService,
+            {
+              ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+              change: {
+                subtype: 'all-versions-in-range',
+              },
+            },
+          );
+        }
       } else if (isAllVersionsEnabled) {
         milestoningState.clearGetAllParameters();
         milestoningState.queryBuilderState.setGetAllFunction(
           QUERY_BUILDER_SUPPORTED_GET_ALL_FUNCTIONS.GET_ALL_VERSIONS,
         );
+        if (!wasAllVersionsEnabled) {
+          QueryBuilderTelemetryHelper.logEvent_MilestoningChanged(
+            applicationStore.telemetryService,
+            {
+              ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+              change: {
+                subtype: 'all-versions',
+              },
+            },
+          );
+        }
       } else if (
         tdsState.queryBuilderState.milestoningState.isMilestonedQuery
       ) {
@@ -693,6 +745,28 @@ export const QueryResultModifierModal = observer(
           businessDate,
           businessDateValue,
         );
+        if (businessDate !== previousBusinessDate) {
+          QueryBuilderTelemetryHelper.logEvent_MilestoningChanged(
+            applicationStore.telemetryService,
+            {
+              ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+              change: {
+                subtype: 'business-date',
+              },
+            },
+          );
+        }
+        if (processingDate !== previousProcessingDate) {
+          QueryBuilderTelemetryHelper.logEvent_MilestoningChanged(
+            applicationStore.telemetryService,
+            {
+              ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+              change: {
+                subtype: 'processing-date',
+              },
+            },
+          );
+        }
       }
       milestoningState.updateQueryBuilderState();
     };

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

@@ -70,6 +70,7 @@ import {
 } from '../QueryBuilderPropertyExpressionEditor.js';
 import { QueryResultModifierModal } from './QueryBuilderResultModifierPanel.js';
 import { QUERY_BUILDER_TEST_ID } from '../../__lib__/QueryBuilderTesting.js';
+import { QueryBuilderTelemetryHelper } from '../../__lib__/QueryBuilderTelemetryHelper.js';
 import { flowResult } from 'mobx';
 import { useApplicationStore } from '@finos/legend-application';
 import {
@@ -167,8 +168,20 @@ const QueryBuilderProjectionColumnContextMenu = observer(
     }
   >(function QueryBuilderProjectionColumnContextMenu(props, ref) {
     const { projectionColumnState } = props;
-    const removeColumn = (): void =>
-      projectionColumnState.tdsState.removeColumn(projectionColumnState);
+    const removeColumn = (): void => {
+      const tdsState = projectionColumnState.tdsState;
+      tdsState.removeColumn(projectionColumnState);
+      QueryBuilderTelemetryHelper.logEvent_ProjectionChanged(
+        tdsState.queryBuilderState.applicationStore.telemetryService,
+        {
+          ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: 'remove',
+            columnCount: tdsState.projectionColumns.length,
+          },
+        },
+      );
+    };
     const convertToDerivation = (): void => {
       if (
         projectionColumnState instanceof QueryBuilderSimpleProjectionColumnState
@@ -418,8 +431,19 @@ const QueryBuilderProjectionColumnEditor = observer(
     const isCalendarEnabled = tdsState.queryBuilderState.isCalendarEnabled;
     const isRemovalDisabled = tdsState.isColumnInUse(projectionColumnState);
 
-    const removeColumn = (): void =>
+    const removeColumn = (): void => {
       tdsState.removeColumn(projectionColumnState);
+      QueryBuilderTelemetryHelper.logEvent_ProjectionChanged(
+        applicationStore.telemetryService,
+        {
+          ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: 'remove',
+            columnCount: tdsState.projectionColumns.length,
+          },
+        },
+      );
+    };
 
     // name
     const setColumnName = (columnName: string): void =>
@@ -435,11 +459,22 @@ const QueryBuilderProjectionColumnEditor = observer(
       op.isCompatibleWithColumn(projectionColumnState),
     );
     const changeOperator =
-      (val: QueryBuilderAggregateOperator | undefined) => (): void =>
+      (val: QueryBuilderAggregateOperator | undefined) => (): void => {
         tdsState.aggregationState.changeColumnAggregateOperator(
           val,
           projectionColumnState,
         );
+        QueryBuilderTelemetryHelper.logEvent_AggregationChanged(
+          applicationStore.telemetryService,
+          {
+            ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+            change: {
+              action: 'operator-change',
+              operatorName: val?.getLabel(projectionColumnState),
+            },
+          },
+        );
+      };
 
     // calendar
     const aggregateCalendarFunctionDateColumns =
@@ -570,12 +605,23 @@ const QueryBuilderProjectionColumnEditor = observer(
               ? tdsState.projectionColumns.length - 1
               : currentRearrangeDropGapIndex,
           );
+          QueryBuilderTelemetryHelper.logEvent_ProjectionChanged(
+            applicationStore.telemetryService,
+            {
+              ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+              change: {
+                action: 'move',
+                columnCount: tdsState.projectionColumns.length,
+              },
+            },
+          );
         }
         setCurrentRearrangeDraggedColumnIndex(undefined);
         setCurrentRearrangeDropGapIndex(undefined);
       },
       [
         tdsState,
+        applicationStore.telemetryService,
         currentRearrangeDropGapIndex,
         currentRearrangeDraggedColumnIndex,
         setCurrentRearrangeDraggedColumnIndex,
@@ -669,8 +715,7 @@ const QueryBuilderProjectionColumnEditor = observer(
            * @workaround typings - https://github.com/react-dnd/react-dnd/pull/3484
            */
           projectionColumnBeingDragged:
-            // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-            (monitor.getItem() as QueryBuilderProjectionColumnDragSource | null)
+            monitor.getItem<QueryBuilderProjectionColumnDragSource | null>()
               ?.columnState,
         }),
       }),
@@ -1304,12 +1349,38 @@ export const QueryBuilderTDSPanel = observer(
     // Toolbar
     const openResultSetModifierEditor = (): void =>
       tdsState.resultSetModifierState.setShowModal(true);
-    const addNewBlankDerivation = (): void => tdsState.addNewBlankDerivation();
+    const addNewBlankDerivation = (): void => {
+      tdsState.addNewBlankDerivation();
+      QueryBuilderTelemetryHelper.logEvent_ProjectionChanged(
+        applicationStore.telemetryService,
+        {
+          ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: 'add-derivation',
+            sourceType: 'derivation',
+            columnCount: tdsState.projectionColumns.length,
+          },
+        },
+      );
+    };
 
     const clearAllProjectionColumns = (): void => {
       tdsState.checkBeforeClearingColumns(() => {
+        // capture before the clear so we report how many columns were removed,
+        // rather than the post-clear count which is always 0
+        const clearedColumnCount = tdsState.projectionColumns.length;
         tdsState.removeAllColumns();
         tdsState.resultSetModifierState.reset();
+        QueryBuilderTelemetryHelper.logEvent_ProjectionChanged(
+          applicationStore.telemetryService,
+          {
+            ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+            change: {
+              action: 'clear',
+              columnCount: clearedColumnCount,
+            },
+          },
+        );
       });
     };
 
@@ -1338,6 +1409,17 @@ export const QueryBuilderTDSPanel = observer(
               `${DEFAULT_LAMBDA_VARIABLE_NAME}${LAMBDA_PIPE}${functionPrettyName} `,
             );
             tdsState.addColumn(derivationProjectionColumn);
+            QueryBuilderTelemetryHelper.logEvent_ProjectionChanged(
+              applicationStore.telemetryService,
+              {
+                ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+                change: {
+                  action: 'add',
+                  sourceType: 'function',
+                  columnCount: tdsState.projectionColumns.length,
+                },
+              },
+            );
             break;
           }
           case QUERY_BUILDER_EXPLORER_TREE_DND_TYPE.ENUM_PROPERTY:
@@ -1352,6 +1434,17 @@ export const QueryBuilderTDSPanel = observer(
                 tdsState.queryBuilderState.explorerState.humanizePropertyName,
               ),
             );
+            QueryBuilderTelemetryHelper.logEvent_ProjectionChanged(
+              applicationStore.telemetryService,
+              {
+                ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+                change: {
+                  action: 'add',
+                  sourceType: 'explorer-property',
+                  columnCount: tdsState.projectionColumns.length,
+                },
+              },
+            );
             break;
           case QUERY_BUILDER_EXPLORER_TREE_DND_TYPE.RELATION_COLUMN: {
             const dragNode = (
@@ -1366,6 +1459,17 @@ export const QueryBuilderTDSPanel = observer(
                 true,
               ),
             );
+            QueryBuilderTelemetryHelper.logEvent_ProjectionChanged(
+              applicationStore.telemetryService,
+              {
+                ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+                change: {
+                  action: 'add',
+                  sourceType: 'explorer-relation',
+                  columnCount: tdsState.projectionColumns.length,
+                },
+              },
+            );
             break;
           }
           case QUERY_BUILDER_FILTER_DND_TYPE.CONDITION:
@@ -1394,13 +1498,24 @@ export const QueryBuilderTDSPanel = observer(
                   tdsState.queryBuilderState.explorerState.humanizePropertyName,
                 ),
               );
+              QueryBuilderTelemetryHelper.logEvent_ProjectionChanged(
+                applicationStore.telemetryService,
+                {
+                  ...tdsState.queryBuilderState.safeGetTelemetryContext(),
+                  change: {
+                    action: 'add',
+                    sourceType: 'filter-condition',
+                    columnCount: tdsState.projectionColumns.length,
+                  },
+                },
+              );
             }
             break;
           default:
             break;
         }
       },
-      [tdsState],
+      [tdsState, applicationStore.telemetryService],
     );
 
     const [{ isDragOver }, panelDropConnector] = useDrop<

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

@@ -79,6 +79,7 @@ import { QUERY_BUILDER_PROJECTION_COLUMN_DND_TYPE } from '../../stores/fetch-str
 import type { QueryBuilderTDSColumnState } from '../../stores/fetch-structure/tds/QueryBuilderTDSColumnState.js';
 import type { QueryBuilderTDSState } from '../../stores/fetch-structure/tds/QueryBuilderTDSState.js';
 import { QUERY_BUILDER_TEST_ID } from '../../__lib__/QueryBuilderTesting.js';
+import { QueryBuilderTelemetryHelper } from '../../__lib__/QueryBuilderTelemetryHelper.js';
 import { QueryBuilderPanelIssueCountBadge } from '../shared/QueryBuilderPanelIssueCountBadge.js';
 import { COLUMN_SORT_TYPE } from '../../graph/QueryBuilderMetaModelConst.js';
 import { CAN_DROP_MAIN_GROUP_DND_TYPES } from './QueryBuilderPostFilterPanel.js';
@@ -138,10 +139,23 @@ const QueryBuilderWindowColumnContextMenu = observer(
     }
   >(function QueryBuilderWindowGroupByColumnContextMenu(props, ref) {
     const { columnState } = props;
+    const applicationStore = useApplicationStore();
     const editColumn = (): void =>
       columnState.windowState.setEditColumn(columnState);
-    const removeColumn = (): void =>
-      columnState.windowState.removeColumn(columnState);
+    const removeColumn = (): void => {
+      const windowState = columnState.windowState;
+      windowState.removeColumn(columnState);
+      QueryBuilderTelemetryHelper.logEvent_WindowChanged(
+        applicationStore.telemetryService,
+        {
+          ...windowState.tdsState.queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: 'remove',
+            columnCount: windowState.windowColumns.length,
+          },
+        },
+      );
+    };
 
     return (
       <MenuContent ref={ref}>
@@ -370,11 +384,22 @@ const QueryBuilderWindowColumnModalEditor = observer(
     };
 
     const handleApply = (): void => {
+      const isEdit = windowState.windowColumns.includes(windowColumnState);
       windowColumnState.setColumnName(selectedColumnName);
       windowColumnState.setOperatorState(selectedOperatorState);
       windowColumnState.setWindows(selectedWindowColumns);
       windowColumnState.setSortBy(selectedSortBy);
       windowState.addWindowColumn(windowColumnState);
+      QueryBuilderTelemetryHelper.logEvent_WindowChanged(
+        applicationStore.telemetryService,
+        {
+          ...windowState.tdsState.queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: isEdit ? 'edit' : 'add',
+            columnCount: windowState.windowColumns.length,
+          },
+        },
+      );
       handleCancel();
     };
 
@@ -781,6 +806,7 @@ const QueryBuilderWindowColumnEditor = observer(
     const { windowColumnState } = props;
     const windowState = windowColumnState.windowState;
     const tdsState = windowState.tdsState;
+    const applicationStore = useApplicationStore();
     const operators = windowState.operators;
     const supportedOperators = tdsState.queryBuilderState.useRelation
       ? operators.filter((op) => op.relationFunc !== undefined)
@@ -852,6 +878,16 @@ const QueryBuilderWindowColumnEditor = observer(
       windowState.tdsState.isColumnInUse(windowColumnState);
     const removeColumn = (): void => {
       windowColumnState.windowState.removeColumn(windowColumnState);
+      QueryBuilderTelemetryHelper.logEvent_WindowChanged(
+        applicationStore.telemetryService,
+        {
+          ...windowColumnState.windowState.tdsState.queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: 'remove',
+            columnCount: windowColumnState.windowState.windowColumns.length,
+          },
+        },
+      );
     };
     const editoColumn = (): void => {
       windowState.setEditColumn(windowColumnState);
@@ -914,8 +950,7 @@ const QueryBuilderWindowColumnEditor = observer(
              * @workaround typings - https://github.com/react-dnd/react-dnd/pull/3484
              */
             olapColumnBeingDragged:
-              // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-              (monitor.getItem() as QueryBuilderWindowColumnDragSource | null)
+              monitor.getItem<QueryBuilderWindowColumnDragSource | null>()
                 ?.columnState,
           }),
         }),
@@ -1264,6 +1299,16 @@ export const QueryBuilderTDSWindowPanel = observer(
             tdsWindowState.tdsState,
           );
           tdsWindowState.addWindowColumn(newWindowState);
+          QueryBuilderTelemetryHelper.logEvent_WindowChanged(
+            applicationStore.telemetryService,
+            {
+              ...tdsWindowState.tdsState.queryBuilderState.safeGetTelemetryContext(),
+              change: {
+                action: 'add',
+                columnCount: tdsWindowState.windowColumns.length,
+              },
+            },
+          );
         } catch (error) {
           assertErrorThrown(error);
           applicationStore.notificationService.notifyError(error.message);

package/src/components/filter/QueryBuilderFilterPanel.tsx

@@ -639,19 +639,34 @@ const buildFilterTree = (
 
 const QueryBuilderFilterGroupConditionEditor = observer(
   (props: {
+    queryBuilderState: QueryBuilderState;
     node: QueryBuilderFilterTreeGroupNodeData;
     isDragOver: boolean;
     isDroppable: boolean;
   }) => {
-    const { node, isDragOver, isDroppable } = props;
+    const { queryBuilderState, 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_FilterChanged(
+        applicationStore.telemetryService,
+        {
+          ...queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: 'group-operation-change',
+            groupOperation:
+              nextOperation === QUERY_BUILDER_GROUP_OPERATION.AND
+                ? 'and'
+                : 'or',
+          },
+        },
       );
     };
 
@@ -1281,7 +1296,18 @@ const QueryBuilderFilterConditionContextMenu = observer(
   >(function QueryBuilderFilterConditionContextMenu(props, ref) {
     const { queryBuilderState, node } = props;
     const filterState = queryBuilderState.filterState;
-    const removeNode = (): void => filterState.removeNodeAndPruneBranch(node);
+    const removeNode = (): void => {
+      filterState.removeNodeAndPruneBranch(node);
+      QueryBuilderTelemetryHelper.logEvent_FilterChanged(
+        queryBuilderState.applicationStore.telemetryService,
+        {
+          ...queryBuilderState.safeGetTelemetryContext(),
+          change: {
+            action: 'remove',
+          },
+        },
+      );
+    };
     const createCondition = (): void => {
       filterState.addNodeFromNode(
         new QueryBuilderFilterTreeBlankConditionNodeData(undefined),
@@ -1591,6 +1617,7 @@ const QueryBuilderFilterTreeNodeContainer = observer(
           >
             {node instanceof QueryBuilderFilterTreeGroupNodeData && (
               <QueryBuilderFilterGroupConditionEditor
+                queryBuilderState={queryBuilderState}
                 node={node}
                 isDroppable={isDroppable}
                 isDragOver={isDragOver}