The module '#node-web-compat' seems to be missing in the aws-jwt-verify library during testing in Next.js

Question

The module '#node-web-compat' seems to be missing in the aws-jwt-verify library during testing in Next.js

Problem description

When testing a service in an API used in a Next.js app and using Babel Jest for specific test files, I'm encountering an issue regarding locating a module. The error that appears in the terminal is shown below.


      Cannot find module '#node-web-compat' from 'node_modules/aws-jwt-verify/dist/cjs/https.js'

      Require stack:
        node_modules/aws-jwt-verify/dist/cjs/https.js
        node_modules/aws-jwt-verify/dist/cjs/jwk.js
        node_modules/aws-jwt-verify/dist/cjs/jwt-rsa.js
        node_modules/aws-jwt-verify/dist/cjs/index.js
        pages/api/auth/auth.service.ts
        __tests__/sign-up/api/auth/auth-service.test.ts

        at Resolver._throwModNotFoundError (node_modules/jest-resolve/build/resolver.js:491:11)
        at Object.<anonymous> (node_modules/aws-jwt-verify/dist/cjs/https.js:9:28)

The service being tested is utilized by TypeScript decorator in middleware. It functions correctly during manual testing but encounters issues only when running tests.

Objective

The goal is to unit test a service that utilizes the library aws-jwt-verify to verify JWT access tokens. The aim is to mock it and use it in Jest unit tests.

Tried methods

I attempted copying the dependency to devDependencies and reinstalling packages, but this did not resolve the issue.

Dependencies in package.json

{
    ...
    "dependencies": {
      "@aws-sdk/client-cognito-identity-provider": "^3.137.0",
      "@chakra-ui/react": "^2.2.3",
      ...
    }
    ...
  }

tsconfig.json

{
    "compilerOptions": {
      "target": "es5",
      ...
    },
    ...
  }

jest.config.js


    const nextJest = require('next/jest');

    const createJestConfig = nextJest({
      dir: './'
    });

    const customJestConfig = {
      moduleDirectories: ['node_modules', '<rootDir>/']
    };

    module.exports = createJestConfig(customJestConfig);

auth.service.ts


    // Code for auth.service.ts goes here

auth-service.test.ts


    // Code for auth-service.test.ts goes here

typescript unit-testing next.js jestjs jwt

Answer 1

Answer №1

I recently encountered a similar issue while working with TypeScript, Jest, and ts-jest. Fortunately, I was able to find the solution in a GitHub thread. https://github.com/facebook/jest/issues/12620

To resolve the issue, I simply had to include the following configuration in my jest.config file:

  moduleNameMapper: {
    '#node-web-compat': "./node-web-compat-node.js",
  }

Answer 2

I recently encountered a similar issue while working with TypeScript, Jest, and ts-jest. Fortunately, I was able to find the solution in a GitHub thread. https://github.com/facebook/jest/issues/12620

To resolve the issue, I simply had to include the following configuration in my jest.config file:

  moduleNameMapper: {
    '#node-web-compat': "./node-web-compat-node.js",
  }

Answer 3

Answer №2

Challenge encountered with mocking library After attempting to revert back to version 2.1.3 of the library, it made a difference in resolving the issue. I found guidance from this source

Difficulty faced with mocking functionality I opted to utilize spyOn

import { CognitoJwtVerifier } from 'aws-jwt-verify';
...
jest.mock('aws-jwt-verify');

test('my test', () => {
 jest.spyOn(CognitoJwtVerifier, 'create').mockImplementation(() => {
   return {
     verify: jest.fn().mockResolvedValue({
     exp: Math.floor(Date.now() / 1000) + 3600,
     client_id: process.env.COGNITO_WEB_CLIENT_ID,
     iss: `https://cognito-idp.${process.env.AWS_REGION}.amazonaws.com/${process.env.COGNITO_USER_POOL_ID}`,
     token_use: 'access'
       })
     };
  });
})

Answer 4

Challenge encountered with mocking library After attempting to revert back to version 2.1.3 of the library, it made a difference in resolving the issue. I found guidance from this source

Difficulty faced with mocking functionality I opted to utilize spyOn

import { CognitoJwtVerifier } from 'aws-jwt-verify';
...
jest.mock('aws-jwt-verify');

test('my test', () => {
 jest.spyOn(CognitoJwtVerifier, 'create').mockImplementation(() => {
   return {
     verify: jest.fn().mockResolvedValue({
     exp: Math.floor(Date.now() / 1000) + 3600,
     client_id: process.env.COGNITO_WEB_CLIENT_ID,
     iss: `https://cognito-idp.${process.env.AWS_REGION}.amazonaws.com/${process.env.COGNITO_USER_POOL_ID}`,
     token_use: 'access'
       })
     };
  });
})

The module '#node-web-compat' seems to be missing in the aws-jwt-verify library during testing in Next.js

Answer №1

Answer №2

Similar questions

Learn how to easily send a collection of images to Cloudinary by utilizing Axios and React hook form within a Next.js environment

The initial function that gets executed in the lodash chain is tap()

After upgrading from Next.js 14.1.0 to 14.1.4, I encountered an error stating that the session cookie exceeds the allowed 4096 bytes limit in Next Auth

Version 4.0 of Electron-React-Boilerplate has encountered an error: The property 'electron' is not recognized on the type 'Window & typeof globalThis'. Perhaps you meant to use 'Electron' instead?

How can I resolve the Error: Element type is invalid?

A Step-by-Step Guide on Including TypeScript Definitions in .NET Core Nuget Packages

Is there a method to authenticate the request sent to an API and confirm the response upon clicking a page element?

Displaying a horizontal scroll bar for legends in ECharts can be achieved by limiting the legend to three lines. If the legend items exceed this limit, they will scroll horizontally to accommodate all items

Is there a way to retrieve the name of a document stored within a collection using Firebase Firestore and Firebase Storage

Incorporating a YouTube channel onto a website with React and Typescript, only to be greeted with a

Tips on retrieving filtered data from the datasource using the isAllselected function, specifically in the checkbox list function "isAllSelected" within Angular 7

Encountering an issue while trying to execute the getServerSideProps function within _app.js in Next

What is the functionality of input onChange in React when using state management?

Error suddenly appeared when trying to serve a previously functional project locally: Firebase function module not found

Drawing coordinate lines on a two-dimensional array that simulates a grid

When trying to update a variable within the then() method of a Promise, the variable does not reflect

The type '(params: any) => CSSProperties' does not share any properties with the type 'Properties<string | number>'. Perhaps you meant to invoke it?

Utilizing the spread operator in Typescript interfaces: best practices

Click on the React JS infinite render component to load more items

Is it possible for the Nextjs application to run in the background using the command line?