Merge pull request #8769 from backstage/freben/techdocs-clients

Some more usage of the `FetchApi`

plugins/scaffolder/api-report.md

@@ -15,10 +15,10 @@ import { Entity } from '@backstage/catalog-model';
 import { EntityName } from '@backstage/catalog-model';
 import { Extension } from '@backstage/core-plugin-api';
 import { ExternalRouteRef } from '@backstage/core-plugin-api';
+import { FetchApi } from '@backstage/core-plugin-api';
 import { FieldProps } from '@rjsf/core';
 import { FieldValidation } from '@rjsf/core';
 import { IconButton } from '@material-ui/core';
-import { IdentityApi } from '@backstage/core-plugin-api';
 import { JsonObject } from '@backstage/types';
 import { JSONSchema } from '@backstage/catalog-model';
 import { Observable } from '@backstage/types';
@@ -166,9 +166,7 @@ export interface RepoUrlPickerUiOptions {
   allowedOwners?: string[];
 }
 
-// Warning: (ae-missing-release-tag) "ScaffolderApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export interface ScaffolderApi {
   // (undocumented)
   getIntegrationsList(options: { allowedHosts: string[] }): Promise<
@@ -189,8 +187,6 @@ export interface ScaffolderApi {
     templateName: EntityName,
   ): Promise<TemplateParameterSchema>;
   // Warning: (ae-forgotten-export) The symbol "ListActionsResponse" needs to be exported by the entry point index.d.ts
-  //
-  // (undocumented)
   listActions(): Promise<ListActionsResponse>;
   scaffold(
     templateName: string,
@@ -200,27 +196,17 @@ export interface ScaffolderApi {
   // Warning: (ae-forgotten-export) The symbol "LogEvent" needs to be exported by the entry point index.d.ts
   //
   // (undocumented)
-  streamLogs({
-    taskId,
-    after,
-  }: {
-    taskId: string;
-    after?: number;
-  }): Observable<LogEvent>;
+  streamLogs(options: { taskId: string; after?: number }): Observable<LogEvent>;
 }
 
-// Warning: (ae-missing-release-tag) "scaffolderApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export const scaffolderApiRef: ApiRef<ScaffolderApi>;
 
-// Warning: (ae-missing-release-tag) "ScaffolderClient" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export class ScaffolderClient implements ScaffolderApi {
   constructor(options: {
     discoveryApi: DiscoveryApi;
-    identityApi: IdentityApi;
+    fetchApi: FetchApi;
     scmIntegrationsApi: ScmIntegrationRegistry;
     useLongPollingLogs?: boolean;
   });
@@ -246,7 +232,7 @@ export class ScaffolderClient implements ScaffolderApi {
     secrets?: Record<string, string>,
   ): Promise<string>;
   // (undocumented)
-  streamLogs(opts: { taskId: string; after?: number }): Observable<LogEvent>;
+  streamLogs(options: { taskId: string; after?: number }): Observable<LogEvent>;
 }
 
 // Warning: (ae-missing-release-tag) "ScaffolderFieldExtensions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)

plugins/scaffolder/dev/index.tsx

@@ -26,9 +26,8 @@ import React from 'react';
 import { scaffolderApiRef, ScaffolderClient } from '../src';
 import { ScaffolderPage } from '../src/plugin';
 import {
-  configApiRef,
   discoveryApiRef,
-  identityApiRef,
+  fetchApiRef,
   storageApiRef,
 } from '@backstage/core-plugin-api';
 import { CatalogEntityPage } from '@backstage/plugin-catalog';
@@ -52,12 +51,11 @@ createDevApp()
     api: scaffolderApiRef,
     deps: {
       discoveryApi: discoveryApiRef,
-      identityApi: identityApiRef,
-      configApi: configApiRef,
+      fetchApi: fetchApiRef,
       scmIntegrationsApi: scmIntegrationsApiRef,
     },
