Addon breaks storyshots/jest due to assuming browser env

Question

Addon breaks storyshots/jest due to assuming browser env

w33ble opened this issue 5 years ago · comments

When using this addon along with @storybook/addon-storyshots, I get the following error when trying to run the tests:

Test suite failed to run

    ReferenceError: window is not defined

      at Object.<anonymous> (node_modules/storybook-readme/backwardCompatibility/index.js:26:1)
      at Object.<anonymous> (node_modules/storybook-readme/backwardCompatibility/with-docs.js:13:9)

Since this addon isn't running in a browser when using Jest, window is undefined.

Fixing that, I get:

ReferenceError: document is not defined

      at insert (node_modules/storybook-readme/styles/styleFactory.js:42:7)
      at ReadmeContent.componentDidMount (node_modules/storybook-readme/components/ReadmeContent/index.js:108:40)

Valerii Sorokobatko · Answer 1 · Fri Aug 02 2019 23:43:38 GMT+0800 (China Standard Time)

PR looks ok but I have not issues with storyshoots even before PR merges

How did you run it?

Valerii Sorokobatko · Answer 2 · Sat Aug 03 2019 00:34:18 GMT+0800 (China Standard Time)

FYI: related PR merged and released in 5.0.6

Joe Fleming · Answer 3 · Sat Aug 03 2019 02:03:54 GMT+0800 (China Standard Time)

I figured out the issue I was having, sorry for not following up here. I was running Jest in node mode, instead of jsdom mode, so none of the DOM stuff worked. I've since switch that.

Re-closing since the fix is in anyway, and you're welcome to revert #193 if you're so inclined. Adding something to the docs about that might be helpful for folks in the future who, like me, configure Jest wrong 😛.

Joe Fleming · Answer 4 · Sat Aug 03 2019 02:05:44 GMT+0800 (China Standard Time)

FYI, this is the config setting: https://jestjs.io/docs/en/configuration.html#testenvironment-string (jsdom is the default, but for some reason I had it set to node).