bug(tests): docgen.parse

[muescha]

Description

i have 2 tests failing.

Steps to reproduce

yarn test

note: since i get errors when installing with yarn.lock i delete it always before yarn run bootstrap

Expected result

no error

Actual result

Summary of all failing tests
 FAIL  packages/gatsby-transformer-react-docgen/src/__tests__/displayname-handler.js
  ● DisplayNameHandler › Explicitly set displayName as static class member

    No suitable component definition found.

      14 |     ${source}
      15 |   `
    > 16 |   return docgen.parse(code, findAllComponentDefinitions, [handler])[0]
         |                 ^
      17 | }
      18 | 
      19 | describe(`DisplayNameHandler`, () => {

      at parse (node_modules/react-docgen/dist/parse.js:66:13)
      at Object.parse (node_modules/react-docgen/dist/main.js:61:29)
      at parse (packages/gatsby-transformer-react-docgen/src/__tests__/displayname-handler.js:16:17)
      at Object.<anonymous> (packages/gatsby-transformer-react-docgen/src/__tests__/displayname-handler.js:32:17)

  ● DisplayNameHandler › Infer displayName from class declaration/expression name

    No suitable component definition found.

      14 |     ${source}
      15 |   `
    > 16 |   return docgen.parse(code, findAllComponentDefinitions, [handler])[0]
         |                 ^
      17 | }
      18 | 
      19 | describe(`DisplayNameHandler`, () => {

      at parse (node_modules/react-docgen/dist/parse.js:66:13)
      at Object.parse (node_modules/react-docgen/dist/main.js:61:29)
      at parse (packages/gatsby-transformer-react-docgen/src/__tests__/displayname-handler.js:16:17)
      at Object.<anonymous> (packages/gatsby-transformer-react-docgen/src/__tests__/displayname-handler.js:67:19)

Environment

Run gatsby info --clipboard in your project directory and paste the output here:

  System:
    OS: macOS 10.15.3
    CPU: (8) x64 Intel(R) Core(TM) i7-3820QM CPU @ 2.70GHz
    Shell: 3.2.57 - /bin/bash
  Binaries:
    Node: 12.13.1 - ~/.nvm/versions/node/v12.13.1/bin/node
    Yarn: 1.21.0 - /usr/local/bin/yarn
    npm: 6.14.5 - ~/.nvm/versions/node/v12.13.1/bin/npm
  Languages:
    Python: 3.7.6 - /usr/local/opt/python/libexec/bin/python
  Browsers:
    Chrome: 83.0.4103.61
    Safari: 13.0.5
  npmGlobalPackages:
    gatsby-cli: 2.12.29

[madalynrose]

Hi there, @muescha! Could you add some more detail about how to reproduce the test failures you're seeing? Which directory are you in?

[muescha]

i am in main directory and running add the tests with yarn test

(Note: I do rm -rf node_modules/ yarn.lock and then yarn run bootstrap after I fetch the master because otherwise I never get some of the node sharp things installed)

[vladar]

It happens because yarn.lock has react-docgen version pinned to 5.0.0-beta.1. And they had a breaking change in 5.0.0 which changed the way it detects react classes reactjs/react-docgen#397

I would say to fix this we should update react-docgen dependency to ^5.0.0 and fix tests. Tests that fail do not extend React.Component, e.g.:

gatsby/packages/gatsby-transformer-react-docgen/src/__tests__/displayname-handler.js

Line 34 in 317aa65

class MyComponent { static displayName = 'foo'; render() {} }

Every entry like this should be changed to

class MyComponent extends React.Component { static displayName = 'foo'; render() {} }

P.S. A PR with the fix is very welcome!

[muescha]

thanks for the guide :)

i start to work on a PR

[muescha]

@vladar

i created an PR:

• fix(gatsby-transformer-react-docgen): update react-docgen, fix tests #24788 fix(plugin): update react-docgen, fix tests

[vladar]

Fixed via #24788