@backstage/integration 0.7.4 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/integration
 
+## 1.0.0
+
+### Major Changes
+
+- b58c70c223: This package has been promoted to v1.0! To understand how this change affects the package, please check out our [versioning policy](https://backstage.io/docs/overview/versioning-policy).
+
+### Patch Changes
+
+- 403837cbac: Added an integration for Gerrit
+- Updated dependencies
+  - @backstage/config@1.0.0
+
+## 0.8.0
+
+### Minor Changes
+
+- 34af86517c: ensure `apiBaseUrl` being set for Bitbucket integrations, replace hardcoded defaults
+
+### Patch Changes
+
+- 33d5e79822: Fix Bitbucket Cloud and Bitbucket Server line number reference.
+
+## 0.7.5
+
+### Patch Changes
+
+- 4e1384884f: Fixed bug in integration package where Self Hosted GitLab instances with custom ports weren't supported (because of the lack of an option to add the port in the integration configs. Now users can add the port directly in the host)
+
 ## 0.7.4
 
 ### Patch Changes
@@ -229,7 +257,7 @@
 
 - 0fd4ea443: Updates the `GithubCredentialsProvider` to return the token type, it can either be `token` or `app` depending on the authentication method.
 
-  Update the `GithubOrgReaderProcessor` NOT to query for email addresses if GitHub Apps is used for authentication, this is due to inconsistencies in the GitHub API when using server to server communications and installation tokens. https://github.community/t/api-v4-unable-to-retrieve-email-resource-not-accessible-by-integration/13831/4 for more info.
+  Update the `GithubOrgReaderProcessor` NOT to query for email addresses if GitHub Apps is used for authentication, this is due to inconsistencies in the GitHub API when using server to server communications and installation tokens. See [this community discussion](https://github.community/t/api-v4-unable-to-retrieve-email-resource-not-accessible-by-integration/13831/4) for more info.
 
   **Removes** deprecated GithubOrgReaderProcessor provider configuration(`catalog.processors.githubOrg`). If you're using the deprecated config section make sure to migrate to [integrations](https://backstage.io/docs/integrations/github/locations) instead.
 

package/config.d.ts

@@ -60,6 +60,31 @@ export interface Config {
       appPassword?: string;
     }>;
 
+    /** Integration configuration for Gerrit */
+    gerrit?: Array<{
+      /**
+       * The hostname of the given Gerrit instance
+       * @visibility frontend
+       */
+      host: string;
+      /**
+       * The base url for the Gerrit instance.
+       * @visibility frontend
+       */
+      baseUrl?: string;
+      /**
+       * The username to use for authenticated requests.
+       * @visibility secret
+       */
+      username?: string;
+      /**
+       * Gerrit password used to authenticate requests. This can be either a password
+       * or a generated access token.
+       * @visibility secret
+       */
+      password?: string;
+    }>;
+
     /** Integration configuration for GitHub */
     github?: Array<{
       /**

package/dist/index.cjs.js

@@ -310,6 +310,8 @@ function readBitbucketIntegrationConfig(config) {
     apiBaseUrl = lodash.trimEnd(apiBaseUrl, "/");
   } else if (host === BITBUCKET_HOST) {
     apiBaseUrl = BITBUCKET_API_BASE_URL;
+  } else {
+    apiBaseUrl = `https://${host}/rest/api/1.0`;
   }
   return {
     host,
@@ -345,13 +347,16 @@ const _BitbucketIntegration = class {
   }
   resolveUrl(options) {
     const resolved = defaultScmResolveUrl(options);
-    if (options.lineNumber) {
-      const url = new URL(resolved);
-      const filename = url.pathname.split("/").slice(-1)[0];
-      url.hash = `${filename}-${options.lineNumber}`;
-      return url.toString();
+    if (!options.lineNumber) {
+      return resolved;
     }
-    return resolved;
+    const url = new URL(resolved);
+    if (this.integrationConfig.host === "bitbucket.org") {
+      url.hash = `lines-${options.lineNumber}`;
+    } else {
+      url.hash = `${options.lineNumber}`;
+    }
+    return url.toString();
   }
   resolveEditUrl(url) {
     const urlData = parseGitUrl__default["default"](url);
@@ -446,6 +451,69 @@ function getBitbucketRequestOptions(config) {
   };
 }
 
+function readGerritIntegrationConfig(config) {
+  const host = config.getString("host");
+  let baseUrl = config.getOptionalString("baseUrl");
+  const username = config.getOptionalString("username");
+  const password = config.getOptionalString("password");
+  if (!isValidHost(host)) {
+    throw new Error(`Invalid Gerrit integration config, '${host}' is not a valid host`);
+  } else if (baseUrl && !isValidUrl(baseUrl)) {
+    throw new Error(`Invalid Gerrit integration config, '${baseUrl}' is not a valid baseUrl`);
+  }
+  if (baseUrl) {
+    baseUrl = lodash.trimEnd(baseUrl, "/");
+  } else {
+    baseUrl = `https://${host}`;
+  }
+  return {
+    host,
+    baseUrl,
+    username,
+    password
+  };
+}
+function readGerritIntegrationConfigs(configs) {
+  return configs.map(readGerritIntegrationConfig);
+}
+
+const _GerritIntegration = class {
+  constructor(integrationConfig) {
+    this.integrationConfig = integrationConfig;
+  }
+  get type() {
+    return "gerrit";
+  }
+  get title() {
+    return this.integrationConfig.host;
+  }
+  get config() {
+    return this.integrationConfig;
+  }
+  resolveUrl(options) {
+    const { url, base, lineNumber } = options;
+    let updated;
+    if (url) {
+      updated = new URL(url, base);
+    } else {
+      updated = new URL(base);
+    }
+    if (lineNumber) {
+      updated.hash = lineNumber.toString();
+    }
+    return updated.toString();
+  }
+  resolveEditUrl(url) {
+    return url;
+  }
+};
+let GerritIntegration = _GerritIntegration;
+GerritIntegration.factory = ({ config }) => {
+  var _a;
+  const configs = readGerritIntegrationConfigs((_a = config.getOptionalConfigArray("integrations.gerrit")) != null ? _a : []);
+  return basicIntegrations(configs.map((c) => new _GerritIntegration(c)), (i) => i.config.host);
+};
+
 const GITHUB_HOST = "github.com";
 const GITHUB_API_BASE_URL = "https://api.github.com";
 const GITHUB_RAW_BASE_URL = "https://raw.githubusercontent.com";
@@ -739,9 +807,7 @@ function readGitLabIntegrationConfig(config) {
   } else {
     baseUrl = `https://${host}`;
   }
-  if (host.includes(":")) {
-    throw new Error(`Invalid GitLab integration config, host '${host}' should just be the host name (e.g. "github.com"), not a URL`);
-  } else if (!isValidHost(host)) {
+  if (!isValidHost(host)) {
     throw new Error(`Invalid GitLab integration config, '${host}' is not a valid host`);
   } else if (!apiBaseUrl || !isValidUrl(apiBaseUrl)) {
     throw new Error(`Invalid GitLab integration config, '${apiBaseUrl}' is not a valid apiBaseUrl`);
@@ -815,7 +881,7 @@ async function getProjectId(target, config) {
   }
   try {
     const repo = url.pathname.split("/-/blob/")[0];
-    const repoIDLookup = new URL(`${url.protocol + url.hostname}/api/v4/projects/${encodeURIComponent(repo.replace(/^\//, ""))}`);
+    const repoIDLookup = new URL(`${url.origin}/api/v4/projects/${encodeURIComponent(repo.replace(/^\//, ""))}`);
     const response = await fetch__default["default"](repoIDLookup.toString(), getGitLabRequestOptions(config));
     const data = await response.json();
     if (!response.ok) {
@@ -946,6 +1012,7 @@ class ScmIntegrations {
       awsS3: AwsS3Integration.factory({ config }),
       azure: AzureIntegration.factory({ config }),
       bitbucket: BitbucketIntegration.factory({ config }),
+      gerrit: GerritIntegration.factory({ config }),
       github: GitHubIntegration.factory({ config }),
       gitlab: GitLabIntegration.factory({ config })
     });
@@ -962,6 +1029,9 @@ class ScmIntegrations {
   get bitbucket() {
     return this.byType.bitbucket;
   }
+  get gerrit() {
+    return this.byType.gerrit;
+  }
   get github() {
     return this.byType.github;
   }
@@ -997,6 +1067,7 @@ exports.AwsS3Integration = AwsS3Integration;
 exports.AzureIntegration = AzureIntegration;
 exports.BitbucketIntegration = BitbucketIntegration;
 exports.DefaultGithubCredentialsProvider = DefaultGithubCredentialsProvider;
+exports.GerritIntegration = GerritIntegration;
 exports.GitHubIntegration = GitHubIntegration;
 exports.GitLabIntegration = GitLabIntegration;
 exports.GithubAppCredentialsMux = GithubAppCredentialsMux;
@@ -1021,6 +1092,8 @@ exports.readAzureIntegrationConfig = readAzureIntegrationConfig;
 exports.readAzureIntegrationConfigs = readAzureIntegrationConfigs;
 exports.readBitbucketIntegrationConfig = readBitbucketIntegrationConfig;
 exports.readBitbucketIntegrationConfigs = readBitbucketIntegrationConfigs;
+exports.readGerritIntegrationConfig = readGerritIntegrationConfig;
+exports.readGerritIntegrationConfigs = readGerritIntegrationConfigs;
 exports.readGitHubIntegrationConfig = readGitHubIntegrationConfig;
 exports.readGitHubIntegrationConfigs = readGitHubIntegrationConfigs;
 exports.readGitLabIntegrationConfig = readGitLabIntegrationConfig;