Merge pull request #5040 from erikxiv/fix/badge-auth

fix: support auth in badge plugin

.changeset/eight-files-rhyme.md

@@ -0,0 +1,6 @@
+---
+'@backstage/plugin-badges': minor
+'@backstage/plugin-badges-backend': patch
+---
+
+Support auth in badge plugin

plugins/badges-backend/src/service/router.test.ts

@@ -114,11 +114,14 @@ describe('createRouter', () => {
       expect(response.text).toEqual(JSON.stringify([badge], null, 2));
 
       expect(catalog.getEntityByName).toHaveBeenCalledTimes(1);
-      expect(catalog.getEntityByName).toHaveBeenCalledWith({
-        namespace: 'default',
-        kind: 'service',
-        name: 'test',
-      });
+      expect(catalog.getEntityByName).toHaveBeenCalledWith(
+        {
+          namespace: 'default',
+          kind: 'service',
+          name: 'test',
+        },
+        { token: undefined },
+      );
 
       expect(badgeBuilder.getBadges).toHaveBeenCalledTimes(1);
       expect(badgeBuilder.createBadgeJson).toHaveBeenCalledTimes(1);
@@ -150,11 +153,14 @@ describe('createRouter', () => {
       expect(response.body).toEqual(Buffer.from(image));
 
       expect(catalog.getEntityByName).toHaveBeenCalledTimes(1);
-      expect(catalog.getEntityByName).toHaveBeenCalledWith({
-        namespace: 'default',
-        kind: 'service',
-        name: 'test',
-      });
+      expect(catalog.getEntityByName).toHaveBeenCalledWith(
+        {
+          namespace: 'default',
+          kind: 'service',
+          name: 'test',
+        },
+        { token: undefined },
+      );
 
       expect(badgeBuilder.getBadges).toHaveBeenCalledTimes(0);
       expect(badgeBuilder.createBadgeSvg).toHaveBeenCalledTimes(1);

plugins/badges-backend/src/service/router.ts

@@ -46,7 +46,12 @@ export async function createRouter(
 
   router.get('/entity/:namespace/:kind/:name/badge-specs', async (req, res) => {
     const { namespace, kind, name } = req.params;
-    const entity = await catalog.getEntityByName({ namespace, kind, name });
+    const entity = await catalog.getEntityByName(
+      { namespace, kind, name },
+      {
+        token: getBearerToken(req.headers.authorization),
+      },
+    );
     if (!entity) {
       throw new NotFoundError(
         `No ${kind} entity in ${namespace} named "${name}"`,
@@ -79,7 +84,12 @@ export async function createRouter(
     '/entity/:namespace/:kind/:name/badge/:badgeId',
     async (req, res) => {
       const { namespace, kind, name, badgeId } = req.params;
-      const entity = await catalog.getEntityByName({ namespace, kind, name });
+      const entity = await catalog.getEntityByName(
+        { namespace, kind, name },
+        {
+          token: getBearerToken(req.headers.authorization),
+        },
+      );
       if (!entity) {
         throw new NotFoundError(
           `No ${kind} entity in ${namespace} named "${name}"`,
@@ -132,3 +142,7 @@ async function getBadgeUrl(
   const baseUrl = await options.discovery.getExternalBaseUrl('badges');
   return `${baseUrl}/entity/${namespace}/${kind}/${name}/badge/${badgeId}`;
 }
+
+function getBearerToken(header?: string): string | undefined {
+  return header?.match(/Bearer\s+(\S+)/i)?.[1];
+}

plugins/badges/src/api/BadgesClient.ts

@@ -15,7 +15,7 @@
  */
 
 import { generatePath } from 'react-router';
-import { DiscoveryApi } from '@backstage/core';
+import { DiscoveryApi, IdentityApi } from '@backstage/core';
 import { ResponseError } from '@backstage/errors';
 import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model';
 import { entityRoute } from '@backstage/plugin-catalog-react';
@@ -23,14 +23,26 @@ import { BadgesApi, BadgeSpec } from './types';
 
 export class BadgesClient implements BadgesApi {
   private readonly discoveryApi: DiscoveryApi;
+  private readonly identityApi: IdentityApi;
 
-  constructor(options: { discoveryApi: DiscoveryApi }) {
+  constructor(options: {
+    discoveryApi: DiscoveryApi;
+    identityApi: IdentityApi;
+  }) {
     this.discoveryApi = options.discoveryApi;
+    this.identityApi = options.identityApi;
   }
 
   public async getEntityBadgeSpecs(entity: Entity): Promise<BadgeSpec[]> {
     const entityBadgeSpecsUrl = await this.getEntityBadgeSpecsUrl(entity);
-    const response = await fetch(entityBadgeSpecsUrl);
+    const token = await this.identityApi.getIdToken();
+    const response = await fetch(entityBadgeSpecsUrl, {
+      headers: token
+        ? {
+            Authorization: `Bearer ${token}`,
+          }
+        : undefined,
+    });
 
     if (!response.ok) {
       throw await ResponseError.fromResponse(response);

plugins/badges/src/plugin.ts

@@ -18,6 +18,7 @@ import {
   createComponentExtension,
   createPlugin,
   discoveryApiRef,
+  identityApiRef,
 } from '@backstage/core';
 import { badgesApiRef, BadgesClient } from './api';
 
@@ -26,8 +27,9 @@ export const badgesPlugin = createPlugin({
   apis: [
     createApiFactory({
       api: badgesApiRef,
-      deps: { discoveryApi: discoveryApiRef },
-      factory: ({ discoveryApi }) => new BadgesClient({ discoveryApi }),
+      deps: { discoveryApi: discoveryApiRef, identityApi: identityApiRef },
+      factory: ({ discoveryApi, identityApi }) =>
+        new BadgesClient({ discoveryApi, identityApi }),
     }),
   ],
 });