@backstage/integration 0.8.0 → 1.1.0-next.1

package/dist/index.d.ts

@@ -296,6 +296,107 @@ declare function getBitbucketRequestOptions(config: BitbucketIntegrationConfig):
     headers: Record<string, string>;
 };
 
+/**
+ * The configuration parameters for a single Gerrit API provider.
+ *
+ * @public
+ */
+declare type GerritIntegrationConfig = {
+    /**
+     * The host of the target that this matches on, e.g. "gerrit-review.com"
+     */
+    host: string;
+    /**
+     * The optional base URL of the Gerrit instance. It is assumed that https
+     * is used and that the base path is "/" on the host. If that is not the
+     * case set the complete base url to the gerrit instance, e.g.
+     * "https://gerrit-review.com/gerrit". This is the url that you would open
+     * in a browser.
+     */
+    baseUrl?: string;
+    /**
+     * Optional base url for Gitiles. This is needed for creating a valid
+     * user-friendly url that can be used for browsing the content of the
+     * provider. If not set a default value will be created in the same way
+     * as the "baseUrl" option.
+     */
+    gitilesBaseUrl?: string;
+    /**
+     * The username to use for requests to gerrit.
+     */
+    username?: string;
+    /**
+     * The password or http token to use for authentication.
+     */
+    password?: string;
+};
+/**
+ * Reads a single Gerrit integration config.
+ *
+ * @param config - The config object of a single integration
+ *
+ * @public
+ */
+declare function readGerritIntegrationConfig(config: Config): GerritIntegrationConfig;
+/**
+ * Reads a set of Gerrit integration configs.
+ *
+ * @param configs - All of the integration config objects
+ *
+ * @public
+ */
+declare function readGerritIntegrationConfigs(configs: Config[]): GerritIntegrationConfig[];
+
+/**
+ * A Gerrit based integration.
+ *
+ * @public
+ */
+declare class GerritIntegration implements ScmIntegration {
+    private readonly integrationConfig;
+    static factory: ScmIntegrationsFactory<GerritIntegration>;
+    constructor(integrationConfig: GerritIntegrationConfig);
+    get type(): string;
+    get title(): string;
+    get config(): GerritIntegrationConfig;
+    resolveUrl(options: {
+        url: string;
+        base: string;
+        lineNumber?: number;
+    }): string;
+    resolveEditUrl(url: string): string;
+}
+
+/**
+ * Return the url to fetch the contents of a file using the Gerrit API.
+ *
+ * @param url - An url pointing to a file in git.
+ * @public
+ */
+declare function getGerritFileContentsApiUrl(config: GerritIntegrationConfig, url: string): string;
+/**
+ * Return request headers for a Gerrit provider.
+ *
+ * @param config - A Gerrit provider config
+ * @public
+ */
+declare function getGerritRequestOptions(config: GerritIntegrationConfig): {
+    headers?: Record<string, string>;
+};
+/**
+ * Parse the json response from Gerrit and strip the magic prefix.
+ *
+ * @remarks
+ *
+ * To prevent against XSSI attacks the JSON response body from Gerrit starts
+ * with a magic prefix that must be stripped before it can be fed to a JSON
+ * parser.
+ *
+ * @param response - An API response.
+ * @public
+ */
+declare function parseGerritJsonResponse(response: Response): Promise<unknown>;
+
 /**
  * The configuration parameters for a single GitHub integration.
  *
@@ -488,6 +589,10 @@ declare type AwsS3IntegrationConfig = {
      * (Optional) ARN of role to be assumed
      */
     roleArn?: string;
