typescript - React.jsx: type er ugyldig når man tester en React-komponent med en svg med Jest og React Testing Library

Jeg har et Next.js 12.1.4-prosjekt som bruker Typescript, React Testing Library og SVGR for å importere ikoner slik: import ChevronLeftIcon from './chevron-left.svg'

Problemet jeg har er at når jeg kjører en test av en komponent som inkluderer en SVG-import, får jeg følgende feil:

console.error
    Warning: React.jsx: type is invalid -- expected a string (for built-in components) or a class/function (for composite components) but got: object.
    
    Check the render method of `Loader`.
        at Loader (.../src/components/atoms/Loader/Loader.tsx:11:36)
        at div
        at button
        at Button (.../src/components/atoms/buttons/Button/Button.tsx:19:5)

      15 |         }`}
      16 |     >
    > 17 |         <LoaderIcon />
         |                       ^
      18 |     </div>
      19 | )
      20 |

      at printWarning (node_modules/react/cjs/react-jsx-runtime.development.js:117:30)
      at error (node_modules/react/cjs/react-jsx-runtime.development.js:93:5)
      at jsxWithValidation (node_modules/react/cjs/react-jsx-runtime.development.js:1152:7)
      at Object.jsxWithValidationDynamic [as jsx] (node_modules/react/cjs/react-jsx-runtime.development.js:1209:12)
      at Loader (src/components/atoms/Loader/Loader.tsx:17:23)
      at renderWithHooks (node_modules/react-dom/cjs/react-dom.development.js:14985:18)
      at mountIndeterminateComponent (node_modules/react-dom/cjs/react-dom.development.js:17811:13)

Jeg kjører tester med yarn test som matcher følgende script fra min package.json: "test": "TZ=UTC ./node_modules/jest/bin/jest.js",

Her er hva jeg har i next.config.js for SVGR:

webpack(config) {
    config.module.rules.push({
        test: /\.svg$/,
        use: ['@svgr/webpack'],
    })

    return config
},

Her er min jest.config.js:

const nextJest = require('next/jest')
const createJestConfig = nextJest({
  dir: './',
})

const customJestConfig = {
  moduleDirectories: ['node_modules', '<rootDir>/src/'],
  testEnvironment: 'jest-environment-jsdom',
  moduleNameMapper: {
    '\\.svg$': '<rootDir>/src/__mocks__/svgrMock.tsx',
  },
}

module.exports = createJestConfig(customJestConfig)

og src/__mocks__/svgrMock.tsx

import React, { SVGProps } from 'react'

const SvgrMock = React.forwardRef<SVGSVGElement, SVGProps<SVGSVGElement>>(
    (props, ref) => <svg ref={ref} {...props} />,
)

SvgrMock.displayName = 'SvgrMock'

export const ReactComponent = SvgrMock
export default SvgrMock

Jeg prøvde også å bruke jest-svg-transformer uten særlig suksess.

Her er versjonene av bibliotekene som er involvert:

  • "next": "^12.1.4"
  • "react": "17.0.2"
  • "react-dom": "17.0.2"
  • "@svgr/webpack": "^5.5.0"
  • "@testing-library/jest-dom": "^5.16.4"
  • "@testing-library/react": "^12.1.4"
  • "@testing-library/user-event": "^14.0.4"
  • "jest": "^27.5.1"
  • "ts-jest": "^27.1.3"
  • "typescript": "4.4.4"

Takk for hjelpen :)

Svar #1

Etter noen dager med prøving og feiling, klarte jeg å fikse dette problemet ved å bruke Jest med Babel-konfigurasjonen fra Next.js-dokumentasjonen, i stedet for å bruke next/jest-pluginen drevet av Rust-kompilatoren: https://nextjs.org/docs/testing#setting-up-jest-with-babel

Jeg måtte også definere en jest-transformer for svg-filene, jestSvgTransformer.js:

const path = require('path')

module.exports = {
  process(src, filePath) {
    if (path.extname(filePath) !== '.svg') {
      return src
    }

    const name = `svg-${path.basename(filePath, '.svg')}`
      .split(/\W+/)
      .map((x) => `${x.charAt(0).toUpperCase()}${x.slice(1)}`)
      .join('')

    return `
const React = require('react');
function ${name}(props) {
  return React.createElement(
    'svg',
    Object.assign({}, props, {'data-file-name': ${name}.name})
  )
}
module.exports = ${name}
            `
  },
}

I jest.config.js

  • i moduleNameMapper: fjern svg fra '^.+\\.(png|jpg|jpeg|gif|webp|avif|ico|bmp)$/i': '<rootDir>/<sti til dine mock-filer (f.eks.) __mocks__>/fileMock.js',
  • i transform: legg til '^.+\\.svg$': '<rootDir>/<sti til dine mock-filer (f.eks.) __mocks__>/jestSvgTransformer.js'
  • legg til moduleDirectories: ['node_modules', 'src'], for å aktivere absolutte imports

Relaterte artikler