plugins/catalog: switch CatalogClient to use DiscoveryApi

packages/app/src/apis.ts

@@ -178,13 +178,7 @@ export const apis = (config: ConfigApi) => {
     }),
   );
 
-  builder.add(
-    catalogApiRef,
-    new CatalogClient({
-      apiOrigin: backendUrl,
-      basePath: '/catalog',
-    }),
-  );
+  builder.add(catalogApiRef, new CatalogClient({ discoveryApi }));
 
   builder.add(
     scaffolderApiRef,

plugins/catalog/src/api/CatalogClient.test.ts

@@ -18,25 +18,21 @@ import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { CatalogClient } from './CatalogClient';
 import { Entity } from '@backstage/catalog-model';
+import { UrlPatternDiscovery } from '@backstage/core';
 
 const server = setupServer();
+const mockBaseUrl = 'http://backstage:9191/i-am-a-mock-base';
+const discoveryApi = UrlPatternDiscovery.compile(mockBaseUrl);
 
 describe('CatalogClient', () => {
   beforeAll(() => server.listen());
   afterEach(() => server.resetHandlers());
   afterAll(() => server.close());
-  const mockApiOrigin = 'http://backstage:9191';
-  const mockBasePath = '/i-am-a-mock-base';
-  let client = new CatalogClient({
-    apiOrigin: mockApiOrigin,
-    basePath: mockBasePath,
-  });
+
+  let client = new CatalogClient({ discoveryApi });
 
   beforeEach(() => {
-    client = new CatalogClient({
-      apiOrigin: mockApiOrigin,
-      basePath: mockBasePath,
-    });
+    client = new CatalogClient({ discoveryApi });
   });
 
   describe('getEntiies', () => {
@@ -61,7 +57,7 @@ describe('CatalogClient', () => {
 
     beforeEach(() => {
       server.use(
-        rest.get(`${mockApiOrigin}${mockBasePath}/entities`, (_, res, ctx) => {
+        rest.get(`${mockBaseUrl}/entities`, (_, res, ctx) => {
           return res(ctx.json(defaultResponse));
         }),
       );
@@ -75,15 +71,12 @@ describe('CatalogClient', () => {
     it('builds entity search filters properly', async () => {
       expect.assertions(2);
       server.use(
-        rest.get(
-          `${mockApiOrigin}${mockBasePath}/entities`,
-          (req, res, ctx) => {
-            expect(req.url.searchParams.toString()).toBe(
-              'a=1&b=2&b=3&%C3%B6=%3D',
-            );
-            return res(ctx.json([]));
-          },
-        ),
+        rest.get(`${mockBaseUrl}/entities`, (req, res, ctx) => {
+          expect(req.url.searchParams.toString()).toBe(
+            'a=1&b=2&b=3&%C3%B6=%3D',
+          );
+          return res(ctx.json([]));
+        }),
       );
 
       const entities = await client.getEntities({

plugins/catalog/src/api/CatalogClient.ts

@@ -20,24 +20,17 @@ import {
   LOCATION_ANNOTATION,
 } from '@backstage/catalog-model';
 import { CatalogApi, EntityCompoundName } from './types';
+import { DiscoveryApi } from '@backstage/core';
 
 export class CatalogClient implements CatalogApi {
-  private apiOrigin: string;
-  private basePath: string;
+  private readonly discoveryApi: DiscoveryApi;
 
-  constructor({
-    apiOrigin,
-    basePath,
-  }: {
-    apiOrigin: string;
-    basePath: string;
-  }) {
-    this.apiOrigin = apiOrigin;
-    this.basePath = basePath;
+  constructor(options: { discoveryApi: DiscoveryApi }) {
+    this.discoveryApi = options.discoveryApi;
   }
 
   private async getRequired(path: string): Promise<any> {
-    const url = `${this.apiOrigin}${this.basePath}${path}`;
+    const url = `${await this.discoveryApi.getBaseUrl('catalog')}${path}`;
     const response = await fetch(url);
 
     if (!response.ok) {
@@ -50,7 +43,7 @@ export class CatalogClient implements CatalogApi {
   }
 
   private async getOptional(path: string): Promise<any | undefined> {
-    const url = `${this.apiOrigin}${this.basePath}${path}`;
+    const url = `${await this.discoveryApi.getBaseUrl('catalog')}${path}`;
     const response = await fetch(url);
 
     if (!response.ok) {
@@ -100,7 +93,7 @@ export class CatalogClient implements CatalogApi {
 
   async addLocation(type: string, target: string) {
     const response = await fetch(
-      `${this.apiOrigin}${this.basePath}/locations`,
+      `${await this.discoveryApi.getBaseUrl('catalog')}/locations`,
       {
         headers: {
           'Content-Type': 'application/json',
@@ -135,7 +128,7 @@ export class CatalogClient implements CatalogApi {
 
   async removeEntityByUid(uid: string): Promise<void> {
     const response = await fetch(
-      `${this.apiOrigin}${this.basePath}/entities/by-uid/${uid}`,
+      `${await this.discoveryApi.getBaseUrl('catalog')}/entities/by-uid/${uid}`,
       {
         method: 'DELETE',
       },