@backstage/integration 1.14.0 → 1.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,41 @@
1
1
  # @backstage/integration
2
2
 
3
+ ## 1.15.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 1573014: The Gerrit integration can now resolve Gitiles urls that point to the following
8
+ refs:
9
+
10
+ - HEAD
11
+ - A SHA
12
+ - Tag
13
+ - Branch
14
+
15
+ ### Patch Changes
16
+
17
+ - Updated dependencies
18
+ - @backstage/config@1.2.0
19
+ - @backstage/errors@1.2.4
20
+
21
+ ## 1.15.0-next.0
22
+
23
+ ### Minor Changes
24
+
25
+ - 1573014: The Gerrit integration can now resolve Gitiles urls that point to the following
26
+ refs:
27
+
28
+ - HEAD
29
+ - A SHA
30
+ - Tag
31
+ - Branch
32
+
33
+ ### Patch Changes
34
+
35
+ - Updated dependencies
36
+ - @backstage/config@1.2.0
37
+ - @backstage/errors@1.2.4
38
+
3
39
  ## 1.14.0
4
40
 
5
41
  ### Minor Changes
@@ -1,6 +1,6 @@
1
1
  import { basicIntegrations } from '../helpers.esm.js';
2
2
  import { readGerritIntegrationConfigs } from './config.esm.js';
3
- import { parseGerritGitilesUrl, buildGerritGitilesUrl } from './core.esm.js';
3
+ import { parseGitilesUrlRef } from './core.esm.js';
4
4
 
