@catladder/cli 0.0.0-refactor-untangle-gitlab-api-requests-from-vorpal-57cf3cf2 → 0.0.0-reference-database-url-1befbbee

package/src/utils/gitlab-without-vorpal/gitLabVariables.ts

@@ -1,290 +0,0 @@
-import memoizee from "memoizee";
-import { times } from "lodash";
-
-import type { LoggerCmdInstance } from "../log";
-import { fetchGitLabApi } from "./fetchGitLabApi";
-import type { GitLabApiDataOptional } from "./GitLabApiDataOptional";
-import { getGitLabHostPathToken } from "./getGitlabHostPathToken";
-import { getGitLabProjectId } from "./gitLabProjectByGitPath";
-import { GitLabTokenMissingError } from "./GitLabTokenMissingError";
-
-/**
- * @see {@link https://gitlab.com/gitlab-org/gitlab-foss/-/blob/master/spec/frontend/ci_variable_list/components/ci_variable_modal_spec.js#L20}
- */
-const maskableRegex = new RegExp("^[a-zA-Z0-9_+=/@:.~-]{8,}$");
-/**
- * @see {@link https://gitlab.com/gitlab-org/gitlab-foss/-/blob/master/spec/frontend/ci_variable_list/components/ci_variable_modal_spec.js#L20}
- */
-const isMaskable = (value: string): boolean => maskableRegex.test(value);
-
-export type GitlabVariable = {
-  variable_type: string;
-  key: string;
-  value: string;
-  hidden: boolean;
-  protected: boolean;
-  masked: boolean;
-  raw: boolean;
-  environment_scope: string;
-  description: string | null;
-};
-const getGitLabVariable = async (
-  {
-    projectId,
-    key,
-    host,
-    token,
-  }: {
-    projectId: string | number;
-    key: string;
-  } & Omit<GitLabApiDataOptional, "path">,
-  logger: LoggerCmdInstance = console,
-) =>
-  fetchGitLabApi<GitlabVariable>(
-    {
-      resourcePath: `projects/${projectId}/variables/${key}`,
-      host,
-      token,
-    },
-    logger,
-  );
-
-const createGitLabVariable = async (
-  {
-    projectId,
-    key,
-    value,
-    masked = true,
-    scope = "*",
-    host,
-    token,
-  }: {
-    projectId: string | number;
-    key: string;
-    value: string;
-    masked?: boolean;
-    scope?: string;
-  } & Omit<GitLabApiDataOptional, "path">,
-  logger: LoggerCmdInstance = console,
-) =>
-  fetchGitLabApi<GitlabVariable>(
-    {
-      resourcePath: `projects/${projectId}/variables`,
-      method: "POST",
-      data: {
-        key,
-        value,
-        masked: masked && isMaskable(value),
-        environment_scope: scope,
-      },
-      host,
-      token,
-    },
-    logger,
-  );
-
-const updateGitLabVariable = async (
-  {
-    projectId,
-    key,
-    value,
-    masked = true,
-    host,
-    token,
-  }: {
-    projectId: string | number;
-    key: string;
-    value: string;
-    masked?: boolean;
-  } & Omit<GitLabApiDataOptional, "path">,
-  logger: LoggerCmdInstance = console,
-) =>
-  fetchGitLabApi<GitlabVariable>(
-    {
-      resourcePath: `projects/${projectId}/variables/${key}`,
-      method: "PUT",
-      data: {
-        value,
-        masked: masked && isMaskable(value),
-      },
-      host,
-      token,
-    },
-    logger,
-  );
-
-const deleteGitLabVariable = async (
-  {
-    projectId,
-    key,
-    host,
-    token,
-  }: {
-    projectId: string | number;
-    key: string;
-  } & Omit<GitLabApiDataOptional, "path">,
-  logger: LoggerCmdInstance = console,
-) =>
-  fetchGitLabApi(
-    {
-      resourcePath: `projects/${projectId}/variables/${key}`,
-      method: "DELETE",
-      host,
-      token,
-    },
-    logger,
-  );
-
-const getGitlabVariablesPage = async (
-  {
-    projectId,
-    page = 1,
-    perPage = 100,
-    host,
-    token,
-  }: {
-    projectId: string | number;
-    /**
-     * @defaultValue 1
-     */
-    page?: number;
-    /**
-     * @defaultValue 100
-     */
-    perPage?: number;
-  } & Omit<GitLabApiDataOptional, "path">,
-  logger: LoggerCmdInstance = console,
-) =>
-  fetchGitLabApi<GitlabVariable[]>(
-    {
-      resourcePath: `projects/${projectId}/variables?per_page=${perPage}&page=${page}`,
-      host,
-      token,
-    },
-    logger,
-  );
-
-export type GetAllVariablesArgs = {
-  /**
-   * Amount of requests in parallel to GitLab
-   *
-   * 5 seems a good value for many projects.
-   * Ideally we would do one request in parallel per component.
-   * @defaultValue 5
-   */
-  parallelRequests?: number;
-  projectId?: string | number;
-  logger?: LoggerCmdInstance;
-} & GitLabApiDataOptional;
-
-const getAllVariables = memoizee(
-  async ({
-    logger = console,
-    parallelRequests = 5,
-    projectId,
-    ...existing
-  }: GetAllVariablesArgs = {}): Promise<Array<GitlabVariable>> => {
-    const { host, path, token } = await getGitLabHostPathToken(
-      existing,
-      logger,
-    );
-    if (!token?.length) {
-      throw new GitLabTokenMissingError();
-    }
-    const id =
-      projectId || (await getGitLabProjectId({ host, path, token }, logger));
-
-    let all: GitlabVariable[] = [];
-    let result: GitlabVariable[][] = [];
-    let page = 1;
-
-    do {
-      // Create an array of promises for parallelRequests pages - Wait for all promises to resolve
-      result = await Promise.all(
-        times(parallelRequests, (i) => i + 1).map((parallelPage) =>
-          getGitlabVariablesPage(
-            { projectId: id, page: parallelPage, host, token },
-            logger,
-          ),
-        ),
-      );
-
-      // Increment the page by parallelRequests
-      page += parallelRequests;
-
-      // Flatten the result array and add it to 'all'
-      all = all.concat(result.flat());
-      // Continue only if the last page had results
-    } while (result.length > 0 && result.slice(-1)[0].length > 0);
-
-    return all;
-  },
-  { promise: true },
-);
-
-type ClVarNameStart = "CL_";
-
-const getAllCatladderEnvVars = async ({
-  logger = console,
-  projectId,
-  ...existing
-}: Omit<GetAllVariablesArgs, "parallelRequests"> = {}) => {
-  const { host, path, token } = await getGitLabHostPathToken(existing, logger);
-  if (!token?.length) {
-    throw new GitLabTokenMissingError();
-  }
-  const id =
-    projectId || (await getGitLabProjectId({ host, path, token }, logger));
-
-  const fetchResults = await gitLabVariable.getAll({
-    projectId: id,
-    host,
-    path,
-    token,
-    logger,
-  });
-  const catladderPrefixed = fetchResults.filter(({ key }) =>
-    key.startsWith("CL_"),
-  );
-  const allVariables = catladderPrefixed.reduce<{
-    [key in `${ClVarNameStart}${string}`]: { backups: number[] } & Omit<
-      Partial<GitlabVariable>,
-      "key"
-    >;
-  }>((acc, { key, value, ...rest }) => {
-    const matchBackup = key.match(/(CL_.*)_backup_([0-9]+)/);
-    if (matchBackup) {
-      const key = matchBackup[1];
-      const timestamp = Number(matchBackup[2]);
-      const backups = [...(acc[key]?.backups ?? []), timestamp];
-      return {
-        ...acc,
-        [key]: {
-          ...(acc[key] ?? {}), // add value
-          backups,
-        },
-      };
-    }
-
-    return {
-      ...acc,
-      [key]: {
-        backups: [],
-        ...(acc[key] ?? {}), // may add backups
-        value,
-        ...rest,
-      },
-    };
-  }, {});
-  return allVariables;
-};
-
-export const gitLabVariable = {
-  get: getGitLabVariable,
-  create: createGitLabVariable,
-  update: updateGitLabVariable,
-  delete: deleteGitLabVariable,
-  getPage: getGitlabVariablesPage,
-  getAll: getAllVariables,
-  getAllCatladder: getAllCatladderEnvVars,
-};

