refactor: introduce getProjectContext abstraction

Author: fgreinacher

lib/fail.js

@@ -4,8 +4,8 @@ import got from "got";
 import _debug from "debug";
 const debug = _debug("semantic-release:gitlab");
 import resolveConfig from "./resolve-config.js";
-import getProjectPath from "./get-project-path.js";
 import getFailComment from "./get-fail-comment.js";
+import getProjectContext from "./get-project-context.js";
 
 export default async (pluginConfig, context) => {
   const {
@@ -25,9 +25,8 @@ export default async (pluginConfig, context) => {
     assignee,
     retryLimit,
   } = resolveConfig(pluginConfig, context);
-  const projectPath = getProjectPath(context, gitlabUrl, repositoryUrl);
-  const encodedProjectPath = encodeURIComponent(projectPath);
-  const projectApiUrl = urlJoin(gitlabApiUrl, `/projects/${encodedProjectPath}`);
+  const { encodedProjectPath, projectApiUrl } = getProjectContext(context, gitlabUrl, gitlabApiUrl, repositoryUrl);
+
   const apiOptions = {
     headers: { "PRIVATE-TOKEN": gitlabToken },
     retry: { limit: retryLimit },

lib/get-project-context.js

@@ -0,0 +1,14 @@
+import urlJoin from "url-join";
+
+import getProjectPath from "./get-project-path.js";
+
+export default (context, gitlabUrl, gitlabApiUrl, repositoryUrl) => {
+  const projectPath = getProjectPath(context, gitlabUrl, repositoryUrl);
+  const encodedProjectPath = encodeURIComponent(projectPath);
+  const projectApiUrl = urlJoin(gitlabApiUrl, `/projects/${encodedProjectPath}`);
+  return {
+    projectPath,
+    encodedProjectPath,
+    projectApiUrl,
+  };
+};

lib/publish.js

@@ -9,9 +9,9 @@ import got from "got";
 import _debug from "debug";
 const debug = _debug("semantic-release:gitlab");
 import resolveConfig from "./resolve-config.js";
-import getProjectPath from "./get-project-path.js";
 import getAssets from "./glob-assets.js";
 import { RELEASE_NAME } from "./definitions/constants.js";
+import getProjectContext from "./get-project-context.js";
 
 const isUrlScheme = (value) => /^(https|http|ftp):\/\//.test(value);
 
@@ -27,9 +27,8 @@ export default async (pluginConfig, context) => {
     context
   );
   const assetsList = [];
-  const projectPath = getProjectPath(context, gitlabUrl, repositoryUrl);
-  const encodedProjectPath = encodeURIComponent(projectPath);
-  const projectApiUrl = urlJoin(gitlabApiUrl, `/projects/${encodedProjectPath}`);
+  const { projectPath, projectApiUrl } = getProjectContext(context, gitlabUrl, gitlabApiUrl, repositoryUrl);
+
   const encodedGitTag = encodeURIComponent(gitTag);
   const encodedVersion = encodeURIComponent(version);
   const apiOptions = {
@@ -131,10 +130,7 @@ export default async (pluginConfig, context) => {
             }
 
             // https://docs.gitlab.com/ee/user/packages/generic_packages/#download-package-file
-            const url = urlJoin(
-              projectApiUrl,
-              `packages/generic/release/${encodedVersion}/${encodedLabel}`
-            );
+            const url = urlJoin(projectApiUrl, `packages/generic/release/${encodedVersion}/${encodedLabel}`);
 
             assetsList.push({ label, alt: "release", url, type: "package", filepath });
 

lib/success.js

@@ -4,7 +4,7 @@ import got from "got";
 import _debug from "debug";
 const debug = _debug("semantic-release:gitlab");
 import resolveConfig from "./resolve-config.js";
-import getProjectPath from "./get-project-path.js";
+import getProjectContext from "./get-project-context.js";
 import getSuccessComment from "./get-success-comment.js";
 
 export default async (pluginConfig, context) => {
@@ -17,9 +17,7 @@ export default async (pluginConfig, context) => {
   } = context;
   const { gitlabToken, gitlabUrl, gitlabApiUrl, successComment, successCommentCondition, proxy, retryLimit } =
     resolveConfig(pluginConfig, context);
-  const projectPath = getProjectPath(context, gitlabUrl, repositoryUrl);
-  const encodedProjectPath = encodeURIComponent(projectPath);
-  const projectApiUrl = urlJoin(gitlabApiUrl, `/projects/${encodedProjectPath}`);
+  const { projectApiUrl } = getProjectContext(context, gitlabUrl, gitlabApiUrl, repositoryUrl);
   const apiOptions = {
     headers: { "PRIVATE-TOKEN": gitlabToken },
     retry: { limit: retryLimit },
@@ -78,10 +76,7 @@ Using 'false' for 'successComment' is deprecated and will be removed in a future
       };
 
       const getRelatedMergeRequests = async (commitHash) => {
-        const relatedMergeRequestsEndpoint = urlJoin(
-          projectApiUrl,
-          `repository/commits/${commitHash}/merge_requests`
-        );
+        const relatedMergeRequestsEndpoint = urlJoin(projectApiUrl, `repository/commits/${commitHash}/merge_requests`);
         debug("Getting MRs from %s", relatedMergeRequestsEndpoint);
         const relatedMergeRequests = await got
           .get(relatedMergeRequestsEndpoint, {

lib/verify.js

@@ -1,11 +1,10 @@
 import { isString, isPlainObject, isNil, isArray } from "lodash-es";
-import urlJoin from "url-join";
 import got from "got";
 import _debug from "debug";
 const debug = _debug("semantic-release:gitlab");
 import AggregateError from "aggregate-error";
 import resolveConfig from "./resolve-config.js";
-import getProjectPath from "./get-project-path.js";
+import getProjectContext from "./get-project-context.js";
 import getError from "./get-error.js";
 
 const isNonEmptyString = (value) => isString(value) && value.trim();
@@ -32,7 +31,7 @@ export default async (pluginConfig, context) => {
     logger,
   } = context;
   const { gitlabToken, gitlabUrl, gitlabApiUrl, proxy, ...options } = resolveConfig(pluginConfig, context);
-  const projectPath = getProjectPath(context, gitlabUrl, repositoryUrl);
+  const { projectPath, projectApiUrl } = getProjectContext(context, gitlabUrl, gitlabApiUrl, repositoryUrl);
 
   debug("apiUrl: %o", gitlabApiUrl);
   debug("projectPath: %o", projectPath);
@@ -64,7 +63,7 @@ export default async (pluginConfig, context) => {
       ({
         permissions: { project_access: projectAccess, group_access: groupAccess },
       } = await got
-        .get(urlJoin(gitlabApiUrl, `/projects/${encodeURIComponent(projectPath)}`), {
+        .get(projectApiUrl, {
           headers: { "PRIVATE-TOKEN": gitlabToken },
           ...proxy,
         })