chore/cli: Replace msw with setupRequestMockHandlers

Signed-off-by: Johan Haals <johan.haals@gmail.com>

.changeset/famous-foxes-invite.md

@@ -0,0 +1,5 @@
+---
+'@backstage/cli': patch
+---
+
+Update usage of msw in default plugin template

packages/backend-common/src/reading/AzureUrlReader.test.ts

@@ -19,7 +19,7 @@ import {
   AzureIntegration,
   readAzureIntegrationConfig,
 } from '@backstage/integration';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import fs from 'fs-extra';
 import mockFs from 'mock-fs';
 import { rest } from 'msw';
@@ -51,7 +51,7 @@ describe('AzureUrlReader', () => {
   });
 
   const worker = setupServer();
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
 
   describe('read', () => {
     beforeEach(() => {

packages/backend-common/src/reading/BitbucketUrlReader.test.ts

@@ -19,7 +19,7 @@ import {
   BitbucketIntegration,
   readBitbucketIntegrationConfig,
 } from '@backstage/integration';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import fs from 'fs-extra';
 import mockFs from 'mock-fs';
 import { rest } from 'msw';
@@ -72,7 +72,7 @@ describe('BitbucketUrlReader', () => {
   });
 
   const worker = setupServer();
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
 
   describe('readUrl', () => {
     worker.use(

packages/backend-common/src/reading/FetchUrlReader.test.ts

@@ -16,7 +16,7 @@
 
 import { ConfigReader } from '@backstage/config';
 import { NotFoundError, NotModifiedError } from '@backstage/errors';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { getVoidLogger } from '../logging';
@@ -28,7 +28,7 @@ const fetchUrlReader = new FetchUrlReader();
 describe('FetchUrlReader', () => {
   const worker = setupServer();
 
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
 
   beforeEach(() => {
     jest.clearAllMocks();

packages/backend-common/src/reading/GithubUrlReader.test.ts

@@ -20,7 +20,7 @@ import {
   GitHubIntegration,
   readGitHubIntegrationConfig,
 } from '@backstage/integration';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import fs from 'fs-extra';
 import mockFs from 'mock-fs';
 import { rest } from 'msw';
@@ -73,7 +73,7 @@ const tmpDir = os.platform() === 'win32' ? 'C:\\tmp' : '/tmp';
 
 describe('GithubUrlReader', () => {
   const worker = setupServer();
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
 
   beforeEach(() => {
     mockFs({

packages/backend-common/src/reading/GitlabUrlReader.test.ts

@@ -15,7 +15,7 @@
  */
 
 import { ConfigReader } from '@backstage/config';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import fs from 'fs-extra';
 import mockFs from 'mock-fs';
 import { rest } from 'msw';
@@ -77,7 +77,7 @@ describe('GitlabUrlReader', () => {
   });
 
   const worker = setupServer();
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
 
   describe('read', () => {
     beforeEach(() => {

packages/cli/templates/default-plugin/src/components/ExampleComponent/ExampleComponent.test.tsx.hbs

@@ -4,12 +4,15 @@ import { ThemeProvider } from '@material-ui/core';
 import { lightTheme } from '@backstage/theme';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
-import { msw, renderInTestApp } from '@backstage/test-utils';
+import {
+  setupRequestMockHandlers,
+  renderInTestApp,
+} from "@backstage/test-utils";
 
 describe('ExampleComponent', () => {
   const server = setupServer();
   // Enable sane handlers for network requests
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   // setup mock response
   beforeEach(() => {

packages/cli/templates/default-plugin/src/components/ExampleFetchComponent/ExampleFetchComponent.test.tsx.hbs

@@ -3,12 +3,12 @@ import { render } from '@testing-library/react';
 import { ExampleFetchComponent } from './ExampleFetchComponent';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 
 describe('ExampleFetchComponent', () => {
   const server = setupServer();
   // Enable sane handlers for network requests
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   // setup mock response
   beforeEach(() => {

packages/core-app-api/src/lib/AuthConnector/DefaultAuthConnector.test.ts

@@ -19,7 +19,7 @@ import { DefaultAuthConnector } from './DefaultAuthConnector';
 import MockOAuthApi from '../../apis/implementations/OAuthRequestApi/MockOAuthApi';
 import * as loginPopup from '../loginPopup';
 import { UrlPatternDiscovery } from '../../apis';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { setupServer } from 'msw/node';
 import { rest } from 'msw';
 
@@ -41,7 +41,7 @@ const defaultOptions = {
 
 describe('DefaultAuthConnector', () => {
   const server = setupServer();
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   afterEach(() => {
     jest.resetAllMocks();

packages/integration/src/bitbucket/core.test.ts

@@ -16,7 +16,7 @@
 
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { BitbucketIntegrationConfig } from './config';
 import {
   getBitbucketDefaultBranch,
@@ -27,7 +27,7 @@ import {
 
 describe('bitbucket core', () => {
   const worker = setupServer();
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
 
   describe('getBitbucketRequestOptions', () => {
     it('inserts a token when needed', () => {

plugins/allure/src/components/AllureReportComponent/AllureReportComponent.test.tsx

@@ -19,12 +19,15 @@ import { ThemeProvider } from '@material-ui/core';
 import { lightTheme } from '@backstage/theme';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
-import { msw, renderInTestApp } from '@backstage/test-utils';
+import {
+  setupRequestMockHandlers,
+  renderInTestApp,
+} from '@backstage/test-utils';
 
 describe('ExampleComponent', () => {
   const server = setupServer();
   // Enable sane handlers for network requests
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   // setup mock response
   beforeEach(() => {

plugins/auth-backend/src/providers/oidc/provider.test.ts

@@ -15,7 +15,7 @@
  */
 
 import { Config, ConfigReader } from '@backstage/config';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import express from 'express';
 import { Session } from 'express-session';
 import { JWK, JWT } from 'jose';
@@ -52,7 +52,7 @@ const clientMetadata = {
 
 describe('OidcAuthProvider', () => {
   const worker = setupServer();
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
 
   beforeEach(() => {
     jest.clearAllMocks();

plugins/bitrise/src/api/bitriseApi.client.test.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { BitriseClientApi } from './bitriseApi.client';
@@ -24,7 +24,7 @@ import { UrlPatternDiscovery } from '@backstage/core-app-api';
 const server = setupServer();
 
 describe('BitriseClientApi', () => {
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   const mockBaseUrl = 'http://backstage:9191/api/proxy';
   const discoveryApi = UrlPatternDiscovery.compile(mockBaseUrl);

plugins/bitrise/src/components/BitriseBuildsTableComponent/BitriseBuildsTableComponent.test.tsx

@@ -18,7 +18,10 @@ import React from 'react';
 import { bitriseApiRef } from '../../plugin';
 import { BitriseClientApi } from '../../api/bitriseApi.client';
 import { setupServer } from 'msw/node';
-import { msw, renderInTestApp } from '@backstage/test-utils';
+import {
+  setupRequestMockHandlers,
+  renderInTestApp,
+} from '@backstage/test-utils';
 import { useBitriseBuilds } from '../../hooks/useBitriseBuilds';
 import { BitriseBuildsTable } from './BitriseBuildsTableComponent';
 import {
@@ -34,7 +37,7 @@ jest.mock('../../hooks/useBitriseBuilds', () => ({
 const server = setupServer();
 
 describe('BitriseBuildsFetchComponent', () => {
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
   const mockBaseUrl = 'http://backstage:9191';
   const discoveryApi = UrlPatternDiscovery.compile(mockBaseUrl);
   let apis: ApiRegistry;

plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.test.ts

@@ -15,7 +15,7 @@
  */
 
 import * as msal from '@azure/msal-node';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { MicrosoftGraphClient } from './client';
@@ -28,7 +28,7 @@ describe('MicrosoftGraphClient', () => {
   let client: MicrosoftGraphClient;
   const worker = setupServer();
 
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
 
   beforeEach(() => {
     confidentialClientApplication.acquireTokenByClientCredential.mockResolvedValue(

plugins/catalog-backend/src/ingestion/processors/UrlReaderProcessor.test.ts

@@ -20,7 +20,7 @@ import {
   UrlReaders,
 } from '@backstage/backend-common';
 import { ConfigReader } from '@backstage/config';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import {
@@ -39,7 +39,7 @@ describe('UrlReaderProcessor', () => {
     set: jest.fn(),
   };
   const server = setupServer();
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   beforeEach(() => {
     jest.resetAllMocks();

plugins/catalog-backend/src/ingestion/processors/github/github.test.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { graphql } from '@octokit/graphql';
 import { graphql as graphqlMsw } from 'msw';
 import { setupServer } from 'msw/node';
@@ -28,7 +28,7 @@ import {
 
 describe('github', () => {
   const server = setupServer();
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   describe('getOrganizationUsers', () => {
     it('reads members', async () => {

plugins/catalog-graphql/src/graphql/module.test.ts

@@ -21,7 +21,7 @@ import { setupServer } from 'msw/node';
 import { ConfigReader } from '@backstage/config';
 import { ReaderEntity } from '../service/client';
 import { createLogger } from 'winston';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { gql } from 'apollo-server';
 
 describe('Catalog Module', () => {
@@ -33,7 +33,7 @@ describe('Catalog Module', () => {
     },
   });
 
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
 
   describe('Default Entity', () => {
     beforeEach(() => {

plugins/catalog-graphql/src/service/client.test.ts

@@ -16,11 +16,11 @@
 import { CatalogClient } from './client';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 
 describe('Catalog GraphQL Module', () => {
   const worker = setupServer();
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
 
   const baseUrl = 'http://localhost:1234';
 

plugins/catalog-import/src/api/CatalogImportClient.test.ts

@@ -50,7 +50,7 @@ import { ConfigReader, UrlPatternDiscovery } from '@backstage/core-app-api';
 import { ScmIntegrations } from '@backstage/integration';
 import { ScmAuthApi } from '@backstage/integration-react';
 import { catalogApiRef } from '@backstage/plugin-catalog-react';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { Octokit } from '@octokit/rest';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
@@ -58,7 +58,7 @@ import { CatalogImportClient } from './CatalogImportClient';
 
 describe('CatalogImportClient', () => {
   const server = setupServer();
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   const mockBaseUrl = 'http://backstage:9191/api/catalog';
   const discoveryApi = UrlPatternDiscovery.compile(mockBaseUrl);

plugins/fossa/src/api/FossaClient.test.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { FindingSummary, FossaApi, FossaClient } from './index';
@@ -40,7 +40,7 @@ const identityApi: IdentityApi = {
 };
 
 describe('FossaClient', () => {
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   const mockBaseUrl = 'http://backstage:9191/api/proxy';
   const discoveryApi = UrlPatternDiscovery.compile(mockBaseUrl);

plugins/github-deployments/src/components/GithubDeploymentsCard.test.tsx

@@ -16,7 +16,10 @@
 import React from 'react';
 
 import { fireEvent } from '@testing-library/react';
-import { msw, renderInTestApp } from '@backstage/test-utils';
+import {
+  setupRequestMockHandlers,
+  renderInTestApp,
+} from '@backstage/test-utils';
 import {
   GithubDeployment,
   GithubDeploymentsApiClient,
@@ -127,7 +130,7 @@ const assertFetchedData = async () => {
 
 describe('github-deployments', () => {
   const worker = setupServer();
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
 
   beforeEach(() => {
     worker.resetHandlers();

plugins/lighthouse/src/components/AuditList/AuditListTable.test.tsx

@@ -16,7 +16,7 @@
 
 import React from 'react';
 import { render } from '@testing-library/react';
-import { wrapInTestApp, msw } from '@backstage/test-utils';
+import { wrapInTestApp, setupRequestMockHandlers } from '@backstage/test-utils';
 import AuditListTable from './AuditListTable';
 
 import {
@@ -36,7 +36,7 @@ describe('AuditListTable', () => {
   let apis: ApiRegistry;
 
   const server = setupServer();
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   beforeEach(() => {
     apis = ApiRegistry.from([

plugins/lighthouse/src/components/AuditList/index.test.tsx

@@ -23,7 +23,7 @@ jest.mock('react-router-dom', () => {
   };
 });
 
-import { msw, wrapInTestApp } from '@backstage/test-utils';
+import { setupRequestMockHandlers, wrapInTestApp } from '@backstage/test-utils';
 import { fireEvent, render } from '@testing-library/react';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
@@ -44,7 +44,7 @@ describe('AuditList', () => {
   let apis: ApiRegistry;
 
   const server = setupServer();
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   beforeEach(() => {
     apis = ApiRegistry.from([

plugins/lighthouse/src/components/AuditView/index.test.tsx

@@ -26,7 +26,7 @@ jest.mock('react-router-dom', () => {
   };
 });
 
-import { msw, wrapInTestApp } from '@backstage/test-utils';
+import { setupRequestMockHandlers, wrapInTestApp } from '@backstage/test-utils';
 import { render } from '@testing-library/react';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
@@ -46,7 +46,7 @@ describe('AuditView', () => {
   let id: string;
 
   const server = setupServer();
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   beforeEach(() => {
     server.use(

plugins/lighthouse/src/components/CreateAudit/index.test.tsx

@@ -23,7 +23,7 @@ jest.mock('react-router-dom', () => {
   };
 });
 
-import { msw, wrapInTestApp } from '@backstage/test-utils';
+import { setupRequestMockHandlers, wrapInTestApp } from '@backstage/test-utils';
 import { fireEvent, render, waitFor } from '@testing-library/react';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
@@ -44,7 +44,7 @@ describe('CreateAudit', () => {
   let apis: ApiRegistry;
   let errorApi: ErrorApi;
   const server = setupServer();
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   beforeEach(() => {
     errorApi = { post: jest.fn(), error$: jest.fn() };

plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/bitbucket.test.ts

@@ -19,7 +19,7 @@ jest.mock('../helpers');
 import { createPublishBitbucketAction } from './bitbucket';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { ScmIntegrations } from '@backstage/integration';
 import { ConfigReader } from '@backstage/config';
 import { getVoidLogger } from '@backstage/backend-common';
@@ -60,7 +60,7 @@ describe('publish:bitbucket', () => {
     createTemporaryDirectory: jest.fn(),
   };
   const server = setupServer();
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   beforeEach(() => {
     jest.resetAllMocks();

plugins/sonarqube/src/api/SonarQubeClient.test.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { FindingSummary, SonarQubeClient } from './index';
@@ -54,7 +54,7 @@ const identityApiGuest: IdentityApi = {
 };
 
 describe('SonarQubeClient', () => {
-  msw.setupDefaultHandlers(server);
+  setupRequestMockHandlers(server);
 
   const mockBaseUrl = 'http://backstage:9191/api/proxy';
   const discoveryApi = UrlPatternDiscovery.compile(mockBaseUrl);

plugins/techdocs-backend/src/search/DefaultTechDocsCollator.test.ts

@@ -20,7 +20,7 @@ import {
 } from '@backstage/backend-common';
 import { Entity } from '@backstage/catalog-model';
 import { DefaultTechDocsCollator } from './DefaultTechDocsCollator';
-import { msw } from '@backstage/test-utils';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
 import { setupServer } from 'msw/node';
 import { rest } from 'msw';
 import { ConfigReader } from '@backstage/config';
@@ -90,7 +90,7 @@ describe('DefaultTechDocsCollator with legacyPathCasing configuration', () => {
   let collator: DefaultTechDocsCollator;
 
   const worker = setupServer();
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
   beforeEach(() => {
     mockDiscoveryApi = {
       getBaseUrl: jest.fn().mockResolvedValue('http://test-backend'),
@@ -148,7 +148,7 @@ describe('DefaultTechDocsCollator', () => {
   let collator: DefaultTechDocsCollator;
 
   const worker = setupServer();
-  msw.setupDefaultHandlers(worker);
+  setupRequestMockHandlers(worker);
   beforeEach(() => {
     mockDiscoveryApi = {
       getBaseUrl: jest.fn().mockResolvedValue('http://test-backend'),