@backstage/integration 0.8.0 → 1.1.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @backstage/integration
 
+## 1.1.0-next.1
+
+### Minor Changes
+
+- b7436743cb: Gerrit integration: Added an optional configuration to set the Gitiles base url.
+
+### Patch Changes
+
+- 1691c6c5c2: Clarify that config locations that emit User and Group kinds now need to declare so in the `catalog.locations.[].rules`
+
+## 1.0.1-next.0
+
+### Patch Changes
+
+- 3ef123bbf0: Support external ID when assuming roles in S3 integration
+
+  In order to assume a role created by a 3rd party as external
+  ID is needed. This change adds an optional field to the s3
+  integration configuration and consumes that in the AwsS3UrlReader.
+
+## 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
@@ -215,6 +247,8 @@
     locations:
       - type: github-multi-org
         target: https://github.myorg.com
+        rules:
+          - allow: [User, Group]
 
     processors:
       githubMultiOrg:

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<{
       /**
@@ -200,6 +225,12 @@ export interface Config {
        * @visibility backend
        */
       roleArn?: string;
+
+      /**
+       * External ID to use when assuming role
+       * @visibility backend
+       */
+      externalId?: string;
     }>;
   };
 }

package/dist/index.cjs.js

@@ -451,6 +451,129 @@ function getBitbucketRequestOptions(config) {
   };
 }
 
+function readGerritIntegrationConfig(config) {
+  const host = config.getString("host");
+  let baseUrl = config.getOptionalString("baseUrl");
+  let gitilesBaseUrl = config.getOptionalString("gitilesBaseUrl");
+  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`);
+  } else if (gitilesBaseUrl && !isValidUrl(gitilesBaseUrl)) {
+    throw new Error(`Invalid Gerrit integration config, '${gitilesBaseUrl}' is not a valid gitilesBaseUrl`);
+  }
+  if (baseUrl) {
+    baseUrl = lodash.trimEnd(baseUrl, "/");
+  } else {
+    baseUrl = `https://${host}`;
+  }
+  if (gitilesBaseUrl) {
+    gitilesBaseUrl = lodash.trimEnd(gitilesBaseUrl, "/");
+  } else {
+    gitilesBaseUrl = `https://${host}`;
+  }
+  return {
+    host,
+    baseUrl,
+    gitilesBaseUrl,
+    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 GERRIT_BODY_PREFIX = ")]}'";
+function parseGitilesUrl(config, url) {
+  const urlPath = url.replace(config.gitilesBaseUrl, "");
+  const parts = urlPath.split("/").filter((p) => !!p);
+  const projectEndIndex = parts.indexOf("+");
+  if (projectEndIndex <= 0) {
+    throw new Error(`Unable to parse project from url: ${url}`);
+  }
+  const project = lodash.trimStart(parts.slice(0, projectEndIndex).join("/"), "/");
+  const branchIndex = parts.indexOf("heads");
+  if (branchIndex <= 0) {
+    throw new Error(`Unable to parse branch from url: ${url}`);
+  }
+  const branch = parts[branchIndex + 1];
+  const filePath = parts.slice(branchIndex + 2).join("/");
+  return {
+    branch,
+    filePath: filePath === "" ? "/" : filePath,
+    project
+  };
+}
+function getAuthenticationPrefix(config) {
+  return config.password ? "/a/" : "/";
+}
+function getGerritFileContentsApiUrl(config, url) {
+  const { branch, filePath, project } = parseGitilesUrl(config, url);
+  return `${config.baseUrl}${getAuthenticationPrefix(config)}projects/${encodeURIComponent(project)}/branches/${branch}/files/${encodeURIComponent(filePath)}/content`;
+}
+function getGerritRequestOptions(config) {
+  const headers = {};
+  if (!config.password) {
+    return headers;
+  }
+  const buffer = Buffer.from(`${config.username}:${config.password}`, "utf8");
+  headers.Authorization = `Basic ${buffer.toString("base64")}`;
+  return {
+    headers
+  };
+}
+async function parseGerritJsonResponse(response) {
+  const responseBody = await response.text();
+  if (responseBody.startsWith(GERRIT_BODY_PREFIX)) {
+    try {
+      return JSON.parse(responseBody.slice(GERRIT_BODY_PREFIX.length));
+    } catch (ex) {
+      throw new Error(`Invalid response from Gerrit: ${responseBody.slice(0, 10)} - ${ex}`);
+    }
+  }
+  throw new Error(`Gerrit JSON body prefix missing. Found: ${responseBody.slice(0, 10)}`);
+}
+
 const GITHUB_HOST = "github.com";
 const GITHUB_API_BASE_URL = "https://api.github.com";
 const GITHUB_RAW_BASE_URL = "https://raw.githubusercontent.com";
@@ -896,13 +1019,15 @@ function readAwsS3IntegrationConfig(config) {
   const accessKeyId = config.getOptionalString("accessKeyId");
   const secretAccessKey = config.getOptionalString("secretAccessKey");
   const roleArn = config.getOptionalString("roleArn");
+  const externalId = config.getOptionalString("externalId");
   return {
     host,
     endpoint,
     s3ForcePathStyle,
     accessKeyId,
     secretAccessKey,
-    roleArn
+    roleArn,
+    externalId
   };
 }
 function readAwsS3IntegrationConfigs(configs) {
@@ -949,6 +1074,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 })
     });
@@ -965,6 +1091,9 @@ class ScmIntegrations {
   get bitbucket() {
     return this.byType.bitbucket;
   }
+  get gerrit() {
+    return this.byType.gerrit;
+  }
   get github() {
     return this.byType.github;
   }
@@ -1000,6 +1129,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;
@@ -1014,16 +1144,21 @@ exports.getBitbucketDefaultBranch = getBitbucketDefaultBranch;
 exports.getBitbucketDownloadUrl = getBitbucketDownloadUrl;
 exports.getBitbucketFileFetchUrl = getBitbucketFileFetchUrl;
 exports.getBitbucketRequestOptions = getBitbucketRequestOptions;
+exports.getGerritFileContentsApiUrl = getGerritFileContentsApiUrl;
+exports.getGerritRequestOptions = getGerritRequestOptions;
 exports.getGitHubFileFetchUrl = getGitHubFileFetchUrl;
 exports.getGitHubRequestOptions = getGitHubRequestOptions;
 exports.getGitLabFileFetchUrl = getGitLabFileFetchUrl;
 exports.getGitLabRequestOptions = getGitLabRequestOptions;
+exports.parseGerritJsonResponse = parseGerritJsonResponse;
 exports.readAwsS3IntegrationConfig = readAwsS3IntegrationConfig;
 exports.readAwsS3IntegrationConfigs = readAwsS3IntegrationConfigs;
 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;