-    factory: ({ discoveryApi, identityApi, scmIntegrationsApi }) =>
-      new ScaffolderClient({ discoveryApi, identityApi, scmIntegrationsApi }),
+    factory: ({ discoveryApi, fetchApi, scmIntegrationsApi }) =>
+      new ScaffolderClient({ discoveryApi, fetchApi, scmIntegrationsApi }),
   })
   .addPage({
     path: '/create',

plugins/scaffolder/src/api.test.ts

@@ -16,7 +16,7 @@
 
 import { ConfigReader } from '@backstage/core-app-api';
 import { ScmIntegrations } from '@backstage/integration';
-import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { MockFetchApi, setupRequestMockHandlers } from '@backstage/test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { ScaffolderClient } from './api';
@@ -32,7 +32,7 @@ describe('api', () => {
   const mockBaseUrl = 'http://backstage/api';
 
   const discoveryApi = { getBaseUrl: async () => mockBaseUrl };
-  const identityApi = {} as any;
+  const fetchApi = new MockFetchApi();
   const scmIntegrationsApi = ScmIntegrations.fromConfig(
     new ConfigReader({
       integrations: {
@@ -50,7 +50,7 @@ describe('api', () => {
     apiClient = new ScaffolderClient({
       scmIntegrationsApi,
       discoveryApi,
-      identityApi,
+      fetchApi,
     });
   });
 
@@ -126,7 +126,7 @@ describe('api', () => {
         apiClient = new ScaffolderClient({
           scmIntegrationsApi,
           discoveryApi,
-          identityApi,
+          fetchApi,
           useLongPollingLogs: true,
         });
       });

plugins/scaffolder/src/api.ts

@@ -18,7 +18,7 @@ import { EntityName } from '@backstage/catalog-model';
 import {
   createApiRef,
   DiscoveryApi,
-  IdentityApi,
+  FetchApi,
 } from '@backstage/core-plugin-api';
 import { ResponseError } from '@backstage/errors';
 import { ScmIntegrationRegistry } from '@backstage/integration';
@@ -28,6 +28,11 @@ import qs from 'qs';
 import ObservableImpl from 'zen-observable';
 import { ListActionsResponse, ScaffolderTask, Status } from './types';
 
+/**
+ * Utility API reference for the {@link ScaffolderApi}.
+ *
+ * @public
+ */
 export const scaffolderApiRef = createApiRef<ScaffolderApi>({
   id: 'plugin.scaffolder.service',
 });
@@ -58,6 +63,11 @@ export type CustomField = {
   validation: (data: JsonValue, field: FieldValidation) => void;
 };
 
+/**
+ * An API to interact with the scaffolder backend.
+ *
+ * @public
+ */
 export interface ScaffolderApi {
   getTemplateParameterSchema(
     templateName: EntityName,
@@ -83,32 +93,33 @@ export interface ScaffolderApi {
     allowedHosts: string[];
   }): Promise<{ type: string; title: string; host: string }[]>;
 
-  // Returns a list of all installed actions.
+  /**
+   * Returns a list of all installed actions.
+   */
   listActions(): Promise<ListActionsResponse>;
 
-  streamLogs({
-    taskId,
-    after,
-  }: {
-    taskId: string;
-    after?: number;
-  }): Observable<LogEvent>;
+  streamLogs(options: { taskId: string; after?: number }): Observable<LogEvent>;
 }
 
+/**
+ * An API to interact with the scaffolder backend.
+ *
+ * @public
+ */
 export class ScaffolderClient implements ScaffolderApi {
   private readonly discoveryApi: DiscoveryApi;
-  private readonly identityApi: IdentityApi;
   private readonly scmIntegrationsApi: ScmIntegrationRegistry;
+  private readonly fetchApi: FetchApi;
   private readonly useLongPollingLogs: boolean;
 
   constructor(options: {
     discoveryApi: DiscoveryApi;
-    identityApi: IdentityApi;
+    fetchApi: FetchApi;
     scmIntegrationsApi: ScmIntegrationRegistry;
     useLongPollingLogs?: boolean;
   }) {
     this.discoveryApi = options.discoveryApi;
-    this.identityApi = options.identityApi;
+    this.fetchApi = options.fetchApi ?? { fetch };
     this.scmIntegrationsApi = options.scmIntegrationsApi;
     this.useLongPollingLogs = options.useLongPollingLogs ?? false;
   }
@@ -129,19 +140,13 @@ export class ScaffolderClient implements ScaffolderApi {
   ): Promise<TemplateParameterSchema> {
     const { namespace, kind, name } = templateName;
 
-    const { token } = await this.identityApi.getCredentials();
     const baseUrl = await this.discoveryApi.getBaseUrl('scaffolder');
     const templatePath = [namespace, kind, name]
       .map(s => encodeURIComponent(s))
       .join('/');
     const url = `${baseUrl}/v2/templates/${templatePath}/parameter-schema`;
 
-    const response = await fetch(url, {
-      headers: {
-        ...(token && { Authorization: `Bearer ${token}` }),
-      },
-    });
-
+    const response = await this.fetchApi.fetch(url);
     if (!response.ok) {
       throw await ResponseError.fromResponse(response);
     }
@@ -163,13 +168,11 @@ export class ScaffolderClient implements ScaffolderApi {
     values: Record<string, any>,
     secrets: Record<string, string> = {},
   ): Promise<string> {
-    const { token } = await this.identityApi.getCredentials();
     const url = `${await this.discoveryApi.getBaseUrl('scaffolder')}/v2/tasks`;
-    const response = await fetch(url, {
+    const response = await this.fetchApi.fetch(url, {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
-        ...(token && { Authorization: `Bearer ${token}` }),
       },
       body: JSON.stringify({
         templateName,
@@ -189,13 +192,10 @@ export class ScaffolderClient implements ScaffolderApi {
   }
 
   async getTask(taskId: string) {
-    const { token } = await this.identityApi.getCredentials();
     const baseUrl = await this.discoveryApi.getBaseUrl('scaffolder');
     const url = `${baseUrl}/v2/tasks/${encodeURIComponent(taskId)}`;
-    const response = await fetch(url, {
-      headers: token ? { Authorization: `Bearer ${token}` } : {},
-    });
 
+    const response = await this.fetchApi.fetch(url);
     if (!response.ok) {
       throw await ResponseError.fromResponse(response);
     }
@@ -203,12 +203,15 @@ export class ScaffolderClient implements ScaffolderApi {
     return await response.json();
   }
 
-  streamLogs(opts: { taskId: string; after?: number }): Observable<LogEvent> {
+  streamLogs(options: {
+    taskId: string;
+    after?: number;
+  }): Observable<LogEvent> {
     if (this.useLongPollingLogs) {
-      return this.streamLogsPolling(opts);
+      return this.streamLogsPolling(options);
     }
 
-    return this.streamLogsEventStream(opts);
+    return this.streamLogsEventStream(options);
   }
 
   private streamLogsEventStream({
@@ -276,7 +279,7 @@ export class ScaffolderClient implements ScaffolderApi {
           const url = `${baseUrl}/v2/tasks/${encodeURIComponent(
             taskId,
           )}/events?${qs.stringify({ after })}`;
-          const response = await fetch(url);
+          const response = await this.fetchApi.fetch(url);
 
           if (!response.ok) {
             // wait for one second to not run into an
@@ -301,16 +304,9 @@ export class ScaffolderClient implements ScaffolderApi {
     });
   }
 
-  /**
-   * @returns ListActionsResponse containing all registered actions.
-   */
   async listActions(): Promise<ListActionsResponse> {
     const baseUrl = await this.discoveryApi.getBaseUrl('scaffolder');
-    const { token } = await this.identityApi.getCredentials();
-    const response = await fetch(`${baseUrl}/v2/actions`, {
-      headers: token ? { Authorization: `Bearer ${token}` } : {},
-    });
-
+    const response = await this.fetchApi.fetch(`${baseUrl}/v2/actions`);
     if (!response.ok) {
       throw await ResponseError.fromResponse(response);
     }

plugins/scaffolder/src/plugin.ts

@@ -33,7 +33,7 @@ import {
   createPlugin,
   createRoutableExtension,
   discoveryApiRef,
-  identityApiRef,
+  fetchApiRef,
 } from '@backstage/core-plugin-api';
 import { OwnedEntityPicker } from './components/fields/OwnedEntityPicker';
 import { EntityTagsPicker } from './components/fields/EntityTagsPicker';
@@ -45,11 +45,15 @@ export const scaffolderPlugin = createPlugin({
       api: scaffolderApiRef,
       deps: {
         discoveryApi: discoveryApiRef,
-        identityApi: identityApiRef,
         scmIntegrationsApi: scmIntegrationsApiRef,
+        fetchApi: fetchApiRef,
       },
-      factory: ({ discoveryApi, identityApi, scmIntegrationsApi }) =>
-        new ScaffolderClient({ discoveryApi, identityApi, scmIntegrationsApi }),
+      factory: ({ discoveryApi, scmIntegrationsApi, fetchApi }) =>
+        new ScaffolderClient({
+          discoveryApi,
+          scmIntegrationsApi,
+          fetchApi,
+        }),
     }),
   ],
   routes: {

plugins/techdocs/api-report.md

@@ -13,6 +13,7 @@ import { CSSProperties } from '@material-ui/styles';
 import { DiscoveryApi } from '@backstage/core-plugin-api';
 import { Entity } from '@backstage/catalog-model';
 import { EntityName } from '@backstage/catalog-model';
+import { FetchApi } from '@backstage/core-plugin-api';
 import { IdentityApi } from '@backstage/core-plugin-api';
 import { LocationSpec } from '@backstage/catalog-model';
 import { default as React_2 } from 'react';
@@ -197,16 +198,11 @@ export const Reader: ({
 // @public (undocumented)
 export const Router: () => JSX.Element;
 
-// Warning: (ae-missing-release-tag) "SyncResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export type SyncResult = 'cached' | 'updated';
 
-// Warning: (ae-missing-release-tag) "TechDocsApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export interface TechDocsApi {
-  // (undocumented)
   getApiOrigin(): Promise<string>;
   // Warning: (ae-forgotten-export) The symbol "TechDocsEntityMetadata" needs to be exported by the entry point index.d.ts
   //
@@ -218,23 +214,15 @@ export interface TechDocsApi {
   getTechDocsMetadata(entityId: EntityName): Promise<TechDocsMetadata>;
 }
 
-// Warning: (ae-missing-release-tag) "techdocsApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export const techdocsApiRef: ApiRef<TechDocsApi>;
 
-// Warning: (ae-missing-release-tag) "TechDocsClient" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public
 export class TechDocsClient implements TechDocsApi {
-  constructor({
-    configApi,
-    discoveryApi,
-    identityApi,
-  }: {
+  constructor(options: {
     configApi: Config;
     discoveryApi: DiscoveryApi;
-    identityApi: IdentityApi;
+    fetchApi: FetchApi;
   });
   // (undocumented)
   configApi: Config;
@@ -244,8 +232,6 @@ export class TechDocsClient implements TechDocsApi {
   getApiOrigin(): Promise<string>;
   getEntityMetadata(entityId: EntityName): Promise<TechDocsEntityMetadata>;
   getTechDocsMetadata(entityId: EntityName): Promise<TechDocsMetadata>;
-  // (undocumented)
-  identityApi: IdentityApi;
 }
 
 // Warning: (ae-missing-release-tag) "TechDocsCustomHome" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -347,11 +333,8 @@ export const TechDocsReaderPage: ({
   children,
 }: TechDocsPageProps) => JSX.Element;
 
-// Warning: (ae-missing-release-tag) "TechDocsStorageApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export interface TechDocsStorageApi {
-  // (undocumented)
   getApiOrigin(): Promise<string>;
   // (undocumented)
   getBaseUrl(
@@ -372,23 +355,16 @@ export interface TechDocsStorageApi {
   ): Promise<SyncResult>;
 }
 
-// Warning: (ae-missing-release-tag) "techdocsStorageApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export const techdocsStorageApiRef: ApiRef<TechDocsStorageApi>;
 
-// Warning: (ae-missing-release-tag) "TechDocsStorageClient" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public
 export class TechDocsStorageClient implements TechDocsStorageApi {
-  constructor({
-    configApi,
-    discoveryApi,
-    identityApi,
-  }: {
+  constructor(options: {
     configApi: Config;
     discoveryApi: DiscoveryApi;
     identityApi: IdentityApi;
+    fetchApi: FetchApi;
   });
   // (undocumented)
   configApi: Config;

plugins/techdocs/src/api.ts

@@ -18,17 +18,40 @@ import { EntityName } from '@backstage/catalog-model';
 import { TechDocsEntityMetadata, TechDocsMetadata } from './types';
 import { createApiRef } from '@backstage/core-plugin-api';
 
+/**
+ * Utility API reference for the {@link TechDocsStorageApi}.
+ *
+ * @public
+ */
 export const techdocsStorageApiRef = createApiRef<TechDocsStorageApi>({
   id: 'plugin.techdocs.storageservice',
 });
 
+/**
+ * Utility API reference for the {@link TechDocsApi}.
+ *
+ * @public
+ */
 export const techdocsApiRef = createApiRef<TechDocsApi>({
   id: 'plugin.techdocs.service',
 });
 
+/**
+ * The outcome of a docs sync operation.
+ *
+ * @public
+ */
 export type SyncResult = 'cached' | 'updated';
 
+/**
+ * API which talks to TechDocs storage to fetch files to render.
+ *
+ * @public
+ */
 export interface TechDocsStorageApi {
+  /**
+   * Set to techdocs.requestUrl as the URL for techdocs-backend API.
+   */
   getApiOrigin(): Promise<string>;
   getStorageUrl(): Promise<string>;
   getBuilder(): Promise<string>;
@@ -44,7 +67,15 @@ export interface TechDocsStorageApi {
   ): Promise<string>;
 }
 
+/**
+ * API to talk to techdocs-backend.
+ *
+ * @public
+ */
 export interface TechDocsApi {
+  /**
+   * Set to techdocs.requestUrl as the URL for techdocs-backend API.
+   */
   getApiOrigin(): Promise<string>;
   getTechDocsMetadata(entityId: EntityName): Promise<TechDocsMetadata>;
   getEntityMetadata(entityId: EntityName): Promise<TechDocsEntityMetadata>;

plugins/techdocs/src/client.test.ts

@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 
-import { MockConfigApi } from '@backstage/test-utils';
 import { UrlPatternDiscovery } from '@backstage/core-app-api';
 import { IdentityApi } from '@backstage/core-plugin-api';
 import { NotFoundError } from '@backstage/errors';
 import { EventSourcePolyfill } from 'event-source-polyfill';
+import { MockConfigApi, MockFetchApi } from '@backstage/test-utils';
 import { TechDocsStorageClient } from './client';
 
 const MockedEventSource = EventSourcePolyfill as jest.MockedClass<
@@ -36,17 +36,13 @@ const mockEntity = {
 describe('TechDocsStorageClient', () => {
   const mockBaseUrl = 'http://backstage:9191/api/techdocs';
   const configApi = new MockConfigApi({
-    techdocs: {
-      requestUrl: 'http://backstage:9191/api/techdocs',
-    },
+    techdocs: { requestUrl: 'http://backstage:9191/api/techdocs' },
   });
   const discoveryApi = UrlPatternDiscovery.compile(mockBaseUrl);
   const identityApi: jest.Mocked<IdentityApi> = {
-    signOut: jest.fn(),
-    getProfileInfo: jest.fn(),
-    getBackstageIdentity: jest.fn(),
     getCredentials: jest.fn(),
-  };
+  } as unknown as jest.Mocked<IdentityApi>;
+  const fetchApi = new MockFetchApi({ injectIdentityAuth: { identityApi } });
 
   beforeEach(() => {
     jest.resetAllMocks();
@@ -58,6 +54,7 @@ describe('TechDocsStorageClient', () => {
       configApi,
       discoveryApi,
       identityApi,
+      fetchApi,
     });
 
     await expect(
@@ -78,6 +75,7 @@ describe('TechDocsStorageClient', () => {
       configApi,
       discoveryApi,
       identityApi,
+      fetchApi,
     });
 
     await expect(
@@ -93,6 +91,7 @@ describe('TechDocsStorageClient', () => {
         configApi,
         discoveryApi,
         identityApi,
+        fetchApi,
       });
 
       MockedEventSource.prototype.addEventListener.mockImplementation(
@@ -103,6 +102,7 @@ describe('TechDocsStorageClient', () => {
         },
       );
 
+      identityApi.getCredentials.mockResolvedValue({});
       await storageApi.syncEntityDocs(mockEntity);
 
       expect(MockedEventSource).toBeCalledWith(
@@ -116,6 +116,7 @@ describe('TechDocsStorageClient', () => {
         configApi,
         discoveryApi,
         identityApi,
+        fetchApi,
       });
 
       MockedEventSource.prototype.addEventListener.mockImplementation(
@@ -127,7 +128,6 @@ describe('TechDocsStorageClient', () => {
       );
 
       identityApi.getCredentials.mockResolvedValue({ token: 'token' });
-
       await storageApi.syncEntityDocs(mockEntity);
 
       expect(MockedEventSource).toBeCalledWith(
@@ -141,6 +141,7 @@ describe('TechDocsStorageClient', () => {
         configApi,
         discoveryApi,
         identityApi,
+        fetchApi,
       });
 
       MockedEventSource.prototype.addEventListener.mockImplementation(
@@ -151,6 +152,7 @@ describe('TechDocsStorageClient', () => {
         },
       );
 
+      identityApi.getCredentials.mockResolvedValue({});
       await expect(storageApi.syncEntityDocs(mockEntity)).resolves.toEqual(
         'cached',
       );
@@ -161,6 +163,7 @@ describe('TechDocsStorageClient', () => {
         configApi,
         discoveryApi,
         identityApi,
+        fetchApi,
       });
 
       MockedEventSource.prototype.addEventListener.mockImplementation(
@@ -171,6 +174,7 @@ describe('TechDocsStorageClient', () => {
         },
       );
 
+      identityApi.getCredentials.mockResolvedValue({});
       await expect(storageApi.syncEntityDocs(mockEntity)).resolves.toEqual(
         'updated',
       );
@@ -181,6 +185,7 @@ describe('TechDocsStorageClient', () => {
         configApi,
         discoveryApi,
         identityApi,
+        fetchApi,
       });
 
       MockedEventSource.prototype.addEventListener.mockImplementation(
@@ -195,6 +200,7 @@ describe('TechDocsStorageClient', () => {
         },
       );
 
+      identityApi.getCredentials.mockResolvedValue({});
       const logHandler = jest.fn();
       await expect(
         storageApi.syncEntityDocs(mockEntity, logHandler),
@@ -209,9 +215,11 @@ describe('TechDocsStorageClient', () => {
         configApi,
         discoveryApi,
         identityApi,
+        fetchApi,
       });
 
       // we await later after we emitted the error
+      identityApi.getCredentials.mockResolvedValue({});
       const promise = storageApi.syncEntityDocs(mockEntity).then();
 
       // flush the event loop
@@ -234,9 +242,11 @@ describe('TechDocsStorageClient', () => {
         configApi,
         discoveryApi,
         identityApi,
+        fetchApi,
       });
 
       // we await later after we emitted the error
+      identityApi.getCredentials.mockResolvedValue({});
       const promise = storageApi.syncEntityDocs(mockEntity).then();
 
       // flush the event loop

plugins/techdocs/src/client.ts

@@ -16,7 +16,11 @@
 
 import { EntityName } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
-import { DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
+import {
+  DiscoveryApi,
+  FetchApi,
+  IdentityApi,
+} from '@backstage/core-plugin-api';
 import { NotFoundError, ResponseError } from '@backstage/errors';
 import { EventSourcePolyfill } from 'event-source-polyfill';
 import { SyncResult, TechDocsApi, TechDocsStorageApi } from './api';
@@ -24,24 +28,22 @@ import { TechDocsEntityMetadata, TechDocsMetadata } from './types';
 
 /**
  * API to talk to `techdocs-backend`.
+ *
+ * @public
  */
 export class TechDocsClient implements TechDocsApi {
   public configApi: Config;
   public discoveryApi: DiscoveryApi;
-  public identityApi: IdentityApi;
+  private fetchApi: FetchApi;
 
-  constructor({
-    configApi,
-    discoveryApi,
-    identityApi,
-  }: {
+  constructor(options: {
     configApi: Config;
     discoveryApi: DiscoveryApi;
-    identityApi: IdentityApi;
+    fetchApi: FetchApi;
   }) {
-    this.configApi = configApi;
-    this.discoveryApi = discoveryApi;
-    this.identityApi = identityApi;
+    this.configApi = options.configApi;
+    this.discoveryApi = options.discoveryApi;
+    this.fetchApi = options.fetchApi;
   }
 
   async getApiOrigin(): Promise<string> {
@@ -65,12 +67,7 @@ export class TechDocsClient implements TechDocsApi {
 
     const apiOrigin = await this.getApiOrigin();
     const requestUrl = `${apiOrigin}/metadata/techdocs/${namespace}/${kind}/${name}`;
-    const { token } = await this.identityApi.getCredentials();
-
-    const request = await fetch(`${requestUrl}`, {
-      headers: token ? { Authorization: `Bearer ${token}` } : {},
-    });
-
+    const request = await this.fetchApi.fetch(`${requestUrl}`);
     if (!request.ok) {
       throw await ResponseError.fromResponse(request);
     }
@@ -93,12 +90,8 @@ export class TechDocsClient implements TechDocsApi {
 
     const apiOrigin = await this.getApiOrigin();
     const requestUrl = `${apiOrigin}/metadata/entity/${namespace}/${kind}/${name}`;
-    const { token } = await this.identityApi.getCredentials();
-
-    const request = await fetch(`${requestUrl}`, {
-      headers: token ? { Authorization: `Bearer ${token}` } : {},
-    });
 
+    const request = await this.fetchApi.fetch(`${requestUrl}`);
     if (!request.ok) {
       throw await ResponseError.fromResponse(request);
     }
@@ -109,24 +102,25 @@ export class TechDocsClient implements TechDocsApi {
 
 /**
  * API which talks to TechDocs storage to fetch files to render.
+ *
+ * @public
  */
 export class TechDocsStorageClient implements TechDocsStorageApi {
   public configApi: Config;
   public discoveryApi: DiscoveryApi;
   public identityApi: IdentityApi;
+  private fetchApi: FetchApi;
 
-  constructor({
-    configApi,
-    discoveryApi,
-    identityApi,
-  }: {
+  constructor(options: {
     configApi: Config;
     discoveryApi: DiscoveryApi;
     identityApi: IdentityApi;
+    fetchApi: FetchApi;
   }) {
-    this.configApi = configApi;
-    this.discoveryApi = discoveryApi;
-    this.identityApi = identityApi;
+    this.configApi = options.configApi;
+    this.discoveryApi = options.discoveryApi;
+    this.identityApi = options.identityApi;
+    this.fetchApi = options.fetchApi;
   }
 
   async getApiOrigin(): Promise<string> {
@@ -160,13 +154,9 @@ export class TechDocsStorageClient implements TechDocsStorageApi {
 
     const storageUrl = await this.getStorageUrl();
     const url = `${storageUrl}/${namespace}/${kind}/${name}/${path}`;
-    const { token } = await this.identityApi.getCredentials();
 
-    const request = await fetch(
+    const request = await this.fetchApi.fetch(
       `${url.endsWith('/') ? url : `${url}/`}index.html`,
-      {
-        headers: token ? { Authorization: `Bearer ${token}` } : {},
-      },
     );
 
     let errorMessage = '';

plugins/techdocs/src/plugin.ts

@@ -28,6 +28,7 @@ import {
   createPlugin,
   createRoutableExtension,
   discoveryApiRef,
+  fetchApiRef,
   identityApiRef,
 } from '@backstage/core-plugin-api';
 
@@ -40,12 +41,14 @@ export const techdocsPlugin = createPlugin({
         configApi: configApiRef,
         discoveryApi: discoveryApiRef,
         identityApi: identityApiRef,
+        fetchApi: fetchApiRef,
       },
-      factory: ({ configApi, discoveryApi, identityApi }) =>
+      factory: ({ configApi, discoveryApi, identityApi, fetchApi }) =>
         new TechDocsStorageClient({
           configApi,
           discoveryApi,
           identityApi,
+          fetchApi,
         }),
     }),
     createApiFactory({
@@ -53,13 +56,13 @@ export const techdocsPlugin = createPlugin({
       deps: {
         configApi: configApiRef,
         discoveryApi: discoveryApiRef,
-        identityApi: identityApiRef,
+        fetchApi: fetchApiRef,
       },
-      factory: ({ configApi, discoveryApi, identityApi }) =>
+      factory: ({ configApi, discoveryApi, fetchApi }) =>
         new TechDocsClient({
           configApi,
           discoveryApi,
-          identityApi,
+          fetchApi,
         }),
     }),
   ],