@backstage/integration 1.0.1-next.0 → 1.1.0

package/dist/index.d.ts

@@ -314,6 +314,13 @@ declare type GerritIntegrationConfig = {
      * 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.
      */
@@ -360,6 +367,36 @@ declare class GerritIntegration implements ScmIntegration {
     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.
  *
@@ -687,6 +724,14 @@ declare class GitLabIntegration implements ScmIntegration {
     }): string;
     resolveEditUrl(url: string): string;
 }
+/**
+ * Takes a GitLab URL and replaces the type part (blob, tree etc).
+ *
+ * @param url - The original URL
+ * @param type - The desired type, e.g. 'blob', 'tree', 'edit'
+ * @public
+ */
+declare function replaceGitLabUrlType(url: string, type: 'blob' | 'tree' | 'edit'): string;
 
 /**
  * Holds all registered SCM integrations, of all types.
@@ -932,4 +977,4 @@ declare class ScmIntegrations implements ScmIntegrationRegistry {
     resolveEditUrl(url: string): string;
 }
 
-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, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, 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, replaceGitLabUrlType };

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';
@@ -445,21 +445,30 @@ 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
   };
@@ -505,6 +514,57 @@ GerritIntegration.factory = ({ config }) => {
   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";
@@ -901,7 +961,7 @@ const _GitLabIntegration = class {
     return defaultScmResolveUrl(options);
   }
   resolveEditUrl(url) {
-    return replaceUrlType(url, "edit");
+    return replaceGitLabUrlType(url, "edit");
   }
 };
 let GitLabIntegration = _GitLabIntegration;
@@ -910,7 +970,7 @@ GitLabIntegration.factory = ({ config }) => {
   const configs = readGitLabIntegrationConfigs((_a = config.getOptionalConfigArray("integrations.gitlab")) != null ? _a : []);
   return basicIntegrations(configs.map((c) => new _GitLabIntegration(c)), (i) => i.config.host);
 };
-function replaceUrlType(url, type) {
+function replaceGitLabUrlType(url, type) {
   return url.replace(/\/\-\/(blob|tree|edit)\//, `/-/${type}/`);
 }
 
@@ -1056,5 +1116,5 @@ class ScmIntegrations {
   }
 }
 
-export { AwsS3Integration, AzureIntegration, BitbucketIntegration, DefaultGithubCredentialsProvider, GerritIntegration, GitHubIntegration, GitLabIntegration, GithubAppCredentialsMux, ScmIntegrations, SingleInstanceGithubCredentialsProvider, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getGitHubFileFetchUrl, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabRequestOptions, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, 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, replaceGitLabUrlType };
 //# sourceMappingURL=index.esm.js.map