|
| 1 | +import {TENANT_PAGES_IDS} from '../store/reducers/tenant/constants'; |
| 2 | + |
| 3 | +import { |
| 4 | + ASIDE_HEADER_COMPACT_KEY, |
| 5 | + CLUSTER_INFO_HIDDEN_KEY, |
| 6 | + INVERTED_DISKS_KEY, |
| 7 | + LANGUAGE_KEY, |
| 8 | + LAST_USED_QUERY_ACTION_KEY, |
| 9 | + PARTITIONS_HIDDEN_COLUMNS_KEY, |
| 10 | + QUERY_INITIAL_MODE_KEY, |
| 11 | + QUERY_USE_MULTI_SCHEMA_KEY, |
| 12 | + SAVED_QUERIES_KEY, |
| 13 | + TENANT_INITIAL_PAGE_KEY, |
| 14 | + THEME_KEY, |
| 15 | + USE_BACKEND_PARAMS_FOR_TABLES_KEY, |
| 16 | + USE_NODES_ENDPOINT_IN_DIAGNOSTICS_KEY, |
| 17 | +} from '../utils/constants'; |
| 18 | +import {QUERY_ACTIONS, QUERY_MODES} from '../utils/query'; |
| 19 | +import {parseJson} from '../utils/utils'; |
| 20 | + |
| 21 | +export type SettingsObject = Record<string, unknown>; |
| 22 | + |
| 23 | +const USE_LOCAL_STORAGE_FOR_SETTINGS_KEY = 'useLocalStorageForSettings'; |
| 24 | + |
| 25 | +/** User settings keys and their default values */ |
| 26 | +const DEFAULT_USER_SETTINGS: SettingsObject = { |
| 27 | + [THEME_KEY]: 'system', |
| 28 | + [LANGUAGE_KEY]: undefined, |
| 29 | + [INVERTED_DISKS_KEY]: false, |
| 30 | + [USE_NODES_ENDPOINT_IN_DIAGNOSTICS_KEY]: false, |
| 31 | + [QUERY_USE_MULTI_SCHEMA_KEY]: false, |
| 32 | + [SAVED_QUERIES_KEY]: [], |
| 33 | + [TENANT_INITIAL_PAGE_KEY]: TENANT_PAGES_IDS.query, |
| 34 | + [QUERY_INITIAL_MODE_KEY]: QUERY_MODES.script, |
| 35 | + [LAST_USED_QUERY_ACTION_KEY]: QUERY_ACTIONS.execute, |
| 36 | + [ASIDE_HEADER_COMPACT_KEY]: true, |
| 37 | + [PARTITIONS_HIDDEN_COLUMNS_KEY]: [], |
| 38 | + [CLUSTER_INFO_HIDDEN_KEY]: true, |
| 39 | + [USE_BACKEND_PARAMS_FOR_TABLES_KEY]: false, |
| 40 | +}; |
| 41 | + |
| 42 | +class SettingsManager { |
| 43 | + constructor() { |
| 44 | + // Migrate settings to LS if external API was used before |
| 45 | + const settingsApi = window.web_version ? window.systemSettings?.settingsApi : undefined; |
| 46 | + |
| 47 | + const useLocalStorage = this.readUserSettingsValue(USE_LOCAL_STORAGE_FOR_SETTINGS_KEY); |
| 48 | + |
| 49 | + if (settingsApi && !useLocalStorage) { |
| 50 | + const externalUserSettings = window.userSettings; |
| 51 | + |
| 52 | + if (externalUserSettings) { |
| 53 | + Object.entries(externalUserSettings).forEach(([key, value]) => |
| 54 | + this.setUserSettingsValue(key, value), |
| 55 | + ); |
| 56 | + } |
| 57 | + |
| 58 | + this.setUserSettingsValue(USE_LOCAL_STORAGE_FOR_SETTINGS_KEY, true); |
| 59 | + } |
| 60 | + } |
| 61 | + |
| 62 | + /** |
| 63 | + * User settings - settings stored in LS or external store |
| 64 | + */ |
| 65 | + getUserSettings() { |
| 66 | + return this.extractSettingsFromLS(); |
| 67 | + } |
| 68 | + |
| 69 | + /** |
| 70 | + * Returns parsed settings value. |
| 71 | + * If value cannot be parsed, returns initially stored string. |
| 72 | + * If there is no value, return default value |
| 73 | + */ |
| 74 | + readUserSettingsValue(key: string, defaultValue?: unknown) { |
| 75 | + return this.readValueFromLS(key) ?? defaultValue ?? DEFAULT_USER_SETTINGS[key]; |
| 76 | + } |
| 77 | + |
| 78 | + /** |
| 79 | + * Stringify value and set it to LS |
| 80 | + */ |
| 81 | + setUserSettingsValue(key: string, value: unknown) { |
| 82 | + return this.setValueToLS(key, value); |
| 83 | + } |
| 84 | + |
| 85 | + private extractSettingsFromLS = () => { |
| 86 | + return Object.entries(DEFAULT_USER_SETTINGS).reduce<SettingsObject>((acc, [key, value]) => { |
| 87 | + acc[key] = this.readUserSettingsValue(key, value); |
| 88 | + return acc; |
| 89 | + }, {}); |
| 90 | + }; |
| 91 | + |
| 92 | + private readValueFromLS = (key: string): unknown => { |
| 93 | + try { |
| 94 | + const value = localStorage.getItem(key); |
| 95 | + |
| 96 | + return parseJson(value); |
| 97 | + } catch { |
| 98 | + return undefined; |
| 99 | + } |
| 100 | + }; |
| 101 | + |
| 102 | + private setValueToLS = (key: string, value: unknown): void => { |
| 103 | + try { |
| 104 | + if (typeof value === 'string') { |
| 105 | + localStorage.setItem(key, value); |
| 106 | + } else { |
| 107 | + localStorage.setItem(key, JSON.stringify(value)); |
| 108 | + } |
| 109 | + } catch {} |
| 110 | + }; |
| 111 | +} |
| 112 | + |
| 113 | +export const settingsManager = new SettingsManager(); |
0 commit comments