package/src/utils/gitlab-without-vorpal/index.ts

@@ -1,12 +0,0 @@
-export * from "./FetchGitLabError";
-export * from "./FetchMethod";
-export * from "./GitLabApiDataOptional";
-export * from "./GitLabTokenMissingError";
-export * from "./fetchGitLabApi";
-export * from "./getGitlabHostPathToken";
-export * from "./gitLabProjectByGitPath";
-export * from "./gitLabVariables";
-export * from "./insertProjectTopics";
-export * from "./loadGitLabToken";
-export * from "./projectAccessToken";
-export * from "./storeGitLabToken";

package/src/utils/gitlab-without-vorpal/insertProjectTopics.ts

@@ -1,35 +0,0 @@
-import type { LoggerCmdInstance } from "../log";
-import { fetchGitLabApi } from "./fetchGitLabApi";
-import { getGitLabHostPathToken } from "./getGitlabHostPathToken";
-import type { GitLabApiDataOptional } from "./GitLabApiDataOptional";
-import { gitLabProjectByGitPath } from "./gitLabProjectByGitPath";
-import { GitLabTokenMissingError } from "./GitLabTokenMissingError";
-
-export const insertProjectTopics = async (
-  {
-    topics: insertTopics,
-    ...existing
-  }: GitLabApiDataOptional & { topics: string[] },
-  logger: LoggerCmdInstance = console,
-) => {
-  const { host, path, token } = await getGitLabHostPathToken(existing, logger);
-  if (!token?.length) {
-    throw new GitLabTokenMissingError();
-  }
-
-  const { id, topics } = await gitLabProjectByGitPath(
-    { path, host, token },
-    logger,
-  );
-
-  await fetchGitLabApi(
-    {
-      resourcePath: `projects/${id}`,
-      data: { topics: [...insertTopics, ...topics] },
-      method: "PUT",
-      host,
-      token,
-    },
-    logger,
-  );
-};

