@catladder/cli 0.0.0-refactor-untangle-gitlab-api-requests-from-vorpal-c65e5318 → 0.0.0-refactor-untangle-gitlab-api-requests-from-vorpal-57cf3cf2

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "0.0.0-refactor-untangle-gitlab-api-requests-from-vorpal-c65e5318",
+  "version": "0.0.0-refactor-untangle-gitlab-api-requests-from-vorpal-57cf3cf2",
   "scripts": {
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",

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

@@ -4,12 +4,11 @@ import open from "open";
 import type { CommandInstance } from "vorpal";
 import type Vorpal from "vorpal";
 import type { GitLabApiDataOptional } from "../../../../utils/gitlab-without-vorpal";
-import { getGitLabHostPathToken } from "../../../../utils/gitlab-without-vorpal";
 import {
-  doGitlabRequest,
-  getGitlabToken,
-  getProjectInfo,
-} from "../../../../utils/gitlab";
+  getGitLabHostPathToken,
+  getGitLabProjectId,
+} from "../../../../utils/gitlab-without-vorpal";
+import { doGitlabRequest, getGitlabToken } from "../../../../utils/gitlab";
 
 const statusEmojiMap: any = {
   failed: "🙀",
@@ -84,7 +83,10 @@ const promptJob = async (
 
 const commandGitlabCi = async (
   vorpal: Vorpal,
-  existing: GitLabApiDataOptional = {},
+  {
+    projectId,
+    ...existing
+  }: GitLabApiDataOptional & { projectId?: number | string } = {},
 ) => {
   vorpal.command("project-ci-job-open", "Open a Job").action(async function () {
     const {
@@ -93,9 +95,10 @@ const commandGitlabCi = async (
       token: inputToken,
     } = await getGitLabHostPathToken(existing, vorpal);
     const token = inputToken || (await getGitlabToken(this, host));
-    const { id: projectId } = await getProjectInfo(this, { host, path, token });
+    const id =
+      projectId || (await getGitLabProjectId({ host, path, token }, vorpal));
 
-    const job = await promptJob(this, projectId, this, { host, path, token });
+    const job = await promptJob(this, id, this, { host, path, token });
     open(job.web_url);
   });
 
@@ -109,18 +112,19 @@ const commandGitlabCi = async (
       } = await getGitLabHostPathToken(existing, vorpal);
       const token = inputToken || (await getGitlabToken(this, host));
       const apiData = { host, path, token };
-      const { id: projectId } = await getProjectInfo(this, apiData);
+      const pId =
+        projectId || (await getGitLabProjectId({ host, path, token }, vorpal));
 
-      const { id } = await promptJob(this, projectId, this, apiData);
+      const { id } = await promptJob(this, pId, this, apiData);
 
       let finished = false;
       while (!finished) {
         const trace = await exec(
-          `curl -s --header "PRIVATE-TOKEN: ${token}" "https://git.panter.ch/api/v4/projects/${projectId}/jobs/${id}/trace"`,
+          `curl -s --header "PRIVATE-TOKEN: ${token}" "https://git.panter.ch/api/v4/projects/${pId}/jobs/${id}/trace"`,
         );
 
         const job = await doGitlabRequest(this, {
-          path: `projects/${projectId}/jobs/${id}`,
+          path: `projects/${pId}/jobs/${id}`,
           host,
           token,
         });

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

@@ -6,14 +6,18 @@ import {
   type GitLabApiDataOptional,
   gitLabVariable,
   FetchGitLabError,
+  getGitLabProjectId,
 } from "../../../../../utils/gitlab-without-vorpal";
-import { getGitlabToken, getProjectInfo } from "../../../../../utils/gitlab";
+import { getGitlabToken } from "../../../../../utils/gitlab";
 
 const TOKEN_NAME = "semantic-release";
 
 export const setupAccessTokens = async (
   vorpal: CommandInstance,
-  existing: GitLabApiDataOptional = {},
+  {
+    projectId,
+    ...existing
+  }: GitLabApiDataOptional & { projectId?: number | string } = {},
 ) => {
   const {
     host,
@@ -21,10 +25,11 @@ export const setupAccessTokens = async (
     token: inputToken,
   } = await getGitLabHostPathToken(existing, vorpal);
   const token = inputToken || (await getGitlabToken(vorpal, host));
-  const { id: projectId } = await getProjectInfo(vorpal, { host, path, token });
+  const id =
+    projectId || (await getGitLabProjectId({ host, path, token }, vorpal));
 
   const projectTokens = await gitLabProjectAccessToken.getList(
-    { projectId, token, host },
+    { projectId: id, token, host },
     vorpal,
   );
   const accessToken = projectTokens.find(
@@ -36,7 +41,7 @@ export const setupAccessTokens = async (
   const newToken = accessToken
     ? await gitLabProjectAccessToken.rotate(
         {
-          projectId,
+          projectId: id,
           tokenId: accessToken.id,
           token,
           host,
@@ -46,7 +51,7 @@ export const setupAccessTokens = async (
       )
     : await gitLabProjectAccessToken.create(
         {
-          projectId,
+          projectId: id,
           token,
           host,
           data: {
@@ -59,7 +64,7 @@ export const setupAccessTokens = async (
         vorpal,
       );
 
-  const fetchCommon = { key: "GL_TOKEN", projectId, host, token };
+  const fetchCommon = { key: "GL_TOKEN", projectId: id, host, token };
   try {
     await gitLabVariable.get(fetchCommon, vorpal);
     await gitLabVariable.update(

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

@@ -8,11 +8,13 @@ import {
 } from "@catladder/pipeline";
 import ensureNamespace from "../utils/ensureNamespace";
 import type { GitLabApiDataOptional } from "../../../../../utils/gitlab-without-vorpal";
-import { getGitLabHostPathToken } from "../../../../../utils/gitlab-without-vorpal";
+import {
+  getGitLabHostPathToken,
+  getGitLabProjectId,
+} from "../../../../../utils/gitlab-without-vorpal";
 import {
   doGitlabRequest,
   getGitlabToken,
-  getProjectInfo,
   upsertAllVariables,
 } from "../../../../../utils/gitlab";
 import { connectToCluster } from "../../../../../utils/cluster";
@@ -20,7 +22,10 @@ import { connectToCluster } from "../../../../../utils/cluster";
 export const setupKubernetes = async (
   vorpal: CommandInstance,
   context: ComponentContext,
-  existing: GitLabApiDataOptional = {},
+  {
+    projectId,
+    ...existing
+  }: GitLabApiDataOptional & { projectId?: number | string } = {},
 ) => {
   const deployConfig = context.deploy?.config;
   if (!isOfDeployType(deployConfig, "kubernetes")) {
@@ -32,11 +37,11 @@ export const setupKubernetes = async (
     token: inputToken,
   } = await getGitLabHostPathToken(existing, vorpal);
   const token = inputToken || (await getGitlabToken(vorpal, host));
-  const requestInfo = { host, path, token };
-
-  const { id: projectId } = await getProjectInfo(vorpal, requestInfo);
+  const id =
+    projectId || (await getGitLabProjectId({ host, path, token }, vorpal));
+  const requestInfo = { host, path, token, projectId: id };
   const deploy_tokens = await doGitlabRequest(vorpal, {
-    path: `projects/${projectId}/deploy_tokens`,
+    path: `projects/${id}/deploy_tokens`,
     host,
     token,
   });
@@ -51,9 +56,9 @@ export const setupKubernetes = async (
     );
 
     await doGitlabRequest(vorpal, {
-      path: `projects/${projectId}/deploy_tokens`,
+      path: `projects/${id}/deploy_tokens`,
       data: {
-        id: projectId,
+        id,
         name: "gitlab-deploy-token",
         scopes: ["read_registry"],
       },

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

@@ -1,4 +1,5 @@
 import type { LoggerCmdInstance } from "../log";
+import { getPreferences, upsertPreferences } from "../preferences";
 import { fetchGitLabApi } from "./fetchGitLabApi";
 import { getGitLabHostPathToken } from "./getGitlabHostPathToken";
 import type { GitLabApiDataOptional } from "./GitLabApiDataOptional";
@@ -37,3 +38,20 @@ export const gitLabProjectByGitPath = async (
     logger,
   );
 };
+
+export const getGitLabProjectId = async (
+  existing: GitLabApiDataOptional = {},
+  logger: LoggerCmdInstance = console,
+) => {
+  const [preferences, { host, path, token }] = await Promise.all([
+    getPreferences(logger),
+    getGitLabHostPathToken(existing, logger),
+  ]);
+  const hostPathKey = `${host}/${path}`;
+  if (preferences.gitLabProjectIds[hostPathKey]) {
+    return preferences.gitLabProjectIds[hostPathKey];
+  }
+  const project = await gitLabProjectByGitPath({ token, host, path }, logger);
+  await upsertPreferences({ gitLabProjectIds: { [hostPathKey]: project.id } });
+  return project.id;
+};

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

@@ -5,7 +5,7 @@ import type { LoggerCmdInstance } from "../log";
 import { fetchGitLabApi } from "./fetchGitLabApi";
 import type { GitLabApiDataOptional } from "./GitLabApiDataOptional";
 import { getGitLabHostPathToken } from "./getGitlabHostPathToken";
-import { gitLabProjectByGitPath } from "./gitLabProjectByGitPath";
+import { getGitLabProjectId } from "./gitLabProjectByGitPath";
 import { GitLabTokenMissingError } from "./GitLabTokenMissingError";
 
 /**
@@ -191,9 +191,8 @@ const getAllVariables = memoizee(
     if (!token?.length) {
       throw new GitLabTokenMissingError();
     }
-    const { id } = projectId
-      ? { id: projectId }
-      : await gitLabProjectByGitPath({ host, path, token }, logger);
+    const id =
+      projectId || (await getGitLabProjectId({ host, path, token }, logger));
 
     let all: GitlabVariable[] = [];
     let result: GitlabVariable[][] = [];
@@ -234,9 +233,8 @@ const getAllCatladderEnvVars = async ({
   if (!token?.length) {
     throw new GitLabTokenMissingError();
   }
-  const { id } = projectId
-    ? { id: projectId }
-    : await gitLabProjectByGitPath({ host, path, token }, logger);
+  const id =
+    projectId || (await getGitLabProjectId({ host, path, token }, logger));
 
   const fetchResults = await gitLabVariable.getAll({
     projectId: id,

package/src/utils/gitlab.ts

@@ -4,7 +4,7 @@ import type { CommandInstance } from "vorpal";
 
 import { getSecretVarName } from "@catladder/pipeline";
 import { getGitRemoteHost } from "../git/gitProjectInformation";
-import { logError, logNotice, logLines, LoggerCmdInstance } from "./log";
+import { logError, logNotice, logLines } from "./log";
 import {
   type FetchMethod,
   type GitLabApiDataOptional,
@@ -14,7 +14,7 @@ import {
   storeGitLabToken,
   gitLabVariable,
   getGitLabHostPathToken,
-  gitLabProjectByGitPath,
+  getGitLabProjectId,
 } from "./gitlab-without-vorpal";
 
 export const setupGitlabToken = async (
@@ -99,23 +99,13 @@ export const doGitlabRequest = async <T = any>(
   },
 ): Promise<T> => fetchGitLabApi<T>({ resourcePath, ...args }, vorpal);
 
-export const getProjectInfo = async (
-  vorpal: CommandInstance | null,
-  existing: GitLabApiDataOptional = {},
-) => {
-  const {
-    host,
-    path,
-    token: inputToken,
-  } = await getGitLabHostPathToken(existing, vorpal);
-  const token = inputToken || (await getGitlabToken(vorpal, host));
-  return gitLabProjectByGitPath({ host, path, token }, vorpal);
-};
-
 export const getVariableValueByRawName = async (
   vorpal: CommandInstance,
   rawName: string,
-  existing: GitLabApiDataOptional = {},
+  {
+    projectId,
+    ...existing
+  }: GitLabApiDataOptional & { projectId?: number | string } = {},
 ) => {
   const {
     host,
@@ -123,13 +113,14 @@ export const getVariableValueByRawName = async (
     token: inputToken,
   } = await getGitLabHostPathToken(existing, vorpal);
   const token = inputToken || (await getGitlabToken(vorpal, host));
-  const { id: projectId } = await getProjectInfo(vorpal, { host, path, token });
+  const id =
+    projectId || (await getGitLabProjectId({ host, path, token }, vorpal));
   const allVariables = await gitLabVariable.getAll({
     logger: vorpal,
     host,
     path,
     token,
-    projectId,
+    projectId: id,
   });
   return allVariables.find((v) => v.key === rawName)?.value;
 };
@@ -147,12 +138,14 @@ const getAllCatladderEnvVarsInGitlab = async (
     token: inputToken,
   } = await getGitLabHostPathToken(existing, vorpal);
   const token = inputToken || (await getGitlabToken(vorpal, host));
+  const id =
+    projectId || (await getGitLabProjectId({ host, path, token }, vorpal));
   return gitLabVariable.getAllCatladder({
     logger: vorpal,
     host,
     path,
     token,
-    projectId,
+    projectId: id,
   });
 };
 
@@ -170,7 +163,7 @@ export const clearBackups = async (
     token: inputToken,
   } = await getGitLabHostPathToken(existing, vorpal);
   const token = inputToken || (await getGitlabToken(vorpal, host));
-  const { id } = await getProjectInfo(vorpal, { host, path, token });
+  const id = await getGitLabProjectId({ host, path, token }, vorpal);
 
   const existingVariables = await getAllCatladderEnvVarsInGitlab(vorpal, {
     projectId: id,
@@ -199,7 +192,10 @@ export const upsertAllVariables = async (
   componentName: string,
   backup = true,
   masked = true, // FIXME: would be better to have this per variable
-  existing: GitLabApiDataOptional = {},
+  {
+    projectId,
+    ...existing
+  }: GitLabApiDataOptional & { projectId?: number | string } = {},
 ): Promise<void> => {
   const {
     host,
@@ -207,7 +203,8 @@ export const upsertAllVariables = async (
     token: inputToken,
   } = await getGitLabHostPathToken(existing, vorpal);
   const token = inputToken || (await getGitlabToken(vorpal, host));
-  const { id } = await getProjectInfo(vorpal, { host, path, token });
+  const id =
+    projectId || (await getGitLabProjectId({ host, path, token }, vorpal));
 
   // we list all existing variables. We also gather backup versions, but its currently unused
   const existingVariables = await getAllCatladderEnvVarsInGitlab(vorpal, {

package/src/utils/preferences/CatladderPreferences.ts

@@ -1,11 +1,13 @@
 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 = {
@@ -18,12 +20,14 @@ export type CatladderPreferences = {
    * 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]: {},
 };
 
 /**