add and use MockFetchApi

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-01-06 19:46:33 +01:00
parent aecfe4f403
commit 6bf7826258
23 changed files with 284 additions and 106 deletions
@@ -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;
@@ -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
@@ -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 = '';
@@ -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,
        }),
    }),
@@ -15,4 +15,3 @@
 */

 import '@testing-library/jest-dom';
-import 'cross-fetch/polyfill';