@finos/legend-data-cube 0.1.16 → 0.1.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finos/legend-data-cube",
-  "version": "0.1.16",
+  "version": "0.1.18",
   "description": "Legend DataCube",
   "keywords": [
     "legend",
@@ -42,9 +42,9 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@finos/legend-art": "7.1.88",
-    "@finos/legend-code-editor": "2.0.54",
-    "@finos/legend-graph": "32.1.12",
+    "@finos/legend-art": "7.1.89",
+    "@finos/legend-code-editor": "2.0.55",
+    "@finos/legend-graph": "32.1.13",
     "@finos/legend-shared": "11.0.9",
     "@types/react": "19.0.10",
     "ag-grid-community": "33.1.1",

package/src/__lib__/DataCubeEvent.ts

@@ -18,4 +18,19 @@ export enum DataCubeEvent {
   SETTINGS__FAILURE__FOUND_UNREGISTERED_SETTING = 'data-cube.settings.failure.found-unregistered-setting',
   SETTINGS__FAILURE__ASSIGN_INCOMPATIBLE_VALUE = 'data-cube.settings.failure.assign-incompatible-value',
   SETTINGS__FAILURE__RETRIEVE_INCOMPATIBLE_VALUE = 'data-cube.settings.failure.retrieve-incompatible-value',
+  EMAIL_DATACUBE = 'data-cube.email-data-cube',
+  EXPORT_DATACUBE = 'data-cube.export-data-cube',
+  CACHING_ENABLE__SUCCESS = 'data-cube.enable-caching.success',
+  CACHING_DISABLE__SUCCESS = 'data-cube.disable-caching.success',
+  SELECT_ACTION_CACHE_LOAD_ALERT = 'data-cube.select-action-caching-load-alert',
+  PAGINATION_ENABLE__SUCCESS = 'data-cube.enable-pagination.success',
+  PAGINATION_DISABLE__SUCCESS = 'data-cube.disable-pagination.success',
+  SELECT_ACTION_PAGINATION_ALERT = 'data-cube.select-action-pagination-alert',
+  APPLY_CHANGES_PROPERTIES = 'data-cube.apply-changes-properties',
+  APPLY_CHANGES_FILTER = 'data-cube.apply-changes-filter',
+  SELECT_ITEM_TITLE_BAR = 'data-cube.select-item-title-bar',
+  SELECT_ITEM_GRIDMENU = 'data-cube.select-item-gridMenu',
+  OPEN_EDITOR_FILTER = 'data-cube.open-editor-filter',
+  OPEN_EDITOR_PROPERTIES = 'data-cube.open-editor-properties',
+  ADD_NEW_COLUMN = 'data-cube.add-new-column',
 }

package/src/components/DataCube.tsx

@@ -25,16 +25,30 @@ import { type DataCubeOptions } from '../stores/DataCubeOptions.js';
 import { DataCubeContextProvider, useDataCube } from './DataCubeProvider.js';
 import type { DataCubeSpecification } from '../stores/core/model/DataCubeSpecification.js';
 import { DataCubeTitleBar } from './DataCubeTitleBar.js';
-import { DEFAULT_REPORT_NAME } from '../stores/core/DataCubeQueryEngine.js';
+import {
+  DataCubeTitleBarMenuItems,
+  DEFAULT_REPORT_NAME,
+} from '../stores/core/DataCubeQueryEngine.js';
 import {
   DataCubePlaceholderErrorDisplay,
   DataCubePlaceholder,
 } from './DataCubePlaceholder.js';
+import { DataCubeEvent } from '../__lib__/DataCubeEvent.js';
 
 const DataCubeRoot = observer(() => {
   const dataCube = useDataCube();
   const view = dataCube.view;
 
+  const logMenuItem = (menuName: string) => {
+    view.dataCube.telemetryService.sendTelemetry(
+      DataCubeEvent.SELECT_ITEM_TITLE_BAR,
+      {
+        ...view.engine.getDataFromSource(view.getInitialSource()),
+        menuName: menuName,
+      },
+    );
+  };
+
   useEffect(() => {
     dataCube.view
       .initialize(dataCube.specification)
@@ -47,18 +61,27 @@ const DataCubeRoot = observer(() => {
         title={view.info.name}
         menuItems={[
           {
-            label: 'Undo',
-            action: () => dataCube.view.snapshotService.undo(),
+            label: DataCubeTitleBarMenuItems.UNDO,
+            action: () => {
+              dataCube.view.snapshotService.undo();
+              logMenuItem(DataCubeTitleBarMenuItems.UNDO);
+            },
             disabled: !dataCube.view.snapshotService.canUndo,
           },
           {
-            label: 'Redo',
-            action: () => dataCube.view.snapshotService.redo(),
+            label: DataCubeTitleBarMenuItems.REDO,
+            action: () => {
+              dataCube.view.snapshotService.redo();
+              logMenuItem(DataCubeTitleBarMenuItems.REDO);
+            },
             disabled: !dataCube.view.snapshotService.canRedo,
           },
           {
-            label: 'Settings...',
-            action: () => dataCube.settingService.display.open(),
+            label: DataCubeTitleBarMenuItems.SETTINGS,
+            action: () => {
+              dataCube.settingService.display.open();
+              logMenuItem(DataCubeTitleBarMenuItems.SETTINGS);
+            },
           },
         ]}
         getMenuItems={dataCube.options?.getHeaderMenuItems}

package/src/components/DataCubeStatusBar.tsx

@@ -19,6 +19,8 @@ import { observer } from 'mobx-react-lite';
 import type { DataCubeViewState } from '../stores/view/DataCubeViewState.js';
 import type { TaskManager } from '../stores/services/DataCubeTaskService.js';
 import { at } from '@finos/legend-shared';
+import { DataCubeEvent } from '../__lib__/DataCubeEvent.js';
+import { DataCubeOpenEditorSource } from '../stores/core/DataCubeQueryEngine.js';
 
 export const DataCubeStatusBar = observer(
   (props: {
@@ -28,12 +30,35 @@ export const DataCubeStatusBar = observer(
     const { view, taskManager } = props;
     const tasks = view?.taskService.tasks ?? taskManager?.tasks;
 
+    const logOpeningPropertiesEditor = () => {
+      view?.dataCube.telemetryService.sendTelemetry(
+        DataCubeEvent.OPEN_EDITOR_PROPERTIES,
+        {
+          ...view.engine.getDataFromSource(view.getInitialSource()),
+          openedFrom: DataCubeOpenEditorSource.STATUS_BAR,
+        },
+      );
+    };
+
+    const logOpeningFilterEditor = () => {
+      view?.dataCube.telemetryService.sendTelemetry(
+        DataCubeEvent.OPEN_EDITOR_FILTER,
+        {
+          ...view.engine.getDataFromSource(view.getInitialSource()),
+          openedFrom: DataCubeOpenEditorSource.STATUS_BAR,
+        },
+      );
+    };
+
     return (
       <div className="flex h-5 w-full justify-between bg-neutral-100">
         <div className="flex">
           <button
             className="flex items-center px-2 text-sky-600 hover:text-sky-700 disabled:text-neutral-400"
-            onClick={() => view?.editor.display.open()}
+            onClick={() => {
+              view?.editor.display.open();
+              logOpeningPropertiesEditor();
+            }}
             disabled={!view}
           >
             <DataCubeIcon.Settings className="text-xl" />
@@ -44,6 +69,7 @@ export const DataCubeStatusBar = observer(
               className="flex items-center text-sky-600 hover:text-sky-700 disabled:text-neutral-400"
               onClick={() => {
                 view?.filter.display.open();
+                logOpeningFilterEditor();
               }}
               disabled={!view}
             >

package/src/components/view/editor/DataCubeEditor.tsx

@@ -27,6 +27,7 @@ import type { DataCubeViewState } from '../../../stores/view/DataCubeViewState.j
 import { FormButton } from '../../core/DataCubeFormUtils.js';
 import { useDataCube } from '../../DataCubeProvider.js';
 import { DataCubeEditorDimensionsPanel } from './DataCubeEditorDimensionsPanel.js';
+import { DataCubeEvent } from '../../../__lib__/DataCubeEvent.js';
 
 export const DataCubeEditor = observer((props: { view: DataCubeViewState }) => {
   const dataCube = useDataCube();
@@ -45,6 +46,13 @@ export const DataCubeEditor = observer((props: { view: DataCubeViewState }) => {
     DataCubeEditorTab.COLUMN_PROPERTIES,
   ];
 
+  const logApplyChangesFromPropertiesEditor = (): void => {
+    view.dataCube.telemetryService.sendTelemetry(
+      DataCubeEvent.APPLY_CHANGES_PROPERTIES,
+      view.engine.getDataFromSource(view.getInitialSource()),
+    );
+  };
+
   return (
     <>
       <div className="relative h-[calc(100%_-_40px)] w-full px-2 pt-8">
@@ -94,6 +102,7 @@ export const DataCubeEditor = observer((props: { view: DataCubeViewState }) => {
           className="ml-2"
           disabled={editor.finalizationState.isInProgress}
           onClick={() => {
+            logApplyChangesFromPropertiesEditor();
             editor
               .applyChanges()
               .catch((error) => alertService.alertUnhandledError(error));
@@ -105,6 +114,7 @@ export const DataCubeEditor = observer((props: { view: DataCubeViewState }) => {
           className="ml-2"
           disabled={editor.finalizationState.isInProgress}
           onClick={() => {
+            logApplyChangesFromPropertiesEditor();
             editor
               .applyChanges({ closeAfterApply: true })
               .catch((error) => alertService.alertUnhandledError(error));

package/src/components/view/extend/DataCubeColumnEditor.tsx

@@ -37,6 +37,7 @@ import { useDataCube } from '../../DataCubeProvider.js';
 import { useMemo, useRef } from 'react';
 import { debounce } from '@finos/legend-shared';
 import { DataCubeCodeEditor } from './DataCubeCodeEditor.js';
+import { DataCubeEvent } from '../../../__lib__/DataCubeEvent.js';
 
 enum DataCubeExtendedColumnKind {
   LEAF_LEVEL_MEASURE = 'Leaf Level Measure',
@@ -70,6 +71,13 @@ export const DataCubeColumnCreator = observer(
       typeDropPropsOpen,
     ] = useDropdownMenu();
 
+    const logAddingNewColumn = (): void => {
+      view.dataCube.telemetryService.sendTelemetry(
+        DataCubeEvent.ADD_NEW_COLUMN,
+        view.engine.getDataFromSource(view.getInitialSource()),
+      );
+    };
+
     const debouncedCheckReturnType = useMemo(
       () =>
         debounce((): void => {
@@ -262,6 +270,7 @@ export const DataCubeColumnCreator = observer(
                 .catch((error) =>
                   dataCube.alertService.alertUnhandledError(error),
                 );
+              logAddingNewColumn();
             }}
           >
             OK

package/src/components/view/filter/DataCubeFilterEditor.tsx

@@ -49,6 +49,7 @@ import { formatDate, guaranteeIsNumber, parseISO } from '@finos/legend-shared';
 import { evaluate } from 'mathjs';
 import { useDataCube } from '../../DataCubeProvider.js';
 import { _findCol } from '../../../stores/core/model/DataCubeColumn.js';
+import { DataCubeEvent } from '../../../__lib__/DataCubeEvent.js';
 
 const FILTER_TREE_OFFSET = 10;
 const FILTER_TREE_INDENTATION_SPACE = 36;
@@ -818,6 +819,13 @@ export const DataCubeFilterEditor = observer(
     const { view } = props;
     const editor = view.filter;
 
+    const logApplyChangesFromFilterEditor = (): void => {
+      view.dataCube.telemetryService.sendTelemetry(
+        DataCubeEvent.APPLY_CHANGES_FILTER,
+        view.engine.getDataFromSource(view.getInitialSource()),
+      );
+    };
+
     useEffect(() => {
       editor.setSelectedNode(undefined);
     }, [editor]);
@@ -872,7 +880,13 @@ export const DataCubeFilterEditor = observer(
         </div>
         <div className="flex h-10 items-center justify-end px-2">
           <FormButton onClick={() => editor.display.close()}>Cancel</FormButton>
-          <FormButton className="ml-2" onClick={() => editor.applyChanges()}>
+          <FormButton
+            className="ml-2"
+            onClick={() => {
+              editor.applyChanges();
+              logApplyChangesFromFilterEditor();
+            }}
+          >
             Apply
           </FormButton>
           <FormButton
@@ -880,6 +894,7 @@ export const DataCubeFilterEditor = observer(
             onClick={() => {
               editor.applyChanges();
               editor.display.close();
+              logApplyChangesFromFilterEditor();
             }}
           >
             OK

package/src/index.tsx

@@ -16,7 +16,7 @@
 
 export { LEGEND_DATACUBE_TEST_ID } from './__lib__/DataCubeTesting.js';
 
-export * from './__lib__/DataCubeTelemetryHelper.js';
+export * from './__lib__/DataCubeEvent.js';
 export * from './stores/core/model/DataCubeSpecification.js';
 export * from './stores/core/model/DataCubeSource.js';
 export { type DataCubeColumn } from './stores/core/model/DataCubeColumn.js';

package/src/stores/core/DataCubeEngine.tsx

@@ -83,6 +83,8 @@ import {
   type DocumentationEntry,
   type LogEvent,
   type PlainObject,
+  type TimingsRecord,
+  type StopWatch,
 } from '@finos/legend-shared';
 import type { CachedDataCubeSource } from './model/CachedDataCubeSource.js';
 import { DataCubeSpecification } from './model/DataCubeSpecification.js';
@@ -242,6 +244,13 @@ export abstract class DataCubeEngine {
 
   abstract processSource(sourceData: PlainObject): Promise<DataCubeSource>;
 
+  abstract getDataFromSource(source?: DataCubeSource): PlainObject;
+
+  abstract finalizeTimingRecord(
+    stopWatch: StopWatch,
+    timings?: TimingsRecord,
+  ): TimingsRecord | undefined;
+
   abstract parseValueSpecification(
     code: string,
     returnSourceInformation?: boolean | undefined,

package/src/stores/core/DataCubeQueryEngine.ts

@@ -273,6 +273,23 @@ export enum DataCubeGridMode {
   MULTIDIMENSIONAL = 'Multidimensional',
 }
 
+export enum DataCubeTitleBarMenuItems {
+  VIEW_SOURCE = 'View Source',
+  RESET_TO_LATEST_SAVE = 'Reset to Latest Save',
+  UPDATE_INFO = 'Update Info...',
+  DELETE_DATACUBE = 'Delete DataCube...',
+  SEE_DOCUMENTATION = 'See Documentation',
+  ABOUT = 'About',
+  UNDO = 'Undo',
+  REDO = 'Redo',
+  SETTINGS = 'Settings...',
+}
+
+export enum DataCubeOpenEditorSource {
+  STATUS_BAR = 'Status Bar',
+  GRID_MENU = 'Grid Menu',
+}
+
 export const PIVOT_COLUMN_NAME_VALUE_SEPARATOR = '__|__';
 
 export const TREE_COLUMN_VALUE_SEPARATOR = '__/__';

package/src/stores/core/model/DataCubeConfiguration.ts

@@ -51,6 +51,7 @@ import {
 } from '@finos/legend-shared';
 import { createModelSchema, list, optional, primitive, raw } from 'serializr';
 import { _findCol } from './DataCubeColumn.js';
+import { PRECISE_PRIMITIVE_TYPE, PRIMITIVE_TYPE } from '@finos/legend-graph';
 
 export type DataCubeConfigurationColorKey =
   | 'normal'
@@ -122,7 +123,37 @@ export class DataCubeColumnConfiguration {
 
   constructor(name: string, type: string) {
     this.name = name;
-    this.type = type;
+    this.type = this._convertPreciseToPrimitiveType(type);
+  }
+
+  _convertPreciseToPrimitiveType(type: string) {
+    switch (type) {
+      case PRECISE_PRIMITIVE_TYPE.STRING:
+        return PRIMITIVE_TYPE.STRING;
+      case PRECISE_PRIMITIVE_TYPE.SMALL_INT:
+      case PRECISE_PRIMITIVE_TYPE.TINY_INT:
+      case PRECISE_PRIMITIVE_TYPE.U_SMALL_INT:
+      case PRECISE_PRIMITIVE_TYPE.U_TINY_INT:
+      case PRECISE_PRIMITIVE_TYPE.INT:
+      case PRECISE_PRIMITIVE_TYPE.U_INT:
+        return PRIMITIVE_TYPE.INTEGER;
+      case PRECISE_PRIMITIVE_TYPE.DOUBLE:
+      case PRECISE_PRIMITIVE_TYPE.BIG_INT:
+      case PRECISE_PRIMITIVE_TYPE.U_BIG_INT:
+        return PRIMITIVE_TYPE.NUMBER;
+      case PRECISE_PRIMITIVE_TYPE.FLOAT:
+        return PRIMITIVE_TYPE.FLOAT;
+      case PRECISE_PRIMITIVE_TYPE.DECIMAL:
+        return PRIMITIVE_TYPE.DECIMAL;
+      case PRECISE_PRIMITIVE_TYPE.STRICTDATE:
+        return PRIMITIVE_TYPE.STRICTDATE;
+      case PRECISE_PRIMITIVE_TYPE.DATETIME:
+        return PRIMITIVE_TYPE.DATETIME;
+      case PRECISE_PRIMITIVE_TYPE.STRICTTIME:
+        return PRIMITIVE_TYPE.STRICTTIME;
+      default:
+        return type;
+    }
   }
 
   static readonly serialization = new SerializationFactory(

package/src/stores/view/DataCubeViewState.ts

@@ -46,6 +46,7 @@ import type { DataCubeSettingService } from '../services/DataCubeSettingService.
 import { CachedDataCubeSource } from '../core/model/CachedDataCubeSource.js';
 import { DataCubeSettingKey } from '../../__lib__/DataCubeSetting.js';
 import { PureClientVersion } from '@finos/legend-graph';
+import { DataCubeEvent } from '../../__lib__/DataCubeEvent.js';
 
 export class DataCubeViewState {
   readonly dataCube: DataCubeState;
@@ -253,6 +254,16 @@ export class DataCubeViewState {
         this.engine,
       );
 
+      const logAlertAction = (cachingEnabled: boolean) => {
+        this.dataCube.telemetryService.sendTelemetry(
+          DataCubeEvent.SELECT_ACTION_CACHE_LOAD_ALERT,
+          {
+            ...this.engine.getDataFromSource(this._initialSource),
+            keepCachingEnabled: cachingEnabled,
+          },
+        );
+      };
+
       // auto-enable cache if specified before broadcasting the first snapshot
       // so first data-fetches will be against cache
       if (specification.options?.autoEnableCache) {
@@ -273,11 +284,14 @@ export class DataCubeViewState {
             actions: [
               {
                 label: 'OK',
-                handler: () => {},
+                handler: () => {
+                  logAlertAction(true);
+                },
               },
               {
                 label: 'Disable Caching',
                 handler: () => {
+                  logAlertAction(false);
                   this.grid
                     .setCachingEnabled(false, {
                       suppressWarning: true,
@@ -290,6 +304,7 @@ export class DataCubeViewState {
               {
                 label: 'Dismiss Warning',
                 handler: () => {
+                  logAlertAction(true);
                   this.settingService.updateValue(
                     this.dataCube.api,
                     DataCubeSettingKey.GRID_CLIENT__SHOW_AUTO_ENABLE_CACHE_PERFORMANCE_WARNING,

package/src/stores/view/grid/DataCubeGridClientEngine.ts

@@ -56,6 +56,7 @@ import {
 } from '../../core/DataCubeEngine.js';
 import { _lambda } from '../../core/DataCubeQueryBuilderUtils.js';
 import { sum } from 'mathjs';
+import { DataCubeEvent } from '../../../__lib__/DataCubeEvent.js';
 
 type DataCubeGridClientCellValue = string | number | boolean | null | undefined;
 type DataCubeGridClientRowData = {
@@ -418,6 +419,16 @@ export class DataCubeGridClientServerSideDataSource
     let result: DataCubeExecutionResult;
     let rowData: DataCubeGridClientRowData[];
 
+    const logAlertAction = (paginationDisabled: boolean) => {
+      this._view.dataCube.telemetryService.sendTelemetry(
+        DataCubeEvent.SELECT_ACTION_PAGINATION_ALERT,
+        {
+          ...this._view.engine.getDataFromSource(this._view.getInitialSource()),
+          keepPaginationDisabled: paginationDisabled,
+        },
+      );
+    };
+
     try {
       result = await this._view.engine.executeQuery(
         _lambda([], [executableQuery]),
@@ -514,6 +525,7 @@ export class DataCubeGridClientServerSideDataSource
                 label: 'Enable Pagination',
                 handler: () => {
                   this._grid.setPaginationEnabled(true);
+                  logAlertAction(false);
                 },
               },
               {
@@ -524,6 +536,7 @@ export class DataCubeGridClientServerSideDataSource
                     DataCubeSettingKey.GRID_CLIENT__SUPPRESS_LARGE_DATASET_WARNING,
                     true,
                   );
+                  logAlertAction(true);
                 },
               },
             ],