Module not found in jest tests #29

Clm-Roig · 2022-06-06T11:22:46Z

Hi,
I'm using auto-animate on a typescript React app and I'm testing it with Jest. When I'm running the app, everything is fine. But when I'm running the tests, I get this error:

Cannot find module '@formkit/auto-animate/react' from 'src/.../a_path_to_my_component'

Complete error:

I don't understand why Jest can't find the module... I'm using node v16.15.0, npm v8.5.5 and react-scripts v5.

Here is my package.json :

Click to see

{
  "name": "suivie",
  "homepage": "https://clm-roig.github.io/suivie",
  "version": "0.2.4",
  "private": true,
  "dependencies": {
    "@emotion/react": "^11.8.2",
    "@emotion/styled": "^11.8.1",
    "@formkit/auto-animate": "^1.0.0-beta.1",
    "@mui/icons-material": "^5.8.2",
    "@mui/lab": "^5.0.0-alpha.84",
    "@mui/material": "^5.8.2",
    "@mui/x-date-pickers": "^5.0.0-alpha.4",
    "@reduxjs/toolkit": "^1.8.2",
    "@testing-library/jest-dom": "^5.16.4",
    "@testing-library/react": "^12.1.5",
    "@testing-library/user-event": "^14.2.0",
    "@types/jest": "^27.5.1",
    "@types/node": "^17.0.36",
    "@types/react": "^18.0.1",
    "@types/uuid": "^8.3.4",
    "date-fns": "^2.28.0",
    "notistack": "^2.0.5",
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-hook-form": "^7.31.3",
    "react-redux": "^8.0.2",
    "react-router-dom": "^6.3.0",
    "react-scripts": "5.0.1",
    "recharts": "^2.1.10",
    "redux-persist": "^6.0.0",
    "typescript": "~4.7.2",
    "uuid": "^8.3.2"
  },
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "coverage": "react-scripts test --coverage --watchAll",
    "eject": "react-scripts eject",
    "release": "standard-version",
    "lint": "eslint \"**/*.{js,ts,tsx}\"",
    "lint:fix": "eslint --fix \"**/*.{js,ts,tsx}\"",
    "format": "prettier --write \"**/*.{js,ts,tsx,css,json}\" --config ./.prettierrc"
  },
  "eslintConfig": {},
  "browserslist": {
    "production": [
      ">0.2%",
      "not dead",
      "not op_mini all"
    ],
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version"
    ]
  },
  "devDependencies": {
    "@commitlint/cli": "^17.0.1",
    "@commitlint/config-conventional": "^17.0.2",
    "@trivago/prettier-plugin-sort-imports": "^3.2.0",
    "@typescript-eslint/eslint-plugin": "^5.27.0",
    "@typescript-eslint/parser": "^5.27.0",
    "eslint": "^8.16.0",
    "eslint-config-airbnb": "^19.0.4",
    "eslint-config-prettier": "^8.5.0",
    "eslint-import-resolver-typescript": "^2.7.1",
    "eslint-plugin-import": "^2.26.0",
    "eslint-plugin-jsx-a11y": "^6.5.1",
    "eslint-plugin-prettier": "^4.0.0",
    "eslint-plugin-react": "^7.30.0",
    "eslint-plugin-react-hooks": "^4.5.0",
    "husky": "^8.0.1",
    "jest-watch-typeahead": "^1.1.0",
    "prettier": "^2.6.2",
    "standard-version": "^9.5.0"
  }
}

My TS config :

Click to see

{
  "compilerOptions": {
    "target": "es5",
    "lib": ["dom", "dom.iterable", "esnext"],
    "allowJs": true,
    "skipLibCheck": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "strict": true,
    "forceConsistentCasingInFileNames": true,
    "noFallthroughCasesInSwitch": true,
    "module": "esnext",
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "noEmit": true,
    "jsx": "react-jsx"
  },
  "include": ["src"]
}

