webapp/packages/plugin-data-viewer/src/DataViewerSettingsService.ts - devel - vshmidt/cloudbeaver

webapp/packages/plugin-data-viewer/src/DataViewerSettingsService.ts
172 строки6 KB
Alexey Potsetsuev
dbeaver/pro#6744 refactor: migration to `@wroud/di` (#3704)
29 авг 2025, 13:22
29 авг 2025, 13:2280f258b
/*
 * CloudBeaver - Cloud Database Manager
 * Copyright (C) 2020-2025 DBeaver Corp and others
 *
 * Licensed under the Apache License, Version 2.0.
 * you may not use this file except in compliance with the License.
 */
import { injectable } from '@cloudbeaver/core-di';
import { HIGHEST_SETTINGS_LAYER, ServerSettingsManagerService, SettingsTransformationService } from '@cloudbeaver/core-root';
import {
  createSettingsAliasResolver,
  createSettingsOverrideResolver,
  ESettingsValueType,
  type ISettingDescription,
  ROOT_SETTINGS_LAYER,
  SettingsManagerService,
  SettingsProvider,
  SettingsProviderService,
  SettingsResolverService,
} from '@cloudbeaver/core-settings';
import { schema, schemaExtra } from '@cloudbeaver/core-utils';
import { DATA_EDITOR_SETTINGS_GROUP } from './DATA_EDITOR_SETTINGS_GROUP.js';

const FETCH_MIN = 10;
const FETCH_MAX = 5000;
const DEFAULT_FETCH_SIZE = 200;

const defaultSettings = schema.object({
  'plugin.data-viewer.disableEdit': schemaExtra.stringedBoolean().default(false),
  'plugin.data-viewer.disableCopyData': schemaExtra.stringedBoolean().default(false),
  'plugin.data-viewer.fetchMax': schema.coerce.number().min(FETCH_MIN).default(FETCH_MAX),
  'resultset.maxrows': schema.coerce.number().min(FETCH_MIN).max(FETCH_MAX).default(DEFAULT_FETCH_SIZE),
  'plugin.data-viewer.export.disabled': schemaExtra.stringedBoolean().default(false),
});

export type DataViewerSettingsSchema = typeof defaultSettings;
export type DataViewerSettings = schema.infer<DataViewerSettingsSchema>;

@injectable(() => [
  SettingsProviderService,
  SettingsManagerService,
  SettingsResolverService,
  SettingsTransformationService,
  ServerSettingsManagerService,
])
export class DataViewerSettingsService {
  get disableEdit(): boolean {
    return this.settings.getValue('plugin.data-viewer.disableEdit');
  }

  get disableCopyData(): boolean {
    return this.settings.getValue('plugin.data-viewer.disableCopyData');
  }

  get disableExportData(): boolean {
    return this.settings.getValue('plugin.data-viewer.export.disabled');
  }

  get maxFetchSize(): number {
    return this.settings.getValue('plugin.data-viewer.fetchMax');
  }

  get minFetchSize(): number {
    return FETCH_MIN;
  }

  get defaultFetchSize(): number {
    return this.settings.getValue('resultset.maxrows');
  }

  readonly settings: SettingsProvider<DataViewerSettingsSchema>;

  constructor(
    private readonly settingsProviderService: SettingsProviderService,
    private readonly settingsManagerService: SettingsManagerService,
    private readonly settingsResolverService: SettingsResolverService,
    private readonly settingsTransformationService: SettingsTransformationService,
    private readonly serverSettingsManagerService: ServerSettingsManagerService,
  ) {
    // Some settings registered in plugin-data-editor-public-settings & permissions
    this.settings = this.settingsProviderService.createSettings(defaultSettings);
    this.settingsResolverService.addResolver(
      ROOT_SETTINGS_LAYER,
      /** @deprecated Use settings instead, will be removed in 23.0.0 */
      createSettingsAliasResolver<DataViewerSettingsSchema>(this.settingsProviderService.settingsResolver, {
        'plugin.data-viewer.disableEdit': 'core.app.dataViewer.disableEdit',
        'plugin.data-viewer.disableCopyData': 'core.app.dataViewer.disableCopyData',
        'plugin.data-viewer.fetchMax': 'core.app.dataViewer.fetchMax',
        'plugin.data-viewer.export.disabled': 'plugin.data-export.disabled',
        'resultset.maxrows': 'core.app.dataViewer.fetchDefault',
      }),
      /** @deprecated Use settings instead, will be removed in 25.0.0 */
      createSettingsAliasResolver<DataViewerSettingsSchema>(this.settingsProviderService.settingsResolver, {
        'resultset.maxrows': 'plugin.data-viewer.fetchDefault',
      }),
      /** @deprecated Use settings instead, will be removed in 23.0.0 */
      createSettingsAliasResolver<DataViewerSettingsSchema>(this.settingsProviderService.settingsResolver, {
        'plugin.data-viewer.export.disabled': 'plugin_data_export.disabled',
      }),
    );

    this.settingsResolverService.addResolver(
      HIGHEST_SETTINGS_LAYER,
      createSettingsOverrideResolver<DataViewerSettingsSchema>(this.settingsProviderService.settingsResolver, {
        'plugin.data-viewer.disableEdit': {
          key: 'permission.data-editor.editing',
          map: value => !value,
        },
        'plugin.data-viewer.disableCopyData': {
          key: 'permission.data-editor.copy',
          map: value => !value,
        },
        'plugin.data-viewer.export.disabled': {
          key: 'permission.data-editor.export',
          map: value => !value,
        },
      }),
    );

    this.registerSettings();
  }

  getDefaultRowsCount(count?: number): number {
    if (typeof count === 'number' && Number.isNaN(count)) {
      count = 0;
    }
    return count !== undefined ? Math.max(this.minFetchSize, Math.min(count, this.maxFetchSize)) : this.defaultFetchSize;
  }

  private registerSettings() {
    this.settingsTransformationService.setSettingTransformer(
      'resultset.maxrows',
      setting =>
        ({
          ...setting,
          name: 'settings_data_editor_fetch_default_name',
          description: 'settings_data_editor_fetch_default_description',
          group: DATA_EDITOR_SETTINGS_GROUP,
        }) as ISettingDescription<DataViewerSettings>,
    );

    this.settingsManagerService.registerSettings<typeof defaultSettings>(() => {
      const settings: ISettingDescription<DataViewerSettings>[] = [
        {
          key: 'plugin.data-viewer.fetchMax',
          access: {
            scope: ['server', 'role'],
          },
          type: ESettingsValueType.Input,
          name: 'settings_data_editor_fetch_max_name',
          description: 'settings_data_editor_fetch_max_description',
          group: DATA_EDITOR_SETTINGS_GROUP,
        },
      ];

      if (!this.serverSettingsManagerService.providedSettings.has('resultset.maxrows')) {
        settings.push({
          key: 'resultset.maxrows',
          access: {
            scope: ['server', 'client'],
          },
          type: ESettingsValueType.Input,
          name: 'settings_data_editor_fetch_default_name',
          description: 'settings_data_editor_fetch_default_description',
          group: DATA_EDITOR_SETTINGS_GROUP,
        });
      }

      return settings;
    });
  }
}