@backstage/integration 1.20.0-next.2 → 1.21.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @backstage/integration
 
+## 1.21.0-next.0
+
+### Minor Changes
+
+- d933f62: Add configurable throttling and retry mechanism for GitLab integration.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/config@1.3.6
+  - @backstage/errors@1.2.7
+
+## 1.20.0
+
+### Minor Changes
+
+- 6999f6d: The AzureUrl class in the @backstage/integration package is now able to process BOTH git branches and git tags. Initially this class only processed git branches and threw an error when non-branch Azure URLs were passed in.
+
+### Patch Changes
+
+- cc6206e: Added support for `{org}.visualstudio.com` domains used by Azure DevOps
+- 7455dae: Use node prefix on native imports
+
 ## 1.20.0-next.2
 
 ### Patch Changes

package/config.d.ts

@@ -386,6 +386,28 @@ export interface Config {
        * @visibility secret
        */
       commitSigningKey?: string;
+
+      /**
+       * Retry configuration for requests.
+       * @visibility frontend
+       */
+      retry?: {
+        /**
+         * Maximum number of retries for failed requests.
+         * @visibility frontend
+         */
+        maxRetries?: number;
+        /**
+         * HTTP status codes that should trigger a retry.
+         * @visibility frontend
+         */
+        retryStatusCodes?: number[];
+        /**
+         * Maximum number of API requests allowed per minute. Set to -1 to disable rate limiting.
+         * @visibility frontend
+         */
+        maxApiRequestsPerMinute?: number;
+      };
     }>;
 
     /** Integration configuration for Google Cloud Storage */

package/dist/gitlab/GitLabIntegration.cjs.js

@@ -2,10 +2,16 @@
 
 var helpers = require('../helpers.cjs.js');
 var config = require('./config.cjs.js');
