-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Review#2: implement
UiSettingsDefaultsClient.
- Loading branch information
Showing
11 changed files
with
363 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import { omit } from 'lodash'; | ||
|
|
||
| import { | ||
| IUiSettingsClient, | ||
| UiSettingsParams, | ||
| PublicUiSettingsParams, | ||
| UserProvidedValues, | ||
| } from './types'; | ||
| import { Logger } from '../logging'; | ||
|
|
||
| export interface BaseUiSettingsDefaultsClientOptions { | ||
| overrides?: Record<string, any>; | ||
| defaults?: Record<string, UiSettingsParams>; | ||
| log: Logger; | ||
| } | ||
|
|
||
| /** | ||
| * Base implementation of the {@link IUiSettingsClient}. | ||
| */ | ||
| export abstract class BaseUiSettingsClient implements IUiSettingsClient { | ||
| private readonly defaults: NonNullable<BaseUiSettingsDefaultsClientOptions['defaults']>; | ||
| private readonly defaultValues: Record<string, unknown>; | ||
| protected readonly overrides: NonNullable<BaseUiSettingsDefaultsClientOptions['overrides']>; | ||
| protected readonly log: Logger; | ||
|
|
||
| protected constructor(options: BaseUiSettingsDefaultsClientOptions) { | ||
| const { defaults = {}, overrides = {}, log } = options; | ||
| this.log = log; | ||
| this.overrides = overrides; | ||
|
|
||
| this.defaults = defaults; | ||
| this.defaultValues = Object.fromEntries( | ||
| Object.entries(this.defaults).map(([key, { value }]) => [key, value]) | ||
| ); | ||
| } | ||
|
|
||
| getRegistered() { | ||
| const copiedDefaults: Record<string, PublicUiSettingsParams> = {}; | ||
| for (const [key, value] of Object.entries(this.defaults)) { | ||
| copiedDefaults[key] = omit(value, 'schema'); | ||
| } | ||
| return copiedDefaults; | ||
| } | ||
|
|
||
| async get<T = any>(key: string): Promise<T> { | ||
| const all = await this.getAll(); | ||
| return all[key] as T; | ||
| } | ||
|
|
||
| async getAll<T = any>() { | ||
| const result = { ...this.defaultValues }; | ||
|
|
||
| const userProvided = await this.getUserProvided(); | ||
| Object.keys(userProvided).forEach((key) => { | ||
| if (userProvided[key].userValue !== undefined) { | ||
| result[key] = userProvided[key].userValue; | ||
| } | ||
| }); | ||
|
|
||
| return Object.freeze(result) as Record<string, T>; | ||
| } | ||
|
|
||
| isOverridden(key: string) { | ||
| return this.overrides.hasOwnProperty(key); | ||
| } | ||
|
|
||
| isSensitive(key: string): boolean { | ||
| const definition = this.defaults[key]; | ||
| return !!definition?.sensitive; | ||
| } | ||
|
|
||
| protected validateKey(key: string, value: unknown) { | ||
| const definition = this.defaults[key]; | ||
| if (value === null || definition === undefined) return; | ||
| if (definition.schema) { | ||
| definition.schema.validate(value, {}, `validation [${key}]`); | ||
| } | ||
| } | ||
|
|
||
| abstract getUserProvided<T = any>(): Promise<Record<string, UserProvidedValues<T>>>; | ||
| abstract setMany(changes: Record<string, any>): Promise<void>; | ||
| abstract set(key: string, value: any): Promise<void>; | ||
| abstract remove(key: string): Promise<void>; | ||
| abstract removeMany(keys: string[]): Promise<void>; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.