lens/src/common/user-store/preference-descriptors.injectable.ts

/**
 * Copyright (c) OpenLens Authors. All rights reserved.
 * Licensed under MIT License. See LICENSE in root directory for more information.
 */
import { getInjectable } from "@ogre-tools/injectable";
import { merge } from "lodash";
import type { ObservableMap } from "mobx";
import { observable } from "mobx";
import homeDirectoryPathInjectable from "../os/home-directory-path.injectable";
import joinPathsInjectable from "../path/join-paths.injectable";
import { defaultThemeId } from "../vars";
import currentTimezoneInjectable from "./current-timezone.injectable";
import type { EditorConfiguration, ExtensionRegistry, KubeconfigSyncEntry, KubeconfigSyncValue, TerminalConfig } from "./preferences-helpers";
import { defaultExtensionRegistryUrlLocation, defaultEditorConfig, defaultTerminalConfig, defaultPackageMirror, getPreferenceDescriptor, packageMirrors } from "./preferences-helpers";

export type PreferenceDescriptors = ReturnType<typeof userStorePreferenceDescriptorsInjectable["instantiate"]>;

const userStorePreferenceDescriptorsInjectable = getInjectable({
  id: "user-store-preference-descriptors",
  instantiate: (di) => {
    const currentTimezone = di.inject(currentTimezoneInjectable);
    const joinPaths = di.inject(joinPathsInjectable);
    const homeDirectoryPath = di.inject(homeDirectoryPathInjectable);

    const mainKubeFolderPath = joinPaths(homeDirectoryPath, ".kube");

    return ({
      httpsProxy: getPreferenceDescriptor<string | undefined>({
        fromStore: val => val,
        toStore: val => val || undefined,
      }),
      shell: getPreferenceDescriptor<string | undefined>({
        fromStore: val => val,
        toStore: val => val || undefined,
      }),
      colorTheme: getPreferenceDescriptor<string>({
        fromStore: val => val || defaultThemeId,
        toStore: val => !val || val === defaultThemeId
          ? undefined
          : val,
      }),
      terminalTheme: getPreferenceDescriptor<string>({
        fromStore: val => val || "",
        toStore: val => val || undefined,
      }),
      localeTimezone: getPreferenceDescriptor<string>({
        fromStore: val => val || currentTimezone,
        toStore: val => !val || val === currentTimezone
          ? undefined
          : val,
      }),
      allowUntrustedCAs: getPreferenceDescriptor<boolean>({
        fromStore: val => val ?? false,
        toStore: val => !val
          ? undefined
          : val,
      }),
      allowErrorReporting: getPreferenceDescriptor<boolean>({
        fromStore: val => val ?? true,
        toStore: val => val
          ? undefined
          : val,
      }),
      downloadMirror: getPreferenceDescriptor<string>({
        fromStore: val => !val || !packageMirrors.has(val)
          ? defaultPackageMirror
          : val,
        toStore: val => val === defaultPackageMirror
          ? undefined
          : val,
      }),
      downloadKubectlBinaries: getPreferenceDescriptor<boolean>({
        fromStore: val => val ?? true,
        toStore: val => val
          ? undefined
          : val,
      }),
      downloadBinariesPath: getPreferenceDescriptor<string | undefined>({
        fromStore: val => val,
        toStore: val => val || undefined,
      }),
      kubectlBinariesPath: getPreferenceDescriptor<string | undefined>({
        fromStore: val => val,
        toStore: val => val || undefined,
      }),
      openAtLogin: getPreferenceDescriptor<boolean>({
        fromStore: val => val ?? false,
        toStore: val => !val
          ? undefined
          : val,
      }),
      terminalCopyOnSelect: getPreferenceDescriptor<boolean>({
        fromStore: val => val ?? false,
        toStore: val => !val
          ? undefined
          : val,
      }),
      hiddenTableColumns: getPreferenceDescriptor<[string, string[]][], Map<string, Set<string>>>({
        fromStore: (val = []) => new Map(
          val.map(([tableId, columnIds]) => [tableId, new Set(columnIds)]),
        ),
        toStore: (val) => {
          const res: [string, string[]][] = [];

          for (const [table, columns] of val) {
            if (columns.size) {
              res.push([table, Array.from(columns)]);
            }
          }

          return res.length ? res : undefined;
        },
      }),
      syncKubeconfigEntries: getPreferenceDescriptor<KubeconfigSyncEntry[], ObservableMap<string, KubeconfigSyncValue>>({
        fromStore: val => observable.map(
          val?.map(({ filePath, ...rest }) => [filePath, rest])
          ?? [[mainKubeFolderPath, {}]],
        ),
        toStore: val => val.size === 1 && val.has(mainKubeFolderPath)
          ? undefined
          : Array.from(val, ([filePath, rest]) => ({ filePath, ...rest })),
      }),
      editorConfiguration: getPreferenceDescriptor<Partial<EditorConfiguration>, EditorConfiguration>({
        fromStore: val => merge(defaultEditorConfig, val),
        toStore: val => val,
      }),
      terminalConfig: getPreferenceDescriptor<Partial<TerminalConfig>, TerminalConfig>({
        fromStore: val => merge(defaultTerminalConfig, val),
        toStore: val => val,
      }),
      extensionRegistryUrl: getPreferenceDescriptor<ExtensionRegistry>({
        fromStore: val => val ?? {
          location: defaultExtensionRegistryUrlLocation,
        },
        toStore: val => val.location === defaultExtensionRegistryUrlLocation
          ? undefined
          : val,
      }),
    }) as const;
  },
});

export default userStorePreferenceDescriptorsInjectable;