package/src/utils/gitlab-without-vorpal/loadGitLabToken.ts

@@ -1,29 +0,0 @@
-import { GitLabTokenMissingError } from "./GitLabTokenMissingError";
-import { storeGitLabToken } from "./storeGitLabToken";
-import type { LoggerCmdInstance } from "../log";
-import { getPreferences } from "../preferences";
-import { getGitRemoteHost } from "../../git";
-
-export const loadGitLabToken = async (
-  gitlabHost?: string,
-  logger: LoggerCmdInstance = console,
-) => {
-  const [preferences, host] = await Promise.all([
-    getPreferences(logger),
-    getGitRemoteHost(gitlabHost),
-  ]);
-  if (preferences.gitlabTokens[host]?.length) {
-    return preferences.gitlabTokens[host];
-  }
-  if (preferences["gitlab-personal-access-token"]?.length) {
-    // Add the token to the hostname based preferences
-    return storeGitLabToken(
-      {
-        token: preferences["gitlab-personal-access-token"],
-        host,
-      },
-      logger,
-    );
-  }
-  throw new GitLabTokenMissingError();
-};

package/src/utils/gitlab-without-vorpal/projectAccessToken.ts

@@ -1,86 +0,0 @@
-import { format } from "date-fns";
-import type { LoggerCmdInstance } from "../log";
-import { fetchGitLabApi } from "./fetchGitLabApi";
-import type { GitLabApiDataOptional } from "./GitLabApiDataOptional";
-
-export type GitLabProjectAccessToken = {
-  id: number;
-  name: string;
-  revoked: boolean;
-  created_at: Date;
-  expires_at: Date;
-  user_id: number;
-  last_used_at: Date;
-  active: boolean;
-  access_level: number;
-  scopes: string[];
-  token: string;
-};
-
-const getProjectAccessTokens = async (
-  {
-    projectId,
-    path,
-    ...existing
-  }: { projectId: string | number } & GitLabApiDataOptional,
-  logger: LoggerCmdInstance = console,
-) =>
-  fetchGitLabApi<GitLabProjectAccessToken[]>(
-    { resourcePath: `projects/${projectId}/access_tokens`, ...existing },
-    logger,
-  );
-
-const rotate = async (
-  {
-    projectId,
-    tokenId,
-    data: { expires_at },
-    path,
-    ...existing
-  }: {
-    projectId: string | number;
-    tokenId: number;
-    data: Pick<GitLabProjectAccessToken, "expires_at">;
-  } & GitLabApiDataOptional,
-  logger: LoggerCmdInstance = console,
-) =>
-  fetchGitLabApi<GitLabProjectAccessToken>(
-    {
-      resourcePath: `projects/${projectId}/access_tokens/${tokenId}/rotate`,
-      data: { expires_at: format(expires_at, "yyyy-MM-dd") },
-      method: "POST",
-      ...existing,
-    },
-    logger,
-  );
-
-const create = async (
-  {
-    projectId,
-    path,
-    data: { expires_at, ...data },
-    ...existing
-  }: {
-    projectId: string | number;
-    data: Pick<
-      GitLabProjectAccessToken,
-      "access_level" | "name" | "scopes" | "expires_at"
-    >;
-  } & GitLabApiDataOptional,
-  logger: LoggerCmdInstance = console,
-) =>
-  fetchGitLabApi<GitLabProjectAccessToken>(
-    {
-      resourcePath: `projects/${projectId}/access_tokens`,
-      data: { expires_at: format(expires_at, "yyyy-MM-dd"), ...data },
-      method: "POST",
-      ...existing,
-    },
-    logger,
-  );
-
-export const gitLabProjectAccessToken = {
-  getList: getProjectAccessTokens,
-  rotate,
-  create,
-};

