@finos/legend-data-cube
Version:
354 lines • 16.6 kB
JavaScript
import { jsx as _jsx } from "react/jsx-runtime";
/**
* 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 { DataCubeSettingKey } from '../../__lib__/DataCubeSetting.js';
import { hashArray, IllegalStateError, isBoolean, isNumber, isString, LogEvent, UnsupportedOperationError, } from '@finos/legend-shared';
import { DataCubeEvent } from '../../__lib__/DataCubeEvent.js';
import { action, computed, makeObservable, observable, runInAction, } from 'mobx';
import { DataCubeSettingsPanel } from '../../components/core/DataCubeSettingsPanel.js';
export var DataCubeSettingGroup;
(function (DataCubeSettingGroup) {
DataCubeSettingGroup["DEBUG"] = "Debug";
DataCubeSettingGroup["EDITOR"] = "Editor";
DataCubeSettingGroup["GRID"] = "Grid";
})(DataCubeSettingGroup || (DataCubeSettingGroup = {}));
export var DataCubeSettingType;
(function (DataCubeSettingType) {
DataCubeSettingType["BOOLEAN"] = "boolean";
DataCubeSettingType["NUMERIC"] = "numeric";
DataCubeSettingType["STRING"] = "string";
DataCubeSettingType["ACTION"] = "action";
})(DataCubeSettingType || (DataCubeSettingType = {}));
export class DataCubeSettingService {
_engine;
_logService;
_layoutService;
_options;
display;
configurations = new Map();
defaultValues = new Map();
_defaultValuesHashCode;
values = new Map();
currentValues = new Map();
constructor(engine, logService, layoutService, options) {
makeObservable(this, {
values: observable,
save: action,
valuesHashCode: computed,
currentValues: observable,
restoreDefaultValues: action,
currentValuesHashCode: computed,
allowRestoreDefaultValues: computed,
});
this._engine = engine;
this._logService = logService;
this._layoutService = layoutService;
this._options = options;
this.display = this._layoutService.newDisplay('Settings', () => _jsx(DataCubeSettingsPanel, {}), {
x: -50,
y: 50,
width: 600,
height: 400,
minWidth: 300,
minHeight: 200,
center: false,
});
const CORE_SETTINGS = [
{
key: DataCubeSettingKey.DEBUGGER__ENABLE_DEBUG_MODE,
title: `Debug Mode: Enabled`,
description: `Enables debug logging when running data queries, updating snapshots, etc.`,
group: DataCubeSettingGroup.DEBUG,
type: DataCubeSettingType.BOOLEAN,
defaultValue: false,
},
{
key: DataCubeSettingKey.DEBUGGER__USE_DEV_CLIENT_PROTOCOL_VERSION,
title: `Use development client protocol version: Enabled`,
description: `Specifies if development client protocol version (vX_X_X) should be used for execution`,
group: DataCubeSettingGroup.DEBUG,
type: DataCubeSettingType.BOOLEAN,
defaultValue: false,
},
{
key: DataCubeSettingKey.DEBUGGER__ACTION__RELOAD,
title: `Reload`,
description: `Manually reload DataCube (keeping all states). This is needed when making changes to settings that require reloading to take effect.`,
group: DataCubeSettingGroup.DEBUG,
type: DataCubeSettingType.ACTION,
action: (api) => api.reload(),
defaultValue: undefined,
},
{
key: DataCubeSettingKey.GRID_CLIENT__SHOW_CACHE_PERFORMANCE_WARNING,
title: `Caching Performance Warning: Enabled`,
description: `Alerts user of potential performance and resource-related issues that caching can cause when enabled.`,
group: DataCubeSettingGroup.GRID,
type: DataCubeSettingType.BOOLEAN,
defaultValue: true,
},
{
key: DataCubeSettingKey.GRID_CLIENT__SHOW_AUTO_ENABLE_CACHE_PERFORMANCE_WARNING,
title: `Caching (Auto-Enabled) Performance Warning: Enabled`,
description: `Alerts user that caching is auto-enabled for the DataCube and of potential performance and resource-related issues that caching can cause when enabled.`,
group: DataCubeSettingGroup.GRID,
type: DataCubeSettingType.BOOLEAN,
defaultValue: true,
},
{
key: DataCubeSettingKey.EDITOR__MAX_HISTORY_STACK_SIZE,
title: `Max History Stack Size`,
description: `Sets the number of maximum snapshots to store in edit history.`,
group: DataCubeSettingGroup.EDITOR,
type: DataCubeSettingType.NUMERIC,
defaultValue: 100,
numericValueMin: 10,
numericValueStep: 10,
action: (api, newValue) => api._runTaskForEachView((view) => {
view.snapshotService.adjustHistorySize(newValue);
}),
},
{
key: DataCubeSettingKey.GRID_CLIENT__SUPPRESS_LARGE_DATASET_WARNING,
title: `Large Dataset Warning: Disabled`,
description: `Suggests user to enable pagination when handling large datasets to improve performance.`,
group: DataCubeSettingGroup.GRID,
type: DataCubeSettingType.BOOLEAN,
defaultValue: false,
},
{
key: DataCubeSettingKey.GRID_CLIENT__ROW_BUFFER,
title: `Row Buffer`,
description: `Sets the number of rows the grid renders outside of the viewable area. e.g. if the buffer is 10 and your grid is showing 50 rows (as that's all that fits on your screen without scrolling), then the grid will actually render 70 in total (10 extra above and 10 extra below). Then when you scroll, the grid will already have 10 rows ready and waiting to show, no redraw is needed. A low small buffer will make initial draws of the grid faster; whereas a big one will reduce the redraw visible vertically scrolling.`,
group: DataCubeSettingGroup.GRID,
type: DataCubeSettingType.NUMERIC,
defaultValue: 50,
numericValueMin: 10,
numericValueStep: 10,
action: (api, newValue) => api._runTaskForEachView((view) => {
if (view.grid.isClientConfigured) {
view.grid.client.updateGridOptions({
rowBuffer: newValue,
});
}
}),
},
{
key: DataCubeSettingKey.GRID_CLIENT__PURGE_CLOSED_ROW_NODES,
title: `Refresh Group Node Data: Enabled`,
description: `Forces refresh data when group node is opened.`,
group: DataCubeSettingGroup.GRID,
type: DataCubeSettingType.BOOLEAN,
defaultValue: false,
action: (api, newValue) => api._runTaskForEachView((view) => {
if (view.grid.isClientConfigured) {
view.grid.client.updateGridOptions({
purgeClosedRowNodes: newValue,
});
}
}),
},
{
key: DataCubeSettingKey.GRID_CLIENT__ACTION__RETRY_FAILED_DATA_FETCHES,
title: `Retry Failed Data Fetches: Action`,
description: `Manually re-runs all failed data fetches in the grid.`,
group: DataCubeSettingGroup.GRID,
type: DataCubeSettingType.ACTION,
action: (api) => api.retryFailedDataFetches(),
defaultValue: undefined,
},
];
const { configurations, values } = options?.settingsData ?? {};
[...CORE_SETTINGS, ...(configurations ?? [])].forEach((configuration) => {
this.configurations.set(configuration.key, configuration);
this.setValue(configuration.key, configuration.defaultValue, [
this.defaultValues,
this.values,
this.currentValues,
]);
});
const settingValues = values ?? {};
Object.keys(settingValues).forEach((key) => {
const value = settingValues[key];
// for unknown settings (e.g. outdated settings, settings' keys changed, etc.), we ignore them
const configuration = this.configurations.get(key);
if (!configuration) {
return;
}
this.setValue(key, value, [this.values, this.currentValues]);
});
// NOTE: if we support explicity setting values from options, they should
// be processed here, as they should override the settings retrieved from
// cache.
this._defaultValuesHashCode = this.computeValuesHashCode(this.defaultValues);
}
setValue(key, value, valueIndexes) {
const configuration = this.configurations.get(key);
if (!configuration) {
this._logService.logWarning(LogEvent.create(DataCubeEvent.SETTINGS__FAILURE__FOUND_UNREGISTERED_SETTING), `Can't set value for unregistered setting '${key}'`);
return false;
}
switch (configuration.type) {
case DataCubeSettingType.BOOLEAN: {
if (!(isBoolean(value) ||
(value === undefined && configuration.valueOptional))) {
this._logService.logWarning(LogEvent.create(DataCubeEvent.SETTINGS__FAILURE__FOUND_UNREGISTERED_SETTING), `Can't set value for setting '${key}': boolean value expected`);
return false;
}
break;
}
case DataCubeSettingType.NUMERIC: {
if (!(isNumber(value) ||
(value === undefined && configuration.valueOptional))) {
this._logService.logWarning(LogEvent.create(DataCubeEvent.SETTINGS__FAILURE__FOUND_UNREGISTERED_SETTING), `Can't set value for setting '${key}': numeric value expected`);
return false;
}
break;
}
case DataCubeSettingType.STRING: {
if (!(isString(value) ||
(value === undefined && configuration.valueOptional))) {
this._logService.logWarning(LogEvent.create(DataCubeEvent.SETTINGS__FAILURE__FOUND_UNREGISTERED_SETTING), `Can't set value for setting '${key}': string value expected`);
return false;
}
break;
}
case DataCubeSettingType.ACTION: {
return false;
}
default:
throw new UnsupportedOperationError(`Can't set value for unsupported setting type '${configuration.type}'`);
}
valueIndexes.forEach((valueIndex) => {
runInAction(() => valueIndex.set(key, value));
});
return true;
}
getConfiguration(key) {
const configuration = this.configurations.get(key);
if (!configuration) {
this._logService.logWarning(LogEvent.create(DataCubeEvent.SETTINGS__FAILURE__FOUND_UNREGISTERED_SETTING), `Can't retrieve value for unregistered setting '${key}'`);
throw new IllegalStateError(`Can't retrieve value for unregistered setting '${key}'`);
}
return configuration;
}
getBooleanValue(key) {
const value = this.values.get(key);
const configuration = this.getConfiguration(key);
if (configuration.type !== DataCubeSettingType.BOOLEAN ||
!isBoolean(value)) {
this._logService.logWarning(LogEvent.create(DataCubeEvent.SETTINGS__FAILURE__RETRIEVE_INCOMPATIBLE_VALUE), `Can't retrieve boolean value for setting '${key}'`);
throw new IllegalStateError(`Can't retrieve boolean value for setting '${key}'`);
}
return value;
}
getNumericValue(key) {
const value = this.values.get(key);
const configuration = this.getConfiguration(key);
if (configuration.type !== DataCubeSettingType.NUMERIC ||
!isNumber(value)) {
this._logService.logWarning(LogEvent.create(DataCubeEvent.SETTINGS__FAILURE__RETRIEVE_INCOMPATIBLE_VALUE), `Can't retrieve numeric value for setting '${key}'`);
throw new IllegalStateError(`Can't retrieve numeric value for setting '${key}'`);
}
return value;
}
getStringValue(key) {
const value = this.values.get(key);
const configuration = this.getConfiguration(key);
if (configuration.type !== DataCubeSettingType.STRING || !isString(value)) {
this._logService.logWarning(LogEvent.create(DataCubeEvent.SETTINGS__FAILURE__RETRIEVE_INCOMPATIBLE_VALUE), `Can't retrieve string value for setting '${key}'`);
throw new IllegalStateError(`Can't retrieve string value for setting '${key}'`);
}
return value;
}
computeValuesHashCode(values) {
return hashArray(Array.from(values.entries())
.toSorted((a, b) => a[0].localeCompare(b[0]))
.map(([key, value]) => `${key}:${value}`));
}
get valuesHashCode() {
return this.computeValuesHashCode(this.values);
}
get currentValuesHashCode() {
return this.computeValuesHashCode(this.currentValues);
}
get allowRestoreDefaultValues() {
return this._defaultValuesHashCode !== this.currentValuesHashCode;
}
restoreDefaultValues() {
this.currentValues.clear();
this.defaultValues.forEach((value, key) => this.currentValues.set(key, value));
}
getCurrentSettingValues() {
const settingValues = {};
this.values.forEach((value, key) => {
const configuration = this.configurations.get(key);
// skip if value is the same as default value
if (configuration && value !== configuration.defaultValue) {
settingValues[key] = value;
}
});
return settingValues;
}
updateValue(api, key, value) {
const configuration = this.configurations.get(key);
if (!configuration) {
this._logService.logWarning(LogEvent.create(DataCubeEvent.SETTINGS__FAILURE__FOUND_UNREGISTERED_SETTING), `Can't set value for unregistered setting '${key}'`);
return;
}
if (!this.setValue(key, value, [this.values, this.currentValues])) {
return;
}
// trigger hook
this._options?.onSettingsChanged?.({
api,
values: this.getCurrentSettingValues(),
});
// trigger action
configuration.action?.(api, value);
}
save(api) {
const changedSettingKeys = new Set();
this.values.forEach((value, key) => {
if (value !== this.currentValues.get(key)) {
changedSettingKeys.add(key);
}
});
// update values
this.values.clear();
this.currentValues.forEach((value, key) => this.values.set(key, value));
// trigger hook
this._options?.onSettingsChanged?.({
api,
values: this.getCurrentSettingValues(),
});
// trigger action
let requiresReload = false;
for (const key of changedSettingKeys) {
const configuration = this.configurations.get(key);
if (configuration?.requiresReload) {
requiresReload = true;
}
if (configuration?.action) {
configuration.action(api, this.values.get(key));
}
}
if (requiresReload) {
api.reload();
}
}
}
//# sourceMappingURL=DataCubeSettingService.js.map