@finos/legend-data-cube 0.0.10 → 0.0.12

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

@@ -28,7 +28,7 @@ import type { DataCubeViewState } from '../../../stores/view/DataCubeViewState.j
 export const DataCubeEditor = observer((props: { view: DataCubeViewState }) => {
   const { view } = props;
   const editor = view.editor;
-  const application = view.application;
+  const engine = view.engine;
   const selectedTab = editor.currentTab;
   const tabs = [
     DataCubeEditorTab.COLUMNS,
@@ -86,7 +86,7 @@ export const DataCubeEditor = observer((props: { view: DataCubeViewState }) => {
           onClick={() => {
             editor
               .applyChanges({ closeAfterApply: true })
-              .catch((error) => application.alertUnhandledError(error));
+              .catch((error) => engine.alertUnhandledError(error));
           }}
         >
           OK
@@ -103,7 +103,7 @@ export const DataCubeEditor = observer((props: { view: DataCubeViewState }) => {
           onClick={() => {
             editor
               .applyChanges()
-              .catch((error) => application.alertUnhandledError(error));
+              .catch((error) => engine.alertUnhandledError(error));
           }}
         >
           Apply

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

@@ -45,7 +45,7 @@ import {
 } from '../../../stores/core/DataCubeQueryEngine.js';
 import { DocumentationKey } from '../../../__lib__/DataCubeDocumentation.js';
 import type { DataCubeViewState } from '../../../stores/view/DataCubeViewState.js';
-import { _sortByColName } from '../../../stores/core/DataCubeQuerySnapshot.js';
+import { _sortByColName } from '../../../stores/core/models/DataCubeColumn.js';
 
 export const DataCubeEditorColumnPropertiesPanel = observer(
   (props: { view: DataCubeViewState }) => {

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

@@ -98,9 +98,9 @@ export const DataCubeEditorGeneralPropertiesPanel = observer(
               </div>
               <FormTextInput
                 className="h-6 w-96 text-lg font-semibold"
-                value={panel.name}
+                value={configuration.name}
                 onChange={(event) => {
-                  panel.setName(event.target.value);
+                  configuration.setName(event.target.value);
                 }}
               />
             </div>

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

@@ -60,7 +60,7 @@ export const DataCubeColumnCreator = observer(
   (props: { state: DataCubeColumnBaseEditorState }) => {
     const { state } = props;
     const view = state.view;
-    const application = view.application;
+    const engine = view.engine;
 
     const nameInputRef = useRef<HTMLInputElement>(null);
     const currentColumnKind = state.isGroupLevel
@@ -91,9 +91,9 @@ export const DataCubeColumnCreator = observer(
         debounce((): void => {
           state
             .getReturnType()
-            .catch((error) => application.alertUnhandledError(error));
+            .catch((error) => engine.alertUnhandledError(error));
         }, 500),
-      [state, application],
+      [state, engine],
     );
 
     useEffect(() => {
@@ -136,7 +136,7 @@ export const DataCubeColumnCreator = observer(
                       position,
                       model,
                       state.codePrefix,
-                      view.engine,
+                      view,
                       () => state.buildExtendBaseQuery(),
                     ),
                   );
@@ -351,7 +351,7 @@ export const DataCubeColumnCreator = observer(
             onClick={() => {
               state
                 .applyChanges()
-                .catch((error) => application.alertUnhandledError(error));
+                .catch((error) => engine.alertUnhandledError(error));
             }}
           >
             OK
@@ -363,7 +363,7 @@ export const DataCubeColumnCreator = observer(
                 onClick={() => {
                   state.manager
                     .deleteColumn(state.initialData.name)
-                    .catch((error) => application.alertUnhandledError(error));
+                    .catch((error) => engine.alertUnhandledError(error));
                 }}
               >
                 Delete
@@ -373,7 +373,7 @@ export const DataCubeColumnCreator = observer(
                 onClick={() => {
                   state
                     .reset()
-                    .catch((error) => application.alertUnhandledError(error));
+                    .catch((error) => engine.alertUnhandledError(error));
                 }}
               >
                 Reset

package/src/components/view/grid/DataCubeGrid.tsx

@@ -49,7 +49,7 @@ import { isNonNullable } from '@finos/legend-shared';
 import type {
   DataCubeConfiguration,
   DataCubeConfigurationColorKey,
-} from '../../../stores/core/DataCubeConfiguration.js';
+} from '../../../stores/core/models/DataCubeConfiguration.js';
 import { generateBaseGridOptions } from '../../../stores/view/grid/DataCubeGridConfigurationBuilder.js';
 import type { DataCubeViewState } from '../../../stores/view/DataCubeViewState.js';
 
@@ -58,10 +58,13 @@ import type { DataCubeViewState } from '../../../stores/view/DataCubeViewState.j
 // We MUST NEVER completely surpress this warning in production, else it's a violation of the ag-grid license!
 // See https://www.ag-grid.com/react-data-grid/licensing/
 const __INTERNAL__original_console_error = console.error; // eslint-disable-line no-console
-// eslint-disable-next-line no-console
-console.error = (message?: unknown, ...agrs: unknown[]) => {
-  console.debug(`%c ${message}`, 'color: silver'); // eslint-disable-line no-console
-};
+// eslint-disable-next-line no-process-env
+if (process.env.NODE_ENV === 'development') {
+  // eslint-disable-next-line no-console
+  console.error = (message?: unknown, ...agrs: unknown[]) => {
+    console.debug(`%c ${message}`, 'color: silver'); // eslint-disable-line no-console
+  };
+}
 
 function textColorStyle(
   key: DataCubeConfigurationColorKey,
@@ -348,8 +351,11 @@ const DataCubeGridClient = observer((props: { view: DataCubeViewState }) => {
         }}
         onGridReady={(params) => {
           grid.configureClient(params.api);
-          // restore original error logging
-          console.error = __INTERNAL__original_console_error; // eslint-disable-line no-console
+          // eslint-disable-next-line no-process-env
+          if (process.env.NODE_ENV === 'development') {
+            // restore original error logging
+            console.error = __INTERNAL__original_console_error; // eslint-disable-line no-console
+          }
         }}
         modules={[
           // community

package/src/index.tsx

@@ -14,11 +14,15 @@
  * limitations under the License.
  */
 
+export * from './stores/core/models/DataCubeQuery.js';
+export * from './stores/core/models/DataCubeSource.js';
+
 export * from './stores/core/DataCubeEngine.js';
-export * from './stores/core/DataCubeApplicationEngine.js';
-export * from './stores/core/DataCubeQuery.js';
+export * from './stores/core/DataCubeQueryEngine.js';
 export * from './stores/core/DataCubeQueryBuilderUtils.js';
-
 export * from './components/core/DataCubeAlert.js';
+
 export * from './components/DataCube.js';
-export * from './components/DataCubeProvider.js';
+export * from './stores/DataCubeAPI.js';
+export * from './stores/DataCubeOptions.js';
+export { DataCubeSettingKey } from './stores/DataCubeSettings.js';

package/src/stores/DataCubeAPI.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { DataCubeSettings } from './DataCubeSettings.js';
+
+export interface DataCubeAPI {
+  getSettings(): DataCubeSettings;
+  refreshFailedDataFetches(): void;
+}

package/src/stores/DataCubeOptions.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { DataCubeInitialInput } from './core/DataCubeEngine.js';
+import type { DataCubeSource } from './core/models/DataCubeSource.js';
+
+export type DataCubeOptions = {
+  enableDebugMode?: boolean | undefined;
+  gridClientRowBuffer?: number | undefined;
+  gridClientPurgeClosedRowNodes?: boolean | undefined;
+  gridClientSuppressLargeDatasetWarning?: boolean | undefined;
+  initialInput?: DataCubeInitialInput | undefined;
+
+  onNameChanged?: ((name: string, source: DataCubeSource) => void) | undefined;
+  onSettingChanged?:
+    | ((
+        key: string,
+        value: string | number | boolean | object | undefined,
+      ) => void)
+    | undefined;
+};

package/src/stores/DataCubeSettings.ts

@@ -0,0 +1,107 @@
+/**
+ * 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 { makeObservable, observable, action } from 'mobx';
+import type { DataCubeState } from './DataCubeState.js';
+
+export enum DataCubeSettingKey {
+  ENABLE_DEBUG_MODE = 'engine.enableDebugMode',
+  GRID_CLIENT_ROW_BUFFER = 'engine.grid-client.rowBuffer',
+  GRID_CLIENT_PURGE_CLOSED_ROW_NODES = 'engine.grid-client.purgeClosedRowNodes',
+  GRID_CLIENT_SUPPRESS_LARGE_DATASET_WARNING = 'engine.grid-client.suppressLargeDatasetWarning',
+}
+
+export const DEFAULT_SETTINGS = {
+  [DataCubeSettingKey.ENABLE_DEBUG_MODE]: false,
+  [DataCubeSettingKey.GRID_CLIENT_ROW_BUFFER]: 50,
+  [DataCubeSettingKey.GRID_CLIENT_PURGE_CLOSED_ROW_NODES]: false,
+  [DataCubeSettingKey.GRID_CLIENT_SUPPRESS_LARGE_DATASET_WARNING]: false,
+};
+
+export class DataCubeSettings {
+  readonly dataCube: DataCubeState;
+
+  constructor(dataCube: DataCubeState) {
+    makeObservable(this, {
+      enableDebugMode: observable,
+      setEnableDebugMode: action,
+
+      gridClientRowBuffer: observable,
+      setGridClientRowBuffer: action,
+
+      gridClientPurgeClosedRowNodes: observable,
+      setGridClientPurgeClosedRowNodes: action,
+
+      gridClientSuppressLargeDatasetWarning: observable,
+      setGridClientSuppressLargeDatasetWarning: action,
+    });
+
+    this.dataCube = dataCube;
+  }
+
+  enableDebugMode = DEFAULT_SETTINGS[DataCubeSettingKey.ENABLE_DEBUG_MODE];
+  gridClientRowBuffer =
+    DEFAULT_SETTINGS[DataCubeSettingKey.GRID_CLIENT_ROW_BUFFER];
+  gridClientPurgeClosedRowNodes =
+    DEFAULT_SETTINGS[DataCubeSettingKey.GRID_CLIENT_PURGE_CLOSED_ROW_NODES];
+  gridClientSuppressLargeDatasetWarning =
+    DEFAULT_SETTINGS[
+      DataCubeSettingKey.GRID_CLIENT_SUPPRESS_LARGE_DATASET_WARNING
+    ];
+
+  setEnableDebugMode(value: boolean) {
+    this.enableDebugMode = value;
+    this.dataCube.onSettingChanged?.(
+      DataCubeSettingKey.ENABLE_DEBUG_MODE,
+      value,
+    );
+  }
+
+  setGridClientRowBuffer(value: number) {
+    this.gridClientRowBuffer = value;
+    this.dataCube.onSettingChanged?.(
+      DataCubeSettingKey.GRID_CLIENT_ROW_BUFFER,
+      value,
+    );
+    this.propagateGridOptionUpdates();
+  }
+
+  setGridClientPurgeClosedRowNodes(value: boolean) {
+    this.gridClientPurgeClosedRowNodes = value;
+    this.dataCube.onSettingChanged?.(
+      DataCubeSettingKey.GRID_CLIENT_PURGE_CLOSED_ROW_NODES,
+      value,
+    );
+    this.propagateGridOptionUpdates();
+  }
+
+  setGridClientSuppressLargeDatasetWarning(value: boolean) {
+    this.gridClientSuppressLargeDatasetWarning = value;
+    this.dataCube.onSettingChanged?.(
+      DataCubeSettingKey.GRID_CLIENT_SUPPRESS_LARGE_DATASET_WARNING,
+      value,
+    );
+  }
+
+  private propagateGridOptionUpdates() {
+    this.dataCube.runTaskForEachView((view) => {
+      view.grid.client.updateGridOptions({
+        rowBuffer: this.gridClientRowBuffer,
+        purgeClosedRowNodes: this.gridClientPurgeClosedRowNodes,
+      });
+    });
+  }
+}

package/src/stores/DataCubeState.tsx

@@ -14,39 +14,65 @@
  * limitations under the License.
  */
 
-import { type DataCubeEngine } from './core/DataCubeEngine.js';
+import {
+  type DataCubeEngine,
+  type DataCubeInitialInput,
+} from './core/DataCubeEngine.js';
 import { DataCubeViewState } from './view/DataCubeViewState.js';
 import type { DisplayState } from './core/DataCubeLayoutManagerState.js';
 import { DocumentationPanel } from '../components/core/DataCubeDocumentationPanel.js';
 import { DataCubeSettingsPanel } from '../components/core/DataCubeSettingsPanel.js';
-import { ActionState, assertErrorThrown } from '@finos/legend-shared';
-import { AlertType } from '../components/core/DataCubeAlert.js';
-import { type DataCubeApplicationEngine } from './core/DataCubeApplicationEngine.js';
+import {
+  ActionState,
+  assertErrorThrown,
+  type DocumentationEntry,
+} from '@finos/legend-shared';
+import {
+  AlertType,
+  type ActionAlert,
+} from '../components/core/DataCubeAlert.js';
+import type { DataCubeSource } from './core/models/DataCubeSource.js';
+import { action, makeObservable, observable } from 'mobx';
+import { DataCubeSettings } from './DataCubeSettings.js';
+import type { DataCubeAPI } from './DataCubeAPI.js';
+import type { DataCubeOptions } from './DataCubeOptions.js';
 
-export class DataCubeState {
-  readonly application: DataCubeApplicationEngine;
+export class DataCubeState implements DataCubeAPI {
   readonly engine: DataCubeEngine;
-
+  readonly settings!: DataCubeSettings;
   readonly initState = ActionState.create();
-
   readonly settingsDisplay: DisplayState;
   readonly documentationDisplay: DisplayState;
-
   // NOTE: when we support multiview, there can be multiple view states to support
   // the first one in that list will be taken as the main view state
   readonly view: DataCubeViewState;
 
-  constructor(application: DataCubeApplicationEngine, engine: DataCubeEngine) {
-    this.application = application;
+  onNameChanged?: ((name: string, source: DataCubeSource) => void) | undefined;
+  onSettingChanged?:
+    | ((
+        key: string,
+        value: string | number | boolean | object | undefined,
+      ) => void)
+    | undefined;
+
+  initialInput?: DataCubeInitialInput | undefined;
+  currentDocumentationEntry?: DocumentationEntry | undefined;
+  currentActionAlert?: ActionAlert | undefined;
+
+  constructor(engine: DataCubeEngine, options?: DataCubeOptions | undefined) {
+    makeObservable(this, {
+      currentDocumentationEntry: observable,
+      openDocumentationEntry: action,
+
+      currentActionAlert: observable,
+      alertAction: action,
+    });
+
     this.engine = engine;
-    this.engine.gridClientTaskRunner = (task) => {
-      // TODO: When we support multi-view (i.e. multiple instances of DataCubes) we would need
-      // to traverse through and update the configurations of all of their grid clients
-      task(this.view.grid.client);
-    };
+    this.settings = new DataCubeSettings(this);
     this.view = new DataCubeViewState(this);
 
-    this.settingsDisplay = this.application.layout.newDisplay(
+    this.settingsDisplay = this.engine.layout.newDisplay(
       'Settings',
       () => <DataCubeSettingsPanel />,
       {
@@ -59,7 +85,7 @@ export class DataCubeState {
         center: false,
       },
     );
-    this.documentationDisplay = this.application.layout.newDisplay(
+    this.documentationDisplay = this.engine.layout.newDisplay(
       'Documentation',
       () => <DocumentationPanel />,
       {
@@ -72,11 +98,56 @@ export class DataCubeState {
         center: false,
       },
     );
+
+    this.onNameChanged = options?.onNameChanged;
+    this.onSettingChanged = options?.onSettingChanged;
+    this.initialInput = options?.initialInput;
+
+    this.settings.enableDebugMode =
+      options?.enableDebugMode !== undefined
+        ? options.enableDebugMode
+        : this.settings.enableDebugMode;
+    this.settings.gridClientRowBuffer =
+      options?.gridClientRowBuffer !== undefined
+        ? options.gridClientRowBuffer
+        : this.settings.gridClientRowBuffer;
+    this.settings.gridClientPurgeClosedRowNodes =
+      options?.gridClientPurgeClosedRowNodes !== undefined
+        ? options.gridClientPurgeClosedRowNodes
+        : this.settings.gridClientPurgeClosedRowNodes;
+    this.settings.gridClientSuppressLargeDatasetWarning =
+      options?.gridClientSuppressLargeDatasetWarning !== undefined
+        ? options.gridClientSuppressLargeDatasetWarning
+        : this.settings.gridClientSuppressLargeDatasetWarning;
+  }
+
+  getSettings() {
+    return this.settings;
+  }
+
+  openDocumentationEntry(entry: DocumentationEntry | undefined) {
+    this.currentDocumentationEntry = entry;
+  }
+
+  alertAction(alert: ActionAlert | undefined) {
+    this.currentActionAlert = alert;
+  }
+
+  refreshFailedDataFetches() {
+    this.runTaskForEachView((view) => {
+      view.grid.client.retryServerSideLoads();
+    });
+  }
+
+  runTaskForEachView(runner: (view: DataCubeViewState) => void) {
+    // TODO: When we support multi-view (i.e. multiple instances of DataCubes) we would need
+    // to traverse through and update the configurations of all of their grid clients
+    runner(this.view);
   }
 
   async initialize() {
     if (!this.initState.isInInitialState) {
-      this.application.logDebug('REPL store is re-initialized');
+      this.engine.logDebug('REPL store is re-initialized');
       return;
     }
     this.initState.inProgress();
@@ -86,9 +157,9 @@ export class DataCubeState {
       this.initState.pass();
     } catch (error: unknown) {
       assertErrorThrown(error);
-      this.application.alertAction({
+      this.alertAction({
         message: `Initialization Failure: ${error.message}`,
-        prompt: `Resolve the issue and reload the application.`,
+        prompt: `Resolve the issue and reload the engine.`,
         type: AlertType.ERROR,
         actions: [],
       });

package/src/stores/core/DataCubeConfigurationBuilder.ts

@@ -18,17 +18,17 @@ import { PRIMITIVE_TYPE } from '@finos/legend-graph';
 import {
   DataCubeColumnConfiguration,
   DataCubeConfiguration,
-} from './DataCubeConfiguration.js';
+} from './models/DataCubeConfiguration.js';
 import {
   DataCubeQueryAggregateOperator,
   DataCubeColumnKind,
   DataCubeFontTextAlignment,
 } from './DataCubeQueryEngine.js';
+import type { DataCubeColumn } from './models/DataCubeColumn.js';
 
-export function buildDefaultColumnConfiguration(column: {
-  name: string;
-  type: string;
-}): DataCubeColumnConfiguration {
+export function buildDefaultColumnConfiguration(
+  column: DataCubeColumn,
+): DataCubeColumnConfiguration {
   const { name, type } = column;
   const config = new DataCubeColumnConfiguration(name, type);
   switch (type) {
@@ -57,7 +57,7 @@ export function buildDefaultColumnConfiguration(column: {
 }
 
 export function buildDefaultConfiguration(
-  columns: { name: string; type: string }[],
+  columns: DataCubeColumn[],
 ): DataCubeConfiguration {
   const configuration = new DataCubeConfiguration();
   configuration.columns = columns.map((column) =>