Migrate from jest to vitest + msw (pactjs-cli)

.changeset/ten-fishes-stare.md

@@ -0,0 +1,5 @@
+---
+'@kadena/pactjs-cli': none
+---
+
+Migrate pactjs-cli from jest to vitest + msw

packages/tools/pactjs-cli/.eslintrc.js

@@ -4,4 +4,5 @@ require('@rushstack/eslint-config/patch/modern-module-resolution');
 module.exports = {
   extends: ['@kadena-dev/eslint-config/profile/lib'],
   parserOptions: { tsconfigRootDir: __dirname },
+  ignorePatterns: ['vitest.config.ts'],
 };

packages/tools/pactjs-cli/package.json

@@ -27,7 +27,7 @@
     "lint:fmt": "prettier . --cache --check",
     "lint:pkg": "lint-package",
     "lint:src": "eslint src --ext .js,.ts",
-    "test": "jest"
+    "test": "vitest"
   },
   "dependencies": {
     "@kadena/pactjs-generator": "workspace:*",
@@ -46,13 +46,13 @@
     "@microsoft/api-extractor": "^7.38.0",
     "@rushstack/eslint-config": "~3.3.0",
     "@types/debug": "~4.1.7",
-    "@types/jest": "^29.5.3",
     "@types/mkdirp": "~1.0.2",
     "@types/node": "^18.17.14",
     "@types/rimraf": "~3.0.2",
     "eslint": "^8.45.0",
-    "jest": "^29.7.0",
+    "msw": "^1.3.2",
     "prettier": "~3.0.3",
-    "typescript": "5.2.2"
+    "typescript": "5.2.2",
+    "vitest": "^0.34.6"
   }
 }

packages/tools/pactjs-cli/src/retrieve-contract/tests/retrieve-contract.test.ts

@@ -1,27 +1,29 @@
-jest.mock('fs');
-jest.mock('../../utils/retrieveContractFromChain');
 import { Command } from 'commander';
 import { writeFileSync } from 'fs';
+import { rest } from 'msw';
+import { setupServer } from 'msw/node';
 import path from 'path';
-import { retrieveContractFromChain } from '../../utils/retrieveContractFromChain';
+import * as RCFC from '../../utils/retrieveContractFromChain';
 import { retrieveContract } from '../retrieve-contract';
 
-const mockedWriteFileSync = writeFileSync as jest.MockedFunction<
-  typeof writeFileSync
->;
-mockedWriteFileSync.mockImplementation(
-  mockedWriteFileSync as jest.MockedFunction<typeof writeFileSync>,
-);
+const restHandlers = [
+  rest.post(
+    'https://api.chainweb.com/chainweb/0.0/mainnet01/chain/8/pact/api/v1/local',
+    (req, res, ctx) => {
+      return res(
+        ctx.status(200),
+        ctx.json({ result: { data: { code: 'some pactCode' } } }),
+      );
+    },
+  ),
+];
 