I understand that maybe this is not related to this library in particular: feel free to tell me to ask this question elsewhere.

Thank you for this module, it's awesome!

StK88 · 2022-06-06T18:16:32Z

I had the same issue, resolved via:

switch to autoAnimate with useRef instead of useAutoAnimate:

import {
  RefObject,
  useEffect,
} from "react"
import autoAnimate from "@formkit/auto-animate"

// https://github.com/formkit/auto-animate/issues/11
export const useAutoAnimate = (ref: RefObject<HTMLElement | null>) => {
  useEffect(() => {
    ref.current && autoAnimate(ref.current)
  }, [ref])
}

set/extend jest settings in package.json (source [CRA v5] Jest + React-markdown = Must use import to load ES Module facebook/create-react-app#11946 (comment)):

"jest": {
  "transformIgnorePatterns": [
    "[/\\\\]node_modules[/\\\\](?!(@formkit/auto-animate)).+\\.(js|jsx|mjs|cjs|ts|tsx)$"
  ]
},

Step 2 should fix the new error from step 1:

export { autoAnimate as default, getTransitionSizes, vAutoAnimate };
    ^^^^^^

SyntaxError: Unexpected token 'export'

Clm-Roig · 2022-06-07T09:23:01Z

Thanks for the hint @StK88 ! I tried what you suggested, with and without the "custom" useAutoAnimate hook but I got this error (in test environment only):

ReferenceError: ResizeObserver is not defined

StK88 · 2022-06-07T11:00:31Z

@Clm-Roig, forgot about that, it also requires mock of global.ResizeObserver in src/setupTests.ts:

// src/setupTests.ts

global.ResizeObserver = jest.fn().mockImplementation(() => ({
  observe: jest.fn(),
  unobserve: jest.fn(),
  disconnect: jest.fn(),
}))

Clm-Roig · 2022-06-07T11:27:18Z

Oh yes I saw this solution when doing my research, but I hoped there will be something else more elegant... Anyway, thank you very much for your time, it works like a charm!

alexandprivate · 2022-08-01T15:52:34Z

Hi all, I tried all, the current solution is not working for me on TS, also not but using allowJs true, any idea?

hjoelh · 2022-08-03T11:18:22Z

I fixed this via https://jestjs.io/docs/manual-mocks#mocking-node-modules
*Note my jest config includes roots: ["<rootDir>/jest"]

jest/__mocks__/@formkit/auto-animate/react.js

const useAutoAnimate = () => [null];
export { useAutoAnimate };

aaronkik · 2022-09-10T00:22:51Z

If you're not using the hook this fixed it for me after looking at

auto-animate/src/index.ts

Lines 644 to 654 in 3dea1af

    
             return Object.freeze({ 
        
               parent: el, 
        
               enable: () => { 
        
                 enabled.add(el) 
        
               }, 
        
               disable: () => { 
        
                 enabled.delete(el) 
        
               }, 
        
               isEnabled: () => enabled.has(el), 
        
             }) 
        
           }

Insert the following under the file __mocks__/@formkit/auto-animate/index.ts

const autoAnimate = jest.fn((el: Element) => ({
  parent: el,
  enable: jest.fn(),
  disable: jest.fn(),
  isEnabled: jest.fn(),
}));

export default autoAnimate;

austin-bev · 2022-10-03T05:05:47Z

I'm getting the same issue with Vue and Vitest.
ReferenceError: ResizeObserver is not defined

Adding this to the test file creates different issues:

 window.ResizeObserver = vi.fn().mockImplementation(() => ({
   observe: vi.fn(),
   unobserve: vi.fn(),
   disconnect: vi.fn(),
 }))