package/src/utils/gitlab-without-vorpal/storeGitLabToken.ts

@@ -1,23 +0,0 @@
-import type { LoggerCmdInstance } from "../log";
-import { upsertPreferences } from "../preferences";
-import { GitLabTokenMissingError } from "./GitLabTokenMissingError";
-import type { GitLabApiDataOptional } from "./GitLabApiDataOptional";
-import { getGitRemoteHost } from "../../git";
-
-export const storeGitLabToken = async (
-  { token, host }: Omit<GitLabApiDataOptional, "path">,
-  logger: LoggerCmdInstance = console,
-) => {
-  if (typeof token !== "string" || !token.length) {
-    throw new GitLabTokenMissingError();
-  }
-  const gitRemoteHost = await getGitRemoteHost(host);
-  await upsertPreferences(
-    {
-      "gitlab-personal-access-token": token,
-      gitlabTokens: { [gitRemoteHost]: token },
-    },
-    logger,
-  );
-  return token;
-};

package/src/utils/preferences/CatladderPreferences.ts

@@ -1,51 +0,0 @@
-const gitlabPersonalAccessToken = "gitlab-personal-access-token";
-const googleAuthUserNumber = "googleAuthUserNumber";
-const gitlabTokens = "gitlabTokens";
-const gitLabProjectIds = "gitLabProjectIds";
-
-const preferenceKeys = [
-  gitlabPersonalAccessToken,
-  googleAuthUserNumber,
-  gitlabTokens,
-  gitLabProjectIds,
-] as const;
-
-export type CatladderPreferences = {
-  /**
-   * @deprecated Use the hostname based `gitlabTokens` instead.
-   */
-  [gitlabPersonalAccessToken]: string | undefined;
-  [googleAuthUserNumber]: string | number | undefined;
-  /**
-   * GitLab tokens by GitLab instance hostname.
-   */
-  [gitlabTokens]: { [instanceHostname in string]: string };
-  [gitLabProjectIds]: { [hostnameProjectPath in string]: number };
-};
-
-const perfFallback: CatladderPreferences = {
-  [gitlabPersonalAccessToken]: undefined,
-  [googleAuthUserNumber]: undefined,
-  [gitlabTokens]: {},
-  [gitLabProjectIds]: {},
-};
-
-/**
- * Merges a partial configuration object with a fallback configuration object.
- * @param config - A partial configuration object of type `Partial<CatladderPreferences>`.
- * @param fallback - The fallback can be passed, in order to use this function for upserting as well.
- */
-export const mergeWithFallback = (
-  config: Partial<CatladderPreferences> = {},
-  fallback = perfFallback,
-): CatladderPreferences =>
-  preferenceKeys.reduce(
-    (acc, key) =>
-      Object.assign(acc, {
-        [key]:
-          typeof fallback[key] === "object"
-            ? Object.assign(fallback[key], config[key] ?? {})
-            : (config[key] ?? fallback[key]),
-      }),
-    {} as CatladderPreferences,
-  );