-const mockedRetrieveContractFromChain =
-  retrieveContractFromChain as jest.MockedFunction<
-    typeof retrieveContractFromChain
-  >;
-mockedRetrieveContractFromChain.mockImplementation(
-  mockedRetrieveContractFromChain as jest.MockedFunction<
-    typeof retrieveContractFromChain
-  >,
-);
+vi.mock('fs', () => ({ writeFileSync: vi.fn() }));
+
+const server = setupServer(...restHandlers);
+beforeAll(() => server.listen({ onUnhandledRequest: 'error' }));
+afterEach(() => server.resetHandlers());
+afterAll(() => server.close());
 
 const createAndRunProgram = async (): Promise<void> => {
   const program = new Command('retrieve-contract');
@@ -37,31 +39,26 @@ const createAndRunProgram = async (): Promise<void> => {
 };
 
 describe('retrieve-contract', () => {
-  afterAll(() => {
-    jest.restoreAllMocks();
-  });
-
   it('calls retrieveContractFromChain', async () => {
-    mockedRetrieveContractFromChain.mockResolvedValue('some code');
-    mockedWriteFileSync.mockReturnValue();
+    const spy = vi.spyOn(RCFC, 'retrieveContractFromChain');
+
     await createAndRunProgram();
 
-    expect(mockedRetrieveContractFromChain.mock.calls[0]).toEqual([
+    expect(spy).toHaveBeenCalledWith(
       'free.crankk01',
       'https://api.chainweb.com/chainweb/0.0/mainnet01/chain/8/pact',
       0,
       'mainnet',
-    ]);
+    );
   });
 
   it('writes the contract to file', async () => {
-    mockedRetrieveContractFromChain.mockResolvedValue('some code');
-    mockedWriteFileSync.mockReturnValue();
     await createAndRunProgram();
 
-    expect(mockedWriteFileSync.mock.calls[0][0]).toContain(
-      path.join('some', 'path', 'to', 'contract.pact'),
+    expect(writeFileSync).toBeCalledWith(
+      path.resolve('some', 'path', 'to', 'contract.pact'),
+      'some pactCode',
+      'utf8',
     );
-    expect(mockedWriteFileSync.mock.calls[0][1]).toEqual('some code');
   });
 });

packages/tools/pactjs-cli/src/utils/tests/callLocal.test.ts

@@ -1,34 +1,30 @@
-jest.mock('cross-fetch');
-import fetch, { Response } from 'cross-fetch';
+import { rest } from 'msw';
+import { setupServer } from 'msw/node';
 import { callLocal } from '../callLocal';
 
-const mockedFetch = fetch as jest.MockedFunction<typeof fetch>;
+const restHandlers = [
+  rest.post('https://json-api.chainweb.com/api/v1/local', (req, res, ctx) => {
+    return res(ctx.status(200), ctx.json({ json: 'some json' }));
+  }),
+  rest.post('https://text-api.chainweb.com/api/v1/local', (req, res, ctx) => {
+    return res(ctx.status(200), ctx.text('some text'));
+  }),
+];
 
-describe('callLocal', () => {
-  it('returns the correct jsonResponse on success', async () => {
-    const response = new Response();
-
-    response.json = jest.fn().mockReturnValue({ json: 'some json' });
-    response.text = jest.fn().mockReturnValue('some text');
-    response.clone = jest.fn().mockImplementation(() => response);
+const server = setupServer(...restHandlers);
 
-    mockedFetch.mockResolvedValue(response);
-
-    const result = await callLocal('https://api.chainweb.com', 'body');
+beforeAll(() => server.listen({ onUnhandledRequest: 'error' }));
+afterEach(() => server.resetHandlers());
+afterAll(() => server.close());
 
+describe('callLocal', () => {
+  it('returns the correct jsonResponse on success', async () => {
+    const result = await callLocal('https://json-api.chainweb.com', 'body');
     expect(result.jsonResponse).toEqual({ json: 'some json' });
   });
 
   it('returns the correct textResponse on success', async () => {
-    const response = new Response();
-
-    response.text = jest.fn().mockReturnValue('some text');
-    response.clone = jest.fn().mockImplementation(() => response);
-
-    mockedFetch.mockResolvedValue(response);
-
-    const result = await callLocal('https://api.chainweb.com', 'body');
-
+    const result = await callLocal('https://text-api.chainweb.com', 'body');
     expect(result.textResponse).toBe('some text');
   });
 });

packages/tools/pactjs-cli/src/utils/tests/retrieveContractFromChain.test.ts

@@ -1,21 +1,26 @@
-jest.mock('../callLocal.ts');
-import { callLocal } from '../callLocal';
+import { rest } from 'msw';
+import { setupServer } from 'msw/node';
 import { retrieveContractFromChain } from '../retrieveContractFromChain';
 
-const mockedCallLocal = callLocal as jest.MockedFunction<typeof callLocal>;
+const restHandlers = [
+  rest.post(
+    'https://api.chainweb.com/chainweb/0.0/mainnet01/chain/8/pact/api/v1/local',
+    (req, res, ctx) => {
+      return res(
+        ctx.status(200),
+        ctx.json({ result: { data: { code: 'some pactCode' } } }),
+      );
+    },
+  ),
+];
 
-describe('retrieveContractFromChain', () => {
-  afterAll(() => {
-    mockedCallLocal.mockRestore();
-  });
+const server = setupServer(...restHandlers);
+beforeAll(() => server.listen({ onUnhandledRequest: 'error' }));
+afterEach(() => server.resetHandlers());
+afterAll(() => server.close());
 
+describe('retrieveContractFromChain', () => {
   it('returns the pactCode on success', async () => {
-    mockedCallLocal.mockResolvedValue({
-      textResponse: 'some pactText',
-      jsonResponse: { result: { data: { code: 'some pactCode' } } },
-      response: { status: 200 } as Response,
-    });
-
     const result = await retrieveContractFromChain(
       'free.crankk01',
       'https://api.chainweb.com/chainweb/0.0/mainnet01/chain/8/pact',