import { useAutoAnimate } from "@formkit/auto-animate/vue";
describe("testsuite", () => {...

ArthurPedroti · 2023-04-05T21:47:29Z

@justin-schroeder

Justin, can you give your opinion about this matter?

I questing this because I think Auto Animate it's an incredible library, and the "main marketing" slogan it's that a library that has "zero-config".

And not for me, but for a lot of devs, Jest is one of the most used js testing libraries, and because of that, I think that's an important issue to discuss.

If the library can't do anything about it, I think that's a good idea to have a disclaimer on the official page about how to integrate the library and what's configs need to use with Jest.

And if have anything to do to turn Auto Animate into a "zero config" with Jest, anyone is working on it or anyone can help?

hjoelh · 2023-04-05T23:33:30Z

@justin-schroeder

Justin, can you give your opinion about this matter?

I questing this because I think Auto Animate it's an incredible library, and the "main marketing" slogan it's that a library that has "zero-config".

And not for me, but for a lot of devs, Jest is one of the most used js testing libraries, and because of that, I think that's an important issue to discuss.

If the library can't do anything about it, I think that's a good idea to have a disclaimer on the official page about how to integrate the library and what's configs need to use with Jest.

And if have anything to do to turn Auto Animate into a "zero config" with Jest, anyone is working on it or anyone can help?

@ArthurPedroti Does this not work for you? #29 (comment)

ArthurPedroti · 2023-04-05T23:44:43Z

@hjoelh

Yes, this is working, my question is more embracing, thinking about newcomers and how is the experience of you facing an error right away and don't have any docs about this error or "official" docs about how to integrate these two libraries.

justin-schroeder · 2023-04-06T11:28:37Z

Honestly im not sure what we can do about this. ResizeObserver is increasingly part of the general web stack, but sadly it is not included in JSDom — jsdom/jsdom#3368. I don’t think we should mock resize observer ourselves.

Perhaps a note in the docs would be appropriate. Happy to accept a PR for that! In the meantime im closing this issue since it is related to module definitions which are unrelated and I believe have improved. 👍

Clm-Roig mentioned this issue Jun 7, 2022

[COMPLETIONS FORM] Animate completions Clm-Roig/suivie#247

Merged

justin-schroeder mentioned this issue Dec 23, 2022

doesn't work with jest? #112

Closed

justin-schroeder closed this as completed Apr 6, 2023

ArthurPedroti mentioned this issue Apr 6, 2023

Adding a Jest Section to the docs #135

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Module not found in jest tests #29

Module not found in jest tests #29

Clm-Roig commented Jun 6, 2022 •

edited

Loading

StK88 commented Jun 6, 2022 •

edited

Loading

Clm-Roig commented Jun 7, 2022

StK88 commented Jun 7, 2022

Clm-Roig commented Jun 7, 2022

alexandprivate commented Aug 1, 2022

hjoelh commented Aug 3, 2022

aaronkik commented Sep 10, 2022

austin-bev commented Oct 3, 2022

ArthurPedroti commented Apr 5, 2023

hjoelh commented Apr 5, 2023 •

edited

Loading

ArthurPedroti commented Apr 5, 2023

justin-schroeder commented Apr 6, 2023

Module not found in jest tests #29

Module not found in jest tests #29

Comments

Clm-Roig commented Jun 6, 2022 • edited Loading

StK88 commented Jun 6, 2022 • edited Loading

Clm-Roig commented Jun 7, 2022

StK88 commented Jun 7, 2022

Clm-Roig commented Jun 7, 2022

alexandprivate commented Aug 1, 2022

hjoelh commented Aug 3, 2022

aaronkik commented Sep 10, 2022

austin-bev commented Oct 3, 2022

ArthurPedroti commented Apr 5, 2023

hjoelh commented Apr 5, 2023 • edited Loading

ArthurPedroti commented Apr 5, 2023

justin-schroeder commented Apr 6, 2023

Clm-Roig commented Jun 6, 2022 •

edited

Loading

StK88 commented Jun 6, 2022 •

edited

Loading

hjoelh commented Apr 5, 2023 •

edited

Loading