package/src/utils/preferences/index.ts

@@ -1,103 +0,0 @@
-import { existsSync } from "fs";
-import { writeFile, readFile, mkdir, cp, chmod } from "fs/promises";
-import { homedir } from "os";
-import { join } from "path/posix";
-import { parse, stringify } from "yaml";
-import {
-  mergeWithFallback,
-  type CatladderPreferences,
-} from "./CatladderPreferences";
-import type { LoggerCmdInstance } from "../log";
-import { logError } from "../log";
-
-export { type CatladderPreferences } from "./CatladderPreferences";
-
-const legacyDir = join(homedir(), ".catladder");
-const legacyPath = join(legacyDir, "preferences.yml");
-
-const configDir = join(homedir(), ".config/catladder");
-const configPath = join(configDir, "preferences.yml");
-const legacyBackupPath = join(configDir, "old_preferences_backup.yml");
-
-const encoding = "utf-8";
-const mode = 0o600;
-
-const readPerfString = () => readFile(configPath, { encoding });
-const writePerfString = (str: string) =>
-  writeFile(configPath, str, { encoding, mode });
-
-const isConfigPath = () => existsSync(configPath);
-const isLegacyPath = () => existsSync(legacyPath);
-
-const createDir = () => mkdir(configDir, { recursive: true, mode: 0o700 });
-
-const copyLegacyConfig = async (target = configPath) => {
-  await cp(legacyPath, target);
-  return chmod(target, mode);
-};
-
-const parseConfigString = (
-  yamlString: string,
-  logger: LoggerCmdInstance = console,
-): CatladderPreferences => {
-  try {
-    return mergeWithFallback(parse(yamlString) ?? {});
-  } catch (error) {
-    logError(logger, "Error when trying to parse preferences", `${error}`);
-    throw error;
-  }
-};
-
-const readPreferences = async (logger: LoggerCmdInstance = console) => {
-  const yamlContent = await readPerfString();
-  return parseConfigString(yamlContent, logger);
-};
-
-const stringifyConfig = (
-  config: Partial<CatladderPreferences> = {},
-  logger: LoggerCmdInstance = console,
-) => {
-  try {
-    const preferences = mergeWithFallback(config);
-    return stringify(preferences);
-  } catch (error) {
-    logError(logger, "Error when trying to stringify preferences", `${error}`);
-    throw error;
-  }
-};
-
-const writePreferences = async (
-  preferences: Partial<CatladderPreferences> = {},
-  logger: LoggerCmdInstance = console,
-) => writePerfString(stringifyConfig(preferences, logger));
-
-const ensureConfigFile = async () => {
-  if (isConfigPath()) {
-    return;
-  }
-  await createDir();
-  if (!isLegacyPath()) {
-    return writePreferences();
-  }
-  await copyLegacyConfig();
-  return copyLegacyConfig(legacyBackupPath);
-};
-
-/**
- * Load preferences from ~/.config/catladder/preferences.yml
- */
-export const getPreferences = async (logger: LoggerCmdInstance = console) => {
-  await ensureConfigFile();
-  return readPreferences(logger);
-};
-
-/**
- * Add or update preference values in ~/.config/catladder/preferences.yml
- */
-export const upsertPreferences = async (
-  preferences: Partial<CatladderPreferences> = {},
-  logger: LoggerCmdInstance = console,
-) => {
-  const current = await getPreferences(logger);
-  return writePreferences(mergeWithFallback(preferences, current), logger);
-};