add and use MockFetchApi

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

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,
         }),