Merge pull request #18329 from Bonial-International-GmbH/pjungermann/bitbucket-cloud/fix-event-support

fix(bitbucketCloud,events): handle missing slug in event payload

.changeset/sixty-icons-brush.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-backend-module-bitbucket-cloud': patch
+---
+
+Fix missing repo slug in `repo:push` events.

plugins/catalog-backend-module-bitbucket-cloud/src/providers/BitbucketCloudEntityProvider.test.ts

@@ -101,7 +101,7 @@ describe('BitbucketCloudEntityProvider', () => {
     },
     repository: {
       type: 'repository',
-      slug: 'test-repo',
+      full_name: 'test-ws/test-repo',
       links: {
         html: {
           href: 'https://bitbucket.org/test-ws/test-repo',
@@ -627,7 +627,7 @@ describe('BitbucketCloudEntityProvider', () => {
         ...repoPushEventParams.eventPayload,
         repository: {
           ...repoPushEventParams.eventPayload.repository,
-          slug: 'not-matching',
+          full_name: `${repoPushEventParams.eventPayload.repository.workspace.slug}/not-matching`,
         },
       },
     });

plugins/catalog-backend-module-bitbucket-cloud/src/providers/BitbucketCloudEntityProvider.ts

@@ -225,6 +225,11 @@ export class BitbucketCloudEntityProvider
     return false;
   }
 
+  private enhanceEvent(event: Events.RepoPushEvent): void {
+    // add missing slug
+    event.repository.slug = event.repository.full_name!.split('/', 2)[1];
+  }
+
   async onRepoPush(event: Events.RepoPushEvent): Promise<void> {
     if (!this.canHandleEvents()) {
       return;
@@ -234,6 +239,8 @@ export class BitbucketCloudEntityProvider
       throw new Error('Not initialized');
     }
 
+    this.enhanceEvent(event);
+
     if (event.repository.workspace.slug !== this.config.workspace) {
       return;
     }
@@ -242,7 +249,7 @@ export class BitbucketCloudEntityProvider
       return;
     }
 
-    const repoName = event.repository.slug;
+    const repoSlug = event.repository.slug!;
     const repoUrl = event.repository.links!.html!.href!;
     this.logger.info(`handle repo:push event for ${repoUrl}`);
 
@@ -253,7 +260,7 @@ export class BitbucketCloudEntityProvider
     // Hence, we will just trigger a refresh for catalog file(s) within the repository
     // if we get notified about changes there.
 
-    const targets = await this.findCatalogFiles(repoName);
+    const targets = await this.findCatalogFiles(repoSlug);
 
     const { token } = await this.tokenManager!.getToken();
     const existing = await this.findExistingLocations(repoUrl, token);
@@ -316,7 +323,7 @@ export class BitbucketCloudEntityProvider
   }
 
   private async findCatalogFiles(
-    repoName?: string,
+    repoSlug?: string,
   ): Promise<IngestionTarget[]> {
     const workspace = this.config.workspace;
     const catalogPath = this.config.catalogPath;
@@ -340,7 +347,7 @@ export class BitbucketCloudEntityProvider
       // ...except the one we need
       '+values.file.commit.repository.links.html.href',
     ].join(',');
-    const optRepoFilter = repoName ? ` repo:${repoName}` : '';
+    const optRepoFilter = repoSlug ? ` repo:${repoSlug}` : '';
     const query = `"${catalogFilename}" path:${catalogPath}${optRepoFilter}`;
     const searchResults = this.client
       .searchCode(workspace, query, { fields })