@catladder/cli 0.0.0-refactor-cli-add-improved-git-utilities-916545cc → 0.0.0-refactor-remove-rails-hosts-60f9538c

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "0.0.0-refactor-cli-add-improved-git-utilities-916545cc",
+  "version": "0.0.0-refactor-remove-rails-hosts-60f9538c",
   "scripts": {
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",
@@ -74,41 +74,42 @@
     "node": ">=18.0.0"
   },
   "devDependencies": {
-    "@gitbeaker/rest": "^40.1.3",
+    "@gitbeaker/rest": "^39.28.0",
     "@kubernetes/client-node": "^0.16.2",
     "@tsconfig/node14": "^1.0.1",
-    "@types/common-tags": "^1.8.0",
+    "@types/common-tags": "^1.8.4",
     "@types/fs-extra": "^5.0.4",
-    "@types/lodash": "^4.14.185",
+    "@types/lodash": "^4.17.7",
     "@types/memoizee": "^0.4.2",
-    "@types/node-fetch": "^2.1.4",
-    "@types/request": "^2.48.1",
+    "@types/node-fetch": "^2.6.11",
+    "@types/request": "^2.48.12",
     "@types/tmp": "^0.2.3",
     "@types/update-notifier": "^2.5.0",
     "@types/vorpal": "^1.12.0",
     "@types/websocket": "^0.0.40",
-    "@types/yargs": "^13.0.0",
+    "@types/yargs": "^17.0.33",
     "child-process-promise": "^2.2.1",
     "clipboardy": "^2.0.0",
     "command-exists-promise": "^2.0.2",
-    "common-tags": "^1.8.0",
+    "common-tags": "^1.8.2",
     "connection-string-parser": "^1.0.4",
-    "dayjs": "^1.10.4",
+    "date-fns": "^3.6.0",
     "fs-extra": "^7.0.1",
+    "gitlab": "^4.4.1",
     "lodash": "^4.17.21",
-    "memoizee": "^0.4.14",
+    "memoizee": "^0.4.17",
     "node-fetch": "^2.3.0",
     "open": "^8.4.0",
-    "prettier": "^3.3.2",
+    "prettier": "^3.3.3",
     "tmp-promise": "^2.0.2",
-    "ts-results-es": "^4.1.0-alpha.1",
+    "ts-results-es": "^4.2.0",
     "tsc-alias": "^1.8.10",
     "typescript": "^5.4.5",
     "vorpal": "^1.12.0",
-    "yaml": "^2.4.5"
+    "yaml": "^2.5.0"
   },
   "dependencies": {
-    "tsx": "^4.16.2"
+    "tsx": "^4.19.0"
   },
   "stableVersion": "0.0.0"
 }

package/src/apps/catenv/catenv.ts