+var pThrottle = require('p-throttle');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var pThrottle__default = /*#__PURE__*/_interopDefaultCompat(pThrottle);
 
 class GitLabIntegration {
   constructor(integrationConfig) {
     this.integrationConfig = integrationConfig;
+    this.fetchImpl = this.createFetchStrategy();
   }
   static factory = ({ config: config$1 }) => {
     const configs = config.readGitLabIntegrationConfigs(
@@ -16,6 +22,7 @@ class GitLabIntegration {
       (i) => i.config.host
     );
   };
+  fetchImpl;
   get type() {
     return "gitlab";
   }
@@ -31,6 +38,67 @@ class GitLabIntegration {
   resolveEditUrl(url) {
     return replaceGitLabUrlType(url, "edit");
   }
+  fetch(input, init) {
+    return this.fetchImpl(input, init);
+  }
+  createFetchStrategy() {
+    let fetchFn = async (url, options) => {
+      return fetch(url, { ...options, mode: "same-origin" });
+    };
+    const retryConfig = this.integrationConfig.retry;
+    if (retryConfig) {
+      fetchFn = this.withRetry(fetchFn, retryConfig);
+      if (retryConfig.maxApiRequestsPerMinute && retryConfig.maxApiRequestsPerMinute > 0) {
+        fetchFn = pThrottle__default.default({
+          limit: retryConfig.maxApiRequestsPerMinute,
+          interval: 6e4
+        })(fetchFn);
+      }
+    }
+    return fetchFn;
+  }
+  withRetry(fetchFn, retryConfig) {
+    const maxRetries = retryConfig?.maxRetries ?? 0;
+    const retryStatusCodes = retryConfig?.retryStatusCodes ?? [];
+    if (maxRetries <= 0 || retryStatusCodes.length === 0) {
+      return fetchFn;
+    }
+    return async (url, options) => {
+      const abortSignal = options?.signal;
+      let response;
+      let attempt = 0;
+      for (; ; ) {
+        response = await fetchFn(url, options);
+        if (!retryStatusCodes.includes(response.status)) {
+          break;
+        }
+        if (attempt++ >= maxRetries) {
+          break;
+        }
+        const retryAfter = response.headers.get("Retry-After");
+        const delay = retryAfter ? parseInt(retryAfter, 10) * 1e3 : Math.min(100 * Math.pow(2, attempt - 1), 1e4);
+        await sleep(delay, abortSignal);
+      }
+      return response;
+    };
+  }
+}
+async function sleep(durationMs, abortSignal) {
+  if (abortSignal?.aborted) {
+    return;
+  }
+  await new Promise((resolve) => {
+    let timeoutHandle = void 0;
+    const done = () => {
+      if (timeoutHandle) {
+        clearTimeout(timeoutHandle);
+      }
+      abortSignal?.removeEventListener("abort", done);
+      resolve();
+    };
+    timeoutHandle = setTimeout(done, durationMs);
+    abortSignal?.addEventListener("abort", done);
+  });
 }
 function replaceGitLabUrlType(url, type) {
   return url.replace(/\/\-\/(blob|tree|edit)\//, `/-/${type}/`);
@@ -38,4 +106,5 @@ function replaceGitLabUrlType(url, type) {
 
 exports.GitLabIntegration = GitLabIntegration;
 exports.replaceGitLabUrlType = replaceGitLabUrlType;
+exports.sleep = sleep;
 //# sourceMappingURL=GitLabIntegration.cjs.js.map

package/dist/gitlab/GitLabIntegration.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"GitLabIntegration.cjs.js","sources":["../../src/gitlab/GitLabIntegration.ts"],"sourcesContent":["/*\n * Copyright 2020 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, defaultScmResolveUrl } from '../helpers';\nimport { ScmIntegration, ScmIntegrationsFactory } from '../types';\nimport {\n  GitLabIntegrationConfig,\n  readGitLabIntegrationConfigs,\n} from './config';\n\n/**\n * A GitLab based integration.\n *\n * @public\n */\nexport class GitLabIntegration implements ScmIntegration {\n  static factory: ScmIntegrationsFactory<GitLabIntegration> = ({ config }) => {\n    const configs = readGitLabIntegrationConfigs(\n      config.getOptionalConfigArray('integrations.gitlab') ?? [],\n    );\n    return basicIntegrations(\n      configs.map(c => new GitLabIntegration(c)),\n      i => i.config.host,\n    );\n  };\n\n  constructor(private readonly integrationConfig: GitLabIntegrationConfig) {}\n\n  get type(): string {\n    return 'gitlab';\n  }\n\n  get title(): string {\n    return this.integrationConfig.host;\n  }\n\n  get config(): GitLabIntegrationConfig {\n    return this.integrationConfig;\n  }\n\n  resolveUrl(options: {\n    url: string;\n    base: string;\n    lineNumber?: number;\n  }): string {\n    return defaultScmResolveUrl(options);\n  }\n\n  resolveEditUrl(url: string): string {\n    return replaceGitLabUrlType(url, 'edit');\n  }\n}\n\n/**\n * Takes a GitLab URL and replaces the type part (blob, tree etc).\n *\n * @param url - The original URL\n * @param type - The desired type, e.g. 'blob', 'tree', 'edit'\n * @public\n */\nexport function replaceGitLabUrlType(\n  url: string,\n  type: 'blob' | 'tree' | 'edit',\n): string {\n  return url.replace(/\\/\\-\\/(blob|tree|edit)\\//, `/-/${type}/`);\n}\n"],"names":["config","readGitLabIntegrationConfigs","basicIntegrations","defaultScmResolveUrl"],"mappings":";;;;;AA4BO,MAAM,iBAAA,CAA4C;AAAA,EAWvD,YAA6B,iBAAA,EAA4C;AAA5C,IAAA,IAAA,CAAA,iBAAA,GAAA,iBAAA;AAAA,EAA6C;AAAA,EAV1E,OAAO,OAAA,GAAqD,CAAC,UAAEA,UAAO,KAAM;AAC1E,IAAA,MAAM,OAAA,GAAUC,mCAAA;AAAA,MACdD,QAAA,CAAO,sBAAA,CAAuB,qBAAqB,CAAA,IAAK;AAAC,KAC3D;AACA,IAAA,OAAOE,yBAAA;AAAA,MACL,QAAQ,GAAA,CAAI,CAAA,CAAA,KAAK,IAAI,iBAAA,CAAkB,CAAC,CAAC,CAAA;AAAA,MACzC,CAAA,CAAA,KAAK,EAAE,MAAA,CAAO;AAAA,KAChB;AAAA,EACF,CAAA;AAAA,EAIA,IAAI,IAAA,GAAe;AACjB,IAAA,OAAO,QAAA;AAAA,EACT;AAAA,EAEA,IAAI,KAAA,GAAgB;AAClB,IAAA,OAAO,KAAK,iBAAA,CAAkB,IAAA;AAAA,EAChC;AAAA,EAEA,IAAI,MAAA,GAAkC;AACpC,IAAA,OAAO,IAAA,CAAK,iBAAA;AAAA,EACd;AAAA,EAEA,WAAW,OAAA,EAIA;AACT,IAAA,OAAOC,6BAAqB,OAAO,CAAA;AAAA,EACrC;AAAA,EAEA,eAAe,GAAA,EAAqB;AAClC,IAAA,OAAO,oBAAA,CAAqB,KAAK,MAAM,CAAA;AAAA,EACzC;AACF;AASO,SAAS,oBAAA,CACd,KACA,IAAA,EACQ;AACR,EAAA,OAAO,GAAA,CAAI,OAAA,CAAQ,0BAAA,EAA4B,CAAA,GAAA,EAAM,IAAI,CAAA,CAAA,CAAG,CAAA;AAC9D;;;;;"}
+{"version":3,"file":"GitLabIntegration.cjs.js","sources":["../../src/gitlab/GitLabIntegration.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { basicIntegrations, defaultScmResolveUrl } from '../helpers';\nimport { ScmIntegration, ScmIntegrationsFactory } from '../types';\nimport {\n  GitLabIntegrationConfig,\n  readGitLabIntegrationConfigs,\n} from './config';\nimport pThrottle from 'p-throttle';\n\ntype FetchFunction = typeof fetch;\n\n/**\n * A GitLab based integration.\n *\n * @public\n */\nexport class GitLabIntegration implements ScmIntegration {\n  static factory: ScmIntegrationsFactory<GitLabIntegration> = ({ config }) => {\n    const configs = readGitLabIntegrationConfigs(\n      config.getOptionalConfigArray('integrations.gitlab') ?? [],\n    );\n    return basicIntegrations(\n      configs.map(c => new GitLabIntegration(c)),\n      i => i.config.host,\n    );\n  };\n\n  private readonly fetchImpl: FetchFunction;\n\n  constructor(private readonly integrationConfig: GitLabIntegrationConfig) {\n    // Configure fetch strategy based on configuration\n    this.fetchImpl = this.createFetchStrategy();\n  }\n\n  get type(): string {\n    return 'gitlab';\n  }\n\n  get title(): string {\n    return this.integrationConfig.host;\n  }\n\n  get config(): GitLabIntegrationConfig {\n    return this.integrationConfig;\n  }\n\n  resolveUrl(options: {\n    url: string;\n    base: string;\n    lineNumber?: number;\n  }): string {\n    return defaultScmResolveUrl(options);\n  }\n\n  resolveEditUrl(url: string): string {\n    return replaceGitLabUrlType(url, 'edit');\n  }\n\n  fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response> {\n    return this.fetchImpl(input, init);\n  }\n\n  private createFetchStrategy(): FetchFunction {\n    let fetchFn: FetchFunction = async (url, options) => {\n      return fetch(url, { ...options, mode: 'same-origin' });\n    };\n\n    const retryConfig = this.integrationConfig.retry;\n    if (retryConfig) {\n      // Apply retry wrapper if configured\n      fetchFn = this.withRetry(fetchFn, retryConfig);\n\n      // Apply throttling wrapper if configured\n      if (\n        retryConfig.maxApiRequestsPerMinute &&\n        retryConfig.maxApiRequestsPerMinute > 0\n      ) {\n        fetchFn = pThrottle({\n          limit: retryConfig.maxApiRequestsPerMinute,\n          interval: 60_000,\n        })(fetchFn);\n      }\n    }\n\n    return fetchFn;\n  }\n\n  private withRetry(\n    fetchFn: FetchFunction,\n    retryConfig: { maxRetries?: number; retryStatusCodes?: number[] },\n  ): FetchFunction {\n    const maxRetries = retryConfig?.maxRetries ?? 0;\n    const retryStatusCodes = retryConfig?.retryStatusCodes ?? [];\n    if (maxRetries <= 0 || retryStatusCodes.length === 0) {\n      return fetchFn;\n    }\n\n    return async (url, options) => {\n      const abortSignal = options?.signal;\n      let response: Response;\n      let attempt = 0;\n      for (;;) {\n        response = await fetchFn(url, options);\n        // If response is not retryable, return immediately\n        if (!retryStatusCodes.includes(response.status)) {\n          break;\n        }\n\n        // If this was the last allowed attempt, return response\n        if (attempt++ >= maxRetries) {\n          break;\n        }\n        // Determine delay from Retry-After header if present, otherwise exponential backoff\n        const retryAfter = response.headers.get('Retry-After');\n        const delay = retryAfter\n          ? parseInt(retryAfter, 10) * 1000\n          : Math.min(100 * Math.pow(2, attempt - 1), 10000); // Exponential backoff, cap at 10 seconds\n\n        await sleep(delay, abortSignal);\n      }\n\n      return response;\n    };\n  }\n}\n\nexport async function sleep(\n  durationMs: number,\n  abortSignal: AbortSignal | null | undefined,\n): Promise<void> {\n  if (abortSignal?.aborted) {\n    return;\n  }\n\n  await new Promise<void>(resolve => {\n    let timeoutHandle: NodeJS.Timeout | undefined = undefined;\n\n    const done = () => {\n      if (timeoutHandle) {\n        clearTimeout(timeoutHandle);\n      }\n      abortSignal?.removeEventListener('abort', done);\n      resolve();\n    };\n\n    timeoutHandle = setTimeout(done, durationMs);\n    abortSignal?.addEventListener('abort', done);\n  });\n}\n\n/**\n * Takes a GitLab URL and replaces the type part (blob, tree etc).\n *\n * @param url - The original URL\n * @param type - The desired type, e.g. 'blob', 'tree', 'edit'\n * @public\n */\nexport function replaceGitLabUrlType(\n  url: string,\n  type: 'blob' | 'tree' | 'edit',\n): string {\n  return url.replace(/\\/\\-\\/(blob|tree|edit)\\//, `/-/${type}/`);\n}\n"],"names":["config","readGitLabIntegrationConfigs","basicIntegrations","defaultScmResolveUrl","pThrottle"],"mappings":";;;;;;;;;;AA8BO,MAAM,iBAAA,CAA4C;AAAA,EAavD,YAA6B,iBAAA,EAA4C;AAA5C,IAAA,IAAA,CAAA,iBAAA,GAAA,iBAAA;AAE3B,IAAA,IAAA,CAAK,SAAA,GAAY,KAAK,mBAAA,EAAoB;AAAA,EAC5C;AAAA,EAfA,OAAO,OAAA,GAAqD,CAAC,UAAEA,UAAO,KAAM;AAC1E,IAAA,MAAM,OAAA,GAAUC,mCAAA;AAAA,MACdD,QAAA,CAAO,sBAAA,CAAuB,qBAAqB,CAAA,IAAK;AAAC,KAC3D;AACA,IAAA,OAAOE,yBAAA;AAAA,MACL,QAAQ,GAAA,CAAI,CAAA,CAAA,KAAK,IAAI,iBAAA,CAAkB,CAAC,CAAC,CAAA;AAAA,MACzC,CAAA,CAAA,KAAK,EAAE,MAAA,CAAO;AAAA,KAChB;AAAA,EACF,CAAA;AAAA,EAEiB,SAAA;AAAA,EAOjB,IAAI,IAAA,GAAe;AACjB,IAAA,OAAO,QAAA;AAAA,EACT;AAAA,EAEA,IAAI,KAAA,GAAgB;AAClB,IAAA,OAAO,KAAK,iBAAA,CAAkB,IAAA;AAAA,EAChC;AAAA,EAEA,IAAI,MAAA,GAAkC;AACpC,IAAA,OAAO,IAAA,CAAK,iBAAA;AAAA,EACd;AAAA,EAEA,WAAW,OAAA,EAIA;AACT,IAAA,OAAOC,6BAAqB,OAAO,CAAA;AAAA,EACrC;AAAA,EAEA,eAAe,GAAA,EAAqB;AAClC,IAAA,OAAO,oBAAA,CAAqB,KAAK,MAAM,CAAA;AAAA,EACzC;AAAA,EAEA,KAAA,CAAM,OAA0B,IAAA,EAAuC;AACrE,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,EAAO,IAAI,CAAA;AAAA,EACnC;AAAA,EAEQ,mBAAA,GAAqC;AAC3C,IAAA,IAAI,OAAA,GAAyB,OAAO,GAAA,EAAK,OAAA,KAAY;AACnD,MAAA,OAAO,MAAM,GAAA,EAAK,EAAE,GAAG,OAAA,EAAS,IAAA,EAAM,eAAe,CAAA;AAAA,IACvD,CAAA;AAEA,IAAA,MAAM,WAAA,GAAc,KAAK,iBAAA,CAAkB,KAAA;AAC3C,IAAA,IAAI,WAAA,EAAa;AAEf,MAAA,OAAA,GAAU,IAAA,CAAK,SAAA,CAAU,OAAA,EAAS,WAAW,CAAA;AAG7C,MAAA,IACE,WAAA,CAAY,uBAAA,IACZ,WAAA,CAAY,uBAAA,GAA0B,CAAA,EACtC;AACA,QAAA,OAAA,GAAUC,0BAAA,CAAU;AAAA,UAClB,OAAO,WAAA,CAAY,uBAAA;AAAA,UACnB,QAAA,EAAU;AAAA,SACX,EAAE,OAAO,CAAA;AAAA,MACZ;AAAA,IACF;AAEA,IAAA,OAAO,OAAA;AAAA,EACT;AAAA,EAEQ,SAAA,CACN,SACA,WAAA,EACe;AACf,IAAA,MAAM,UAAA,GAAa,aAAa,UAAA,IAAc,CAAA;AAC9C,IAAA,MAAM,gBAAA,GAAmB,WAAA,EAAa,gBAAA,IAAoB,EAAC;AAC3D,IAAA,IAAI,UAAA,IAAc,CAAA,IAAK,gBAAA,CAAiB,MAAA,KAAW,CAAA,EAAG;AACpD,MAAA,OAAO,OAAA;AAAA,IACT;AAEA,IAAA,OAAO,OAAO,KAAK,OAAA,KAAY;AAC7B,MAAA,MAAM,cAAc,OAAA,EAAS,MAAA;AAC7B,MAAA,IAAI,QAAA;AACJ,MAAA,IAAI,OAAA,GAAU,CAAA;AACd,MAAA,WAAS;AACP,QAAA,QAAA,GAAW,MAAM,OAAA,CAAQ,GAAA,EAAK,OAAO,CAAA;AAErC,QAAA,IAAI,CAAC,gBAAA,CAAiB,QAAA,CAAS,QAAA,CAAS,MAAM,CAAA,EAAG;AAC/C,UAAA;AAAA,QACF;AAGA,QAAA,IAAI,aAAa,UAAA,EAAY;AAC3B,UAAA;AAAA,QACF;AAEA,QAAA,MAAM,UAAA,GAAa,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,aAAa,CAAA;AACrD,QAAA,MAAM,QAAQ,UAAA,GACV,QAAA,CAAS,UAAA,EAAY,EAAE,IAAI,GAAA,GAC3B,IAAA,CAAK,GAAA,CAAI,GAAA,GAAM,KAAK,GAAA,CAAI,CAAA,EAAG,OAAA,GAAU,CAAC,GAAG,GAAK,CAAA;AAElD,QAAA,MAAM,KAAA,CAAM,OAAO,WAAW,CAAA;AAAA,MAChC;AAEA,MAAA,OAAO,QAAA;AAAA,IACT,CAAA;AAAA,EACF;AACF;AAEA,eAAsB,KAAA,CACpB,YACA,WAAA,EACe;AACf,EAAA,IAAI,aAAa,OAAA,EAAS;AACxB,IAAA;AAAA,EACF;AAEA,EAAA,MAAM,IAAI,QAAc,CAAA,OAAA,KAAW;AACjC,IAAA,IAAI,aAAA,GAA4C,MAAA;AAEhD,IAAA,MAAM,OAAO,MAAM;AACjB,MAAA,IAAI,aAAA,EAAe;AACjB,QAAA,YAAA,CAAa,aAAa,CAAA;AAAA,MAC5B;AACA,MAAA,WAAA,EAAa,mBAAA,CAAoB,SAAS,IAAI,CAAA;AAC9C,MAAA,OAAA,EAAQ;AAAA,IACV,CAAA;AAEA,IAAA,aAAA,GAAgB,UAAA,CAAW,MAAM,UAAU,CAAA;AAC3C,IAAA,WAAA,EAAa,gBAAA,CAAiB,SAAS,IAAI,CAAA;AAAA,EAC7C,CAAC,CAAA;AACH;AASO,SAAS,oBAAA,CACd,KACA,IAAA,EACQ;AACR,EAAA,OAAO,GAAA,CAAI,OAAA,CAAQ,0BAAA,EAA4B,CAAA,GAAA,EAAM,IAAI,CAAA,CAAA,CAAG,CAAA;AAC9D;;;;;;"}

package/dist/gitlab/GitLabIntegration.esm.js

@@ -1,9 +1,11 @@
 import { basicIntegrations, defaultScmResolveUrl } from '../helpers.esm.js';
 import { readGitLabIntegrationConfigs } from './config.esm.js';
+import pThrottle from 'p-throttle';
 
 class GitLabIntegration {
   constructor(integrationConfig) {
     this.integrationConfig = integrationConfig;
+    this.fetchImpl = this.createFetchStrategy();
   }
   static factory = ({ config }) => {
     const configs = readGitLabIntegrationConfigs(
@@ -14,6 +16,7 @@ class GitLabIntegration {
       (i) => i.config.host
     );
   };
+  fetchImpl;
   get type() {
     return "gitlab";
   }
@@ -29,10 +32,71 @@ class GitLabIntegration {
   resolveEditUrl(url) {
     return replaceGitLabUrlType(url, "edit");
   }
+  fetch(input, init) {
+    return this.fetchImpl(input, init);
+  }
+  createFetchStrategy() {
+    let fetchFn = async (url, options) => {
+      return fetch(url, { ...options, mode: "same-origin" });
+    };
+    const retryConfig = this.integrationConfig.retry;
+    if (retryConfig) {
+      fetchFn = this.withRetry(fetchFn, retryConfig);
+      if (retryConfig.maxApiRequestsPerMinute && retryConfig.maxApiRequestsPerMinute > 0) {
+        fetchFn = pThrottle({
+          limit: retryConfig.maxApiRequestsPerMinute,
+          interval: 6e4
+        })(fetchFn);
+      }
+    }
+    return fetchFn;
+  }
+  withRetry(fetchFn, retryConfig) {
+    const maxRetries = retryConfig?.maxRetries ?? 0;
+    const retryStatusCodes = retryConfig?.retryStatusCodes ?? [];
+    if (maxRetries <= 0 || retryStatusCodes.length === 0) {
+      return fetchFn;
+    }
+    return async (url, options) => {
+      const abortSignal = options?.signal;
+      let response;
+      let attempt = 0;
+      for (; ; ) {
+        response = await fetchFn(url, options);
+        if (!retryStatusCodes.includes(response.status)) {
+          break;
+        }
+        if (attempt++ >= maxRetries) {
+          break;
+        }
+        const retryAfter = response.headers.get("Retry-After");
+        const delay = retryAfter ? parseInt(retryAfter, 10) * 1e3 : Math.min(100 * Math.pow(2, attempt - 1), 1e4);
+        await sleep(delay, abortSignal);
+      }
+      return response;
+    };
+  }
+}
+async function sleep(durationMs, abortSignal) {
+  if (abortSignal?.aborted) {
+    return;
+  }
+  await new Promise((resolve) => {
+    let timeoutHandle = void 0;
+    const done = () => {
+      if (timeoutHandle) {
+        clearTimeout(timeoutHandle);
+      }
+      abortSignal?.removeEventListener("abort", done);
+      resolve();
+    };
+    timeoutHandle = setTimeout(done, durationMs);
+    abortSignal?.addEventListener("abort", done);
+  });
 }
 function replaceGitLabUrlType(url, type) {
   return url.replace(/\/\-\/(blob|tree|edit)\//, `/-/${type}/`);
 }
 
-export { GitLabIntegration, replaceGitLabUrlType };
+export { GitLabIntegration, replaceGitLabUrlType, sleep };
 //# sourceMappingURL=GitLabIntegration.esm.js.map

package/dist/gitlab/GitLabIntegration.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"GitLabIntegration.esm.js","sources":["../../src/gitlab/GitLabIntegration.ts"],"sourcesContent":["/*\n * Copyright 2020 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, defaultScmResolveUrl } from '../helpers';\nimport { ScmIntegration, ScmIntegrationsFactory } from '../types';\nimport {\n  GitLabIntegrationConfig,\n  readGitLabIntegrationConfigs,\n} from './config';\n\n/**\n * A GitLab based integration.\n *\n * @public\n */\nexport class GitLabIntegration implements ScmIntegration {\n  static factory: ScmIntegrationsFactory<GitLabIntegration> = ({ config }) => {\n    const configs = readGitLabIntegrationConfigs(\n      config.getOptionalConfigArray('integrations.gitlab') ?? [],\n    );\n    return basicIntegrations(\n      configs.map(c => new GitLabIntegration(c)),\n      i => i.config.host,\n    );\n  };\n\n  constructor(private readonly integrationConfig: GitLabIntegrationConfig) {}\n\n  get type(): string {\n    return 'gitlab';\n  }\n\n  get title(): string {\n    return this.integrationConfig.host;\n  }\n\n  get config(): GitLabIntegrationConfig {\n    return this.integrationConfig;\n  }\n\n  resolveUrl(options: {\n    url: string;\n    base: string;\n    lineNumber?: number;\n  }): string {\n    return defaultScmResolveUrl(options);\n  }\n\n  resolveEditUrl(url: string): string {\n    return replaceGitLabUrlType(url, 'edit');\n  }\n}\n\n/**\n * Takes a GitLab URL and replaces the type part (blob, tree etc).\n *\n * @param url - The original URL\n * @param type - The desired type, e.g. 'blob', 'tree', 'edit'\n * @public\n */\nexport function replaceGitLabUrlType(\n  url: string,\n  type: 'blob' | 'tree' | 'edit',\n): string {\n  return url.replace(/\\/\\-\\/(blob|tree|edit)\\//, `/-/${type}/`);\n}\n"],"names":[],"mappings":";;;AA4BO,MAAM,iBAAA,CAA4C;AAAA,EAWvD,YAA6B,iBAAA,EAA4C;AAA5C,IAAA,IAAA,CAAA,iBAAA,GAAA,iBAAA;AAAA,EAA6C;AAAA,EAV1E,OAAO,OAAA,GAAqD,CAAC,EAAE,QAAO,KAAM;AAC1E,IAAA,MAAM,OAAA,GAAU,4BAAA;AAAA,MACd,MAAA,CAAO,sBAAA,CAAuB,qBAAqB,CAAA,IAAK;AAAC,KAC3D;AACA,IAAA,OAAO,iBAAA;AAAA,MACL,QAAQ,GAAA,CAAI,CAAA,CAAA,KAAK,IAAI,iBAAA,CAAkB,CAAC,CAAC,CAAA;AAAA,MACzC,CAAA,CAAA,KAAK,EAAE,MAAA,CAAO;AAAA,KAChB;AAAA,EACF,CAAA;AAAA,EAIA,IAAI,IAAA,GAAe;AACjB,IAAA,OAAO,QAAA;AAAA,EACT;AAAA,EAEA,IAAI,KAAA,GAAgB;AAClB,IAAA,OAAO,KAAK,iBAAA,CAAkB,IAAA;AAAA,EAChC;AAAA,EAEA,IAAI,MAAA,GAAkC;AACpC,IAAA,OAAO,IAAA,CAAK,iBAAA;AAAA,EACd;AAAA,EAEA,WAAW,OAAA,EAIA;AACT,IAAA,OAAO,qBAAqB,OAAO,CAAA;AAAA,EACrC;AAAA,EAEA,eAAe,GAAA,EAAqB;AAClC,IAAA,OAAO,oBAAA,CAAqB,KAAK,MAAM,CAAA;AAAA,EACzC;AACF;AASO,SAAS,oBAAA,CACd,KACA,IAAA,EACQ;AACR,EAAA,OAAO,GAAA,CAAI,OAAA,CAAQ,0BAAA,EAA4B,CAAA,GAAA,EAAM,IAAI,CAAA,CAAA,CAAG,CAAA;AAC9D;;;;"}
+{"version":3,"file":"GitLabIntegration.esm.js","sources":["../../src/gitlab/GitLabIntegration.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { basicIntegrations, defaultScmResolveUrl } from '../helpers';\nimport { ScmIntegration, ScmIntegrationsFactory } from '../types';\nimport {\n  GitLabIntegrationConfig,\n  readGitLabIntegrationConfigs,\n} from './config';\nimport pThrottle from 'p-throttle';\n\ntype FetchFunction = typeof fetch;\n\n/**\n * A GitLab based integration.\n *\n * @public\n */\nexport class GitLabIntegration implements ScmIntegration {\n  static factory: ScmIntegrationsFactory<GitLabIntegration> = ({ config }) => {\n    const configs = readGitLabIntegrationConfigs(\n      config.getOptionalConfigArray('integrations.gitlab') ?? [],\n    );\n    return basicIntegrations(\n      configs.map(c => new GitLabIntegration(c)),\n      i => i.config.host,\n    );\n  };\n\n  private readonly fetchImpl: FetchFunction;\n\n  constructor(private readonly integrationConfig: GitLabIntegrationConfig) {\n    // Configure fetch strategy based on configuration\n    this.fetchImpl = this.createFetchStrategy();\n  }\n\n  get type(): string {\n    return 'gitlab';\n  }\n\n  get title(): string {\n    return this.integrationConfig.host;\n  }\n\n  get config(): GitLabIntegrationConfig {\n    return this.integrationConfig;\n  }\n\n  resolveUrl(options: {\n    url: string;\n    base: string;\n    lineNumber?: number;\n  }): string {\n    return defaultScmResolveUrl(options);\n  }\n\n  resolveEditUrl(url: string): string {\n    return replaceGitLabUrlType(url, 'edit');\n  }\n\n  fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response> {\n    return this.fetchImpl(input, init);\n  }\n\n  private createFetchStrategy(): FetchFunction {\n    let fetchFn: FetchFunction = async (url, options) => {\n      return fetch(url, { ...options, mode: 'same-origin' });\n    };\n\n    const retryConfig = this.integrationConfig.retry;\n    if (retryConfig) {\n      // Apply retry wrapper if configured\n      fetchFn = this.withRetry(fetchFn, retryConfig);\n\n      // Apply throttling wrapper if configured\n      if (\n        retryConfig.maxApiRequestsPerMinute &&\n        retryConfig.maxApiRequestsPerMinute > 0\n      ) {\n        fetchFn = pThrottle({\n          limit: retryConfig.maxApiRequestsPerMinute,\n          interval: 60_000,\n        })(fetchFn);\n      }\n    }\n\n    return fetchFn;\n  }\n\n  private withRetry(\n    fetchFn: FetchFunction,\n    retryConfig: { maxRetries?: number; retryStatusCodes?: number[] },\n  ): FetchFunction {\n    const maxRetries = retryConfig?.maxRetries ?? 0;\n    const retryStatusCodes = retryConfig?.retryStatusCodes ?? [];\n    if (maxRetries <= 0 || retryStatusCodes.length === 0) {\n      return fetchFn;\n    }\n\n    return async (url, options) => {\n      const abortSignal = options?.signal;\n      let response: Response;\n      let attempt = 0;\n      for (;;) {\n        response = await fetchFn(url, options);\n        // If response is not retryable, return immediately\n        if (!retryStatusCodes.includes(response.status)) {\n          break;\n        }\n\n        // If this was the last allowed attempt, return response\n        if (attempt++ >= maxRetries) {\n          break;\n        }\n        // Determine delay from Retry-After header if present, otherwise exponential backoff\n        const retryAfter = response.headers.get('Retry-After');\n        const delay = retryAfter\n          ? parseInt(retryAfter, 10) * 1000\n          : Math.min(100 * Math.pow(2, attempt - 1), 10000); // Exponential backoff, cap at 10 seconds\n\n        await sleep(delay, abortSignal);\n      }\n\n      return response;\n    };\n  }\n}\n\nexport async function sleep(\n  durationMs: number,\n  abortSignal: AbortSignal | null | undefined,\n): Promise<void> {\n  if (abortSignal?.aborted) {\n    return;\n  }\n\n  await new Promise<void>(resolve => {\n    let timeoutHandle: NodeJS.Timeout | undefined = undefined;\n\n    const done = () => {\n      if (timeoutHandle) {\n        clearTimeout(timeoutHandle);\n      }\n      abortSignal?.removeEventListener('abort', done);\n      resolve();\n    };\n\n    timeoutHandle = setTimeout(done, durationMs);\n    abortSignal?.addEventListener('abort', done);\n  });\n}\n\n/**\n * Takes a GitLab URL and replaces the type part (blob, tree etc).\n *\n * @param url - The original URL\n * @param type - The desired type, e.g. 'blob', 'tree', 'edit'\n * @public\n */\nexport function replaceGitLabUrlType(\n  url: string,\n  type: 'blob' | 'tree' | 'edit',\n): string {\n  return url.replace(/\\/\\-\\/(blob|tree|edit)\\//, `/-/${type}/`);\n}\n"],"names":[],"mappings":";;;;AA8BO,MAAM,iBAAA,CAA4C;AAAA,EAavD,YAA6B,iBAAA,EAA4C;AAA5C,IAAA,IAAA,CAAA,iBAAA,GAAA,iBAAA;AAE3B,IAAA,IAAA,CAAK,SAAA,GAAY,KAAK,mBAAA,EAAoB;AAAA,EAC5C;AAAA,EAfA,OAAO,OAAA,GAAqD,CAAC,EAAE,QAAO,KAAM;AAC1E,IAAA,MAAM,OAAA,GAAU,4BAAA;AAAA,MACd,MAAA,CAAO,sBAAA,CAAuB,qBAAqB,CAAA,IAAK;AAAC,KAC3D;AACA,IAAA,OAAO,iBAAA;AAAA,MACL,QAAQ,GAAA,CAAI,CAAA,CAAA,KAAK,IAAI,iBAAA,CAAkB,CAAC,CAAC,CAAA;AAAA,MACzC,CAAA,CAAA,KAAK,EAAE,MAAA,CAAO;AAAA,KAChB;AAAA,EACF,CAAA;AAAA,EAEiB,SAAA;AAAA,EAOjB,IAAI,IAAA,GAAe;AACjB,IAAA,OAAO,QAAA;AAAA,EACT;AAAA,EAEA,IAAI,KAAA,GAAgB;AAClB,IAAA,OAAO,KAAK,iBAAA,CAAkB,IAAA;AAAA,EAChC;AAAA,EAEA,IAAI,MAAA,GAAkC;AACpC,IAAA,OAAO,IAAA,CAAK,iBAAA;AAAA,EACd;AAAA,EAEA,WAAW,OAAA,EAIA;AACT,IAAA,OAAO,qBAAqB,OAAO,CAAA;AAAA,EACrC;AAAA,EAEA,eAAe,GAAA,EAAqB;AAClC,IAAA,OAAO,oBAAA,CAAqB,KAAK,MAAM,CAAA;AAAA,EACzC;AAAA,EAEA,KAAA,CAAM,OAA0B,IAAA,EAAuC;AACrE,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,EAAO,IAAI,CAAA;AAAA,EACnC;AAAA,EAEQ,mBAAA,GAAqC;AAC3C,IAAA,IAAI,OAAA,GAAyB,OAAO,GAAA,EAAK,OAAA,KAAY;AACnD,MAAA,OAAO,MAAM,GAAA,EAAK,EAAE,GAAG,OAAA,EAAS,IAAA,EAAM,eAAe,CAAA;AAAA,IACvD,CAAA;AAEA,IAAA,MAAM,WAAA,GAAc,KAAK,iBAAA,CAAkB,KAAA;AAC3C,IAAA,IAAI,WAAA,EAAa;AAEf,MAAA,OAAA,GAAU,IAAA,CAAK,SAAA,CAAU,OAAA,EAAS,WAAW,CAAA;AAG7C,MAAA,IACE,WAAA,CAAY,uBAAA,IACZ,WAAA,CAAY,uBAAA,GAA0B,CAAA,EACtC;AACA,QAAA,OAAA,GAAU,SAAA,CAAU;AAAA,UAClB,OAAO,WAAA,CAAY,uBAAA;AAAA,UACnB,QAAA,EAAU;AAAA,SACX,EAAE,OAAO,CAAA;AAAA,MACZ;AAAA,IACF;AAEA,IAAA,OAAO,OAAA;AAAA,EACT;AAAA,EAEQ,SAAA,CACN,SACA,WAAA,EACe;AACf,IAAA,MAAM,UAAA,GAAa,aAAa,UAAA,IAAc,CAAA;AAC9C,IAAA,MAAM,gBAAA,GAAmB,WAAA,EAAa,gBAAA,IAAoB,EAAC;AAC3D,IAAA,IAAI,UAAA,IAAc,CAAA,IAAK,gBAAA,CAAiB,MAAA,KAAW,CAAA,EAAG;AACpD,MAAA,OAAO,OAAA;AAAA,IACT;AAEA,IAAA,OAAO,OAAO,KAAK,OAAA,KAAY;AAC7B,MAAA,MAAM,cAAc,OAAA,EAAS,MAAA;AAC7B,MAAA,IAAI,QAAA;AACJ,MAAA,IAAI,OAAA,GAAU,CAAA;AACd,MAAA,WAAS;AACP,QAAA,QAAA,GAAW,MAAM,OAAA,CAAQ,GAAA,EAAK,OAAO,CAAA;AAErC,QAAA,IAAI,CAAC,gBAAA,CAAiB,QAAA,CAAS,QAAA,CAAS,MAAM,CAAA,EAAG;AAC/C,UAAA;AAAA,QACF;AAGA,QAAA,IAAI,aAAa,UAAA,EAAY;AAC3B,UAAA;AAAA,QACF;AAEA,QAAA,MAAM,UAAA,GAAa,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,aAAa,CAAA;AACrD,QAAA,MAAM,QAAQ,UAAA,GACV,QAAA,CAAS,UAAA,EAAY,EAAE,IAAI,GAAA,GAC3B,IAAA,CAAK,GAAA,CAAI,GAAA,GAAM,KAAK,GAAA,CAAI,CAAA,EAAG,OAAA,GAAU,CAAC,GAAG,GAAK,CAAA;AAElD,QAAA,MAAM,KAAA,CAAM,OAAO,WAAW,CAAA;AAAA,MAChC;AAEA,MAAA,OAAO,QAAA;AAAA,IACT,CAAA;AAAA,EACF;AACF;AAEA,eAAsB,KAAA,CACpB,YACA,WAAA,EACe;AACf,EAAA,IAAI,aAAa,OAAA,EAAS;AACxB,IAAA;AAAA,EACF;AAEA,EAAA,MAAM,IAAI,QAAc,CAAA,OAAA,KAAW;AACjC,IAAA,IAAI,aAAA,GAA4C,MAAA;AAEhD,IAAA,MAAM,OAAO,MAAM;AACjB,MAAA,IAAI,aAAA,EAAe;AACjB,QAAA,YAAA,CAAa,aAAa,CAAA;AAAA,MAC5B;AACA,MAAA,WAAA,EAAa,mBAAA,CAAoB,SAAS,IAAI,CAAA;AAC9C,MAAA,OAAA,EAAQ;AAAA,IACV,CAAA;AAEA,IAAA,aAAA,GAAgB,UAAA,CAAW,MAAM,UAAU,CAAA;AAC3C,IAAA,WAAA,EAAa,gBAAA,CAAiB,SAAS,IAAI,CAAA;AAAA,EAC7C,CAAC,CAAA;AACH;AASO,SAAS,oBAAA,CACd,KACA,IAAA,EACQ;AACR,EAAA,OAAO,GAAA,CAAI,OAAA,CAAQ,0BAAA,EAA4B,CAAA,GAAA,EAAM,IAAI,CAAA,CAAA,CAAG,CAAA;AAC9D;;;;"}

package/dist/gitlab/config.cjs.js

@@ -5,6 +5,25 @@ var helpers = require('../helpers.cjs.js');
 
 const GITLAB_HOST = "gitlab.com";
 const GITLAB_API_BASE_URL = "https://gitlab.com/api/v4";
+function readOptionalNumberArray(config, key) {
+  const value = config.getOptional(key);
+  if (value === void 0) {
+    return void 0;
+  }
+  if (!Array.isArray(value)) {
+    throw new Error(
+      `Invalid ${key} config: expected an array, got ${typeof value}`
+    );
+  }
+  return value.map((item, index) => {
+    if (typeof item !== "number") {
+      throw new Error(
+        `Invalid ${key} config: all values must be numbers, got ${typeof item} at index ${index}`
+      );
+    }
+    return item;
+  });
+}
 function readGitLabIntegrationConfig(config) {
   const host = config.getString("host");
   let apiBaseUrl = config.getOptionalString("apiBaseUrl");
@@ -33,12 +52,19 @@ function readGitLabIntegrationConfig(config) {
       `Invalid GitLab integration config, '${baseUrl}' is not a valid baseUrl`
     );
   }
+  const retryConfig = config.getOptionalConfig("retry");
+  const retry = retryConfig ? {
+    maxRetries: retryConfig.getOptionalNumber("maxRetries") ?? 0,
+    retryStatusCodes: readOptionalNumberArray(retryConfig, "retryStatusCodes") ?? [],
+    maxApiRequestsPerMinute: retryConfig.getOptionalNumber("maxApiRequestsPerMinute") ?? -1
+  } : void 0;
   return {
     host,
     token,
     apiBaseUrl,
     baseUrl,
-    commitSigningKey: config.getOptionalString("commitSigningKey")
+    commitSigningKey: config.getOptionalString("commitSigningKey"),
+    retry
   };
 }
 function readGitLabIntegrationConfigs(configs) {

package/dist/gitlab/config.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.cjs.js","sources":["../../src/gitlab/config.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { Config } from '@backstage/config';\nimport { trimEnd } from 'lodash';\nimport { isValidHost, isValidUrl } from '../helpers';\n\nconst GITLAB_HOST = 'gitlab.com';\nconst GITLAB_API_BASE_URL = 'https://gitlab.com/api/v4';\n\n/**\n * The configuration parameters for a single GitLab integration.\n *\n * @public\n */\nexport type GitLabIntegrationConfig = {\n  /**\n   * The host of the target that this matches on, e.g. `gitlab.com`.\n   */\n  host: string;\n\n  /**\n   * The base URL of the API of this provider, e.g.\n   * `https://gitlab.com/api/v4`, with no trailing slash.\n   *\n   * May be omitted specifically for public GitLab; then it will be deduced.\n   */\n  apiBaseUrl: string;\n\n  /**\n   * The authorization token to use for requests to this provider.\n   *\n   * If no token is specified, anonymous access is used.\n   */\n  token?: string;\n\n  /**\n   * The baseUrl of this provider, e.g. `https://gitlab.com`, which is passed\n   * into the GitLab client.\n   *\n   * If no baseUrl is provided, it will default to `https://${host}`\n   */\n  baseUrl: string;\n\n  /**\n   * Signing key to sign commits\n   */\n  commitSigningKey?: string;\n};\n\n/**\n * Reads a single GitLab integration config.\n *\n * @param config - The config object of a single integration\n * @public\n */\nexport function readGitLabIntegrationConfig(\n  config: Config,\n): GitLabIntegrationConfig {\n  const host = config.getString('host');\n  let apiBaseUrl = config.getOptionalString('apiBaseUrl');\n  const token = config.getOptionalString('token')?.trim();\n  let baseUrl = config.getOptionalString('baseUrl');\n  if (apiBaseUrl) {\n    apiBaseUrl = trimEnd(apiBaseUrl, '/');\n  } else if (host === GITLAB_HOST) {\n    apiBaseUrl = GITLAB_API_BASE_URL;\n  }\n\n  if (baseUrl) {\n    baseUrl = trimEnd(baseUrl, '/');\n  } else {\n    baseUrl = `https://${host}`;\n  }\n\n  if (!isValidHost(host)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${host}' is not a valid host`,\n    );\n  } else if (!apiBaseUrl || !isValidUrl(apiBaseUrl)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${apiBaseUrl}' is not a valid apiBaseUrl`,\n    );\n  } else if (!isValidUrl(baseUrl)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${baseUrl}' is not a valid baseUrl`,\n    );\n  }\n\n  return {\n    host,\n    token,\n    apiBaseUrl,\n    baseUrl,\n    commitSigningKey: config.getOptionalString('commitSigningKey'),\n  };\n}\n\n/**\n * Reads a set of GitLab integration configs, and inserts some defaults for\n * public GitLab if not specified.\n *\n * @param configs - All of the integration config objects\n * @public\n */\nexport function readGitLabIntegrationConfigs(\n  configs: Config[],\n): GitLabIntegrationConfig[] {\n  // First read all the explicit integrations\n  const result = configs.map(readGitLabIntegrationConfig);\n\n  // As a convenience we always make sure there's at least an unauthenticated\n  // reader for public gitlab repos.\n  if (!result.some(c => c.host === GITLAB_HOST)) {\n    result.push({\n      host: GITLAB_HOST,\n      apiBaseUrl: GITLAB_API_BASE_URL,\n      baseUrl: `https://${GITLAB_HOST}`,\n    });\n  }\n\n  return result;\n}\n\n/**\n * Reads a GitLab integration config, and returns\n * relative path.\n *\n * @param config - GitLabIntegrationConfig object\n * @public\n */\nexport function getGitLabIntegrationRelativePath(\n  config: GitLabIntegrationConfig,\n): string {\n  let relativePath = '';\n  if (config.host !== GITLAB_HOST) {\n    relativePath = new URL(config.baseUrl).pathname;\n  }\n  return trimEnd(relativePath, '/');\n}\n"],"names":["trimEnd","isValidHost","isValidUrl"],"mappings":";;;;;AAoBA,MAAM,WAAA,GAAc,YAAA;AACpB,MAAM,mBAAA,GAAsB,2BAAA;AAgDrB,SAAS,4BACd,MAAA,EACyB;AACzB,EAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,MAAM,CAAA;AACpC,EAAA,IAAI,UAAA,GAAa,MAAA,CAAO,iBAAA,CAAkB,YAAY,CAAA;AACtD,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,iBAAA,CAAkB,OAAO,GAAG,IAAA,EAAK;AACtD,EAAA,IAAI,OAAA,GAAU,MAAA,CAAO,iBAAA,CAAkB,SAAS,CAAA;AAChD,EAAA,IAAI,UAAA,EAAY;AACd,IAAA,UAAA,GAAaA,cAAA,CAAQ,YAAY,GAAG,CAAA;AAAA,EACtC,CAAA,MAAA,IAAW,SAAS,WAAA,EAAa;AAC/B,IAAA,UAAA,GAAa,mBAAA;AAAA,EACf;AAEA,EAAA,IAAI,OAAA,EAAS;AACX,IAAA,OAAA,GAAUA,cAAA,CAAQ,SAAS,GAAG,CAAA;AAAA,EAChC,CAAA,MAAO;AACL,IAAA,OAAA,GAAU,WAAW,IAAI,CAAA,CAAA;AAAA,EAC3B;AAEA,EAAA,IAAI,CAACC,mBAAA,CAAY,IAAI,CAAA,EAAG;AACtB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,IAAI,CAAA,qBAAA;AAAA,KAC7C;AAAA,EACF,WAAW,CAAC,UAAA,IAAc,CAACC,kBAAA,CAAW,UAAU,CAAA,EAAG;AACjD,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,UAAU,CAAA,2BAAA;AAAA,KACnD;AAAA,EACF,CAAA,MAAA,IAAW,CAACA,kBAAA,CAAW,OAAO,CAAA,EAAG;AAC/B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,OAAO,CAAA,wBAAA;AAAA,KAChD;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,IAAA;AAAA,IACA,KAAA;AAAA,IACA,UAAA;AAAA,IACA,OAAA;AAAA,IACA,gBAAA,EAAkB,MAAA,CAAO,iBAAA,CAAkB,kBAAkB;AAAA,GAC/D;AACF;AASO,SAAS,6BACd,OAAA,EAC2B;AAE3B,EAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,GAAA,CAAI,2BAA2B,CAAA;AAItD,EAAA,IAAI,CAAC,MAAA,CAAO,IAAA,CAAK,OAAK,CAAA,CAAE,IAAA,KAAS,WAAW,CAAA,EAAG;AAC7C,IAAA,MAAA,CAAO,IAAA,CAAK;AAAA,MACV,IAAA,EAAM,WAAA;AAAA,MACN,UAAA,EAAY,mBAAA;AAAA,MACZ,OAAA,EAAS,WAAW,WAAW,CAAA;AAAA,KAChC,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,MAAA;AACT;AASO,SAAS,iCACd,MAAA,EACQ;AACR,EAAA,IAAI,YAAA,GAAe,EAAA;AACnB,EAAA,IAAI,MAAA,CAAO,SAAS,WAAA,EAAa;AAC/B,IAAA,YAAA,GAAe,IAAI,GAAA,CAAI,MAAA,CAAO,OAAO,CAAA,CAAE,QAAA;AAAA,EACzC;AACA,EAAA,OAAOF,cAAA,CAAQ,cAAc,GAAG,CAAA;AAClC;;;;;;"}
+{"version":3,"file":"config.cjs.js","sources":["../../src/gitlab/config.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { Config } from '@backstage/config';\nimport { trimEnd } from 'lodash';\nimport { isValidHost, isValidUrl } from '../helpers';\n\nconst GITLAB_HOST = 'gitlab.com';\nconst GITLAB_API_BASE_URL = 'https://gitlab.com/api/v4';\n\n/**\n * Reads an optional number array from config\n */\nfunction readOptionalNumberArray(\n  config: Config,\n  key: string,\n): number[] | undefined {\n  const value = config.getOptional(key);\n  if (value === undefined) {\n    return undefined;\n  }\n  if (!Array.isArray(value)) {\n    throw new Error(\n      `Invalid ${key} config: expected an array, got ${typeof value}`,\n    );\n  }\n  return value.map((item, index) => {\n    if (typeof item !== 'number') {\n      throw new Error(\n        `Invalid ${key} config: all values must be numbers, got ${typeof item} at index ${index}`,\n      );\n    }\n    return item;\n  });\n}\n\n/**\n * The configuration parameters for a single GitLab integration.\n *\n * @public\n */\nexport type GitLabIntegrationConfig = {\n  /**\n   * The host of the target that this matches on, e.g. `gitlab.com`.\n   */\n  host: string;\n\n  /**\n   * The base URL of the API of this provider, e.g.\n   * `https://gitlab.com/api/v4`, with no trailing slash.\n   *\n   * May be omitted specifically for public GitLab; then it will be deduced.\n   */\n  apiBaseUrl: string;\n\n  /**\n   * The authorization token to use for requests to this provider.\n   *\n   * If no token is specified, anonymous access is used.\n   */\n  token?: string;\n\n  /**\n   * The baseUrl of this provider, e.g. `https://gitlab.com`, which is passed\n   * into the GitLab client.\n   *\n   * If no baseUrl is provided, it will default to `https://${host}`\n   */\n  baseUrl: string;\n\n  /**\n   * Signing key to sign commits\n   */\n  commitSigningKey?: string;\n\n  /**\n   * Retry configuration for failed requests.\n   */\n  retry?: {\n    /**\n     * Maximum number of retries for failed requests\n     * @defaultValue 0\n     */\n    maxRetries?: number;\n\n    /**\n     * HTTP status codes that should trigger a retry\n     * @defaultValue []\n     */\n    retryStatusCodes?: number[];\n\n    /**\n     * Rate limit for requests per minute\n     * @defaultValue -1\n     */\n    maxApiRequestsPerMinute?: number;\n  };\n};\n\n/**\n * Reads a single GitLab integration config.\n *\n * @param config - The config object of a single integration\n * @public\n */\nexport function readGitLabIntegrationConfig(\n  config: Config,\n): GitLabIntegrationConfig {\n  const host = config.getString('host');\n  let apiBaseUrl = config.getOptionalString('apiBaseUrl');\n  const token = config.getOptionalString('token')?.trim();\n  let baseUrl = config.getOptionalString('baseUrl');\n  if (apiBaseUrl) {\n    apiBaseUrl = trimEnd(apiBaseUrl, '/');\n  } else if (host === GITLAB_HOST) {\n    apiBaseUrl = GITLAB_API_BASE_URL;\n  }\n\n  if (baseUrl) {\n    baseUrl = trimEnd(baseUrl, '/');\n  } else {\n    baseUrl = `https://${host}`;\n  }\n\n  if (!isValidHost(host)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${host}' is not a valid host`,\n    );\n  } else if (!apiBaseUrl || !isValidUrl(apiBaseUrl)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${apiBaseUrl}' is not a valid apiBaseUrl`,\n    );\n  } else if (!isValidUrl(baseUrl)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${baseUrl}' is not a valid baseUrl`,\n    );\n  }\n\n  const retryConfig = config.getOptionalConfig('retry');\n\n  const retry = retryConfig\n    ? {\n        maxRetries: retryConfig.getOptionalNumber('maxRetries') ?? 0,\n        retryStatusCodes:\n          readOptionalNumberArray(retryConfig, 'retryStatusCodes') ?? [],\n        maxApiRequestsPerMinute:\n          retryConfig.getOptionalNumber('maxApiRequestsPerMinute') ?? -1,\n      }\n    : undefined;\n\n  return {\n    host,\n    token,\n    apiBaseUrl,\n    baseUrl,\n    commitSigningKey: config.getOptionalString('commitSigningKey'),\n    retry,\n  };\n}\n\n/**\n * Reads a set of GitLab integration configs, and inserts some defaults for\n * public GitLab if not specified.\n *\n * @param configs - All of the integration config objects\n * @public\n */\nexport function readGitLabIntegrationConfigs(\n  configs: Config[],\n): GitLabIntegrationConfig[] {\n  // First read all the explicit integrations\n  const result = configs.map(readGitLabIntegrationConfig);\n\n  // As a convenience we always make sure there's at least an unauthenticated\n  // reader for public gitlab repos.\n  if (!result.some(c => c.host === GITLAB_HOST)) {\n    result.push({\n      host: GITLAB_HOST,\n      apiBaseUrl: GITLAB_API_BASE_URL,\n      baseUrl: `https://${GITLAB_HOST}`,\n    });\n  }\n\n  return result;\n}\n\n/**\n * Reads a GitLab integration config, and returns\n * relative path.\n *\n * @param config - GitLabIntegrationConfig object\n * @public\n */\nexport function getGitLabIntegrationRelativePath(\n  config: GitLabIntegrationConfig,\n): string {\n  let relativePath = '';\n  if (config.host !== GITLAB_HOST) {\n    relativePath = new URL(config.baseUrl).pathname;\n  }\n  return trimEnd(relativePath, '/');\n}\n"],"names":["trimEnd","isValidHost","isValidUrl"],"mappings":";;;;;AAoBA,MAAM,WAAA,GAAc,YAAA;AACpB,MAAM,mBAAA,GAAsB,2BAAA;AAK5B,SAAS,uBAAA,CACP,QACA,GAAA,EACsB;AACtB,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,WAAA,CAAY,GAAG,CAAA;AACpC,EAAA,IAAI,UAAU,MAAA,EAAW;AACvB,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACzB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,QAAA,EAAW,GAAG,CAAA,gCAAA,EAAmC,OAAO,KAAK,CAAA;AAAA,KAC/D;AAAA,EACF;AACA,EAAA,OAAO,KAAA,CAAM,GAAA,CAAI,CAAC,IAAA,EAAM,KAAA,KAAU;AAChC,IAAA,IAAI,OAAO,SAAS,QAAA,EAAU;AAC5B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,WAAW,GAAG,CAAA,yCAAA,EAA4C,OAAO,IAAI,aAAa,KAAK,CAAA;AAAA,OACzF;AAAA,IACF;AACA,IAAA,OAAO,IAAA;AAAA,EACT,CAAC,CAAA;AACH;AAuEO,SAAS,4BACd,MAAA,EACyB;AACzB,EAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,MAAM,CAAA;AACpC,EAAA,IAAI,UAAA,GAAa,MAAA,CAAO,iBAAA,CAAkB,YAAY,CAAA;AACtD,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,iBAAA,CAAkB,OAAO,GAAG,IAAA,EAAK;AACtD,EAAA,IAAI,OAAA,GAAU,MAAA,CAAO,iBAAA,CAAkB,SAAS,CAAA;AAChD,EAAA,IAAI,UAAA,EAAY;AACd,IAAA,UAAA,GAAaA,cAAA,CAAQ,YAAY,GAAG,CAAA;AAAA,EACtC,CAAA,MAAA,IAAW,SAAS,WAAA,EAAa;AAC/B,IAAA,UAAA,GAAa,mBAAA;AAAA,EACf;AAEA,EAAA,IAAI,OAAA,EAAS;AACX,IAAA,OAAA,GAAUA,cAAA,CAAQ,SAAS,GAAG,CAAA;AAAA,EAChC,CAAA,MAAO;AACL,IAAA,OAAA,GAAU,WAAW,IAAI,CAAA,CAAA;AAAA,EAC3B;AAEA,EAAA,IAAI,CAACC,mBAAA,CAAY,IAAI,CAAA,EAAG;AACtB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,IAAI,CAAA,qBAAA;AAAA,KAC7C;AAAA,EACF,WAAW,CAAC,UAAA,IAAc,CAACC,kBAAA,CAAW,UAAU,CAAA,EAAG;AACjD,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,UAAU,CAAA,2BAAA;AAAA,KACnD;AAAA,EACF,CAAA,MAAA,IAAW,CAACA,kBAAA,CAAW,OAAO,CAAA,EAAG;AAC/B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,OAAO,CAAA,wBAAA;AAAA,KAChD;AAAA,EACF;AAEA,EAAA,MAAM,WAAA,GAAc,MAAA,CAAO,iBAAA,CAAkB,OAAO,CAAA;AAEpD,EAAA,MAAM,QAAQ,WAAA,GACV;AAAA,IACE,UAAA,EAAY,WAAA,CAAY,iBAAA,CAAkB,YAAY,CAAA,IAAK,CAAA;AAAA,IAC3D,gBAAA,EACE,uBAAA,CAAwB,WAAA,EAAa,kBAAkB,KAAK,EAAC;AAAA,IAC/D,uBAAA,EACE,WAAA,CAAY,iBAAA,CAAkB,yBAAyB,CAAA,IAAK;AAAA,GAChE,GACA,MAAA;AAEJ,EAAA,OAAO;AAAA,IACL,IAAA;AAAA,IACA,KAAA;AAAA,IACA,UAAA;AAAA,IACA,OAAA;AAAA,IACA,gBAAA,EAAkB,MAAA,CAAO,iBAAA,CAAkB,kBAAkB,CAAA;AAAA,IAC7D;AAAA,GACF;AACF;AASO,SAAS,6BACd,OAAA,EAC2B;AAE3B,EAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,GAAA,CAAI,2BAA2B,CAAA;AAItD,EAAA,IAAI,CAAC,MAAA,CAAO,IAAA,CAAK,OAAK,CAAA,CAAE,IAAA,KAAS,WAAW,CAAA,EAAG;AAC7C,IAAA,MAAA,CAAO,IAAA,CAAK;AAAA,MACV,IAAA,EAAM,WAAA;AAAA,MACN,UAAA,EAAY,mBAAA;AAAA,MACZ,OAAA,EAAS,WAAW,WAAW,CAAA;AAAA,KAChC,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,MAAA;AACT;AASO,SAAS,iCACd,MAAA,EACQ;AACR,EAAA,IAAI,YAAA,GAAe,EAAA;AACnB,EAAA,IAAI,MAAA,CAAO,SAAS,WAAA,EAAa;AAC/B,IAAA,YAAA,GAAe,IAAI,GAAA,CAAI,MAAA,CAAO,OAAO,CAAA,CAAE,QAAA;AAAA,EACzC;AACA,EAAA,OAAOF,cAAA,CAAQ,cAAc,GAAG,CAAA;AAClC;;;;;;"}

package/dist/gitlab/config.esm.js

@@ -3,6 +3,25 @@ import { isValidHost, isValidUrl } from '../helpers.esm.js';
 
 const GITLAB_HOST = "gitlab.com";
 const GITLAB_API_BASE_URL = "https://gitlab.com/api/v4";
+function readOptionalNumberArray(config, key) {
+  const value = config.getOptional(key);
+  if (value === void 0) {
+    return void 0;
+  }
+  if (!Array.isArray(value)) {
+    throw new Error(
+      `Invalid ${key} config: expected an array, got ${typeof value}`
+    );
+  }
+  return value.map((item, index) => {
+    if (typeof item !== "number") {
+      throw new Error(
+        `Invalid ${key} config: all values must be numbers, got ${typeof item} at index ${index}`
+      );
+    }
+    return item;
+  });
+}
 function readGitLabIntegrationConfig(config) {
   const host = config.getString("host");
   let apiBaseUrl = config.getOptionalString("apiBaseUrl");
@@ -31,12 +50,19 @@ function readGitLabIntegrationConfig(config) {
       `Invalid GitLab integration config, '${baseUrl}' is not a valid baseUrl`
     );
   }
+  const retryConfig = config.getOptionalConfig("retry");
+  const retry = retryConfig ? {
+    maxRetries: retryConfig.getOptionalNumber("maxRetries") ?? 0,
+    retryStatusCodes: readOptionalNumberArray(retryConfig, "retryStatusCodes") ?? [],
+    maxApiRequestsPerMinute: retryConfig.getOptionalNumber("maxApiRequestsPerMinute") ?? -1
+  } : void 0;
   return {
     host,
     token,
     apiBaseUrl,
     baseUrl,
-    commitSigningKey: config.getOptionalString("commitSigningKey")
+    commitSigningKey: config.getOptionalString("commitSigningKey"),
+    retry
   };
 }
 function readGitLabIntegrationConfigs(configs) {

package/dist/gitlab/config.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.esm.js","sources":["../../src/gitlab/config.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { Config } from '@backstage/config';\nimport { trimEnd } from 'lodash';\nimport { isValidHost, isValidUrl } from '../helpers';\n\nconst GITLAB_HOST = 'gitlab.com';\nconst GITLAB_API_BASE_URL = 'https://gitlab.com/api/v4';\n\n/**\n * The configuration parameters for a single GitLab integration.\n *\n * @public\n */\nexport type GitLabIntegrationConfig = {\n  /**\n   * The host of the target that this matches on, e.g. `gitlab.com`.\n   */\n  host: string;\n\n  /**\n   * The base URL of the API of this provider, e.g.\n   * `https://gitlab.com/api/v4`, with no trailing slash.\n   *\n   * May be omitted specifically for public GitLab; then it will be deduced.\n   */\n  apiBaseUrl: string;\n\n  /**\n   * The authorization token to use for requests to this provider.\n   *\n   * If no token is specified, anonymous access is used.\n   */\n  token?: string;\n\n  /**\n   * The baseUrl of this provider, e.g. `https://gitlab.com`, which is passed\n   * into the GitLab client.\n   *\n   * If no baseUrl is provided, it will default to `https://${host}`\n   */\n  baseUrl: string;\n\n  /**\n   * Signing key to sign commits\n   */\n  commitSigningKey?: string;\n};\n\n/**\n * Reads a single GitLab integration config.\n *\n * @param config - The config object of a single integration\n * @public\n */\nexport function readGitLabIntegrationConfig(\n  config: Config,\n): GitLabIntegrationConfig {\n  const host = config.getString('host');\n  let apiBaseUrl = config.getOptionalString('apiBaseUrl');\n  const token = config.getOptionalString('token')?.trim();\n  let baseUrl = config.getOptionalString('baseUrl');\n  if (apiBaseUrl) {\n    apiBaseUrl = trimEnd(apiBaseUrl, '/');\n  } else if (host === GITLAB_HOST) {\n    apiBaseUrl = GITLAB_API_BASE_URL;\n  }\n\n  if (baseUrl) {\n    baseUrl = trimEnd(baseUrl, '/');\n  } else {\n    baseUrl = `https://${host}`;\n  }\n\n  if (!isValidHost(host)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${host}' is not a valid host`,\n    );\n  } else if (!apiBaseUrl || !isValidUrl(apiBaseUrl)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${apiBaseUrl}' is not a valid apiBaseUrl`,\n    );\n  } else if (!isValidUrl(baseUrl)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${baseUrl}' is not a valid baseUrl`,\n    );\n  }\n\n  return {\n    host,\n    token,\n    apiBaseUrl,\n    baseUrl,\n    commitSigningKey: config.getOptionalString('commitSigningKey'),\n  };\n}\n\n/**\n * Reads a set of GitLab integration configs, and inserts some defaults for\n * public GitLab if not specified.\n *\n * @param configs - All of the integration config objects\n * @public\n */\nexport function readGitLabIntegrationConfigs(\n  configs: Config[],\n): GitLabIntegrationConfig[] {\n  // First read all the explicit integrations\n  const result = configs.map(readGitLabIntegrationConfig);\n\n  // As a convenience we always make sure there's at least an unauthenticated\n  // reader for public gitlab repos.\n  if (!result.some(c => c.host === GITLAB_HOST)) {\n    result.push({\n      host: GITLAB_HOST,\n      apiBaseUrl: GITLAB_API_BASE_URL,\n      baseUrl: `https://${GITLAB_HOST}`,\n    });\n  }\n\n  return result;\n}\n\n/**\n * Reads a GitLab integration config, and returns\n * relative path.\n *\n * @param config - GitLabIntegrationConfig object\n * @public\n */\nexport function getGitLabIntegrationRelativePath(\n  config: GitLabIntegrationConfig,\n): string {\n  let relativePath = '';\n  if (config.host !== GITLAB_HOST) {\n    relativePath = new URL(config.baseUrl).pathname;\n  }\n  return trimEnd(relativePath, '/');\n}\n"],"names":[],"mappings":";;;AAoBA,MAAM,WAAA,GAAc,YAAA;AACpB,MAAM,mBAAA,GAAsB,2BAAA;AAgDrB,SAAS,4BACd,MAAA,EACyB;AACzB,EAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,MAAM,CAAA;AACpC,EAAA,IAAI,UAAA,GAAa,MAAA,CAAO,iBAAA,CAAkB,YAAY,CAAA;AACtD,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,iBAAA,CAAkB,OAAO,GAAG,IAAA,EAAK;AACtD,EAAA,IAAI,OAAA,GAAU,MAAA,CAAO,iBAAA,CAAkB,SAAS,CAAA;AAChD,EAAA,IAAI,UAAA,EAAY;AACd,IAAA,UAAA,GAAa,OAAA,CAAQ,YAAY,GAAG,CAAA;AAAA,EACtC,CAAA,MAAA,IAAW,SAAS,WAAA,EAAa;AAC/B,IAAA,UAAA,GAAa,mBAAA;AAAA,EACf;AAEA,EAAA,IAAI,OAAA,EAAS;AACX,IAAA,OAAA,GAAU,OAAA,CAAQ,SAAS,GAAG,CAAA;AAAA,EAChC,CAAA,MAAO;AACL,IAAA,OAAA,GAAU,WAAW,IAAI,CAAA,CAAA;AAAA,EAC3B;AAEA,EAAA,IAAI,CAAC,WAAA,CAAY,IAAI,CAAA,EAAG;AACtB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,IAAI,CAAA,qBAAA;AAAA,KAC7C;AAAA,EACF,WAAW,CAAC,UAAA,IAAc,CAAC,UAAA,CAAW,UAAU,CAAA,EAAG;AACjD,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,UAAU,CAAA,2BAAA;AAAA,KACnD;AAAA,EACF,CAAA,MAAA,IAAW,CAAC,UAAA,CAAW,OAAO,CAAA,EAAG;AAC/B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,OAAO,CAAA,wBAAA;AAAA,KAChD;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,IAAA;AAAA,IACA,KAAA;AAAA,IACA,UAAA;AAAA,IACA,OAAA;AAAA,IACA,gBAAA,EAAkB,MAAA,CAAO,iBAAA,CAAkB,kBAAkB;AAAA,GAC/D;AACF;AASO,SAAS,6BACd,OAAA,EAC2B;AAE3B,EAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,GAAA,CAAI,2BAA2B,CAAA;AAItD,EAAA,IAAI,CAAC,MAAA,CAAO,IAAA,CAAK,OAAK,CAAA,CAAE,IAAA,KAAS,WAAW,CAAA,EAAG;AAC7C,IAAA,MAAA,CAAO,IAAA,CAAK;AAAA,MACV,IAAA,EAAM,WAAA;AAAA,MACN,UAAA,EAAY,mBAAA;AAAA,MACZ,OAAA,EAAS,WAAW,WAAW,CAAA;AAAA,KAChC,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,MAAA;AACT;AASO,SAAS,iCACd,MAAA,EACQ;AACR,EAAA,IAAI,YAAA,GAAe,EAAA;AACnB,EAAA,IAAI,MAAA,CAAO,SAAS,WAAA,EAAa;AAC/B,IAAA,YAAA,GAAe,IAAI,GAAA,CAAI,MAAA,CAAO,OAAO,CAAA,CAAE,QAAA;AAAA,EACzC;AACA,EAAA,OAAO,OAAA,CAAQ,cAAc,GAAG,CAAA;AAClC;;;;"}
+{"version":3,"file":"config.esm.js","sources":["../../src/gitlab/config.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { Config } from '@backstage/config';\nimport { trimEnd } from 'lodash';\nimport { isValidHost, isValidUrl } from '../helpers';\n\nconst GITLAB_HOST = 'gitlab.com';\nconst GITLAB_API_BASE_URL = 'https://gitlab.com/api/v4';\n\n/**\n * Reads an optional number array from config\n */\nfunction readOptionalNumberArray(\n  config: Config,\n  key: string,\n): number[] | undefined {\n  const value = config.getOptional(key);\n  if (value === undefined) {\n    return undefined;\n  }\n  if (!Array.isArray(value)) {\n    throw new Error(\n      `Invalid ${key} config: expected an array, got ${typeof value}`,\n    );\n  }\n  return value.map((item, index) => {\n    if (typeof item !== 'number') {\n      throw new Error(\n        `Invalid ${key} config: all values must be numbers, got ${typeof item} at index ${index}`,\n      );\n    }\n    return item;\n  });\n}\n\n/**\n * The configuration parameters for a single GitLab integration.\n *\n * @public\n */\nexport type GitLabIntegrationConfig = {\n  /**\n   * The host of the target that this matches on, e.g. `gitlab.com`.\n   */\n  host: string;\n\n  /**\n   * The base URL of the API of this provider, e.g.\n   * `https://gitlab.com/api/v4`, with no trailing slash.\n   *\n   * May be omitted specifically for public GitLab; then it will be deduced.\n   */\n  apiBaseUrl: string;\n\n  /**\n   * The authorization token to use for requests to this provider.\n   *\n   * If no token is specified, anonymous access is used.\n   */\n  token?: string;\n\n  /**\n   * The baseUrl of this provider, e.g. `https://gitlab.com`, which is passed\n   * into the GitLab client.\n   *\n   * If no baseUrl is provided, it will default to `https://${host}`\n   */\n  baseUrl: string;\n\n  /**\n   * Signing key to sign commits\n   */\n  commitSigningKey?: string;\n\n  /**\n   * Retry configuration for failed requests.\n   */\n  retry?: {\n    /**\n     * Maximum number of retries for failed requests\n     * @defaultValue 0\n     */\n    maxRetries?: number;\n\n    /**\n     * HTTP status codes that should trigger a retry\n     * @defaultValue []\n     */\n    retryStatusCodes?: number[];\n\n    /**\n     * Rate limit for requests per minute\n     * @defaultValue -1\n     */\n    maxApiRequestsPerMinute?: number;\n  };\n};\n\n/**\n * Reads a single GitLab integration config.\n *\n * @param config - The config object of a single integration\n * @public\n */\nexport function readGitLabIntegrationConfig(\n  config: Config,\n): GitLabIntegrationConfig {\n  const host = config.getString('host');\n  let apiBaseUrl = config.getOptionalString('apiBaseUrl');\n  const token = config.getOptionalString('token')?.trim();\n  let baseUrl = config.getOptionalString('baseUrl');\n  if (apiBaseUrl) {\n    apiBaseUrl = trimEnd(apiBaseUrl, '/');\n  } else if (host === GITLAB_HOST) {\n    apiBaseUrl = GITLAB_API_BASE_URL;\n  }\n\n  if (baseUrl) {\n    baseUrl = trimEnd(baseUrl, '/');\n  } else {\n    baseUrl = `https://${host}`;\n  }\n\n  if (!isValidHost(host)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${host}' is not a valid host`,\n    );\n  } else if (!apiBaseUrl || !isValidUrl(apiBaseUrl)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${apiBaseUrl}' is not a valid apiBaseUrl`,\n    );\n  } else if (!isValidUrl(baseUrl)) {\n    throw new Error(\n      `Invalid GitLab integration config, '${baseUrl}' is not a valid baseUrl`,\n    );\n  }\n\n  const retryConfig = config.getOptionalConfig('retry');\n\n  const retry = retryConfig\n    ? {\n        maxRetries: retryConfig.getOptionalNumber('maxRetries') ?? 0,\n        retryStatusCodes:\n          readOptionalNumberArray(retryConfig, 'retryStatusCodes') ?? [],\n        maxApiRequestsPerMinute:\n          retryConfig.getOptionalNumber('maxApiRequestsPerMinute') ?? -1,\n      }\n    : undefined;\n\n  return {\n    host,\n    token,\n    apiBaseUrl,\n    baseUrl,\n    commitSigningKey: config.getOptionalString('commitSigningKey'),\n    retry,\n  };\n}\n\n/**\n * Reads a set of GitLab integration configs, and inserts some defaults for\n * public GitLab if not specified.\n *\n * @param configs - All of the integration config objects\n * @public\n */\nexport function readGitLabIntegrationConfigs(\n  configs: Config[],\n): GitLabIntegrationConfig[] {\n  // First read all the explicit integrations\n  const result = configs.map(readGitLabIntegrationConfig);\n\n  // As a convenience we always make sure there's at least an unauthenticated\n  // reader for public gitlab repos.\n  if (!result.some(c => c.host === GITLAB_HOST)) {\n    result.push({\n      host: GITLAB_HOST,\n      apiBaseUrl: GITLAB_API_BASE_URL,\n      baseUrl: `https://${GITLAB_HOST}`,\n    });\n  }\n\n  return result;\n}\n\n/**\n * Reads a GitLab integration config, and returns\n * relative path.\n *\n * @param config - GitLabIntegrationConfig object\n * @public\n */\nexport function getGitLabIntegrationRelativePath(\n  config: GitLabIntegrationConfig,\n): string {\n  let relativePath = '';\n  if (config.host !== GITLAB_HOST) {\n    relativePath = new URL(config.baseUrl).pathname;\n  }\n  return trimEnd(relativePath, '/');\n}\n"],"names":[],"mappings":";;;AAoBA,MAAM,WAAA,GAAc,YAAA;AACpB,MAAM,mBAAA,GAAsB,2BAAA;AAK5B,SAAS,uBAAA,CACP,QACA,GAAA,EACsB;AACtB,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,WAAA,CAAY,GAAG,CAAA;AACpC,EAAA,IAAI,UAAU,MAAA,EAAW;AACvB,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACzB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,QAAA,EAAW,GAAG,CAAA,gCAAA,EAAmC,OAAO,KAAK,CAAA;AAAA,KAC/D;AAAA,EACF;AACA,EAAA,OAAO,KAAA,CAAM,GAAA,CAAI,CAAC,IAAA,EAAM,KAAA,KAAU;AAChC,IAAA,IAAI,OAAO,SAAS,QAAA,EAAU;AAC5B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,WAAW,GAAG,CAAA,yCAAA,EAA4C,OAAO,IAAI,aAAa,KAAK,CAAA;AAAA,OACzF;AAAA,IACF;AACA,IAAA,OAAO,IAAA;AAAA,EACT,CAAC,CAAA;AACH;AAuEO,SAAS,4BACd,MAAA,EACyB;AACzB,EAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,MAAM,CAAA;AACpC,EAAA,IAAI,UAAA,GAAa,MAAA,CAAO,iBAAA,CAAkB,YAAY,CAAA;AACtD,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,iBAAA,CAAkB,OAAO,GAAG,IAAA,EAAK;AACtD,EAAA,IAAI,OAAA,GAAU,MAAA,CAAO,iBAAA,CAAkB,SAAS,CAAA;AAChD,EAAA,IAAI,UAAA,EAAY;AACd,IAAA,UAAA,GAAa,OAAA,CAAQ,YAAY,GAAG,CAAA;AAAA,EACtC,CAAA,MAAA,IAAW,SAAS,WAAA,EAAa;AAC/B,IAAA,UAAA,GAAa,mBAAA;AAAA,EACf;AAEA,EAAA,IAAI,OAAA,EAAS;AACX,IAAA,OAAA,GAAU,OAAA,CAAQ,SAAS,GAAG,CAAA;AAAA,EAChC,CAAA,MAAO;AACL,IAAA,OAAA,GAAU,WAAW,IAAI,CAAA,CAAA;AAAA,EAC3B;AAEA,EAAA,IAAI,CAAC,WAAA,CAAY,IAAI,CAAA,EAAG;AACtB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,IAAI,CAAA,qBAAA;AAAA,KAC7C;AAAA,EACF,WAAW,CAAC,UAAA,IAAc,CAAC,UAAA,CAAW,UAAU,CAAA,EAAG;AACjD,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,UAAU,CAAA,2BAAA;AAAA,KACnD;AAAA,EACF,CAAA,MAAA,IAAW,CAAC,UAAA,CAAW,OAAO,CAAA,EAAG;AAC/B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,uCAAuC,OAAO,CAAA,wBAAA;AAAA,KAChD;AAAA,EACF;AAEA,EAAA,MAAM,WAAA,GAAc,MAAA,CAAO,iBAAA,CAAkB,OAAO,CAAA;AAEpD,EAAA,MAAM,QAAQ,WAAA,GACV;AAAA,IACE,UAAA,EAAY,WAAA,CAAY,iBAAA,CAAkB,YAAY,CAAA,IAAK,CAAA;AAAA,IAC3D,gBAAA,EACE,uBAAA,CAAwB,WAAA,EAAa,kBAAkB,KAAK,EAAC;AAAA,IAC/D,uBAAA,EACE,WAAA,CAAY,iBAAA,CAAkB,yBAAyB,CAAA,IAAK;AAAA,GAChE,GACA,MAAA;AAEJ,EAAA,OAAO;AAAA,IACL,IAAA;AAAA,IACA,KAAA;AAAA,IACA,UAAA;AAAA,IACA,OAAA;AAAA,IACA,gBAAA,EAAkB,MAAA,CAAO,iBAAA,CAAkB,kBAAkB,CAAA;AAAA,IAC7D;AAAA,GACF;AACF;AASO,SAAS,6BACd,OAAA,EAC2B;AAE3B,EAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,GAAA,CAAI,2BAA2B,CAAA;AAItD,EAAA,IAAI,CAAC,MAAA,CAAO,IAAA,CAAK,OAAK,CAAA,CAAE,IAAA,KAAS,WAAW,CAAA,EAAG;AAC7C,IAAA,MAAA,CAAO,IAAA,CAAK;AAAA,MACV,IAAA,EAAM,WAAA;AAAA,MACN,UAAA,EAAY,mBAAA;AAAA,MACZ,OAAA,EAAS,WAAW,WAAW,CAAA;AAAA,KAChC,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,MAAA;AACT;AASO,SAAS,iCACd,MAAA,EACQ;AACR,EAAA,IAAI,YAAA,GAAe,EAAA;AACnB,EAAA,IAAI,MAAA,CAAO,SAAS,WAAA,EAAa;AAC/B,IAAA,YAAA,GAAe,IAAI,GAAA,CAAI,MAAA,CAAO,OAAO,CAAA,CAAE,QAAA;AAAA,EACzC;AACA,EAAA,OAAO,OAAA,CAAQ,cAAc,GAAG,CAAA;AAClC;;;;"}

package/dist/gitlab/core.cjs.js

@@ -1,15 +1,10 @@
 'use strict';
 
-var fetch = require('cross-fetch');
 var config = require('./config.cjs.js');
 
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
-
-async function getGitLabFileFetchUrl(url, config, token) {
-  const projectID = await getProjectId(url, config, token);
-  return buildProjectUrl(url, projectID, config).toString();
+function getGitLabFileFetchUrl(url, config, _token) {
+  const projectPath = extractProjectPath(url, config);
+  return Promise.resolve(buildProjectUrl(url, projectPath, config).toString());
 }
 function getGitLabRequestOptions(config, token) {
   const headers = {};
@@ -19,16 +14,17 @@ function getGitLabRequestOptions(config, token) {
   }
   return { headers };
 }
-function buildProjectUrl(target, projectID, config$1) {
+function buildProjectUrl(target, projectPathOrID, config$1) {
   try {
     const url = new URL(target);
     const branchAndFilePath = url.pathname.split("/blob/").slice(1).join("/blob/");
     const [branch, ...filePath] = branchAndFilePath.split("/");
     const relativePath = config.getGitLabIntegrationRelativePath(config$1);
+    const projectIdentifier = encodeURIComponent(String(projectPathOrID));
     url.pathname = [
       ...relativePath ? [relativePath] : [],
       "api/v4/projects",
-      projectID,
+      projectIdentifier,
       "repository/files",
       encodeURIComponent(decodeURIComponent(filePath.join("/"))),
       "raw"
@@ -39,47 +35,23 @@ function buildProjectUrl(target, projectID, config$1) {
     throw new Error(`Incorrect url: ${target}, ${e}`);
   }
 }
-async function getProjectId(target, config$1, token) {
+function extractProjectPath(target, config$1) {
   const url = new URL(target);
   if (!url.pathname.includes("/blob/")) {
     throw new Error(
-      `Failed converting ${url.pathname} to a project id. Url path must include /blob/.`
+      `Failed extracting project path from ${url.pathname}. Url path must include /blob/.`
     );
   }
-  try {
-    let repo = url.pathname.split("/-/blob/")[0].split("/blob/")[0];
-    const relativePath = config.getGitLabIntegrationRelativePath(config$1);
-    if (relativePath) {
-      repo = repo.replace(relativePath, "");
-    }
-    const repoIDLookup = new URL(
-      `${url.origin}${relativePath}/api/v4/projects/${encodeURIComponent(
-        repo.replace(/^\//, "")
-      )}`
-    );
-    const response = await fetch__default.default(
-      repoIDLookup.toString(),
-      getGitLabRequestOptions(config$1, token)
-    );
-    const data = await response.json();
-    if (!response.ok) {
-      if (response.status === 401) {
-        throw new Error(
-          "GitLab Error: 401 - Unauthorized. The access token used is either expired, or does not have permission to read the project"
-        );
-      }
-      throw new Error(
-        `GitLab Error '${data.error}', ${data.error_description}`
-      );
-    }
-    return Number(data.id);
-  } catch (e) {
-    throw new Error(`Could not get GitLab project ID for: ${target}, ${e}`);
+  let repo = url.pathname.split("/-/blob/")[0].split("/blob/")[0];
+  const relativePath = config.getGitLabIntegrationRelativePath(config$1);
+  if (relativePath) {
+    repo = repo.replace(relativePath, "");
   }
+  return repo.replace(/^\//, "");
 }
 
 exports.buildProjectUrl = buildProjectUrl;
+exports.extractProjectPath = extractProjectPath;
 exports.getGitLabFileFetchUrl = getGitLabFileFetchUrl;
 exports.getGitLabRequestOptions = getGitLabRequestOptions;
-exports.getProjectId = getProjectId;
 //# sourceMappingURL=core.cjs.js.map

package/dist/gitlab/core.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"core.cjs.js","sources":["../../src/gitlab/core.ts"],"sourcesContent":["/*\n * Copyright 2020 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 fetch from 'cross-fetch';\nimport {\n  getGitLabIntegrationRelativePath,\n  GitLabIntegrationConfig,\n} from './config';\n\n/**\n * Given a URL pointing to a file on a provider, returns a URL that is suitable\n * for fetching the contents of the data.\n *\n * @remarks\n *\n * Converts\n * from: https://gitlab.example.com/a/b/blob/master/c.yaml\n * to:   https://gitlab.com/api/v4/projects/projectId/repository/c.yaml?ref=master\n * -or-\n * from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n * to:   https://gitlab.com/api/v4/projects/projectId/repository/files/filepath?ref=branch\n *\n * @param url - A URL pointing to a file\n * @param config - The relevant provider config\n * @public\n */\nexport async function getGitLabFileFetchUrl(\n  url: string,\n  config: GitLabIntegrationConfig,\n  token?: string,\n): Promise<string> {\n  const projectID = await getProjectId(url, config, token);\n  return buildProjectUrl(url, projectID, config).toString();\n}\n\n/**\n * Gets the request options necessary to make requests to a given provider.\n *\n * @param config - The relevant provider config\n * @param token - An optional auth token to use for communicating with GitLab. By default uses the integration token\n * @public\n */\nexport function getGitLabRequestOptions(\n  config: GitLabIntegrationConfig,\n  token?: string,\n): { headers: Record<string, string> } {\n  const headers: Record<string, string> = {};\n\n  const accessToken = token || config.token;\n  if (accessToken) {\n    // OAuth, Personal, Project, and Group access tokens can all be passed via\n    // a bearer authorization header\n    // https://docs.gitlab.com/api/rest/authentication/#personalprojectgroup-access-tokens\n    headers.Authorization = `Bearer ${accessToken}`;\n  }\n\n  return { headers };\n}\n\n// Converts\n// from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n// to:   https://gitlab.com/api/v4/projects/projectId/repository/files/filepath?ref=branch\nexport function buildProjectUrl(\n  target: string,\n  projectID: Number,\n  config: GitLabIntegrationConfig,\n): URL {\n  try {\n    const url = new URL(target);\n\n    const branchAndFilePath = url.pathname\n      .split('/blob/')\n      .slice(1)\n      .join('/blob/');\n    const [branch, ...filePath] = branchAndFilePath.split('/');\n    const relativePath = getGitLabIntegrationRelativePath(config);\n\n    url.pathname = [\n      ...(relativePath ? [relativePath] : []),\n      'api/v4/projects',\n      projectID,\n      'repository/files',\n      encodeURIComponent(decodeURIComponent(filePath.join('/'))),\n      'raw',\n    ].join('/');\n\n    url.search = `?ref=${branch}`;\n\n    return url;\n  } catch (e) {\n    throw new Error(`Incorrect url: ${target}, ${e}`);\n  }\n}\n\n// Convert\n// from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n// to:   The project ID that corresponds to the URL\nexport async function getProjectId(\n  target: string,\n  config: GitLabIntegrationConfig,\n  token?: string,\n): Promise<number> {\n  const url = new URL(target);\n\n  if (!url.pathname.includes('/blob/')) {\n    throw new Error(\n      `Failed converting ${url.pathname} to a project id. Url path must include /blob/.`,\n    );\n  }\n\n  try {\n    let repo = url.pathname.split('/-/blob/')[0].split('/blob/')[0];\n\n    // Get gitlab relative path\n    const relativePath = getGitLabIntegrationRelativePath(config);\n\n    // Check relative path exist and replace it if it's the case.\n    if (relativePath) {\n      repo = repo.replace(relativePath, '');\n    }\n\n    // Convert\n    // to: https://gitlab.com/api/v4/projects/groupA%2Fteams%2FsubgroupA%2FteamA%2Frepo\n    const repoIDLookup = new URL(\n      `${url.origin}${relativePath}/api/v4/projects/${encodeURIComponent(\n        repo.replace(/^\\//, ''),\n      )}`,\n    );\n\n    const response = await fetch(\n      repoIDLookup.toString(),\n      getGitLabRequestOptions(config, token),\n    );\n\n    const data = await response.json();\n\n    if (!response.ok) {\n      if (response.status === 401) {\n        throw new Error(\n          'GitLab Error: 401 - Unauthorized. The access token used is either expired, or does not have permission to read the project',\n        );\n      }\n\n      throw new Error(\n        `GitLab Error '${data.error}', ${data.error_description}`,\n      );\n    }\n\n    return Number(data.id);\n  } catch (e) {\n    throw new Error(`Could not get GitLab project ID for: ${target}, ${e}`);\n  }\n}\n"],"names":["config","getGitLabIntegrationRelativePath","fetch"],"mappings":";;;;;;;;;AAuCA,eAAsB,qBAAA,CACpB,GAAA,EACA,MAAA,EACA,KAAA,EACiB;AACjB,EAAA,MAAM,SAAA,GAAY,MAAM,YAAA,CAAa,GAAA,EAAK,QAAQ,KAAK,CAAA;AACvD,EAAA,OAAO,eAAA,CAAgB,GAAA,EAAK,SAAA,EAAW,MAAM,EAAE,QAAA,EAAS;AAC1D;AASO,SAAS,uBAAA,CACd,QACA,KAAA,EACqC;AACrC,EAAA,MAAM,UAAkC,EAAC;AAEzC,EAAA,MAAM,WAAA,GAAc,SAAS,MAAA,CAAO,KAAA;AACpC,EAAA,IAAI,WAAA,EAAa;AAIf,IAAA,OAAA,CAAQ,aAAA,GAAgB,UAAU,WAAW,CAAA,CAAA;AAAA,EAC/C;AAEA,EAAA,OAAO,EAAE,OAAA,EAAQ;AACnB;AAKO,SAAS,eAAA,CACd,MAAA,EACA,SAAA,EACAA,QAAA,EACK;AACL,EAAA,IAAI;AACF,IAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,MAAM,CAAA;AAE1B,IAAA,MAAM,iBAAA,GAAoB,GAAA,CAAI,QAAA,CAC3B,KAAA,CAAM,QAAQ,EACd,KAAA,CAAM,CAAC,CAAA,CACP,IAAA,CAAK,QAAQ,CAAA;AAChB,IAAA,MAAM,CAAC,MAAA,EAAQ,GAAG,QAAQ,CAAA,GAAI,iBAAA,CAAkB,MAAM,GAAG,CAAA;AACzD,IAAA,MAAM,YAAA,GAAeC,wCAAiCD,QAAM,CAAA;AAE5D,IAAA,GAAA,CAAI,QAAA,GAAW;AAAA,MACb,GAAI,YAAA,GAAe,CAAC,YAAY,IAAI,EAAC;AAAA,MACrC,iBAAA;AAAA,MACA,SAAA;AAAA,MACA,kBAAA;AAAA,MACA,mBAAmB,kBAAA,CAAmB,QAAA,CAAS,IAAA,CAAK,GAAG,CAAC,CAAC,CAAA;AAAA,MACzD;AAAA,KACF,CAAE,KAAK,GAAG,CAAA;AAEV,IAAA,GAAA,CAAI,MAAA,GAAS,QAAQ,MAAM,CAAA,CAAA;AAE3B,IAAA,OAAO,GAAA;AAAA,EACT,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,MAAM,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EAClD;AACF;AAKA,eAAsB,YAAA,CACpB,MAAA,EACAA,QAAA,EACA,KAAA,EACiB;AACjB,EAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,MAAM,CAAA;AAE1B,EAAA,IAAI,CAAC,GAAA,CAAI,QAAA,CAAS,QAAA,CAAS,QAAQ,CAAA,EAAG;AACpC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,kBAAA,EAAqB,IAAI,QAAQ,CAAA,+CAAA;AAAA,KACnC;AAAA,EACF;AAEA,EAAA,IAAI;AACF,IAAA,IAAI,IAAA,GAAO,GAAA,CAAI,QAAA,CAAS,KAAA,CAAM,UAAU,CAAA,CAAE,CAAC,CAAA,CAAE,KAAA,CAAM,QAAQ,CAAA,CAAE,CAAC,CAAA;AAG9D,IAAA,MAAM,YAAA,GAAeC,wCAAiCD,QAAM,CAAA;AAG5D,IAAA,IAAI,YAAA,EAAc;AAChB,MAAA,IAAA,GAAO,IAAA,CAAK,OAAA,CAAQ,YAAA,EAAc,EAAE,CAAA;AAAA,IACtC;AAIA,IAAA,MAAM,eAAe,IAAI,GAAA;AAAA,MACvB,CAAA,EAAG,GAAA,CAAI,MAAM,CAAA,EAAG,YAAY,CAAA,iBAAA,EAAoB,kBAAA;AAAA,QAC9C,IAAA,CAAK,OAAA,CAAQ,KAAA,EAAO,EAAE;AAAA,OACvB,CAAA;AAAA,KACH;AAEA,IAAA,MAAM,WAAW,MAAME,sBAAA;AAAA,MACrB,aAAa,QAAA,EAAS;AAAA,MACtB,uBAAA,CAAwBF,UAAQ,KAAK;AAAA,KACvC;AAEA,IAAA,MAAM,IAAA,GAAO,MAAM,QAAA,CAAS,IAAA,EAAK;AAEjC,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAEA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,cAAA,EAAiB,IAAA,CAAK,KAAK,CAAA,GAAA,EAAM,KAAK,iBAAiB,CAAA;AAAA,OACzD;AAAA,IACF;AAEA,IAAA,OAAO,MAAA,CAAO,KAAK,EAAE,CAAA;AAAA,EACvB,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qCAAA,EAAwC,MAAM,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EACxE;AACF;;;;;;;"}
+{"version":3,"file":"core.cjs.js","sources":["../../src/gitlab/core.ts"],"sourcesContent":["/*\n * Copyright 2020 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 {\n  getGitLabIntegrationRelativePath,\n  GitLabIntegrationConfig,\n} from './config';\n\n/**\n * Given a URL pointing to a file on a provider, returns a URL that is suitable\n * for fetching the contents of the data.\n *\n * @remarks\n *\n * Converts\n * from: https://gitlab.example.com/a/b/blob/master/c.yaml\n * to:   https://gitlab.com/api/v4/projects/a%2Fb/repository/files/c.yaml/raw?ref=master\n * -or-\n * from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n * to:   https://gitlab.com/api/v4/projects/groupA%2Fteams%2FteamA%2FsubgroupA%2FrepoA/repository/files/filepath/raw?ref=branch\n *\n * @param url - A URL pointing to a file\n * @param config - The relevant provider config\n * @param token - An optional auth token (not used in path extraction, kept for compatibility)\n * @public\n */\nexport function getGitLabFileFetchUrl(\n  url: string,\n  config: GitLabIntegrationConfig,\n  _token?: string,\n): Promise<string> {\n  // Use project path directly instead of making an API call to get project ID\n  // Note: _token parameter kept for backward compatibility but not used for path extraction\n  const projectPath = extractProjectPath(url, config);\n  return Promise.resolve(buildProjectUrl(url, projectPath, config).toString());\n}\n\n/**\n * Gets the request options necessary to make requests to a given provider.\n *\n * @param config - The relevant provider config\n * @param token - An optional auth token to use for communicating with GitLab. By default uses the integration token\n * @public\n */\nexport function getGitLabRequestOptions(\n  config: GitLabIntegrationConfig,\n  token?: string,\n): { headers: Record<string, string> } {\n  const headers: Record<string, string> = {};\n\n  const accessToken = token || config.token;\n  if (accessToken) {\n    // OAuth, Personal, Project, and Group access tokens can all be passed via\n    // a bearer authorization header\n    // https://docs.gitlab.com/api/rest/authentication/#personalprojectgroup-access-tokens\n    headers.Authorization = `Bearer ${accessToken}`;\n  }\n\n  return { headers };\n}\n\n// Converts\n// from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n// to:   https://gitlab.com/api/v4/projects/groupA%2Fteams%2FteamA%2FsubgroupA%2FrepoA/repository/files/filepath/raw?ref=branch\nexport function buildProjectUrl(\n  target: string,\n  projectPathOrID: string | Number,\n  config: GitLabIntegrationConfig,\n): URL {\n  try {\n    const url = new URL(target);\n\n    const branchAndFilePath = url.pathname\n      .split('/blob/')\n      .slice(1)\n      .join('/blob/');\n    const [branch, ...filePath] = branchAndFilePath.split('/');\n    const relativePath = getGitLabIntegrationRelativePath(config);\n\n    const projectIdentifier = encodeURIComponent(String(projectPathOrID));\n\n    url.pathname = [\n      ...(relativePath ? [relativePath] : []),\n      'api/v4/projects',\n      projectIdentifier,\n      'repository/files',\n      encodeURIComponent(decodeURIComponent(filePath.join('/'))),\n      'raw',\n    ].join('/');\n\n    url.search = `?ref=${branch}`;\n\n    return url;\n  } catch (e) {\n    throw new Error(`Incorrect url: ${target}, ${e}`);\n  }\n}\n\n/**\n * Extracts the project path from a GitLab URL\n * from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n * to:   groupA/teams/teamA/subgroupA/repoA\n */\nexport function extractProjectPath(\n  target: string,\n  config: GitLabIntegrationConfig,\n): string {\n  const url = new URL(target);\n\n  if (!url.pathname.includes('/blob/')) {\n    throw new Error(\n      `Failed extracting project path from ${url.pathname}. Url path must include /blob/.`,\n    );\n  }\n\n  let repo = url.pathname.split('/-/blob/')[0].split('/blob/')[0];\n\n  // Get gitlab relative path\n  const relativePath = getGitLabIntegrationRelativePath(config);\n\n  // Check relative path exist and replace it if it's the case.\n  if (relativePath) {\n    repo = repo.replace(relativePath, '');\n  }\n\n  // Remove leading slash\n  return repo.replace(/^\\//, '');\n}\n"],"names":["config","getGitLabIntegrationRelativePath"],"mappings":";;;;AAuCO,SAAS,qBAAA,CACd,GAAA,EACA,MAAA,EACA,MAAA,EACiB;AAGjB,EAAA,MAAM,WAAA,GAAc,kBAAA,CAAmB,GAAA,EAAK,MAAM,CAAA;AAClD,EAAA,OAAO,OAAA,CAAQ,QAAQ,eAAA,CAAgB,GAAA,EAAK,aAAa,MAAM,CAAA,CAAE,UAAU,CAAA;AAC7E;AASO,SAAS,uBAAA,CACd,QACA,KAAA,EACqC;AACrC,EAAA,MAAM,UAAkC,EAAC;AAEzC,EAAA,MAAM,WAAA,GAAc,SAAS,MAAA,CAAO,KAAA;AACpC,EAAA,IAAI,WAAA,EAAa;AAIf,IAAA,OAAA,CAAQ,aAAA,GAAgB,UAAU,WAAW,CAAA,CAAA;AAAA,EAC/C;AAEA,EAAA,OAAO,EAAE,OAAA,EAAQ;AACnB;AAKO,SAAS,eAAA,CACd,MAAA,EACA,eAAA,EACAA,QAAA,EACK;AACL,EAAA,IAAI;AACF,IAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,MAAM,CAAA;AAE1B,IAAA,MAAM,iBAAA,GAAoB,GAAA,CAAI,QAAA,CAC3B,KAAA,CAAM,QAAQ,EACd,KAAA,CAAM,CAAC,CAAA,CACP,IAAA,CAAK,QAAQ,CAAA;AAChB,IAAA,MAAM,CAAC,MAAA,EAAQ,GAAG,QAAQ,CAAA,GAAI,iBAAA,CAAkB,MAAM,GAAG,CAAA;AACzD,IAAA,MAAM,YAAA,GAAeC,wCAAiCD,QAAM,CAAA;AAE5D,IAAA,MAAM,iBAAA,GAAoB,kBAAA,CAAmB,MAAA,CAAO,eAAe,CAAC,CAAA;AAEpE,IAAA,GAAA,CAAI,QAAA,GAAW;AAAA,MACb,GAAI,YAAA,GAAe,CAAC,YAAY,IAAI,EAAC;AAAA,MACrC,iBAAA;AAAA,MACA,iBAAA;AAAA,MACA,kBAAA;AAAA,MACA,mBAAmB,kBAAA,CAAmB,QAAA,CAAS,IAAA,CAAK,GAAG,CAAC,CAAC,CAAA;AAAA,MACzD;AAAA,KACF,CAAE,KAAK,GAAG,CAAA;AAEV,IAAA,GAAA,CAAI,MAAA,GAAS,QAAQ,MAAM,CAAA,CAAA;AAE3B,IAAA,OAAO,GAAA;AAAA,EACT,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,MAAM,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EAClD;AACF;AAOO,SAAS,kBAAA,CACd,QACAA,QAAA,EACQ;AACR,EAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,MAAM,CAAA;AAE1B,EAAA,IAAI,CAAC,GAAA,CAAI,QAAA,CAAS,QAAA,CAAS,QAAQ,CAAA,EAAG;AACpC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,oCAAA,EAAuC,IAAI,QAAQ,CAAA,+BAAA;AAAA,KACrD;AAAA,EACF;AAEA,EAAA,IAAI,IAAA,GAAO,GAAA,CAAI,QAAA,CAAS,KAAA,CAAM,UAAU,CAAA,CAAE,CAAC,CAAA,CAAE,KAAA,CAAM,QAAQ,CAAA,CAAE,CAAC,CAAA;AAG9D,EAAA,MAAM,YAAA,GAAeC,wCAAiCD,QAAM,CAAA;AAG5D,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,IAAA,GAAO,IAAA,CAAK,OAAA,CAAQ,YAAA,EAAc,EAAE,CAAA;AAAA,EACtC;AAGA,EAAA,OAAO,IAAA,CAAK,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA;AAC/B;;;;;;;"}

package/dist/gitlab/core.esm.js

@@ -1,9 +1,8 @@
-import fetch from 'cross-fetch';
 import { getGitLabIntegrationRelativePath } from './config.esm.js';
 
-async function getGitLabFileFetchUrl(url, config, token) {
-  const projectID = await getProjectId(url, config, token);
-  return buildProjectUrl(url, projectID, config).toString();
+function getGitLabFileFetchUrl(url, config, _token) {
+  const projectPath = extractProjectPath(url, config);
+  return Promise.resolve(buildProjectUrl(url, projectPath, config).toString());
 }
 function getGitLabRequestOptions(config, token) {
   const headers = {};
@@ -13,16 +12,17 @@ function getGitLabRequestOptions(config, token) {
   }
   return { headers };
 }
-function buildProjectUrl(target, projectID, config) {
+function buildProjectUrl(target, projectPathOrID, config) {
   try {
     const url = new URL(target);
     const branchAndFilePath = url.pathname.split("/blob/").slice(1).join("/blob/");
     const [branch, ...filePath] = branchAndFilePath.split("/");
     const relativePath = getGitLabIntegrationRelativePath(config);
+    const projectIdentifier = encodeURIComponent(String(projectPathOrID));
     url.pathname = [
       ...relativePath ? [relativePath] : [],
       "api/v4/projects",
-      projectID,
+      projectIdentifier,
       "repository/files",
       encodeURIComponent(decodeURIComponent(filePath.join("/"))),
       "raw"
@@ -33,44 +33,20 @@ function buildProjectUrl(target, projectID, config) {
     throw new Error(`Incorrect url: ${target}, ${e}`);
   }
 }
-async function getProjectId(target, config, token) {
+function extractProjectPath(target, config) {
   const url = new URL(target);
   if (!url.pathname.includes("/blob/")) {
     throw new Error(
-      `Failed converting ${url.pathname} to a project id. Url path must include /blob/.`
+      `Failed extracting project path from ${url.pathname}. Url path must include /blob/.`
     );
   }
-  try {
-    let repo = url.pathname.split("/-/blob/")[0].split("/blob/")[0];
-    const relativePath = getGitLabIntegrationRelativePath(config);
-    if (relativePath) {
-      repo = repo.replace(relativePath, "");
-    }
-    const repoIDLookup = new URL(
-      `${url.origin}${relativePath}/api/v4/projects/${encodeURIComponent(
-        repo.replace(/^\//, "")
-      )}`
-    );
-    const response = await fetch(
-      repoIDLookup.toString(),
-      getGitLabRequestOptions(config, token)
-    );
-    const data = await response.json();
-    if (!response.ok) {
-      if (response.status === 401) {
-        throw new Error(
-          "GitLab Error: 401 - Unauthorized. The access token used is either expired, or does not have permission to read the project"
-        );
-      }
-      throw new Error(
-        `GitLab Error '${data.error}', ${data.error_description}`
-      );
-    }
-    return Number(data.id);
-  } catch (e) {
-    throw new Error(`Could not get GitLab project ID for: ${target}, ${e}`);
+  let repo = url.pathname.split("/-/blob/")[0].split("/blob/")[0];
+  const relativePath = getGitLabIntegrationRelativePath(config);
+  if (relativePath) {
+    repo = repo.replace(relativePath, "");
   }
+  return repo.replace(/^\//, "");
 }
 
-export { buildProjectUrl, getGitLabFileFetchUrl, getGitLabRequestOptions, getProjectId };
+export { buildProjectUrl, extractProjectPath, getGitLabFileFetchUrl, getGitLabRequestOptions };
 //# sourceMappingURL=core.esm.js.map

package/dist/gitlab/core.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"core.esm.js","sources":["../../src/gitlab/core.ts"],"sourcesContent":["/*\n * Copyright 2020 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 fetch from 'cross-fetch';\nimport {\n  getGitLabIntegrationRelativePath,\n  GitLabIntegrationConfig,\n} from './config';\n\n/**\n * Given a URL pointing to a file on a provider, returns a URL that is suitable\n * for fetching the contents of the data.\n *\n * @remarks\n *\n * Converts\n * from: https://gitlab.example.com/a/b/blob/master/c.yaml\n * to:   https://gitlab.com/api/v4/projects/projectId/repository/c.yaml?ref=master\n * -or-\n * from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n * to:   https://gitlab.com/api/v4/projects/projectId/repository/files/filepath?ref=branch\n *\n * @param url - A URL pointing to a file\n * @param config - The relevant provider config\n * @public\n */\nexport async function getGitLabFileFetchUrl(\n  url: string,\n  config: GitLabIntegrationConfig,\n  token?: string,\n): Promise<string> {\n  const projectID = await getProjectId(url, config, token);\n  return buildProjectUrl(url, projectID, config).toString();\n}\n\n/**\n * Gets the request options necessary to make requests to a given provider.\n *\n * @param config - The relevant provider config\n * @param token - An optional auth token to use for communicating with GitLab. By default uses the integration token\n * @public\n */\nexport function getGitLabRequestOptions(\n  config: GitLabIntegrationConfig,\n  token?: string,\n): { headers: Record<string, string> } {\n  const headers: Record<string, string> = {};\n\n  const accessToken = token || config.token;\n  if (accessToken) {\n    // OAuth, Personal, Project, and Group access tokens can all be passed via\n    // a bearer authorization header\n    // https://docs.gitlab.com/api/rest/authentication/#personalprojectgroup-access-tokens\n    headers.Authorization = `Bearer ${accessToken}`;\n  }\n\n  return { headers };\n}\n\n// Converts\n// from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n// to:   https://gitlab.com/api/v4/projects/projectId/repository/files/filepath?ref=branch\nexport function buildProjectUrl(\n  target: string,\n  projectID: Number,\n  config: GitLabIntegrationConfig,\n): URL {\n  try {\n    const url = new URL(target);\n\n    const branchAndFilePath = url.pathname\n      .split('/blob/')\n      .slice(1)\n      .join('/blob/');\n    const [branch, ...filePath] = branchAndFilePath.split('/');\n    const relativePath = getGitLabIntegrationRelativePath(config);\n\n    url.pathname = [\n      ...(relativePath ? [relativePath] : []),\n      'api/v4/projects',\n      projectID,\n      'repository/files',\n      encodeURIComponent(decodeURIComponent(filePath.join('/'))),\n      'raw',\n    ].join('/');\n\n    url.search = `?ref=${branch}`;\n\n    return url;\n  } catch (e) {\n    throw new Error(`Incorrect url: ${target}, ${e}`);\n  }\n}\n\n// Convert\n// from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n// to:   The project ID that corresponds to the URL\nexport async function getProjectId(\n  target: string,\n  config: GitLabIntegrationConfig,\n  token?: string,\n): Promise<number> {\n  const url = new URL(target);\n\n  if (!url.pathname.includes('/blob/')) {\n    throw new Error(\n      `Failed converting ${url.pathname} to a project id. Url path must include /blob/.`,\n    );\n  }\n\n  try {\n    let repo = url.pathname.split('/-/blob/')[0].split('/blob/')[0];\n\n    // Get gitlab relative path\n    const relativePath = getGitLabIntegrationRelativePath(config);\n\n    // Check relative path exist and replace it if it's the case.\n    if (relativePath) {\n      repo = repo.replace(relativePath, '');\n    }\n\n    // Convert\n    // to: https://gitlab.com/api/v4/projects/groupA%2Fteams%2FsubgroupA%2FteamA%2Frepo\n    const repoIDLookup = new URL(\n      `${url.origin}${relativePath}/api/v4/projects/${encodeURIComponent(\n        repo.replace(/^\\//, ''),\n      )}`,\n    );\n\n    const response = await fetch(\n      repoIDLookup.toString(),\n      getGitLabRequestOptions(config, token),\n    );\n\n    const data = await response.json();\n\n    if (!response.ok) {\n      if (response.status === 401) {\n        throw new Error(\n          'GitLab Error: 401 - Unauthorized. The access token used is either expired, or does not have permission to read the project',\n        );\n      }\n\n      throw new Error(\n        `GitLab Error '${data.error}', ${data.error_description}`,\n      );\n    }\n\n    return Number(data.id);\n  } catch (e) {\n    throw new Error(`Could not get GitLab project ID for: ${target}, ${e}`);\n  }\n}\n"],"names":[],"mappings":";;;AAuCA,eAAsB,qBAAA,CACpB,GAAA,EACA,MAAA,EACA,KAAA,EACiB;AACjB,EAAA,MAAM,SAAA,GAAY,MAAM,YAAA,CAAa,GAAA,EAAK,QAAQ,KAAK,CAAA;AACvD,EAAA,OAAO,eAAA,CAAgB,GAAA,EAAK,SAAA,EAAW,MAAM,EAAE,QAAA,EAAS;AAC1D;AASO,SAAS,uBAAA,CACd,QACA,KAAA,EACqC;AACrC,EAAA,MAAM,UAAkC,EAAC;AAEzC,EAAA,MAAM,WAAA,GAAc,SAAS,MAAA,CAAO,KAAA;AACpC,EAAA,IAAI,WAAA,EAAa;AAIf,IAAA,OAAA,CAAQ,aAAA,GAAgB,UAAU,WAAW,CAAA,CAAA;AAAA,EAC/C;AAEA,EAAA,OAAO,EAAE,OAAA,EAAQ;AACnB;AAKO,SAAS,eAAA,CACd,MAAA,EACA,SAAA,EACA,MAAA,EACK;AACL,EAAA,IAAI;AACF,IAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,MAAM,CAAA;AAE1B,IAAA,MAAM,iBAAA,GAAoB,GAAA,CAAI,QAAA,CAC3B,KAAA,CAAM,QAAQ,EACd,KAAA,CAAM,CAAC,CAAA,CACP,IAAA,CAAK,QAAQ,CAAA;AAChB,IAAA,MAAM,CAAC,MAAA,EAAQ,GAAG,QAAQ,CAAA,GAAI,iBAAA,CAAkB,MAAM,GAAG,CAAA;AACzD,IAAA,MAAM,YAAA,GAAe,iCAAiC,MAAM,CAAA;AAE5D,IAAA,GAAA,CAAI,QAAA,GAAW;AAAA,MACb,GAAI,YAAA,GAAe,CAAC,YAAY,IAAI,EAAC;AAAA,MACrC,iBAAA;AAAA,MACA,SAAA;AAAA,MACA,kBAAA;AAAA,MACA,mBAAmB,kBAAA,CAAmB,QAAA,CAAS,IAAA,CAAK,GAAG,CAAC,CAAC,CAAA;AAAA,MACzD;AAAA,KACF,CAAE,KAAK,GAAG,CAAA;AAEV,IAAA,GAAA,CAAI,MAAA,GAAS,QAAQ,MAAM,CAAA,CAAA;AAE3B,IAAA,OAAO,GAAA;AAAA,EACT,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,MAAM,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EAClD;AACF;AAKA,eAAsB,YAAA,CACpB,MAAA,EACA,MAAA,EACA,KAAA,EACiB;AACjB,EAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,MAAM,CAAA;AAE1B,EAAA,IAAI,CAAC,GAAA,CAAI,QAAA,CAAS,QAAA,CAAS,QAAQ,CAAA,EAAG;AACpC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,kBAAA,EAAqB,IAAI,QAAQ,CAAA,+CAAA;AAAA,KACnC;AAAA,EACF;AAEA,EAAA,IAAI;AACF,IAAA,IAAI,IAAA,GAAO,GAAA,CAAI,QAAA,CAAS,KAAA,CAAM,UAAU,CAAA,CAAE,CAAC,CAAA,CAAE,KAAA,CAAM,QAAQ,CAAA,CAAE,CAAC,CAAA;AAG9D,IAAA,MAAM,YAAA,GAAe,iCAAiC,MAAM,CAAA;AAG5D,IAAA,IAAI,YAAA,EAAc;AAChB,MAAA,IAAA,GAAO,IAAA,CAAK,OAAA,CAAQ,YAAA,EAAc,EAAE,CAAA;AAAA,IACtC;AAIA,IAAA,MAAM,eAAe,IAAI,GAAA;AAAA,MACvB,CAAA,EAAG,GAAA,CAAI,MAAM,CAAA,EAAG,YAAY,CAAA,iBAAA,EAAoB,kBAAA;AAAA,QAC9C,IAAA,CAAK,OAAA,CAAQ,KAAA,EAAO,EAAE;AAAA,OACvB,CAAA;AAAA,KACH;AAEA,IAAA,MAAM,WAAW,MAAM,KAAA;AAAA,MACrB,aAAa,QAAA,EAAS;AAAA,MACtB,uBAAA,CAAwB,QAAQ,KAAK;AAAA,KACvC;AAEA,IAAA,MAAM,IAAA,GAAO,MAAM,QAAA,CAAS,IAAA,EAAK;AAEjC,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAEA,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,cAAA,EAAiB,IAAA,CAAK,KAAK,CAAA,GAAA,EAAM,KAAK,iBAAiB,CAAA;AAAA,OACzD;AAAA,IACF;AAEA,IAAA,OAAO,MAAA,CAAO,KAAK,EAAE,CAAA;AAAA,EACvB,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qCAAA,EAAwC,MAAM,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EACxE;AACF;;;;"}
+{"version":3,"file":"core.esm.js","sources":["../../src/gitlab/core.ts"],"sourcesContent":["/*\n * Copyright 2020 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 {\n  getGitLabIntegrationRelativePath,\n  GitLabIntegrationConfig,\n} from './config';\n\n/**\n * Given a URL pointing to a file on a provider, returns a URL that is suitable\n * for fetching the contents of the data.\n *\n * @remarks\n *\n * Converts\n * from: https://gitlab.example.com/a/b/blob/master/c.yaml\n * to:   https://gitlab.com/api/v4/projects/a%2Fb/repository/files/c.yaml/raw?ref=master\n * -or-\n * from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n * to:   https://gitlab.com/api/v4/projects/groupA%2Fteams%2FteamA%2FsubgroupA%2FrepoA/repository/files/filepath/raw?ref=branch\n *\n * @param url - A URL pointing to a file\n * @param config - The relevant provider config\n * @param token - An optional auth token (not used in path extraction, kept for compatibility)\n * @public\n */\nexport function getGitLabFileFetchUrl(\n  url: string,\n  config: GitLabIntegrationConfig,\n  _token?: string,\n): Promise<string> {\n  // Use project path directly instead of making an API call to get project ID\n  // Note: _token parameter kept for backward compatibility but not used for path extraction\n  const projectPath = extractProjectPath(url, config);\n  return Promise.resolve(buildProjectUrl(url, projectPath, config).toString());\n}\n\n/**\n * Gets the request options necessary to make requests to a given provider.\n *\n * @param config - The relevant provider config\n * @param token - An optional auth token to use for communicating with GitLab. By default uses the integration token\n * @public\n */\nexport function getGitLabRequestOptions(\n  config: GitLabIntegrationConfig,\n  token?: string,\n): { headers: Record<string, string> } {\n  const headers: Record<string, string> = {};\n\n  const accessToken = token || config.token;\n  if (accessToken) {\n    // OAuth, Personal, Project, and Group access tokens can all be passed via\n    // a bearer authorization header\n    // https://docs.gitlab.com/api/rest/authentication/#personalprojectgroup-access-tokens\n    headers.Authorization = `Bearer ${accessToken}`;\n  }\n\n  return { headers };\n}\n\n// Converts\n// from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n// to:   https://gitlab.com/api/v4/projects/groupA%2Fteams%2FteamA%2FsubgroupA%2FrepoA/repository/files/filepath/raw?ref=branch\nexport function buildProjectUrl(\n  target: string,\n  projectPathOrID: string | Number,\n  config: GitLabIntegrationConfig,\n): URL {\n  try {\n    const url = new URL(target);\n\n    const branchAndFilePath = url.pathname\n      .split('/blob/')\n      .slice(1)\n      .join('/blob/');\n    const [branch, ...filePath] = branchAndFilePath.split('/');\n    const relativePath = getGitLabIntegrationRelativePath(config);\n\n    const projectIdentifier = encodeURIComponent(String(projectPathOrID));\n\n    url.pathname = [\n      ...(relativePath ? [relativePath] : []),\n      'api/v4/projects',\n      projectIdentifier,\n      'repository/files',\n      encodeURIComponent(decodeURIComponent(filePath.join('/'))),\n      'raw',\n    ].join('/');\n\n    url.search = `?ref=${branch}`;\n\n    return url;\n  } catch (e) {\n    throw new Error(`Incorrect url: ${target}, ${e}`);\n  }\n}\n\n/**\n * Extracts the project path from a GitLab URL\n * from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n * to:   groupA/teams/teamA/subgroupA/repoA\n */\nexport function extractProjectPath(\n  target: string,\n  config: GitLabIntegrationConfig,\n): string {\n  const url = new URL(target);\n\n  if (!url.pathname.includes('/blob/')) {\n    throw new Error(\n      `Failed extracting project path from ${url.pathname}. Url path must include /blob/.`,\n    );\n  }\n\n  let repo = url.pathname.split('/-/blob/')[0].split('/blob/')[0];\n\n  // Get gitlab relative path\n  const relativePath = getGitLabIntegrationRelativePath(config);\n\n  // Check relative path exist and replace it if it's the case.\n  if (relativePath) {\n    repo = repo.replace(relativePath, '');\n  }\n\n  // Remove leading slash\n  return repo.replace(/^\\//, '');\n}\n"],"names":[],"mappings":";;AAuCO,SAAS,qBAAA,CACd,GAAA,EACA,MAAA,EACA,MAAA,EACiB;AAGjB,EAAA,MAAM,WAAA,GAAc,kBAAA,CAAmB,GAAA,EAAK,MAAM,CAAA;AAClD,EAAA,OAAO,OAAA,CAAQ,QAAQ,eAAA,CAAgB,GAAA,EAAK,aAAa,MAAM,CAAA,CAAE,UAAU,CAAA;AAC7E;AASO,SAAS,uBAAA,CACd,QACA,KAAA,EACqC;AACrC,EAAA,MAAM,UAAkC,EAAC;AAEzC,EAAA,MAAM,WAAA,GAAc,SAAS,MAAA,CAAO,KAAA;AACpC,EAAA,IAAI,WAAA,EAAa;AAIf,IAAA,OAAA,CAAQ,aAAA,GAAgB,UAAU,WAAW,CAAA,CAAA;AAAA,EAC/C;AAEA,EAAA,OAAO,EAAE,OAAA,EAAQ;AACnB;AAKO,SAAS,eAAA,CACd,MAAA,EACA,eAAA,EACA,MAAA,EACK;AACL,EAAA,IAAI;AACF,IAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,MAAM,CAAA;AAE1B,IAAA,MAAM,iBAAA,GAAoB,GAAA,CAAI,QAAA,CAC3B,KAAA,CAAM,QAAQ,EACd,KAAA,CAAM,CAAC,CAAA,CACP,IAAA,CAAK,QAAQ,CAAA;AAChB,IAAA,MAAM,CAAC,MAAA,EAAQ,GAAG,QAAQ,CAAA,GAAI,iBAAA,CAAkB,MAAM,GAAG,CAAA;AACzD,IAAA,MAAM,YAAA,GAAe,iCAAiC,MAAM,CAAA;AAE5D,IAAA,MAAM,iBAAA,GAAoB,kBAAA,CAAmB,MAAA,CAAO,eAAe,CAAC,CAAA;AAEpE,IAAA,GAAA,CAAI,QAAA,GAAW;AAAA,MACb,GAAI,YAAA,GAAe,CAAC,YAAY,IAAI,EAAC;AAAA,MACrC,iBAAA;AAAA,MACA,iBAAA;AAAA,MACA,kBAAA;AAAA,MACA,mBAAmB,kBAAA,CAAmB,QAAA,CAAS,IAAA,CAAK,GAAG,CAAC,CAAC,CAAA;AAAA,MACzD;AAAA,KACF,CAAE,KAAK,GAAG,CAAA;AAEV,IAAA,GAAA,CAAI,MAAA,GAAS,QAAQ,MAAM,CAAA,CAAA;AAE3B,IAAA,OAAO,GAAA;AAAA,EACT,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,MAAM,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EAClD;AACF;AAOO,SAAS,kBAAA,CACd,QACA,MAAA,EACQ;AACR,EAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,MAAM,CAAA;AAE1B,EAAA,IAAI,CAAC,GAAA,CAAI,QAAA,CAAS,QAAA,CAAS,QAAQ,CAAA,EAAG;AACpC,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,oCAAA,EAAuC,IAAI,QAAQ,CAAA,+BAAA;AAAA,KACrD;AAAA,EACF;AAEA,EAAA,IAAI,IAAA,GAAO,GAAA,CAAI,QAAA,CAAS,KAAA,CAAM,UAAU,CAAA,CAAE,CAAC,CAAA,CAAE,KAAA,CAAM,QAAQ,CAAA,CAAE,CAAC,CAAA;AAG9D,EAAA,MAAM,YAAA,GAAe,iCAAiC,MAAM,CAAA;AAG5D,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,IAAA,GAAO,IAAA,CAAK,OAAA,CAAQ,YAAA,EAAc,EAAE,CAAA;AAAA,EACtC;AAGA,EAAA,OAAO,IAAA,CAAK,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA;AAC/B;;;;"}

package/dist/index.d.ts

@@ -996,6 +996,26 @@ type GitLabIntegrationConfig = {
      * Signing key to sign commits
      */
     commitSigningKey?: string;
+    /**
+     * Retry configuration for failed requests.
+     */
+    retry?: {
+        /**
+         * Maximum number of retries for failed requests
+         * @defaultValue 0
+         */
+        maxRetries?: number;
+        /**
+         * HTTP status codes that should trigger a retry
+         * @defaultValue []
+         */
+        retryStatusCodes?: number[];
+        /**
+         * Rate limit for requests per minute
+         * @defaultValue -1
+         */
+        maxApiRequestsPerMinute?: number;
+    };
 };
 /**
  * Reads a single GitLab integration config.
@@ -1029,6 +1049,7 @@ declare function getGitLabIntegrationRelativePath(config: GitLabIntegrationConfi
 declare class GitLabIntegration implements ScmIntegration {
     private readonly integrationConfig;
     static factory: ScmIntegrationsFactory<GitLabIntegration>;
+    private readonly fetchImpl;
     constructor(integrationConfig: GitLabIntegrationConfig);
     get type(): string;
     get title(): string;
@@ -1039,6 +1060,9 @@ declare class GitLabIntegration implements ScmIntegration {
         lineNumber?: number;
     }): string;
     resolveEditUrl(url: string): string;
+    fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+    private createFetchStrategy;
+    private withRetry;
 }
 /**
  * Takes a GitLab URL and replaces the type part (blob, tree etc).
@@ -1840,16 +1864,17 @@ declare class SingleInstanceGithubCredentialsProvider implements GithubCredentia
  *
  * Converts
  * from: https://gitlab.example.com/a/b/blob/master/c.yaml
- * to:   https://gitlab.com/api/v4/projects/projectId/repository/c.yaml?ref=master
+ * to:   https://gitlab.com/api/v4/projects/a%2Fb/repository/files/c.yaml/raw?ref=master
  * -or-
  * from: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath
- * to:   https://gitlab.com/api/v4/projects/projectId/repository/files/filepath?ref=branch
+ * to:   https://gitlab.com/api/v4/projects/groupA%2Fteams%2FteamA%2FsubgroupA%2FrepoA/repository/files/filepath/raw?ref=branch
  *
  * @param url - A URL pointing to a file
  * @param config - The relevant provider config
+ * @param token - An optional auth token (not used in path extraction, kept for compatibility)
  * @public
  */
-declare function getGitLabFileFetchUrl(url: string, config: GitLabIntegrationConfig, token?: string): Promise<string>;
+declare function getGitLabFileFetchUrl(url: string, config: GitLabIntegrationConfig, _token?: string): Promise<string>;
 /**
  * Gets the request options necessary to make requests to a given provider.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/integration",
-  "version": "1.20.0-next.2",
+  "version": "1.21.0-next.0",
   "description": "Helpers for managing integrations towards external systems",
   "backstage": {
     "role": "common-library"
@@ -46,11 +46,12 @@
     "cross-fetch": "^4.0.0",
     "git-url-parse": "^15.0.0",
     "lodash": "^4.17.21",
-    "luxon": "^3.0.0"
+    "luxon": "^3.0.0",
+    "p-throttle": "^4.1.1"
   },
   "devDependencies": {
-    "@backstage/cli": "0.35.4-next.2",
-    "@backstage/config-loader": "1.10.8-next.0",
+    "@backstage/cli": "0.35.5-next.0",
+    "@backstage/config-loader": "1.10.9-next.0",
     "msw": "^1.0.0"
   },
   "configSchema": "config.d.ts",