lens/src/migrations/helpers.ts

/**
 * Copyright (c) OpenLens Authors. All rights reserved.
 * Licensed under MIT License. See LICENSE in root directory for more information.
 */

import type Conf from "conf";
import type { Migrations } from "conf/dist/source/types";
import { getOrInsert, iter } from "../common/utils";
import { isTestEnv } from "../common/vars";

export function migrationLog(...args: any[]) {
  if (!isTestEnv) {
    console.log(...args);
  }
}

export interface MigrationDeclaration {
  version: string;
  run(store: Conf<any>): void;
}

export function joinMigrations(...declarations: MigrationDeclaration[]): Migrations<any> {
  const migrations = new Map<string, MigrationDeclaration["run"][]>();

  for (const decl of declarations) {
    getOrInsert(migrations, decl.version, []).push(decl.run);
  }

  return Object.fromEntries(
    iter.map(
      migrations,
      ([v, fns]) => [v, (store: Conf<any>) => {
        migrationLog(`Running ${v} migration for ${store.path}`);

        for (const fn of fns) {
          fn(store);
        }
      }],
    ),
  );
}