devtools/projects/ng-devtools/src/lib/application-providers/settings_provider.ts - main - githubmirror/angular

devtools/projects/ng-devtools/src/lib/application-providers/settings_provider.ts
128 строк4 KB
Georgi Serev
refactor(devtools): rename timing API to performance track
29 июл 2026, 18:38
29 июл 2026, 18:38184c479
/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.dev/license
 */

import {provideAppInitializer, inject, Provider, EnvironmentProviders} from '@angular/core';
import {SETTINGS_STORE_KEY, SettingsStore} from '../application-services/settings_store';
import {ApplicationOperations} from '../application-operations';
import {Settings} from '../application-services/settings';
import {
  DATA_VERSION_KEY,
  LATEST_DATA_VERSION,
  SettingsDataV1,
  SettingsDataV2,
} from './settings_versions';

export function provideSettings(): (Provider | EnvironmentProviders)[] {
  let savedSettings: {[key: string]: unknown};

  return [
    provideAppInitializer(async () => {
      const appOperations = inject(ApplicationOperations);
      const keyedItem = await appOperations.getStorageItems([SETTINGS_STORE_KEY]);
      const data = (keyedItem[SETTINGS_STORE_KEY] ?? {}) as {[key: string]: unknown};
      savedSettings = applyMigrations(data, appOperations);
    }),
    {
      provide: SettingsStore,
      useFactory: () => new SettingsStore(savedSettings),
    },
    Settings,
  ];
}

/**
 * Migrates the provided data to the latest data format, if needed.
 * Returns a new object with the migrated data.
 *
 * @param data Non-migrated data
 * @param appOperations
 * @returns New migrated data object
 */
export function applyMigrations(
  data: {[key: string]: unknown},
  appOperations: ApplicationOperations,
): {[key: string]: unknown} {
  let dataCopy = structuredClone(data);
  const dataVer = dataCopy[DATA_VERSION_KEY];

  if (dataVer === LATEST_DATA_VERSION) {
    return dataCopy;
  }

  /**
   * Any changes to the data format must be handled in this part of the code
   * by comparing the data versions and applying the respective changes to
   * that data. All migrations should be kept and applied in chronological order
   * starting from oldest to latest/newest. The exact approach how this is performed
   * is up to the developer.
   *
   * Example:
   *
   * Data v1 (initial format; provided data): { 'theme': 'd' };
   * Data v2 (older format): { 'theme-option': 'dark' };
   * Data v3 (latest format): { 'theme-setting': 'dark-theme' };
   *
   * // Migrate data from v1 to v2
   * if (dataVer === 1) {
   *   const themeMap = {
   *     'd': 'dark',
   *     'l': 'light',
   *   };
   *   dataCopy['theme-option'] = themeMap[dataCopy['theme']];
   *   delete dataCopy['theme'];
   *   dataCopy[DATA_VERSION_KEY] = 2;
   * }
   *
   * // Migrate data from v2 to v3 (latest)
   * if (dataVer === 2) {
   *   const themeMap = {
   *     'dark': 'dark-theme',
   *     'light': 'light-theme',
   *   };
   *   dataCopy['theme-setting'] = themeMap[dataCopy['theme-option']];
   *   delete dataCopy['theme-option']
   *   dataCopy[DATA_VERSION_KEY] = 3;
   * }
   *
   */

  // APPLY ANY MIGRATIONS TO THE DATA HERE.

  // V1 -> V2 migration
  if (dataVer === 1) {
    const currData = dataCopy as unknown as SettingsDataV1;
    const newData: SettingsDataV2 = {
      [DATA_VERSION_KEY]: 2,

      // No change
      'theme@general': currData['theme@general'],
      'show_hydration_overlays@components': currData['show_hydration_overlays@components'],

      // Convert `timing_api_enabled` (cat: `general`) key to `performance_track` (cat: `profiling`).
      'performance_track@profiling': currData['timing_api_enabled@general'],

      // Convert `activeTab` (cat: `general`) key to `active_tab` (cat: `general`).
      'active_tab@general': currData['activeTab@general'],

      // Change the category of `show_comment_nodes` (from `general` to `components`).
      'show_comment_nodes@components': currData['show_comment_nodes@general'],

      // Flags that are no longer needed:
      // - router_graph_enabled@general
      // - signal_graph_enabled@general
      // - transfer_state_enabled@general
    };

    dataCopy = newData as unknown as {[key: string]: unknown};
  }

  dataCopy[DATA_VERSION_KEY] = LATEST_DATA_VERSION;
  appOperations.setStorageItems({[SETTINGS_STORE_KEY]: dataCopy});

  return dataCopy;
}