+    /**
+     * (Optional) External ID to use when assuming role
+     */
+    externalId?: string;
 };
 /**
  * Reads a single Aws S3 integration config.
@@ -629,6 +734,7 @@ interface ScmIntegrationRegistry extends ScmIntegrationsGroup<ScmIntegration> {
     awsS3: ScmIntegrationsGroup<AwsS3Integration>;
     azure: ScmIntegrationsGroup<AzureIntegration>;
     bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
+    gerrit: ScmIntegrationsGroup<GerritIntegration>;
     github: ScmIntegrationsGroup<GitHubIntegration>;
     gitlab: ScmIntegrationsGroup<GitLabIntegration>;
     /**
@@ -833,6 +939,7 @@ interface IntegrationsByType {
     awsS3: ScmIntegrationsGroup<AwsS3Integration>;
     azure: ScmIntegrationsGroup<AzureIntegration>;
     bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
+    gerrit: ScmIntegrationsGroup<GerritIntegration>;
     github: ScmIntegrationsGroup<GitHubIntegration>;
     gitlab: ScmIntegrationsGroup<GitLabIntegration>;
 }
@@ -848,6 +955,7 @@ declare class ScmIntegrations implements ScmIntegrationRegistry {
     get awsS3(): ScmIntegrationsGroup<AwsS3Integration>;
     get azure(): ScmIntegrationsGroup<AzureIntegration>;
     get bitbucket(): ScmIntegrationsGroup<BitbucketIntegration>;
+    get gerrit(): ScmIntegrationsGroup<GerritIntegration>;
     get github(): ScmIntegrationsGroup<GitHubIntegration>;
     get gitlab(): ScmIntegrationsGroup<GitLabIntegration>;
     list(): ScmIntegration[];
@@ -861,4 +969,4 @@ declare class ScmIntegrations implements ScmIntegrationRegistry {
     resolveEditUrl(url: string): string;
 }
 
-export { AwsS3Integration, AwsS3IntegrationConfig, AzureIntegration, AzureIntegrationConfig, BitbucketIntegration, BitbucketIntegrationConfig, DefaultGithubCredentialsProvider, GitHubIntegration, GitHubIntegrationConfig, GitLabIntegration, GitLabIntegrationConfig, GithubAppConfig, GithubAppCredentialsMux, GithubCredentialType, GithubCredentials, GithubCredentialsProvider, GoogleGcsIntegrationConfig, IntegrationsByType, ScmIntegration, ScmIntegrationRegistry, ScmIntegrations, ScmIntegrationsFactory, ScmIntegrationsGroup, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType };
+export { AwsS3Integration, AwsS3IntegrationConfig, AzureIntegration, AzureIntegrationConfig, BitbucketIntegration, BitbucketIntegrationConfig, DefaultGithubCredentialsProvider, GerritIntegration, GerritIntegrationConfig, GitHubIntegration, GitHubIntegrationConfig, GitLabIntegration, GitLabIntegrationConfig, GithubAppConfig, GithubAppCredentialsMux, GithubCredentialType, GithubCredentials, GithubCredentialsProvider, GoogleGcsIntegrationConfig, IntegrationsByType, ScmIntegration, ScmIntegrationRegistry, ScmIntegrations, ScmIntegrationsFactory, ScmIntegrationsGroup, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getGerritFileContentsApiUrl, getGerritRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, parseGerritJsonResponse, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType };

package/dist/index.esm.js

@@ -1,5 +1,5 @@
 import parseGitUrl from 'git-url-parse';
-import { trimEnd } from 'lodash';
+import { trimEnd, trimStart } from 'lodash';
 import fetch from 'cross-fetch';
 import { createAppAuth } from '@octokit/auth-app';
 import { Octokit } from '@octokit/rest';
@@ -442,6 +442,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 = trimEnd(baseUrl, "/");
+  } else {
+    baseUrl = `https://${host}`;
+  }
+  if (gitilesBaseUrl) {
+    gitilesBaseUrl = 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 = 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";
@@ -887,13 +1010,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) {
@@ -940,6 +1065,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 })
     });
@@ -956,6 +1082,9 @@ class ScmIntegrations {
   get bitbucket() {
     return this.byType.bitbucket;
   }
+  get gerrit() {
+    return this.byType.gerrit;
+  }
   get github() {
     return this.byType.github;
   }
@@ -987,5 +1116,5 @@ class ScmIntegrations {
   }
 }
 
-export { AwsS3Integration, AzureIntegration, BitbucketIntegration, DefaultGithubCredentialsProvider, GitHubIntegration, GitLabIntegration, GithubAppCredentialsMux, ScmIntegrations, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType };
+export { AwsS3Integration, AzureIntegration, BitbucketIntegration, DefaultGithubCredentialsProvider, GerritIntegration, GitHubIntegration, GitLabIntegration, GithubAppCredentialsMux, ScmIntegrations, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getGerritFileContentsApiUrl, getGerritRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, parseGerritJsonResponse, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGoogleGcsIntegrationConfig, replaceGitHubUrlType };
 //# sourceMappingURL=index.esm.js.map