5
5
  class GerritIntegration {
6
6
  constructor(integrationConfig) {
@@ -28,8 +28,8 @@ class GerritIntegration {
28
28
  const { url, base, lineNumber } = options;
29
29
  let updated;
30
30
  if (url.startsWith("/")) {
31
- const { branch, project } = parseGerritGitilesUrl(this.config, base);
32
- return buildGerritGitilesUrl(this.config, project, branch, url);
31
+ const { basePath } = parseGitilesUrlRef(this.config, base);
32
+ return basePath + url;
33
33
  }
34
34
  if (url) {
35
35
  updated = new URL(url, base);
@@ -1 +1 @@
1
- {"version":3,"file":"GerritIntegration.esm.js","sources":["../../src/gerrit/GerritIntegration.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { basicIntegrations } from '../helpers';\nimport { ScmIntegration, ScmIntegrationsFactory } from '../types';\nimport {\n GerritIntegrationConfig,\n readGerritIntegrationConfigs,\n} from './config';\nimport { parseGerritGitilesUrl, buildGerritGitilesUrl } from './core';\n\n/**\n * A Gerrit based integration.\n *\n * @public\n */\nexport class GerritIntegration implements ScmIntegration {\n static factory: ScmIntegrationsFactory<GerritIntegration> = ({ config }) => {\n const configs = readGerritIntegrationConfigs(\n config.getOptionalConfigArray('integrations.gerrit') ?? [],\n );\n return basicIntegrations(\n configs.map(c => new GerritIntegration(c)),\n i => i.config.host,\n );\n };\n\n constructor(private readonly integrationConfig: GerritIntegrationConfig) {}\n\n get type(): string {\n return 'gerrit';\n }\n\n get title(): string {\n return this.integrationConfig.host;\n }\n\n get config(): GerritIntegrationConfig {\n return this.integrationConfig;\n }\n\n resolveUrl(options: {\n url: string;\n base: string;\n lineNumber?: number;\n }): string {\n const { url, base, lineNumber } = options;\n let updated;\n if (url.startsWith('/')) {\n const { branch, project } = parseGerritGitilesUrl(this.config, base);\n return buildGerritGitilesUrl(this.config, project, branch, url);\n }\n if (url) {\n updated = new URL(url, base);\n } else {\n updated = new URL(base);\n }\n if (lineNumber) {\n updated.hash = lineNumber.toString();\n }\n return updated.toString();\n }\n\n resolveEditUrl(url: string): string {\n // Not applicable for gerrit.\n return url;\n }\n}\n"],"names":[],"mappings":";;;;AA6BO,MAAM,iBAA4C,CAAA;AAAA,EAWvD,YAA6B,iBAA4C,EAAA;AAA5C,IAAA,IAAA,CAAA,iBAAA,GAAA,iBAAA,CAAA;AAAA,GAA6C;AAAA,EAV1E,OAAO,OAAA,GAAqD,CAAC,EAAE,QAAa,KAAA;AAC1E,IAAA,MAAM,OAAU,GAAA,4BAAA;AAAA,MACd,MAAO,CAAA,sBAAA,CAAuB,qBAAqB,CAAA,IAAK,EAAC;AAAA,KAC3D,CAAA;AACA,IAAO,OAAA,iBAAA;AAAA,MACL,QAAQ,GAAI,CAAA,CAAA,CAAA,KAAK,IAAI,iBAAA,CAAkB,CAAC,CAAC,CAAA;AAAA,MACzC,CAAA,CAAA,KAAK,EAAE,MAAO,CAAA,IAAA;AAAA,KAChB,CAAA;AAAA,GACF,CAAA;AAAA,EAIA,IAAI,IAAe,GAAA;AACjB,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AAAA,EAEA,IAAI,KAAgB,GAAA;AAClB,IAAA,OAAO,KAAK,iBAAkB,CAAA,IAAA,CAAA;AAAA,GAChC;AAAA,EAEA,IAAI,MAAkC,GAAA;AACpC,IAAA,OAAO,IAAK,CAAA,iBAAA,CAAA;AAAA,GACd;AAAA,EAEA,WAAW,OAIA,EAAA;AACT,IAAA,MAAM,EAAE,GAAA,EAAK,IAAM,EAAA,UAAA,EAAe,GAAA,OAAA,CAAA;AAClC,IAAI,IAAA,OAAA,CAAA;AACJ,IAAI,IAAA,GAAA,CAAI,UAAW,CAAA,GAAG,CAAG,EAAA;AACvB,MAAA,MAAM,EAAE,MAAQ,EAAA,OAAA,KAAY,qBAAsB,CAAA,IAAA,CAAK,QAAQ,IAAI,CAAA,CAAA;AACnE,MAAA,OAAO,qBAAsB,CAAA,IAAA,CAAK,MAAQ,EAAA,OAAA,EAAS,QAAQ,GAAG,CAAA,CAAA;AAAA,KAChE;AACA,IAAA,IAAI,GAAK,EAAA;AACP,MAAU,OAAA,GAAA,IAAI,GAAI,CAAA,GAAA,EAAK,IAAI,CAAA,CAAA;AAAA,KACtB,MAAA;AACL,MAAU,OAAA,GAAA,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,KACxB;AACA,IAAA,IAAI,UAAY,EAAA;AACd,MAAQ,OAAA,CAAA,IAAA,GAAO,WAAW,QAAS,EAAA,CAAA;AAAA,KACrC;AACA,IAAA,OAAO,QAAQ,QAAS,EAAA,CAAA;AAAA,GAC1B;AAAA,EAEA,eAAe,GAAqB,EAAA;AAElC,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AACF;;;;"}
1
+ {"version":3,"file":"GerritIntegration.esm.js","sources":["../../src/gerrit/GerritIntegration.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { basicIntegrations } from '../helpers';\nimport { ScmIntegration, ScmIntegrationsFactory } from '../types';\nimport {\n GerritIntegrationConfig,\n readGerritIntegrationConfigs,\n} from './config';\nimport { parseGitilesUrlRef } from './core';\n\n/**\n * A Gerrit based integration.\n *\n * @public\n */\nexport class GerritIntegration implements ScmIntegration {\n static factory: ScmIntegrationsFactory<GerritIntegration> = ({ config }) => {\n const configs = readGerritIntegrationConfigs(\n config.getOptionalConfigArray('integrations.gerrit') ?? [],\n );\n return basicIntegrations(\n configs.map(c => new GerritIntegration(c)),\n i => i.config.host,\n );\n };\n\n constructor(private readonly integrationConfig: GerritIntegrationConfig) {}\n\n get type(): string {\n return 'gerrit';\n }\n\n get title(): string {\n return this.integrationConfig.host;\n }\n\n get config(): GerritIntegrationConfig {\n return this.integrationConfig;\n }\n\n resolveUrl(options: {\n url: string;\n base: string;\n lineNumber?: number;\n }): string {\n const { url, base, lineNumber } = options;\n let updated;\n if (url.startsWith('/')) {\n const { basePath } = parseGitilesUrlRef(this.config, base);\n return basePath + url;\n }\n if (url) {\n updated = new URL(url, base);\n } else {\n updated = new URL(base);\n }\n if (lineNumber) {\n updated.hash = lineNumber.toString();\n }\n return updated.toString();\n }\n\n resolveEditUrl(url: string): string {\n // Not applicable for gerrit.\n return url;\n }\n}\n"],"names":[],"mappings":";;;;AA6BO,MAAM,iBAA4C,CAAA;AAAA,EAWvD,YAA6B,iBAA4C,EAAA;AAA5C,IAAA,IAAA,CAAA,iBAAA,GAAA,iBAAA,CAAA;AAAA,GAA6C;AAAA,EAV1E,OAAO,OAAA,GAAqD,CAAC,EAAE,QAAa,KAAA;AAC1E,IAAA,MAAM,OAAU,GAAA,4BAAA;AAAA,MACd,MAAO,CAAA,sBAAA,CAAuB,qBAAqB,CAAA,IAAK,EAAC;AAAA,KAC3D,CAAA;AACA,IAAO,OAAA,iBAAA;AAAA,MACL,QAAQ,GAAI,CAAA,CAAA,CAAA,KAAK,IAAI,iBAAA,CAAkB,CAAC,CAAC,CAAA;AAAA,MACzC,CAAA,CAAA,KAAK,EAAE,MAAO,CAAA,IAAA;AAAA,KAChB,CAAA;AAAA,GACF,CAAA;AAAA,EAIA,IAAI,IAAe,GAAA;AACjB,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AAAA,EAEA,IAAI,KAAgB,GAAA;AAClB,IAAA,OAAO,KAAK,iBAAkB,CAAA,IAAA,CAAA;AAAA,GAChC;AAAA,EAEA,IAAI,MAAkC,GAAA;AACpC,IAAA,OAAO,IAAK,CAAA,iBAAA,CAAA;AAAA,GACd;AAAA,EAEA,WAAW,OAIA,EAAA;AACT,IAAA,MAAM,EAAE,GAAA,EAAK,IAAM,EAAA,UAAA,EAAe,GAAA,OAAA,CAAA;AAClC,IAAI,IAAA,OAAA,CAAA;AACJ,IAAI,IAAA,GAAA,CAAI,UAAW,CAAA,GAAG,CAAG,EAAA;AACvB,MAAA,MAAM,EAAE,QAAS,EAAA,GAAI,kBAAmB,CAAA,IAAA,CAAK,QAAQ,IAAI,CAAA,CAAA;AACzD,MAAA,OAAO,QAAW,GAAA,GAAA,CAAA;AAAA,KACpB;AACA,IAAA,IAAI,GAAK,EAAA;AACP,MAAU,OAAA,GAAA,IAAI,GAAI,CAAA,GAAA,EAAK,IAAI,CAAA,CAAA;AAAA,KACtB,MAAA;AACL,MAAU,OAAA,GAAA,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,KACxB;AACA,IAAA,IAAI,UAAY,EAAA;AACd,MAAQ,OAAA,CAAA,IAAA,GAAO,WAAW,QAAS,EAAA,CAAA;AAAA,KACrC;AACA,IAAA,OAAO,QAAQ,QAAS,EAAA,CAAA;AAAA,GAC1B;AAAA,EAEA,eAAe,GAAqB,EAAA;AAElC,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AACF;;;;"}
@@ -1,4 +1,4 @@
1
- import { trimStart } from 'lodash';
1
+ import { trimStart, takeWhile, join, trimEnd } from 'lodash';
2
2
 
3
3
  const GERRIT_BODY_PREFIX = ")]}'";
4
4
  function parseGerritGitilesUrl(config, url) {
@@ -23,8 +23,69 @@ function parseGerritGitilesUrl(config, url) {
23
23
  project
24
24
  };
25
25
  }
26
- function buildGerritGitilesUrl(config, project, branch, filePath) {
27
- return `${config.gitilesBaseUrl}/${project}/+/refs/heads/${branch}/${trimStart(filePath, "/")}`;
26
+ function parseGitilesUrlRef(config, url) {
27
+ const baseUrlParse = new URL(config.gitilesBaseUrl);
28
+ const urlParse = new URL(url);
29
+ const urlPath = trimStart(
30
+ urlParse.pathname.substring(urlParse.pathname.startsWith("/a/") ? 2 : 0).replace(baseUrlParse.pathname, ""),
31
+ "/"
32
+ );
33
+ const parts = urlPath.split("/").filter((p) => !!p);
34
+ const projectParts = takeWhile(parts, (p) => p !== "+");
35
+ if (projectParts.length === 0) {
36
+ throw new Error(`Unable to parse gitiles url: ${url}`);
37
+ }
38
+ const rest = parts.slice(projectParts.length + 1);
39
+ const project = join(projectParts, "/");
40
+ if (rest.length > 0 && rest[0] === "HEAD") {
41
+ const ref = rest.shift();
42
+ const path = join(rest, "/");
43
+ return {
44
+ project,
45
+ ref,
46
+ refType: "head",
47
+ path: path || "/",
48
+ basePath: trimEnd(url.replace(path, ""), "/")
49
+ };
50
+ }
51
+ if (rest.length > 0 && rest[0].length === 40) {
52
+ const ref = rest.shift();
53
+ const path = join(rest, "/");
54
+ return {
55
+ project,
56
+ ref,
57
+ refType: "sha",
58
+ path: path || "/",
59
+ basePath: trimEnd(url.replace(path, ""), "/")
60
+ };
61
+ }
62
+ const remainingPath = join(rest, "/");
63
+ const refsRegexp = /^refs\/(?<refsReference>heads|tags)\/(?<ref>.*?)(\/|$)/;
64
+ const result = refsRegexp.exec(remainingPath);
65
+ if (result) {
66
+ const matchString = result[0];
67
+ let refType;
68
+ const { refsReference, ref } = result.groups || {};
69
+ const path = remainingPath.replace(matchString, "");
70
+ switch (refsReference) {
71
+ case "heads":
72
+ refType = "branch";
73
+ break;
74
+ case "tags":
75
+ refType = "tag";
76
+ break;
77
+ default:
78
+ throw new Error(`Unable to parse gitiles url: ${url}`);
79
+ }
80
+ return {
81
+ project,
82
+ ref,
83
+ refType,
84
+ path: path || "/",
85
+ basePath: trimEnd(url.replace(path, ""), "/")
86
+ };
87
+ }
88
+ throw new Error(`Unable to parse gitiles : ${url}`);
28
89
  }
29
90
  function buildGerritGitilesArchiveUrl(config, project, branch, filePath) {
30
91
  const archiveName = filePath === "/" || filePath === "" ? ".tar.gz" : `/${filePath}.tar.gz`;
@@ -102,5 +163,5 @@ async function parseGerritJsonResponse(response) {
102
163
  );
103
164
  }
104
165
 
105
- export { buildGerritGitilesArchiveUrl, buildGerritGitilesUrl, getAuthenticationPrefix, getGerritBranchApiUrl, getGerritCloneRepoUrl, getGerritFileContentsApiUrl, getGerritProjectsApiUrl, getGerritRequestOptions, getGitilesAuthenticationUrl, parseGerritGitilesUrl, parseGerritJsonResponse };
166
+ export { buildGerritGitilesArchiveUrl, getAuthenticationPrefix, getGerritBranchApiUrl, getGerritCloneRepoUrl, getGerritFileContentsApiUrl, getGerritProjectsApiUrl, getGerritRequestOptions, getGitilesAuthenticationUrl, parseGerritGitilesUrl, parseGerritJsonResponse, parseGitilesUrlRef };
106
167
  //# sourceMappingURL=core.esm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"core.esm.js","sources":["../../src/gerrit/core.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { trimStart } from 'lodash';\nimport { GerritIntegrationConfig } from './config';\n\nconst GERRIT_BODY_PREFIX = \")]}'\";\n\n/**\n * Parse a Gitiles URL and return branch, file path and project.\n *\n * @remarks\n *\n * Gerrit only handles code reviews so it does not have a native way to browse\n * or showing the content of gits. Image if Github only had the \"pull requests\"\n * tab.\n *\n * Any source code browsing is instead handled by optional services outside\n * Gerrit. The url format chosen for the Gerrit url reader is the one used by\n * the Gitiles project. Gerrit will work perfectly with Backstage without\n * having Gitiles installed but there are some places in the Backstage GUI\n * with links to the url used by the url reader. These will not work unless\n * the urls point to an actual Gitiles installation.\n *\n * Gitiles url:\n * https://g.com/optional_path/\\{project\\}/+/refs/heads/\\{branch\\}/\\{filePath\\}\n * https://g.com/a/optional_path/\\{project\\}/+/refs/heads/\\{branch\\}/\\{filePath\\}\n *\n *\n * @param url - An URL pointing to a file stored in git.\n * @public\n */\n\nexport function parseGerritGitilesUrl(\n config: GerritIntegrationConfig,\n url: string,\n): { branch: string; filePath: string; project: string } {\n const baseUrlParse = new URL(config.gitilesBaseUrl!);\n const urlParse = new URL(url);\n\n // Remove the gerrit authentication prefix '/a/' from the url\n // In case of the gitilesBaseUrl is https://review.gerrit.com/plugins/gitiles\n // and the url provided is https://review.gerrit.com/a/plugins/gitiles/...\n // remove the prefix only if the pathname start with '/a/'\n const urlPath = urlParse.pathname\n .substring(urlParse.pathname.startsWith('/a/') ? 2 : 0)\n .replace(baseUrlParse.pathname, '');\n\n const parts = urlPath.split('/').filter(p => !!p);\n\n const projectEndIndex = parts.indexOf('+');\n\n if (projectEndIndex <= 0) {\n throw new Error(`Unable to parse project from url: ${url}`);\n }\n const project = trimStart(parts.slice(0, projectEndIndex).join('/'), '/');\n\n const branchIndex = parts.indexOf('heads');\n if (branchIndex <= 0) {\n throw new Error(`Unable to parse branch from url: ${url}`);\n }\n const branch = parts[branchIndex + 1];\n const filePath = parts.slice(branchIndex + 2).join('/');\n\n return {\n branch,\n filePath: filePath === '' ? '/' : filePath,\n project,\n };\n}\n\n/**\n * Build a Gerrit Gitiles url that targets a specific path.\n *\n * @param config - A Gerrit provider config.\n * @param project - The name of the git project\n * @param branch - The branch we will target.\n * @param filePath - The absolute file path.\n * @public\n */\nexport function buildGerritGitilesUrl(\n config: GerritIntegrationConfig,\n project: string,\n branch: string,\n filePath: string,\n): string {\n return `${\n config.gitilesBaseUrl\n }/${project}/+/refs/heads/${branch}/${trimStart(filePath, '/')}`;\n}\n\n/**\n * Build a Gerrit Gitiles archive url that targets a specific branch and path\n *\n * @param config - A Gerrit provider config.\n * @param project - The name of the git project\n * @param branch - The branch we will target.\n * @param filePath - The absolute file path.\n * @public\n */\nexport function buildGerritGitilesArchiveUrl(\n config: GerritIntegrationConfig,\n project: string,\n branch: string,\n filePath: string,\n): string {\n const archiveName =\n filePath === '/' || filePath === '' ? '.tar.gz' : `/${filePath}.tar.gz`;\n return `${getGitilesAuthenticationUrl(\n config,\n )}/${project}/+archive/refs/heads/${branch}${archiveName}`;\n}\n\n/**\n * Return the authentication prefix.\n *\n * @remarks\n *\n * To authenticate with a password the API url must be prefixed with \"/a/\".\n * If no password is set anonymous access (without the prefix) will\n * be used.\n *\n * @param config - A Gerrit provider config.\n * @public\n */\nexport function getAuthenticationPrefix(\n config: GerritIntegrationConfig,\n): string {\n return config.password ? '/a/' : '/';\n}\n\n/**\n * Return the authentication gitiles url.\n *\n * @remarks\n *\n * To authenticate with a password the API url must be prefixed with \"/a/\".\n * If no password is set anonymous access (without the prefix) will\n * be used.\n *\n * @param config - A Gerrit provider config.\n */\nexport function getGitilesAuthenticationUrl(\n config: GerritIntegrationConfig,\n): string {\n if (!config.baseUrl || !config.gitilesBaseUrl) {\n throw new Error(\n 'Unexpected Gerrit config values. baseUrl or gitilesBaseUrl not set.',\n );\n }\n if (config.gitilesBaseUrl.startsWith(config.baseUrl)) {\n return config.gitilesBaseUrl.replace(\n config.baseUrl.concat('/'),\n config.baseUrl.concat(getAuthenticationPrefix(config)),\n );\n }\n if (config.password) {\n throw new Error(\n 'Since the baseUrl (Gerrit) is not part of the gitilesBaseUrl, an authentication URL could not be constructed.',\n );\n }\n return config.gitilesBaseUrl!;\n}\n\n/**\n * Return the url to get branch info from the Gerrit API.\n *\n * @param config - A Gerrit provider config.\n * @param url - An url pointing to a file in git.\n * @public\n */\nexport function getGerritBranchApiUrl(\n config: GerritIntegrationConfig,\n url: string,\n) {\n const { branch, project } = parseGerritGitilesUrl(config, url);\n\n return `${config.baseUrl}${getAuthenticationPrefix(\n config,\n )}projects/${encodeURIComponent(project)}/branches/${branch}`;\n}\n\n/**\n * Return the url to clone the repo that is referenced by the url.\n *\n * @param url - An url pointing to a file in git.\n * @public\n */\nexport function getGerritCloneRepoUrl(\n config: GerritIntegrationConfig,\n url: string,\n) {\n const { project } = parseGerritGitilesUrl(config, url);\n\n return `${config.cloneUrl}${getAuthenticationPrefix(config)}${project}`;\n}\n\n/**\n * Return the url to fetch the contents of a file using the Gerrit API.\n *\n * @param config - A Gerrit provider config.\n * @param url - An url pointing to a file in git.\n * @public\n */\nexport function getGerritFileContentsApiUrl(\n config: GerritIntegrationConfig,\n url: string,\n) {\n const { branch, filePath, project } = parseGerritGitilesUrl(config, url);\n\n return `${config.baseUrl}${getAuthenticationPrefix(\n config,\n )}projects/${encodeURIComponent(\n project,\n )}/branches/${branch}/files/${encodeURIComponent(filePath)}/content`;\n}\n\n/**\n * Return the url to query available projects using the Gerrit API.\n *\n * @param config - A Gerrit provider config.\n * @public\n */\nexport function getGerritProjectsApiUrl(config: GerritIntegrationConfig) {\n return `${config.baseUrl}${getAuthenticationPrefix(config)}projects/`;\n}\n\n/**\n * Return request headers for a Gerrit provider.\n *\n * @param config - A Gerrit provider config\n * @public\n */\nexport function getGerritRequestOptions(config: GerritIntegrationConfig): {\n headers?: Record<string, string>;\n} {\n const headers: Record<string, string> = {};\n\n if (!config.password) {\n return headers;\n }\n const buffer = Buffer.from(`${config.username}:${config.password}`, 'utf8');\n headers.Authorization = `Basic ${buffer.toString('base64')}`;\n return {\n headers,\n };\n}\n\n/**\n * Parse the json response from Gerrit and strip the magic prefix.\n *\n * @remarks\n *\n * To prevent against XSSI attacks the JSON response body from Gerrit starts\n * with a magic prefix that must be stripped before it can be fed to a JSON\n * parser.\n *\n * @param response - An API response.\n * @public\n */\nexport async function parseGerritJsonResponse(\n response: Response,\n): Promise<unknown> {\n const responseBody = await response.text();\n if (responseBody.startsWith(GERRIT_BODY_PREFIX)) {\n try {\n return JSON.parse(responseBody.slice(GERRIT_BODY_PREFIX.length));\n } catch (ex) {\n throw new Error(\n `Invalid response from Gerrit: ${responseBody.slice(0, 10)} - ${ex}`,\n );\n }\n }\n throw new Error(\n `Gerrit JSON body prefix missing. Found: ${responseBody.slice(0, 10)}`,\n );\n}\n"],"names":[],"mappings":";;AAkBA,MAAM,kBAAqB,GAAA,MAAA,CAAA;AA2BX,SAAA,qBAAA,CACd,QACA,GACuD,EAAA;AACvD,EAAA,MAAM,YAAe,GAAA,IAAI,GAAI,CAAA,MAAA,CAAO,cAAe,CAAA,CAAA;AACnD,EAAM,MAAA,QAAA,GAAW,IAAI,GAAA,CAAI,GAAG,CAAA,CAAA;AAM5B,EAAA,MAAM,OAAU,GAAA,QAAA,CAAS,QACtB,CAAA,SAAA,CAAU,SAAS,QAAS,CAAA,UAAA,CAAW,KAAK,CAAA,GAAI,IAAI,CAAC,CAAA,CACrD,OAAQ,CAAA,YAAA,CAAa,UAAU,EAAE,CAAA,CAAA;AAEpC,EAAM,MAAA,KAAA,GAAQ,QAAQ,KAAM,CAAA,GAAG,EAAE,MAAO,CAAA,CAAA,CAAA,KAAK,CAAC,CAAC,CAAC,CAAA,CAAA;AAEhD,EAAM,MAAA,eAAA,GAAkB,KAAM,CAAA,OAAA,CAAQ,GAAG,CAAA,CAAA;AAEzC,EAAA,IAAI,mBAAmB,CAAG,EAAA;AACxB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAqC,kCAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,GAC5D;AACA,EAAM,MAAA,OAAA,GAAU,SAAU,CAAA,KAAA,CAAM,KAAM,CAAA,CAAA,EAAG,eAAe,CAAE,CAAA,IAAA,CAAK,GAAG,CAAA,EAAG,GAAG,CAAA,CAAA;AAExE,EAAM,MAAA,WAAA,GAAc,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAA,CAAA;AACzC,EAAA,IAAI,eAAe,CAAG,EAAA;AACpB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAoC,iCAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,GAC3D;AACA,EAAM,MAAA,MAAA,GAAS,KAAM,CAAA,WAAA,GAAc,CAAC,CAAA,CAAA;AACpC,EAAA,MAAM,WAAW,KAAM,CAAA,KAAA,CAAM,cAAc,CAAC,CAAA,CAAE,KAAK,GAAG,CAAA,CAAA;AAEtD,EAAO,OAAA;AAAA,IACL,MAAA;AAAA,IACA,QAAA,EAAU,QAAa,KAAA,EAAA,GAAK,GAAM,GAAA,QAAA;AAAA,IAClC,OAAA;AAAA,GACF,CAAA;AACF,CAAA;AAWO,SAAS,qBACd,CAAA,MAAA,EACA,OACA,EAAA,MAAA,EACA,QACQ,EAAA;AACR,EAAO,OAAA,CAAA,EACL,MAAO,CAAA,cACT,CAAI,CAAA,EAAA,OAAO,CAAiB,cAAA,EAAA,MAAM,CAAI,CAAA,EAAA,SAAA,CAAU,QAAU,EAAA,GAAG,CAAC,CAAA,CAAA,CAAA;AAChE,CAAA;AAWO,SAAS,4BACd,CAAA,MAAA,EACA,OACA,EAAA,MAAA,EACA,QACQ,EAAA;AACR,EAAA,MAAM,cACJ,QAAa,KAAA,GAAA,IAAO,aAAa,EAAK,GAAA,SAAA,GAAY,IAAI,QAAQ,CAAA,OAAA,CAAA,CAAA;AAChE,EAAA,OAAO,CAAG,EAAA,2BAAA;AAAA,IACR,MAAA;AAAA,GACD,CAAI,CAAA,EAAA,OAAO,CAAwB,qBAAA,EAAA,MAAM,GAAG,WAAW,CAAA,CAAA,CAAA;AAC1D,CAAA;AAcO,SAAS,wBACd,MACQ,EAAA;AACR,EAAO,OAAA,MAAA,CAAO,WAAW,KAAQ,GAAA,GAAA,CAAA;AACnC,CAAA;AAaO,SAAS,4BACd,MACQ,EAAA;AACR,EAAA,IAAI,CAAC,MAAA,CAAO,OAAW,IAAA,CAAC,OAAO,cAAgB,EAAA;AAC7C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,qEAAA;AAAA,KACF,CAAA;AAAA,GACF;AACA,EAAA,IAAI,MAAO,CAAA,cAAA,CAAe,UAAW,CAAA,MAAA,CAAO,OAAO,CAAG,EAAA;AACpD,IAAA,OAAO,OAAO,cAAe,CAAA,OAAA;AAAA,MAC3B,MAAA,CAAO,OAAQ,CAAA,MAAA,CAAO,GAAG,CAAA;AAAA,MACzB,MAAO,CAAA,OAAA,CAAQ,MAAO,CAAA,uBAAA,CAAwB,MAAM,CAAC,CAAA;AAAA,KACvD,CAAA;AAAA,GACF;AACA,EAAA,IAAI,OAAO,QAAU,EAAA;AACnB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,+GAAA;AAAA,KACF,CAAA;AAAA,GACF;AACA,EAAA,OAAO,MAAO,CAAA,cAAA,CAAA;AAChB,CAAA;AASgB,SAAA,qBAAA,CACd,QACA,GACA,EAAA;AACA,EAAA,MAAM,EAAE,MAAQ,EAAA,OAAA,EAAY,GAAA,qBAAA,CAAsB,QAAQ,GAAG,CAAA,CAAA;AAE7D,EAAO,OAAA,CAAA,EAAG,MAAO,CAAA,OAAO,CAAG,EAAA,uBAAA;AAAA,IACzB,MAAA;AAAA,GACD,CAAY,SAAA,EAAA,kBAAA,CAAmB,OAAO,CAAC,aAAa,MAAM,CAAA,CAAA,CAAA;AAC7D,CAAA;AAQgB,SAAA,qBAAA,CACd,QACA,GACA,EAAA;AACA,EAAA,MAAM,EAAE,OAAA,EAAY,GAAA,qBAAA,CAAsB,QAAQ,GAAG,CAAA,CAAA;AAErD,EAAO,OAAA,CAAA,EAAG,OAAO,QAAQ,CAAA,EAAG,wBAAwB,MAAM,CAAC,GAAG,OAAO,CAAA,CAAA,CAAA;AACvE,CAAA;AASgB,SAAA,2BAAA,CACd,QACA,GACA,EAAA;AACA,EAAA,MAAM,EAAE,MAAQ,EAAA,QAAA,EAAU,SAAY,GAAA,qBAAA,CAAsB,QAAQ,GAAG,CAAA,CAAA;AAEvE,EAAO,OAAA,CAAA,EAAG,MAAO,CAAA,OAAO,CAAG,EAAA,uBAAA;AAAA,IACzB,MAAA;AAAA,GACD,CAAY,SAAA,EAAA,kBAAA;AAAA,IACX,OAAA;AAAA,GACD,CAAa,UAAA,EAAA,MAAM,CAAU,OAAA,EAAA,kBAAA,CAAmB,QAAQ,CAAC,CAAA,QAAA,CAAA,CAAA;AAC5D,CAAA;AAQO,SAAS,wBAAwB,MAAiC,EAAA;AACvE,EAAA,OAAO,GAAG,MAAO,CAAA,OAAO,CAAG,EAAA,uBAAA,CAAwB,MAAM,CAAC,CAAA,SAAA,CAAA,CAAA;AAC5D,CAAA;AAQO,SAAS,wBAAwB,MAEtC,EAAA;AACA,EAAA,MAAM,UAAkC,EAAC,CAAA;AAEzC,EAAI,IAAA,CAAC,OAAO,QAAU,EAAA;AACpB,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AACA,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,IAAA,CAAK,CAAG,EAAA,MAAA,CAAO,QAAQ,CAAI,CAAA,EAAA,MAAA,CAAO,QAAQ,CAAA,CAAA,EAAI,MAAM,CAAA,CAAA;AAC1E,EAAA,OAAA,CAAQ,aAAgB,GAAA,CAAA,MAAA,EAAS,MAAO,CAAA,QAAA,CAAS,QAAQ,CAAC,CAAA,CAAA,CAAA;AAC1D,EAAO,OAAA;AAAA,IACL,OAAA;AAAA,GACF,CAAA;AACF,CAAA;AAcA,eAAsB,wBACpB,QACkB,EAAA;AAClB,EAAM,MAAA,YAAA,GAAe,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACzC,EAAI,IAAA,YAAA,CAAa,UAAW,CAAA,kBAAkB,CAAG,EAAA;AAC/C,IAAI,IAAA;AACF,MAAA,OAAO,KAAK,KAAM,CAAA,YAAA,CAAa,KAAM,CAAA,kBAAA,CAAmB,MAAM,CAAC,CAAA,CAAA;AAAA,aACxD,EAAI,EAAA;AACX,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,iCAAiC,YAAa,CAAA,KAAA,CAAM,GAAG,EAAE,CAAC,MAAM,EAAE,CAAA,CAAA;AAAA,OACpE,CAAA;AAAA,KACF;AAAA,GACF;AACA,EAAA,MAAM,IAAI,KAAA;AAAA,IACR,CAA2C,wCAAA,EAAA,YAAA,CAAa,KAAM,CAAA,CAAA,EAAG,EAAE,CAAC,CAAA,CAAA;AAAA,GACtE,CAAA;AACF;;;;"}
1
+ {"version":3,"file":"core.esm.js","sources":["../../src/gerrit/core.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { join, takeWhile, trimEnd, trimStart } from 'lodash';\nimport { GerritIntegrationConfig } from './config';\n\nconst GERRIT_BODY_PREFIX = \")]}'\";\n\n/**\n * Parse a Gitiles URL and return branch, file path and project.\n *\n * @remarks\n *\n * Gerrit only handles code reviews so it does not have a native way to browse\n * or showing the content of gits. Image if Github only had the \"pull requests\"\n * tab.\n *\n * Any source code browsing is instead handled by optional services outside\n * Gerrit. The url format chosen for the Gerrit url reader is the one used by\n * the Gitiles project. Gerrit will work perfectly with Backstage without\n * having Gitiles installed but there are some places in the Backstage GUI\n * with links to the url used by the url reader. These will not work unless\n * the urls point to an actual Gitiles installation.\n *\n * Gitiles url:\n * https://g.com/optional_path/\\{project\\}/+/refs/heads/\\{branch\\}/\\{filePath\\}\n * https://g.com/a/optional_path/\\{project\\}/+/refs/heads/\\{branch\\}/\\{filePath\\}\n *\n *\n * @param url - An URL pointing to a file stored in git.\n * @public\n */\n\nexport function parseGerritGitilesUrl(\n config: GerritIntegrationConfig,\n url: string,\n): { branch: string; filePath: string; project: string } {\n const baseUrlParse = new URL(config.gitilesBaseUrl!);\n const urlParse = new URL(url);\n\n // Remove the gerrit authentication prefix '/a/' from the url\n // In case of the gitilesBaseUrl is https://review.gerrit.com/plugins/gitiles\n // and the url provided is https://review.gerrit.com/a/plugins/gitiles/...\n // remove the prefix only if the pathname start with '/a/'\n const urlPath = urlParse.pathname\n .substring(urlParse.pathname.startsWith('/a/') ? 2 : 0)\n .replace(baseUrlParse.pathname, '');\n\n const parts = urlPath.split('/').filter(p => !!p);\n\n const projectEndIndex = parts.indexOf('+');\n\n if (projectEndIndex <= 0) {\n throw new Error(`Unable to parse project from url: ${url}`);\n }\n const project = trimStart(parts.slice(0, projectEndIndex).join('/'), '/');\n\n const branchIndex = parts.indexOf('heads');\n if (branchIndex <= 0) {\n throw new Error(`Unable to parse branch from url: ${url}`);\n }\n const branch = parts[branchIndex + 1];\n const filePath = parts.slice(branchIndex + 2).join('/');\n\n return {\n branch,\n filePath: filePath === '' ? '/' : filePath,\n project,\n };\n}\n\n/**\n * Parses Gitiles urls and returns the following:\n *\n * - The project\n * - The type of ref. I.e: branch name, SHA, HEAD or tag.\n * - The file path from the repo root.\n * - The base path as the path that points to the repo root.\n *\n * Supported types of gitiles urls that point to:\n *\n * - Branches\n * - Tags\n * - A commit SHA\n * - HEAD\n *\n * @param config - A Gerrit provider config.\n * @param url - An url to a file or folder in Gitiles.\n * @public\n */\nexport function parseGitilesUrlRef(\n config: GerritIntegrationConfig,\n url: string,\n): {\n project: string;\n path: string;\n ref: string;\n refType: 'sha' | 'branch' | 'tag' | 'head';\n basePath: string;\n} {\n const baseUrlParse = new URL(config.gitilesBaseUrl!);\n const urlParse = new URL(url);\n // Remove the gerrit authentication prefix '/a/' from the url\n // In case of the gitilesBaseUrl is https://review.gerrit.com/plugins/gitiles\n // and the url provided is https://review.gerrit.com/a/plugins/gitiles/...\n // remove the prefix only if the pathname start with '/a/'\n const urlPath = trimStart(\n urlParse.pathname\n .substring(urlParse.pathname.startsWith('/a/') ? 2 : 0)\n .replace(baseUrlParse.pathname, ''),\n '/',\n );\n\n // Find the project by taking everything up to \"/+/\".\n const parts = urlPath.split('/').filter(p => !!p);\n const projectParts = takeWhile(parts, p => p !== '+');\n if (projectParts.length === 0) {\n throw new Error(`Unable to parse gitiles url: ${url}`);\n }\n // Also remove the \"+\" after the project.\n const rest = parts.slice(projectParts.length + 1);\n const project = join(projectParts, '/');\n\n // match <project>/+/HEAD/<path>\n if (rest.length > 0 && rest[0] === 'HEAD') {\n const ref = rest.shift()!;\n const path = join(rest, '/');\n return {\n project,\n ref,\n refType: 'head' as const,\n path: path || '/',\n basePath: trimEnd(url.replace(path, ''), '/'),\n };\n }\n // match <project>/+/<sha>/<path>\n if (rest.length > 0 && rest[0].length === 40) {\n const ref = rest.shift()!;\n const path = join(rest, '/');\n return {\n project,\n ref,\n refType: 'sha' as const,\n path: path || '/',\n basePath: trimEnd(url.replace(path, ''), '/'),\n };\n }\n const remainingPath = join(rest, '/');\n // Regexp for matching \"refs/tags/<tag>\" or \"refs/heads/<branch>/\"\n const refsRegexp = /^refs\\/(?<refsReference>heads|tags)\\/(?<ref>.*?)(\\/|$)/;\n const result = refsRegexp.exec(remainingPath);\n if (result) {\n const matchString = result[0];\n let refType;\n const { refsReference, ref } = result.groups || {};\n const path = remainingPath.replace(matchString, '');\n switch (refsReference) {\n case 'heads':\n refType = 'branch' as const;\n break;\n case 'tags':\n refType = 'tag' as const;\n break;\n default:\n throw new Error(`Unable to parse gitiles url: ${url}`);\n }\n return {\n project,\n ref,\n refType,\n path: path || '/',\n basePath: trimEnd(url.replace(path, ''), '/'),\n };\n }\n throw new Error(`Unable to parse gitiles : ${url}`);\n}\n\n/**\n * Build a Gerrit Gitiles url that targets a specific path.\n *\n * @param config - A Gerrit provider config.\n * @param project - The name of the git project\n * @param branch - The branch we will target.\n * @param filePath - The absolute file path.\n * @public\n */\nexport function buildGerritGitilesUrl(\n config: GerritIntegrationConfig,\n project: string,\n branch: string,\n filePath: string,\n): string {\n return `${\n config.gitilesBaseUrl\n }/${project}/+/refs/heads/${branch}/${trimStart(filePath, '/')}`;\n}\n\n/**\n * Build a Gerrit Gitiles archive url that targets a specific branch and path\n *\n * @param config - A Gerrit provider config.\n * @param project - The name of the git project\n * @param branch - The branch we will target.\n * @param filePath - The absolute file path.\n * @public\n */\nexport function buildGerritGitilesArchiveUrl(\n config: GerritIntegrationConfig,\n project: string,\n branch: string,\n filePath: string,\n): string {\n const archiveName =\n filePath === '/' || filePath === '' ? '.tar.gz' : `/${filePath}.tar.gz`;\n return `${getGitilesAuthenticationUrl(\n config,\n )}/${project}/+archive/refs/heads/${branch}${archiveName}`;\n}\n\n/**\n * Return the authentication prefix.\n *\n * @remarks\n *\n * To authenticate with a password the API url must be prefixed with \"/a/\".\n * If no password is set anonymous access (without the prefix) will\n * be used.\n *\n * @param config - A Gerrit provider config.\n * @public\n */\nexport function getAuthenticationPrefix(\n config: GerritIntegrationConfig,\n): string {\n return config.password ? '/a/' : '/';\n}\n\n/**\n * Return the authentication gitiles url.\n *\n * @remarks\n *\n * To authenticate with a password the API url must be prefixed with \"/a/\".\n * If no password is set anonymous access (without the prefix) will\n * be used.\n *\n * @param config - A Gerrit provider config.\n */\nexport function getGitilesAuthenticationUrl(\n config: GerritIntegrationConfig,\n): string {\n if (!config.baseUrl || !config.gitilesBaseUrl) {\n throw new Error(\n 'Unexpected Gerrit config values. baseUrl or gitilesBaseUrl not set.',\n );\n }\n if (config.gitilesBaseUrl.startsWith(config.baseUrl)) {\n return config.gitilesBaseUrl.replace(\n config.baseUrl.concat('/'),\n config.baseUrl.concat(getAuthenticationPrefix(config)),\n );\n }\n if (config.password) {\n throw new Error(\n 'Since the baseUrl (Gerrit) is not part of the gitilesBaseUrl, an authentication URL could not be constructed.',\n );\n }\n return config.gitilesBaseUrl!;\n}\n\n/**\n * Return the url to get branch info from the Gerrit API.\n *\n * @param config - A Gerrit provider config.\n * @param url - An url pointing to a file in git.\n * @public\n */\nexport function getGerritBranchApiUrl(\n config: GerritIntegrationConfig,\n url: string,\n) {\n const { branch, project } = parseGerritGitilesUrl(config, url);\n\n return `${config.baseUrl}${getAuthenticationPrefix(\n config,\n )}projects/${encodeURIComponent(project)}/branches/${branch}`;\n}\n\n/**\n * Return the url to clone the repo that is referenced by the url.\n *\n * @param url - An url pointing to a file in git.\n * @public\n */\nexport function getGerritCloneRepoUrl(\n config: GerritIntegrationConfig,\n url: string,\n) {\n const { project } = parseGerritGitilesUrl(config, url);\n\n return `${config.cloneUrl}${getAuthenticationPrefix(config)}${project}`;\n}\n\n/**\n * Return the url to fetch the contents of a file using the Gerrit API.\n *\n * @param config - A Gerrit provider config.\n * @param url - An url pointing to a file in git.\n * @public\n */\nexport function getGerritFileContentsApiUrl(\n config: GerritIntegrationConfig,\n url: string,\n) {\n const { branch, filePath, project } = parseGerritGitilesUrl(config, url);\n\n return `${config.baseUrl}${getAuthenticationPrefix(\n config,\n )}projects/${encodeURIComponent(\n project,\n )}/branches/${branch}/files/${encodeURIComponent(filePath)}/content`;\n}\n\n/**\n * Return the url to query available projects using the Gerrit API.\n *\n * @param config - A Gerrit provider config.\n * @public\n */\nexport function getGerritProjectsApiUrl(config: GerritIntegrationConfig) {\n return `${config.baseUrl}${getAuthenticationPrefix(config)}projects/`;\n}\n\n/**\n * Return request headers for a Gerrit provider.\n *\n * @param config - A Gerrit provider config\n * @public\n */\nexport function getGerritRequestOptions(config: GerritIntegrationConfig): {\n headers?: Record<string, string>;\n} {\n const headers: Record<string, string> = {};\n\n if (!config.password) {\n return headers;\n }\n const buffer = Buffer.from(`${config.username}:${config.password}`, 'utf8');\n headers.Authorization = `Basic ${buffer.toString('base64')}`;\n return {\n headers,\n };\n}\n\n/**\n * Parse the json response from Gerrit and strip the magic prefix.\n *\n * @remarks\n *\n * To prevent against XSSI attacks the JSON response body from Gerrit starts\n * with a magic prefix that must be stripped before it can be fed to a JSON\n * parser.\n *\n * @param response - An API response.\n * @public\n */\nexport async function parseGerritJsonResponse(\n response: Response,\n): Promise<unknown> {\n const responseBody = await response.text();\n if (responseBody.startsWith(GERRIT_BODY_PREFIX)) {\n try {\n return JSON.parse(responseBody.slice(GERRIT_BODY_PREFIX.length));\n } catch (ex) {\n throw new Error(\n `Invalid response from Gerrit: ${responseBody.slice(0, 10)} - ${ex}`,\n );\n }\n }\n throw new Error(\n `Gerrit JSON body prefix missing. Found: ${responseBody.slice(0, 10)}`,\n );\n}\n"],"names":[],"mappings":";;AAkBA,MAAM,kBAAqB,GAAA,MAAA,CAAA;AA2BX,SAAA,qBAAA,CACd,QACA,GACuD,EAAA;AACvD,EAAA,MAAM,YAAe,GAAA,IAAI,GAAI,CAAA,MAAA,CAAO,cAAe,CAAA,CAAA;AACnD,EAAM,MAAA,QAAA,GAAW,IAAI,GAAA,CAAI,GAAG,CAAA,CAAA;AAM5B,EAAA,MAAM,OAAU,GAAA,QAAA,CAAS,QACtB,CAAA,SAAA,CAAU,SAAS,QAAS,CAAA,UAAA,CAAW,KAAK,CAAA,GAAI,IAAI,CAAC,CAAA,CACrD,OAAQ,CAAA,YAAA,CAAa,UAAU,EAAE,CAAA,CAAA;AAEpC,EAAM,MAAA,KAAA,GAAQ,QAAQ,KAAM,CAAA,GAAG,EAAE,MAAO,CAAA,CAAA,CAAA,KAAK,CAAC,CAAC,CAAC,CAAA,CAAA;AAEhD,EAAM,MAAA,eAAA,GAAkB,KAAM,CAAA,OAAA,CAAQ,GAAG,CAAA,CAAA;AAEzC,EAAA,IAAI,mBAAmB,CAAG,EAAA;AACxB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAqC,kCAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,GAC5D;AACA,EAAM,MAAA,OAAA,GAAU,SAAU,CAAA,KAAA,CAAM,KAAM,CAAA,CAAA,EAAG,eAAe,CAAE,CAAA,IAAA,CAAK,GAAG,CAAA,EAAG,GAAG,CAAA,CAAA;AAExE,EAAM,MAAA,WAAA,GAAc,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAA,CAAA;AACzC,EAAA,IAAI,eAAe,CAAG,EAAA;AACpB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAoC,iCAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,GAC3D;AACA,EAAM,MAAA,MAAA,GAAS,KAAM,CAAA,WAAA,GAAc,CAAC,CAAA,CAAA;AACpC,EAAA,MAAM,WAAW,KAAM,CAAA,KAAA,CAAM,cAAc,CAAC,CAAA,CAAE,KAAK,GAAG,CAAA,CAAA;AAEtD,EAAO,OAAA;AAAA,IACL,MAAA;AAAA,IACA,QAAA,EAAU,QAAa,KAAA,EAAA,GAAK,GAAM,GAAA,QAAA;AAAA,IAClC,OAAA;AAAA,GACF,CAAA;AACF,CAAA;AAqBgB,SAAA,kBAAA,CACd,QACA,GAOA,EAAA;AACA,EAAA,MAAM,YAAe,GAAA,IAAI,GAAI,CAAA,MAAA,CAAO,cAAe,CAAA,CAAA;AACnD,EAAM,MAAA,QAAA,GAAW,IAAI,GAAA,CAAI,GAAG,CAAA,CAAA;AAK5B,EAAA,MAAM,OAAU,GAAA,SAAA;AAAA,IACd,QAAS,CAAA,QAAA,CACN,SAAU,CAAA,QAAA,CAAS,SAAS,UAAW,CAAA,KAAK,CAAI,GAAA,CAAA,GAAI,CAAC,CAAA,CACrD,OAAQ,CAAA,YAAA,CAAa,UAAU,EAAE,CAAA;AAAA,IACpC,GAAA;AAAA,GACF,CAAA;AAGA,EAAM,MAAA,KAAA,GAAQ,QAAQ,KAAM,CAAA,GAAG,EAAE,MAAO,CAAA,CAAA,CAAA,KAAK,CAAC,CAAC,CAAC,CAAA,CAAA;AAChD,EAAA,MAAM,YAAe,GAAA,SAAA,CAAU,KAAO,EAAA,CAAA,CAAA,KAAK,MAAM,GAAG,CAAA,CAAA;AACpD,EAAI,IAAA,YAAA,CAAa,WAAW,CAAG,EAAA;AAC7B,IAAA,MAAM,IAAI,KAAA,CAAM,CAAgC,6BAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,GACvD;AAEA,EAAA,MAAM,IAAO,GAAA,KAAA,CAAM,KAAM,CAAA,YAAA,CAAa,SAAS,CAAC,CAAA,CAAA;AAChD,EAAM,MAAA,OAAA,GAAU,IAAK,CAAA,YAAA,EAAc,GAAG,CAAA,CAAA;AAGtC,EAAA,IAAI,KAAK,MAAS,GAAA,CAAA,IAAK,IAAK,CAAA,CAAC,MAAM,MAAQ,EAAA;AACzC,IAAM,MAAA,GAAA,GAAM,KAAK,KAAM,EAAA,CAAA;AACvB,IAAM,MAAA,IAAA,GAAO,IAAK,CAAA,IAAA,EAAM,GAAG,CAAA,CAAA;AAC3B,IAAO,OAAA;AAAA,MACL,OAAA;AAAA,MACA,GAAA;AAAA,MACA,OAAS,EAAA,MAAA;AAAA,MACT,MAAM,IAAQ,IAAA,GAAA;AAAA,MACd,UAAU,OAAQ,CAAA,GAAA,CAAI,QAAQ,IAAM,EAAA,EAAE,GAAG,GAAG,CAAA;AAAA,KAC9C,CAAA;AAAA,GACF;AAEA,EAAA,IAAI,KAAK,MAAS,GAAA,CAAA,IAAK,KAAK,CAAC,CAAA,CAAE,WAAW,EAAI,EAAA;AAC5C,IAAM,MAAA,GAAA,GAAM,KAAK,KAAM,EAAA,CAAA;AACvB,IAAM,MAAA,IAAA,GAAO,IAAK,CAAA,IAAA,EAAM,GAAG,CAAA,CAAA;AAC3B,IAAO,OAAA;AAAA,MACL,OAAA;AAAA,MACA,GAAA;AAAA,MACA,OAAS,EAAA,KAAA;AAAA,MACT,MAAM,IAAQ,IAAA,GAAA;AAAA,MACd,UAAU,OAAQ,CAAA,GAAA,CAAI,QAAQ,IAAM,EAAA,EAAE,GAAG,GAAG,CAAA;AAAA,KAC9C,CAAA;AAAA,GACF;AACA,EAAM,MAAA,aAAA,GAAgB,IAAK,CAAA,IAAA,EAAM,GAAG,CAAA,CAAA;AAEpC,EAAA,MAAM,UAAa,GAAA,wDAAA,CAAA;AACnB,EAAM,MAAA,MAAA,GAAS,UAAW,CAAA,IAAA,CAAK,aAAa,CAAA,CAAA;AAC5C,EAAA,IAAI,MAAQ,EAAA;AACV,IAAM,MAAA,WAAA,GAAc,OAAO,CAAC,CAAA,CAAA;AAC5B,IAAI,IAAA,OAAA,CAAA;AACJ,IAAA,MAAM,EAAE,aAAe,EAAA,GAAA,EAAQ,GAAA,MAAA,CAAO,UAAU,EAAC,CAAA;AACjD,IAAA,MAAM,IAAO,GAAA,aAAA,CAAc,OAAQ,CAAA,WAAA,EAAa,EAAE,CAAA,CAAA;AAClD,IAAA,QAAQ,aAAe;AAAA,MACrB,KAAK,OAAA;AACH,QAAU,OAAA,GAAA,QAAA,CAAA;AACV,QAAA,MAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAU,OAAA,GAAA,KAAA,CAAA;AACV,QAAA,MAAA;AAAA,MACF;AACE,QAAA,MAAM,IAAI,KAAA,CAAM,CAAgC,6BAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,KACzD;AACA,IAAO,OAAA;AAAA,MACL,OAAA;AAAA,MACA,GAAA;AAAA,MACA,OAAA;AAAA,MACA,MAAM,IAAQ,IAAA,GAAA;AAAA,MACd,UAAU,OAAQ,CAAA,GAAA,CAAI,QAAQ,IAAM,EAAA,EAAE,GAAG,GAAG,CAAA;AAAA,KAC9C,CAAA;AAAA,GACF;AACA,EAAA,MAAM,IAAI,KAAA,CAAM,CAA6B,0BAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AACpD,CAAA;AA+BO,SAAS,4BACd,CAAA,MAAA,EACA,OACA,EAAA,MAAA,EACA,QACQ,EAAA;AACR,EAAA,MAAM,cACJ,QAAa,KAAA,GAAA,IAAO,aAAa,EAAK,GAAA,SAAA,GAAY,IAAI,QAAQ,CAAA,OAAA,CAAA,CAAA;AAChE,EAAA,OAAO,CAAG,EAAA,2BAAA;AAAA,IACR,MAAA;AAAA,GACD,CAAI,CAAA,EAAA,OAAO,CAAwB,qBAAA,EAAA,MAAM,GAAG,WAAW,CAAA,CAAA,CAAA;AAC1D,CAAA;AAcO,SAAS,wBACd,MACQ,EAAA;AACR,EAAO,OAAA,MAAA,CAAO,WAAW,KAAQ,GAAA,GAAA,CAAA;AACnC,CAAA;AAaO,SAAS,4BACd,MACQ,EAAA;AACR,EAAA,IAAI,CAAC,MAAA,CAAO,OAAW,IAAA,CAAC,OAAO,cAAgB,EAAA;AAC7C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,qEAAA;AAAA,KACF,CAAA;AAAA,GACF;AACA,EAAA,IAAI,MAAO,CAAA,cAAA,CAAe,UAAW,CAAA,MAAA,CAAO,OAAO,CAAG,EAAA;AACpD,IAAA,OAAO,OAAO,cAAe,CAAA,OAAA;AAAA,MAC3B,MAAA,CAAO,OAAQ,CAAA,MAAA,CAAO,GAAG,CAAA;AAAA,MACzB,MAAO,CAAA,OAAA,CAAQ,MAAO,CAAA,uBAAA,CAAwB,MAAM,CAAC,CAAA;AAAA,KACvD,CAAA;AAAA,GACF;AACA,EAAA,IAAI,OAAO,QAAU,EAAA;AACnB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,+GAAA;AAAA,KACF,CAAA;AAAA,GACF;AACA,EAAA,OAAO,MAAO,CAAA,cAAA,CAAA;AAChB,CAAA;AASgB,SAAA,qBAAA,CACd,QACA,GACA,EAAA;AACA,EAAA,MAAM,EAAE,MAAQ,EAAA,OAAA,EAAY,GAAA,qBAAA,CAAsB,QAAQ,GAAG,CAAA,CAAA;AAE7D,EAAO,OAAA,CAAA,EAAG,MAAO,CAAA,OAAO,CAAG,EAAA,uBAAA;AAAA,IACzB,MAAA;AAAA,GACD,CAAY,SAAA,EAAA,kBAAA,CAAmB,OAAO,CAAC,aAAa,MAAM,CAAA,CAAA,CAAA;AAC7D,CAAA;AAQgB,SAAA,qBAAA,CACd,QACA,GACA,EAAA;AACA,EAAA,MAAM,EAAE,OAAA,EAAY,GAAA,qBAAA,CAAsB,QAAQ,GAAG,CAAA,CAAA;AAErD,EAAO,OAAA,CAAA,EAAG,OAAO,QAAQ,CAAA,EAAG,wBAAwB,MAAM,CAAC,GAAG,OAAO,CAAA,CAAA,CAAA;AACvE,CAAA;AASgB,SAAA,2BAAA,CACd,QACA,GACA,EAAA;AACA,EAAA,MAAM,EAAE,MAAQ,EAAA,QAAA,EAAU,SAAY,GAAA,qBAAA,CAAsB,QAAQ,GAAG,CAAA,CAAA;AAEvE,EAAO,OAAA,CAAA,EAAG,MAAO,CAAA,OAAO,CAAG,EAAA,uBAAA;AAAA,IACzB,MAAA;AAAA,GACD,CAAY,SAAA,EAAA,kBAAA;AAAA,IACX,OAAA;AAAA,GACD,CAAa,UAAA,EAAA,MAAM,CAAU,OAAA,EAAA,kBAAA,CAAmB,QAAQ,CAAC,CAAA,QAAA,CAAA,CAAA;AAC5D,CAAA;AAQO,SAAS,wBAAwB,MAAiC,EAAA;AACvE,EAAA,OAAO,GAAG,MAAO,CAAA,OAAO,CAAG,EAAA,uBAAA,CAAwB,MAAM,CAAC,CAAA,SAAA,CAAA,CAAA;AAC5D,CAAA;AAQO,SAAS,wBAAwB,MAEtC,EAAA;AACA,EAAA,MAAM,UAAkC,EAAC,CAAA;AAEzC,EAAI,IAAA,CAAC,OAAO,QAAU,EAAA;AACpB,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AACA,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,IAAA,CAAK,CAAG,EAAA,MAAA,CAAO,QAAQ,CAAI,CAAA,EAAA,MAAA,CAAO,QAAQ,CAAA,CAAA,EAAI,MAAM,CAAA,CAAA;AAC1E,EAAA,OAAA,CAAQ,aAAgB,GAAA,CAAA,MAAA,EAAS,MAAO,CAAA,QAAA,CAAS,QAAQ,CAAC,CAAA,CAAA,CAAA;AAC1D,EAAO,OAAA;AAAA,IACL,OAAA;AAAA,GACF,CAAA;AACF,CAAA;AAcA,eAAsB,wBACpB,QACkB,EAAA;AAClB,EAAM,MAAA,YAAA,GAAe,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACzC,EAAI,IAAA,YAAA,CAAa,UAAW,CAAA,kBAAkB,CAAG,EAAA;AAC/C,IAAI,IAAA;AACF,MAAA,OAAO,KAAK,KAAM,CAAA,YAAA,CAAa,KAAM,CAAA,kBAAA,CAAmB,MAAM,CAAC,CAAA,CAAA;AAAA,aACxD,EAAI,EAAA;AACX,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,iCAAiC,YAAa,CAAA,KAAA,CAAM,GAAG,EAAE,CAAC,MAAM,EAAE,CAAA,CAAA;AAAA,OACpE,CAAA;AAAA,KACF;AAAA,GACF;AACA,EAAA,MAAM,IAAI,KAAA;AAAA,IACR,CAA2C,wCAAA,EAAA,YAAA,CAAa,KAAM,CAAA,CAAA,EAAG,EAAE,CAAC,CAAA,CAAA;AAAA,GACtE,CAAA;AACF;;;;"}
package/dist/index.cjs.js CHANGED
@@ -1277,8 +1277,69 @@ function parseGerritGitilesUrl(config, url) {
1277
1277
  project
1278
1278
  };
1279
1279
  }
1280
- function buildGerritGitilesUrl(config, project, branch, filePath) {
1281
- return `${config.gitilesBaseUrl}/${project}/+/refs/heads/${branch}/${lodash.trimStart(filePath, "/")}`;
1280
+ function parseGitilesUrlRef(config, url) {
1281
+ const baseUrlParse = new URL(config.gitilesBaseUrl);
1282
+ const urlParse = new URL(url);
1283
+ const urlPath = lodash.trimStart(
1284
+ urlParse.pathname.substring(urlParse.pathname.startsWith("/a/") ? 2 : 0).replace(baseUrlParse.pathname, ""),
1285
+ "/"
1286
+ );
1287
+ const parts = urlPath.split("/").filter((p) => !!p);
1288
+ const projectParts = lodash.takeWhile(parts, (p) => p !== "+");
1289
+ if (projectParts.length === 0) {
1290
+ throw new Error(`Unable to parse gitiles url: ${url}`);
1291
+ }
1292
+ const rest = parts.slice(projectParts.length + 1);
1293
+ const project = lodash.join(projectParts, "/");
1294
+ if (rest.length > 0 && rest[0] === "HEAD") {
1295
+ const ref = rest.shift();
1296
+ const path = lodash.join(rest, "/");
1297
+ return {
1298
+ project,
1299
+ ref,
1300
+ refType: "head",
1301
+ path: path || "/",
1302
+ basePath: lodash.trimEnd(url.replace(path, ""), "/")
1303
+ };
1304
+ }
1305
+ if (rest.length > 0 && rest[0].length === 40) {
1306
+ const ref = rest.shift();
1307
+ const path = lodash.join(rest, "/");
1308
+ return {
1309
+ project,
1310
+ ref,
1311
+ refType: "sha",
1312
+ path: path || "/",
1313
+ basePath: lodash.trimEnd(url.replace(path, ""), "/")
1314
+ };
1315
+ }
1316
+ const remainingPath = lodash.join(rest, "/");
1317
+ const refsRegexp = /^refs\/(?<refsReference>heads|tags)\/(?<ref>.*?)(\/|$)/;
1318
+ const result = refsRegexp.exec(remainingPath);
1319
+ if (result) {
1320
+ const matchString = result[0];
1321
+ let refType;
1322
+ const { refsReference, ref } = result.groups || {};
1323
+ const path = remainingPath.replace(matchString, "");
1324
+ switch (refsReference) {
1325
+ case "heads":
1326
+ refType = "branch";
1327
+ break;
1328
+ case "tags":
1329
+ refType = "tag";
1330
+ break;
1331
+ default:
1332
+ throw new Error(`Unable to parse gitiles url: ${url}`);
1333
+ }
1334
+ return {
1335
+ project,
1336
+ ref,
1337
+ refType,
1338
+ path: path || "/",
1339
+ basePath: lodash.trimEnd(url.replace(path, ""), "/")
1340
+ };
1341
+ }
1342
+ throw new Error(`Unable to parse gitiles : ${url}`);
1282
1343
  }
1283
1344
  function buildGerritGitilesArchiveUrl(config, project, branch, filePath) {
1284
1345
  const archiveName = filePath === "/" || filePath === "" ? ".tar.gz" : `/${filePath}.tar.gz`;
@@ -1382,8 +1443,8 @@ class GerritIntegration {
1382
1443
  const { url, base, lineNumber } = options;
1383
1444
  let updated;
1384
1445
  if (url.startsWith("/")) {
1385
- const { branch, project } = parseGerritGitilesUrl(this.config, base);
1386
- return buildGerritGitilesUrl(this.config, project, branch, url);
1446
+ const { basePath } = parseGitilesUrlRef(this.config, base);
1447
+ return basePath + url;
1387
1448
  }
1388
1449
  if (url) {
1389
1450
  updated = new URL(url, base);
@@ -2337,6 +2398,7 @@ exports.getHarnessRequestOptions = getHarnessRequestOptions;
2337
2398
  exports.parseGerritGitilesUrl = parseGerritGitilesUrl;
2338
2399
  exports.parseGerritJsonResponse = parseGerritJsonResponse;
2339
2400
  exports.parseGiteaUrl = parseGiteaUrl;
2401
+ exports.parseGitilesUrlRef = parseGitilesUrlRef;
2340
2402
  exports.parseHarnessUrl = parseHarnessUrl;
2341
2403
  exports.readAwsCodeCommitIntegrationConfig = readAwsCodeCommitIntegrationConfig;
2342
2404
  exports.readAwsCodeCommitIntegrationConfigs = readAwsCodeCommitIntegrationConfigs;