@backstage/integration 1.3.1-next.1 → 1.3.1

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @backstage/integration
 
+## 1.3.1
+
+### Patch Changes
+
+- eadf56bbbf: Bump `git-url-parse` version to `^13.0.0`
+- 7d47def9c4: Removed dependency on `@types/jest`.
+- 667d917488: Updated dependency `msw` to `^0.47.0`.
+- 87ec2ba4d6: Updated dependency `msw` to `^0.46.0`.
+- bf5e9030eb: Updated dependency `msw` to `^0.45.0`.
+- 42918e085c: Fixed bug in the `bitbucketServer` integration where token did not take precedence over supplied username and password which is described in the documentation.
+- f76f22c649: Improved caching around github app tokens.
+  Tokens are now cached for 50 minutes, not 10.
+  Calls to get app installations are also included in this cache.
+  If you have more than one github app configured, consider adding `allowedInstallationOwners` to your apps configuration to gain the most benefit from these performance changes.
+- Updated dependencies
+  - @backstage/config@1.0.2
+  - @backstage/errors@1.1.1
+
+## 1.3.1-next.2
+
+### Patch Changes
+
+- 7d47def9c4: Removed dependency on `@types/jest`.
+- f76f22c649: Improved caching around github app tokens.
+  Tokens are now cached for 50 minutes, not 10.
+  Calls to get app installations are also included in this cache.
+  If you have more than one github app configured, consider adding `allowedInstallationOwners` to your apps configuration to gain the most benefit from these performance changes.
+- Updated dependencies
+  - @backstage/config@1.0.2-next.0
+  - @backstage/errors@1.1.1-next.0
+
 ## 1.3.1-next.1
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -1081,16 +1081,30 @@ function chooseEndpoint(config, credentials) {
 class Cache {
   constructor() {
     this.tokenCache = /* @__PURE__ */ new Map();
-    this.isNotExpired = (date) => date.diff(luxon.DateTime.local(), "minutes").minutes > 50;
+    this.isExpired = (date) => luxon.DateTime.local() > date;
+  }
+  async getOrCreateToken(owner, repo, supplier) {
+    let existingInstallationData = this.tokenCache.get(owner);
+    if (!existingInstallationData || this.isExpired(existingInstallationData.expiresAt)) {
+      existingInstallationData = await supplier();
+      existingInstallationData.expiresAt = existingInstallationData.expiresAt.minus({ minutes: 10 });
+      this.tokenCache.set(owner, existingInstallationData);
+    }
+    if (!this.appliesToRepo(existingInstallationData, repo)) {
+      throw new Error(
+        `The Backstage GitHub application used in the ${owner} organization does not have access to a repository with the name ${repo}`
+      );
+    }
+    return { accessToken: existingInstallationData.token };
   }
-  async getOrCreateToken(key, supplier) {
-    const item = this.tokenCache.get(key);
-    if (item && this.isNotExpired(item.expiresAt)) {
-      return { accessToken: item.token };
+  appliesToRepo(tokenData, repo) {
+    if (repo === void 0) {
+      return true;
+    }
+    if (tokenData.repositories !== void 0) {
+      return tokenData.repositories.includes(repo);
     }
-    const result = await supplier();
-    this.tokenCache.set(key, result);
-    return { accessToken: result.token };
+    return true;
   }
 }
 const HEADERS = {
@@ -1114,23 +1128,25 @@ class GithubAppManager {
   }
   async getInstallationCredentials(owner, repo) {
     var _a;
-    const { installationId, suspended } = await this.getInstallationData(owner);
     if (this.allowedInstallationOwners) {
       if (!((_a = this.allowedInstallationOwners) == null ? void 0 : _a.includes(owner))) {
         return { accessToken: void 0 };
       }
     }
-    if (suspended) {
-      throw new Error(`The GitHub application for ${owner} is suspended`);
-    }
-    const cacheKey = repo ? `${owner}/${repo}` : owner;
-    return this.cache.getOrCreateToken(cacheKey, async () => {
+    return this.cache.getOrCreateToken(owner, repo, async () => {
       var _a2;
+      const { installationId, suspended } = await this.getInstallationData(
+        owner
+      );
+      if (suspended) {
+        throw new Error(`The GitHub application for ${owner} is suspended`);
+      }
       const result = await this.appClient.apps.createInstallationAccessToken({
         installation_id: installationId,
         headers: HEADERS
       });
-      if (repo && result.data.repository_selection === "selected") {
+      let repositoryNames;
+      if (result.data.repository_selection === "selected") {
         const installationClient = new rest.Octokit({
           baseUrl: this.baseUrl,
           auth: result.data.token
@@ -1139,18 +1155,12 @@ class GithubAppManager {
           installationClient.apps.listReposAccessibleToInstallation
         );
         const repositories = (_a2 = repos.repositories) != null ? _a2 : repos;
-        const hasRepo = repositories.some((repository) => {
-          return repository.name === repo;
-        });
-        if (!hasRepo) {
-          throw new Error(
-            `The Backstage GitHub application used in the ${owner} organization does not have access to a repository with the name ${repo}`
-          );
-        }
+        repositoryNames = repositories.map((repository) => repository.name);
       }
       return {
         token: result.data.token,
-        expiresAt: luxon.DateTime.fromISO(result.data.expires_at)
+        expiresAt: luxon.DateTime.fromISO(result.data.expires_at),
+        repositories: repositoryNames
       };
     });
   }