fix: encode repoid in release URL returned by publish

Author: pvdlg

lib/publish.js

@@ -7,21 +7,22 @@ const getRepoId = require('./get-repo-id');
 module.exports = async (pluginConfig, {options: {repositoryUrl}, nextRelease: {gitTag, gitHead, notes}, logger}) => {
   const {gitlabToken, gitlabUrl, gitlabApiPathPrefix} = resolveConfig(pluginConfig);
   const repoId = getRepoId(gitlabUrl, repositoryUrl);
+  const encodedRepoId = encodeURIComponent(repoId);
   const apiUrl = urlJoin(gitlabUrl, gitlabApiPathPrefix);
-  const gitTagEncoded = encodeURIComponent(gitTag);
+  const encodedGitTag = encodeURIComponent(gitTag);
 
   debug('repoId: %o', repoId);
   debug('release name: %o', gitTag);
   debug('release ref: %o', gitHead);
 
   debug('Update git tag %o with commit %o and release description', gitTag, gitHead);
-  await got.post(urlJoin(apiUrl, `/projects/${encodeURIComponent(repoId)}/repository/tags/${gitTagEncoded}/release`), {
+  await got.post(urlJoin(apiUrl, `/projects/${encodedRepoId}/repository/tags/${encodedGitTag}/release`), {
     json: true,
     headers: {'PRIVATE-TOKEN': gitlabToken},
     body: {tag_name: gitTag, description: notes}, // eslint-disable-line camelcase
   });
 
   logger.log('Published GitLab release: %s', gitTag);
 
-  return {url: urlJoin(gitlabUrl, repoId, `/tags/${gitTagEncoded}`), name: 'GitHub release'};
+  return {url: urlJoin(gitlabUrl, encodedRepoId, `/tags/${encodedGitTag}`), name: 'GitHub release'};
 };

test/integration.test.js

@@ -71,19 +71,20 @@ test.serial('Publish a release', async t => {
   process.env.GL_TOKEN = 'gitlab_token';
   const nextRelease = {gitHead: '123', gitTag: 'v1.0.0', notes: 'Test release note body'};
   const options = {branch: 'master', repositoryUrl: `https://gitlab.com/${owner}/${repo}.git`};
+  const encodedRepoId = encodeURIComponent(`${owner}/${repo}`);
 
   const gitlab = authenticate()
-    .get(`/projects/${owner}%2F${repo}`)
+    .get(`/projects/${encodedRepoId}`)
     .reply(200, {permissions: {project_access: {access_level: 30}}})
-    .post(`/projects/${owner}%2F${repo}/repository/tags/${nextRelease.gitTag}/release`, {
+    .post(`/projects/${encodedRepoId}/repository/tags/${nextRelease.gitTag}/release`, {
       tag_name: nextRelease.gitTag,
       description: nextRelease.notes,
     })
     .reply(200);
 
   const result = await t.context.m.publish({}, {nextRelease, options, logger: t.context.logger});
 
-  t.is(result.url, `https://gitlab.com/${owner}/${repo}/tags/${nextRelease.gitTag}`);
+  t.is(result.url, `https://gitlab.com/${encodedRepoId}/tags/${nextRelease.gitTag}`);
   t.deepEqual(t.context.log.args[0], ['Verify GitLab authentication (%s)', 'https://gitlab.com/api/v4']);
   t.deepEqual(t.context.log.args[1], ['Published GitLab release: %s', nextRelease.gitTag]);
   t.true(gitlab.isDone());
@@ -94,12 +95,13 @@ test.serial('Verify Github auth and release', async t => {
   const owner = 'test_user';
   const repo = 'test_repo';
   const options = {repositoryUrl: `https://github.com/${owner}/${repo}.git`};
+  const encodedRepoId = encodeURIComponent(`${owner}/${repo}`);
   const nextRelease = {gitHead: '123', gitTag: 'v1.0.0', notes: 'Test release note body'};
 
   const gitlab = authenticate()
-    .get(`/projects/${owner}%2F${repo}`)
+    .get(`/projects/${encodedRepoId}`)
     .reply(200, {permissions: {project_access: {access_level: 30}}})
-    .post(`/projects/${owner}%2F${repo}/repository/tags/${nextRelease.gitTag}/release`, {
+    .post(`/projects/${encodedRepoId}/repository/tags/${nextRelease.gitTag}/release`, {
       tag_name: nextRelease.gitTag,
       description: nextRelease.notes,
     })
@@ -108,7 +110,7 @@ test.serial('Verify Github auth and release', async t => {
   await t.notThrows(t.context.m.verifyConditions({}, {options, logger: t.context.logger}));
   const result = await t.context.m.publish({}, {nextRelease, options, logger: t.context.logger});
 
-  t.is(result.url, `https://gitlab.com/${owner}/${repo}/tags/${nextRelease.gitTag}`);
+  t.is(result.url, `https://gitlab.com/${encodedRepoId}/tags/${nextRelease.gitTag}`);
   t.deepEqual(t.context.log.args[0], ['Verify GitLab authentication (%s)', 'https://gitlab.com/api/v4']);
   t.deepEqual(t.context.log.args[1], ['Published GitLab release: %s', nextRelease.gitTag]);
   t.true(gitlab.isDone());

test/publish.test.js

@@ -37,18 +37,19 @@ test.serial('Publish a release', async t => {
   const pluginConfig = {};
   const nextRelease = {gitHead: '123', gitTag: '@scope/v1.0.0', notes: 'Test release note body'};
   const options = {repositoryUrl: `https://gitlab.com/${owner}/${repo}.git`};
-  const gitTagEncoded = encodeURIComponent(nextRelease.gitTag);
+  const encodedRepoId = encodeURIComponent(`${owner}/${repo}`);
+  const encodedGitTag = encodeURIComponent(nextRelease.gitTag);
 
   const gitlab = authenticate()
-    .post(`/projects/${owner}%2F${repo}/repository/tags/${gitTagEncoded}/release`, {
+    .post(`/projects/${encodedRepoId}/repository/tags/${encodedGitTag}/release`, {
       tag_name: nextRelease.gitTag,
       description: nextRelease.notes,
     })
     .reply(200);
 
   const result = await publish(pluginConfig, {options, nextRelease, logger: t.context.logger});
 
-  t.is(result.url, `https://gitlab.com/${owner}/${repo}/tags/${gitTagEncoded}`);
+  t.is(result.url, `https://gitlab.com/${encodedRepoId}/tags/${encodedGitTag}`);
   t.deepEqual(t.context.log.args[0], ['Published GitLab release: %s', nextRelease.gitTag]);
   t.true(gitlab.isDone());
 });