add and use MockFetchApi

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

plugins/scaffolder/api-report.md

@@ -19,7 +19,6 @@ 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';
@@ -188,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,
@@ -209,8 +206,7 @@ export const scaffolderApiRef: ApiRef<ScaffolderApi>;
 export class ScaffolderClient implements ScaffolderApi {
   constructor(options: {
     discoveryApi: DiscoveryApi;
-    identityApi: IdentityApi;
-    fetchApi?: FetchApi;
+    fetchApi: FetchApi;
     scmIntegrationsApi: ScmIntegrationRegistry;
     useLongPollingLogs?: boolean;
   });

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

@@ -19,7 +19,6 @@ import {
   createApiRef,
   DiscoveryApi,
   FetchApi,
-  IdentityApi,
 } from '@backstage/core-plugin-api';
 import { ResponseError } from '@backstage/errors';
 import { ScmIntegrationRegistry } from '@backstage/integration';
@@ -94,7 +93,9 @@ 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(options: { taskId: string; after?: number }): Observable<LogEvent>;
@@ -107,20 +108,17 @@ export interface ScaffolderApi {
  */
 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;
+    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;
@@ -142,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 this.fetchApi.fetch(url, {
-      headers: {
-        ...(token && { Authorization: `Bearer ${token}` }),
-      },
-    });
-
+    const response = await this.fetchApi.fetch(url);
     if (!response.ok) {
       throw await ResponseError.fromResponse(response);
     }
@@ -176,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 this.fetchApi.fetch(url, {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
-        ...(token && { Authorization: `Bearer ${token}` }),
       },
       body: JSON.stringify({
         templateName,
@@ -202,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 this.fetchApi.fetch(url, {
-      headers: token ? { Authorization: `Bearer ${token}` } : {},
-    });
 
+    const response = await this.fetchApi.fetch(url);
     if (!response.ok) {
       throw await ResponseError.fromResponse(response);
     }
@@ -317,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 this.fetchApi.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

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

plugins/techdocs/api-report.md

@@ -222,8 +222,7 @@ export class TechDocsClient implements TechDocsApi {
   constructor(options: {
     configApi: Config;
     discoveryApi: DiscoveryApi;
-    identityApi: IdentityApi;
-    fetchApi?: FetchApi;
+    fetchApi: FetchApi;
   });
   // (undocumented)
   configApi: Config;
@@ -233,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)
@@ -382,7 +379,7 @@ export class TechDocsStorageClient implements TechDocsStorageApi {
     configApi: Config;
     discoveryApi: DiscoveryApi;
     identityApi: IdentityApi;
-    fetchApi?: FetchApi;
+    fetchApi: FetchApi;
   });
   // (undocumented)
   configApi: Config;

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().setAuthorization({ 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

@@ -34,19 +34,16 @@ import { TechDocsEntityMetadata, TechDocsMetadata } from './types';
 export class TechDocsClient implements TechDocsApi {
   public configApi: Config;
   public discoveryApi: DiscoveryApi;
-  public identityApi: IdentityApi;
   private fetchApi: FetchApi;
 
   constructor(options: {
     configApi: Config;
     discoveryApi: DiscoveryApi;
-    identityApi: IdentityApi;
-    fetchApi?: FetchApi;
+    fetchApi: FetchApi;
   }) {
     this.configApi = options.configApi;
     this.discoveryApi = options.discoveryApi;
-    this.identityApi = options.identityApi;
-    this.fetchApi = options.fetchApi ?? { fetch };
+    this.fetchApi = options.fetchApi;
   }
 
   async getApiOrigin(): Promise<string> {
@@ -70,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 this.fetchApi.fetch(`${requestUrl}`, {
-      headers: token ? { Authorization: `Bearer ${token}` } : {},
-    });
-
+    const request = await this.fetchApi.fetch(`${requestUrl}`);
     if (!request.ok) {
       throw await ResponseError.fromResponse(request);
     }
@@ -98,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 this.fetchApi.fetch(`${requestUrl}`, {
-      headers: token ? { Authorization: `Bearer ${token}` } : {},
-    });
 
+    const request = await this.fetchApi.fetch(`${requestUrl}`);
     if (!request.ok) {
       throw await ResponseError.fromResponse(request);
     }
@@ -114,11 +102,8 @@ export class TechDocsClient implements TechDocsApi {
 
 /**
  * API which talks to TechDocs storage to fetch files to render.
-<<<<<<< HEAD
-=======
  *
  * @public
->>>>>>> 31c54b8ea2 (Make the techdocs APIs use the FetchApi)
  */
 export class TechDocsStorageClient implements TechDocsStorageApi {
   public configApi: Config;
@@ -130,12 +115,12 @@ export class TechDocsStorageClient implements TechDocsStorageApi {
     configApi: Config;
     discoveryApi: DiscoveryApi;
     identityApi: IdentityApi;
-    fetchApi?: FetchApi;
+    fetchApi: FetchApi;
   }) {
     this.configApi = options.configApi;
     this.discoveryApi = options.discoveryApi;
     this.identityApi = options.identityApi;
-    this.fetchApi = options.fetchApi ?? { fetch };
+    this.fetchApi = options.fetchApi;
   }
 
   async getApiOrigin(): Promise<string> {
@@ -169,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 this.fetchApi.fetch(
       `${url.endsWith('/') ? url : `${url}/`}index.html`,
-      {
-        headers: token ? { Authorization: `Bearer ${token}` } : {},
-      },
     );
 
     let errorMessage = '';

plugins/techdocs/src/plugin.ts

@@ -56,14 +56,12 @@ export const techdocsPlugin = createPlugin({
       deps: {
         configApi: configApiRef,
         discoveryApi: discoveryApiRef,
-        identityApi: identityApiRef,
         fetchApi: fetchApiRef,
       },
-      factory: ({ configApi, discoveryApi, identityApi, fetchApi }) =>
+      factory: ({ configApi, discoveryApi, fetchApi }) =>
         new TechDocsClient({
           configApi,
           discoveryApi,
-          identityApi,
           fetchApi,
         }),
     }),

plugins/techdocs/src/setupTests.ts

@@ -15,4 +15,3 @@
  */
 
 import '@testing-library/jest-dom';
-import 'cross-fetch/polyfill';