@@ -12,7 +12,7 @@ export default async (choice?: Choice) => {
   }
 
   await Promise.all([
-    generatePipelineFiles(config, config.pipelineType ?? "gitlab", "local"),
+    generatePipelineFiles(config, config.pipelineType ?? "gitlab"),
     writeDotEnvFiles(config, choice),
 
     writeDTsFiles(config, choice),

package/src/apps/cli/commands/project/index.ts

@@ -12,8 +12,7 @@ import commandSetup from "./commandSetup";
 import commandRenewToken from "./commandRenewToken";
 import commandListPods from "./commandListPods";
 import commandNamespace from "./commandNamespace";
-import commandOpenCostDashboard from "./commandOpenCostDashboard";
-import commandOpenDashboard from "./commandOpenDashboard";
+
 import commandOpenEnv from "./commandOpenEnv";
 import commandOpenGit from "./commandOpenGit";
 import commandOpenLogs from "./commandOpenLogs";
@@ -35,12 +34,8 @@ export default async (vorpal: Vorpal) => {
   commandPauseProject(vorpal);
   commandDeleteProject(vorpal);
 
-  commandOpenDashboard(vorpal);
-
   commandOpenLogs(vorpal);
 
-  commandOpenCostDashboard(vorpal);
-
   commandCloudSqlProxy(vorpal);
   commandProjectRestoreDb(vorpal);
   commandOpenGit(vorpal);

package/src/apps/cli/commands/project/setup/setupAccessTokens.ts

@@ -1,20 +1,10 @@
 import type { CommandInstance } from "vorpal";
-import dayjs from "dayjs";
+import { add, format } from "date-fns";
 import { doGitlabRequest, getProjectInfo } from "../../../../../utils/gitlab";
-import {
-  getGitlabProjectId,
-  gitlabApiClient,
-  type GitlabRestClient,
-} from "../../../../../gitlab";
 
 const TOKEN_NAME = "semantic-release";
 
-export const setupAccessTokens = async (
-  instance: CommandInstance,
-  preinit?: [number, GitlabRestClient],
-) => {
-  const [id, gitlabApi] =
-    preinit ?? (await Promise.all([getGitlabProjectId(), gitlabApiClient()]));
+export const setupAccessTokens = async (instance: CommandInstance) => {
   const { id: projectId } = await getProjectInfo(instance);
 
   const projectTokens = await doGitlabRequest(
@@ -25,10 +15,10 @@ export const setupAccessTokens = async (
     (t) => t.name === TOKEN_NAME && t.active === true,
   );
 
-  const expires_at = dayjs()
-    .add(1, "year")
-    .subtract(1, "day")
-    .format("YYYY-MM-DD");
+  const expires_at = format(
+    add(new Date(), { years: 1, days: -1 }),
+    "yyyy-MM-dd",
+  );
 
   const newToken = token
     ? await doGitlabRequest(

package/src/apps/cli/commands/project/setup/setupCloudRun.ts

@@ -78,9 +78,7 @@ export const setupCloudRun = async (
     },
     context.env,
     context.name,
-    {
-      backup: false,
-      masked: false,
-    },
+    false, // backup
+    false, // masked
   );
 };

package/src/apps/cli/commands/project/setup/setupKubernetes.ts

@@ -6,30 +6,27 @@ import {
 import type { CommandInstance } from "vorpal";
 import { exec } from "child-process-promise";
 import { connectToCluster } from "../../../../../utils/cluster";
-import { upsertAllVariables } from "../../../../../utils/gitlab";
+import {
+  doGitlabRequest,
+  getProjectInfo,
+  upsertAllVariables,
+} from "../../../../../utils/gitlab";
 import ensureNamespace from "../utils/ensureNamespace";
-import type { GitlabRestClient } from "../../../../../gitlab";
-import { getGitlabProjectId, gitlabApiClient } from "../../../../../gitlab";
 
 export const setupKubernetes = async (
   instance: CommandInstance,
   context: ComponentContext,
-  preinit?: [number, GitlabRestClient],
 ) => {
   const deployConfig = context.deploy?.config;
   if (!isOfDeployType(deployConfig, "kubernetes")) {
     throw new Error("cannot run setupKubernetes on non-kubernetes deployments");
   }
-  const [id, gitlabApi] =
-    preinit ?? (await Promise.all([getGitlabProjectId(), gitlabApiClient()]));
-
-  const deploy_tokens = await gitlabApi.DeployTokens.all({ projectId: id });
 
-  // const { id: projectId } = await getProjectInfo(instance);
-  // const deploy_tokens = await doGitlabRequest(
-  //   instance,
-  //   `projects/${projectId}/deploy_tokens`,
-  // );
+  const { id: projectId } = await getProjectInfo(instance);
+  const deploy_tokens = await doGitlabRequest(
+    instance,
+    `projects/${projectId}/deploy_tokens`,
+  );
 
   if (
     !deploy_tokens.find(
@@ -39,21 +36,17 @@ export const setupKubernetes = async (
     instance.log(
       "I will setup the 'GitLab Deploy Token', so Kubernetes can pull images from this project.",
     );
-    await gitlabApi.DeployTokens.create(
-      "gitlab-deploy-token",
-      ["read_registry"],
-      { projectId: id },
+
+    await doGitlabRequest(
+      instance,
+      `projects/${projectId}/deploy_tokens`,
+      {
+        id: projectId,
+        name: "gitlab-deploy-token",
+        scopes: ["read_registry"],
+      },
+      "POST",
     );
-    // await doGitlabRequest(
-    //   instance,
-    //   `projects/${projectId}/deploy_tokens`,
-    //   {
-    //     id: projectId,
-    //     name: "gitlab-deploy-token",
-    //     scopes: ["read_registry"],
-    //   },
-    //   "POST",
-    // );
   }
 
   const fullName = getFullKubernetesClusterName(deployConfig.cluster);
@@ -167,8 +160,12 @@ EOF
   instance.log("");
   instance.log("pusing secrets to gitlab...");
 
-  await upsertAllVariables(instance, vars, context.env, context.name, {
-    backup: false,
-  });
+  await upsertAllVariables(
+    instance,
+    vars,
+    context.env,
+    context.name,
+    false, // no backup
+  );
   instance.log("done!");
 };

package/src/apps/cli/commands/project/setup/setupTopic.ts

@@ -1,12 +1,17 @@
 import type { CommandInstance } from "vorpal";
-import { getGitlabProjectInfo, gitlabApiClient } from "../../../../../gitlab";
+import { doGitlabRequest, getProjectInfo } from "../../../../../utils/gitlab";
 
 const catladderTopic = "catladder";
 
 export const setupTopic = async (instance: CommandInstance) => {
-  const api = await gitlabApiClient();
-  const info = await getGitlabProjectInfo(api);
-  await api.Projects.edit(info.id, {
-    topics: [catladderTopic, ...info.topics],
-  });
+  const { id: projectId } = await getProjectInfo(instance);
+
+  const { topics } = await doGitlabRequest(instance, `projects/${projectId}`);
+
+  await doGitlabRequest(
+    instance,
+    `projects/${projectId}`,
+    { topics: [catladderTopic, ...topics] },
+    "PUT",
+  );
 };

package/src/apps/cli/utils/getGoogleAuthUserNumber.ts

@@ -4,8 +4,9 @@ import {
   setPreference,
 } from "../../../utils/preferences";
 
+const KEY = "googleAuthUserNumber";
 export const getGoogleAuthUserNumber = async function () {
-  if (!(await hasPreference("googleAuthUserNumber"))) {
+  if (!(await hasPreference(KEY))) {
     this.log(
       "Please type in your google auth user number (0 if you have only one google account or maybe 1 if you have multiple)",
     );
@@ -16,10 +17,7 @@ export const getGoogleAuthUserNumber = async function () {
       default: "0",
       message: "Auth user ",
     });
-    await setPreference(
-      "googleAuthUserNumber",
-      Number.parseInt(authUserNumber, 10),
-    );
+    await setPreference(KEY, authUserNumber);
   }
-  return getPreference("googleAuthUserNumber");
+  return getPreference(KEY);
 };

package/src/packageInfos.ts

@@ -4,7 +4,6 @@
 // this will point to the root package.json
 
 const path = require.main?.path + "/../package.json";
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const ownPkg = require(path);
 
 export default ownPkg;

package/src/utils/gitlab.ts

@@ -5,20 +5,11 @@ import memoizee from "memoizee";
 import fetch from "node-fetch";
 import open from "open";
 import type { CommandInstance } from "vorpal";
-import { hasPreference } from "./preferences";
-import {
-  setGitlabToken,
-  getGitlabToken as getGitlabTokenFromPerferences,
-  getGitlabProjectId,
-  getGitlabProjectInfo,
-  gitlabApiClient,
-  type GitlabRestClient,
-} from "../gitlab";
-import type { Camelize, ProjectVariableSchema } from "@gitbeaker/rest";
-
-export const hasGitlabToken = async () =>
-  await hasPreference("gitlab-personal-access-token");
+import { getPreference, hasPreference, setPreference } from "./preferences";
 
+const TOKEN_KEY = "gitlab-personal-access-token";
+
+export const hasGitlabToken = async () => await hasPreference(TOKEN_KEY);
 export const setupGitlabToken = async (vorpal: CommandInstance) => {
   vorpal.log("");
   vorpal.log("☝ in order to access the api, we need a personal access token");
@@ -32,10 +23,6 @@ export const setupGitlabToken = async (vorpal: CommandInstance) => {
     name: "shouldContinue",
     type: "prompt",
   });
-  if (!shouldContinue) {
-    console.info("Aborted by user");
-    process.exit(0);
-  }
 
   open("https://git.panter.ch/-/profile/personal_access_tokens");
 
@@ -47,15 +34,12 @@ export const setupGitlabToken = async (vorpal: CommandInstance) => {
     default: "",
     message: "Your personal access token ",
   });
-  if (typeof personalToken === "string" && personalToken.length) {
-    await setGitlabToken(personalToken);
-  } else {
-    console.error("⚠️ no gitlab personal access token set");
+  if (personalToken) {
+    await setPreference(TOKEN_KEY, personalToken);
   }
 };
 export const getGitlabToken = async (vorpal: CommandInstance | null) => {
-  const { token } = await getGitlabTokenFromPerferences();
-  if (!token?.length) {
+  if (!(await hasGitlabToken())) {
     if (!vorpal) {
       console.error(
         "⚠️ gitlab token missing, please run catladder to set it up",
@@ -64,7 +48,7 @@ export const getGitlabToken = async (vorpal: CommandInstance | null) => {
     }
     await setupGitlabToken(vorpal);
   }
-  return token;
+  return getPreference(TOKEN_KEY);
 };
 
 type Method = "GET" | "PUT" | "POST" | "DELETE";
@@ -75,9 +59,6 @@ export const doGitlabRequest = async <T = any>(
   method: Method = "GET",
 ): Promise<T> => {
   const rootToken = await getGitlabToken(vorpal);
-  if (typeof rootToken !== "string") {
-    throw new Error("Missing gitlab personal access token!");
-  }
 
   //const method = data ? (update ? "PUT" : "POST") : "GET";
 
@@ -107,10 +88,24 @@ export const doGitlabRequest = async <T = any>(
   );
 };
 
-export const getProjectInfo = async (vorpal: CommandInstance | null) =>
-  getGitlabProjectInfo();
+export const getProjectInfo = async (
+  vorpal: CommandInstance | null,
+): Promise<{ id: string; web_url: string }> => {
+  const gitRemoteOriginUrl = (
+    await exec("git config --get remote.origin.url")
+  ).stdout.trim();
+  const projectPath =
+    /(https:\/\/|git@)git\.panter\.ch[:/]([^.]*)(\.git)?/g.exec(
+      gitRemoteOriginUrl,
+    );
+  const project = await doGitlabRequest(
+    vorpal,
+    `projects/${encodeURIComponent(projectPath[2])}`,
+  );
+  return project;
+};
 
-export type GitlabVariable = {
+type GitlabVariable = {
   variable_type: string;
   key: string;
   value: string;
@@ -121,36 +116,25 @@ export type GitlabVariable = {
 export const getAllVariables = memoizee(
   async (
     vorpal: CommandInstance | null,
-    preinit?: [number, GitlabRestClient],
-  ): Promise<(ProjectVariableSchema | Camelize<ProjectVariableSchema>)[]> => {
-    const [id, gitlabApi] =
-      preinit ?? (await Promise.all([getGitlabProjectId(), gitlabApiClient()]));
-    // how many requests to do in parallel, 5 seems a good value for many projects, ideally we would do one request in parallel per component
-    const n = 5;
-    let all: (ProjectVariableSchema | Camelize<ProjectVariableSchema>)[] = [];
-    let result: (ProjectVariableSchema | Camelize<ProjectVariableSchema>)[][] =
-      [];
+    n = 5, // how many requests to do in parallel, 5 seems a good value for many projects, ideally we would do one request in parallel per component
+  ): Promise<Array<GitlabVariable>> => {
+    const { id } = await getProjectInfo(vorpal);
+
+    let all: Array<GitlabVariable> = [];
+    let result: Array<Array<GitlabVariable>> = [];
     let page = 1;
 
     do {
       // Create an array of promises for N pages
       const promises = Array.from({ length: n }, (_, i) => {
-        return gitlabApi.ProjectVariables.all(id, {
-          page: page + i,
-          perPage: 100,
-        });
+        return doGitlabRequest(
+          vorpal,
+          `projects/${id}/variables?per_page=100&page=${page + i}`,
+        );
       });
 
       // Wait for all promises to resolve
-      result = await Promise.all(
-        Array.from({ length: n }, async (_, i) => {
-          const res = await gitlabApi.ProjectVariables.all(id, {
-            page: page + i,
-            perPage: 100,
-          });
-          return res;
-        }),
-      );
+      result = await Promise.all(promises);
 
       // Increment the page by N
       page += n;
@@ -176,11 +160,60 @@ export const getVariableValueByRawName = async (
 const maskableRegex = new RegExp("^[a-zA-Z0-9_+=/@:.~-]{8,}$"); // SEE 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);
 
-const getAllCatladderEnvVarsInGitlab = async (
+const createVariable = async (
   vorpal: CommandInstance,
-  preinit?: [number, GitlabRestClient],
+  projectId: string,
+  key: string,
+  value: string,
+  masked = true,
+  environment_scope = "*",
 ) => {
-  const allVariables = await getAllVariables(vorpal, preinit).then((v) =>
+  return await doGitlabRequest(
+    vorpal,
+    `projects/${projectId}/variables`,
+    {
+      key,
+      value,
+      masked: masked && isMaskable(value),
+      environment_scope,
+    },
+    "POST",
+  );
+};
+
+const updateVariable = async (
+  vorpal: CommandInstance,
+  projectId: string,
+  key: string,
+  value: string,
+  masked = true,
+) => {
+  return await doGitlabRequest(
+    vorpal,
+    `projects/${projectId}/variables/${key}`,
+    {
+      value,
+      masked: masked && isMaskable(value),
+    },
+    "PUT",
+  );
+};
+
+const deleteVariable = async (
+  vorpal: CommandInstance,
+  projectId: string,
+  key: string,
+) => {
+  return await doGitlabRequest(
+    vorpal,
+    `projects/${projectId}/variables/${key}`,
+    undefined,
+    "DELETE",
+  );
+};
+
+const getAllCatladderEnvVarsInGitlab = async (vorpal: CommandInstance) => {
+  const allVariables = await getAllVariables(vorpal).then((v) =>
     v.reduce<{
       [key: string]: {
         value?: string;
@@ -223,25 +256,16 @@ const getAllCatladderEnvVarsInGitlab = async (
 
 const getBackupKey = (fullKey: string, timestamp: number) =>
   `${fullKey}_backup_${timestamp}`;
-
 export const clearBackups = async (vorpal: CommandInstance, keep: number) => {
-  const [id, gitlabApi] = await Promise.all([
-    getGitlabProjectId(),
-    gitlabApiClient(),
-  ]);
-  const existingVariables = await getAllCatladderEnvVarsInGitlab(vorpal, [
-    id,
-    gitlabApi,
-  ]);
-  // const { id } = await getProjectInfo(vorpal);
+  const existingVariables = await getAllCatladderEnvVarsInGitlab(vorpal);
+  const { id } = await getProjectInfo(vorpal);
   for (const [key, { backups }] of Object.entries(existingVariables)) {
     const backupsSorted = backups.sort((a, b) => b - a);
     //const toKeep = backupsSorted.slice(0, keep);
     const toDelete = backupsSorted.slice(keep);
 
     for (const timestamp of toDelete) {
-      await gitlabApi.ProjectVariables.remove(id, getBackupKey(key, timestamp));
-      // await deleteVariable(vorpal, id, getBackupKey(key, timestamp));
+      await deleteVariable(vorpal, id, getBackupKey(key, timestamp));
     }
   }
 };
@@ -251,26 +275,13 @@ export const upsertAllVariables = async (
   variables: Record<string, any>,
   env: string,
   componentName: string,
-  {
-    backup = true,
-    masked = true,
-    preinit,
-  }: {
-    backup?: boolean;
-    // FIXME: would be better to have this per variable
-    masked?: boolean;
-    preinit?: [number, GitlabRestClient];
-  } = {},
+  backup = true,
+  masked = true, // FIXME: would be better to have this per variable
 ): Promise<void> => {
-  const [id, gitlabApi] =
-    preinit ?? (await Promise.all([getGitlabProjectId(), gitlabApiClient()]));
-  // const { id } = await getProjectInfo(vorpal);
+  const { id } = await getProjectInfo(vorpal);
 
   // we list all existing variables. We also gather backup versions, but its currently unused
-  const existingVariables = await getAllCatladderEnvVarsInGitlab(vorpal, [
-    id,
-    gitlabApi,
-  ]);
+  const existingVariables = await getAllCatladderEnvVarsInGitlab(vorpal);
   for (const [key, value] of Object.entries(variables ?? {})) {
     const fullKey = getSecretVarName(env, componentName, key);
     const valueSanitized = isObject(value) ? JSON.stringify(value) : `${value}`;
@@ -282,30 +293,21 @@ export const upsertAllVariables = async (
       if (exists) {
         vorpal.log(`changed: ${key}`);
 
-        await gitlabApi.ProjectVariables.edit(id, fullKey, valueSanitized, {
-          filter: { environment_scope: "All (default)" },
-          masked,
-        });
-        // await updateVariable(vorpal, id, fullKey, valueSanitized, masked);
+        await updateVariable(vorpal, id, fullKey, valueSanitized, masked);
         // write backup
         if (backup) {
-          await gitlabApi.ProjectVariables.create(
+          await createVariable(
+            vorpal,
             id,
             getBackupKey(fullKey, new Date().getTime()),
             oldValue,
-            {
-              environmentScope: "_backup",
-              masked,
-            },
+            masked,
+            "_backup",
           );
         }
       } else {
         vorpal.log(`new    : ${key}`);
-        await gitlabApi.ProjectVariables.create(id, fullKey, valueSanitized, {
-          environmentScope: "All (default)",
-          masked,
-        });
-        // await createVariable(vorpal, id, fullKey, valueSanitized, masked);
+        await createVariable(vorpal, id, fullKey, valueSanitized, masked);
       }
     } else {
       vorpal.log(`skip   : ${key}`);

package/src/utils/preferences/index.ts

@@ -0,0 +1,36 @@
+import { createFile, pathExists, readFile, writeFile } from "fs-extra";
+import { homedir } from "os";
+
+import { parse, stringify } from "yaml";
+const directory = `${homedir()}/.catladder`;
+const file = `${directory}/preferences.yml`;
+
+const getPreferences = async () => {
+  if (!(await pathExists(file))) {
+    await createFile(file);
+  }
+  return (parse(await readFile(file, { encoding: "utf-8" })) ?? {}) as Record<
+    string,
+    string
+  >;
+};
+
+export const hasPreference = async (key: string) => {
+  const preferences = await getPreferences();
+  return key in preferences;
+};
+export const getPreference = async (key: string) => {
+  const preferences = await getPreferences();
+  return preferences[key];
+};
+
+export const setPreference = async (key: string, value: string | number) => {
+  const preferences = await getPreferences();
+
+  const newPreferences = {
+    ...preferences,
+    [key]: value,
+  };
+
+  await writeFile(file, stringify(newPreferences));
+};

package/dist/cli/src/apps/cli/commands/project/commandMigrateHelm3.d.ts

@@ -1,7 +0,0 @@
-import type Vorpal from "vorpal";
-/**
- * Error: rendered manifests contain a resource that already exists.
- * Unable to continue with install: ConfigMap "web-app-env" in namespace "pvl-bike2school-dev" exists and cannot be imported into the current release: invalid ownership metadata; label validation error: missing key "app.kubernetes.io/managed-by": must be set to "Helm"; annotation validation error: missing key "meta.helm.sh/release-name": must be set to "pvl-bike2school-dev-web"; annotation validation error: missing key "meta.helm.sh/release-namespace": must be set to "pvl-bike2school-dev"
- */
-declare const _default: (vorpal: Vorpal) => Promise<Vorpal.Command>;
-export default _default;