toJSX does not have a default for `options.file` #1153

RoachaelRoadmunk · 2020-07-16T20:54:37Z

Subject of the issue

After the most recent release, Storybook will not build and returns this error:

WARN ./src/components/Box/Box.stories.mdx
WARN Module build failed (from ./node_modules/@mdx-js/loader/index.js):
WARN TypeError: Cannot read property 'path' of undefined
WARN     at Function.toJSX (project/node_modules/@storybook/addon-docs/node_modules/@mdx-js/mdx/mdx-hast-to-jsx.js:124:30)
WARN     at extractExports (project/node_modules/@storybook/addon-docs/dist/mdx/mdx-compiler-plugin.js:396:29)
WARN     at Compiler (project/node_modules/@storybook/addon-docs/dist/mdx/mdx-compiler-plugin.js:454:14)
WARN     at Function.stringify (project/node_modules/unified/index.js:354:12)
WARN     at pipelineStringify (project/node_modules/unified/index.js:41:18)
WARN     at wrapped (project/node_modules/trough/wrap.js:25:19)
WARN     at next (project/node_modules/trough/index.js:57:24)
WARN     at done (project/node_modules/trough/wrap.js:55:16)
WARN     at done (project/node_modules/unified/index.js:35:7)
WARN     at done (project/node_modules/unified/index.js:314:11)
WARN     at next (project/node_modules/trough/index.js:59:14)
WARN     at done (project/node_modules/trough/wrap.js:55:16)
WARN     at then (project/node_modules/trough/wrap.js:62:5)
WARN     at wrapped (project/node_modules/trough/wrap.js:45:9)
WARN     at next (project/node_modules/trough/index.js:57:24)
WARN     at done (project/node_modules/trough/wrap.js:55:16)
WARN  @ ./src/components/Box sync nonrecursive ^\.\/(?:(?:Box\.stories\.mdx)$)$ ./Box.stories.mdx
WARN  @ ./.storybook/generated-entry.js
WARN  @ multi ./node_modules/@storybook/core/dist/server/common/polyfills.js ./node_modules/@storybook/core/dist/server/preview/globals.js ./node_modules/@storybook/addon-docs/dist/frameworks/common/config.js ./node_modules/@storybook/addon-docs/dist/frameworks/react/config.js ./.storybook/preview.js ./.storybook/generated-entry.js

This might be Storybook's issue to solve, but it also seems as if there isn't a defaulting occurring for options.file inside of toJSX() here, which was introduced in #1126.

Your environment

OS: OSX 10.15.5
Packages: @storybook/addon-docs ^5.3.13, @storybook/react ^5.3.13
Env: lerna + yarn

Steps to reproduce

Have a .stories.mdx file in a storybook build
execute the build-storybook script that Storybook ships with

Expected behaviour

Storybook builds

Actual behaviour

Storybook fails building with the above error

The text was updated successfully, but these errors were encountered:

wooorm · 2020-07-16T21:29:31Z

This sounds like a storybook problem to me? 🤔 maybe you'll have better luck asking those folks?

RoachaelRoadmunk · 2020-07-16T21:37:09Z

After some more investigation... I am more convinced it is actually related to the commit I referenced.

In there, filename: options.file.path is added in several places. When I modified the file (mdx-hast-to-jsx.js) locally to filename: options.filepath the error was resolved.

I believe the wrong option is possibly being selected. options.file does not appear to be part of the options object that is passed.

owenallenaz · 2020-07-16T21:38:30Z

I am experiencing the exact same issue. When I update my package.json to add the following to my package.json dependencies object the issue goes away.

"@mdx-js/loader": "1.6.7",
"@mdx-js/mdx": "1.6.7",
"@mdx-js/react": "1.6.7",

So I think it is definitely related to 1.6.8. Now it might be in the way that @storybook/addon-docs uses it.

wooorm · 2020-07-16T21:52:25Z

/cc @silvenon

tylergaw · 2020-07-16T22:21:09Z

I hit this same thing and same as @owenallenaz, if I force 1.6.7 the warning in the description goes away, and I'm able to view mdx stories in Storybook. Just in case anyone else is hitting this, to continue working I'm adding a resolutions block to my package.json to force the previous version.

"resolutions": {
    "@mdx-js/loader": "1.6.7",
    "@mdx-js/mdx": "1.6.7",
    "@mdx-js/react": "1.6.7",
    "@mdx-js/util": "1.6.7"
  }

I'm using Yarn. Not sure if that same thing works with npm or not.

johno · 2020-07-16T22:47:05Z

Ah, yeah we need to more gracefully handle null for file. I'll have a fix in a few, thanks for reporting!

johno · 2020-07-16T23:08:15Z

This should now be fixed in version 1.6.9. Please let us know if that doesn't work. Thanks!

dusave · 2020-07-16T23:15:33Z

@johno Issue still seems to be there, same error.

Confirmed the upgrade to 1.6.9

johno · 2020-07-16T23:25:51Z

Hrmmm. Bummer! Thanks for checking @dustinsavery

Could someone perhaps provide a reproduction so I can debug this more deeply?

johno · 2020-07-16T23:26:54Z

I’m guessing the file argument must be coming in as null rather than undefined.

dusave · 2020-07-16T23:28:23Z

It's called from here

dusave · 2020-07-16T23:34:40Z

@johno Could you conditionally add the filename property here if one is given? Either that or perhaps doing some null/undefined checks or optional chaining to verify the property exists?

johno · 2020-07-16T23:59:24Z

Either that or perhaps doing some null/undefined checks or optional chaining to verify the property exists?

We should definitely add that, but right now the MDX core package isn't transpiled and we support older versions of node that don't have optional changing.

I've opened up another PR which will hopefully address more falsy edge cases.

johno · 2020-07-17T00:22:08Z

Hopefully 1.6.10 addresses it now 😆.

dusave · 2020-07-17T03:51:50Z

@johno It didn't 😭 I went ahead and tested it and got a fix. PR is here

JounQin · 2020-07-17T04:03:09Z

@johno 1.6.10 won't work because toJSX is called inside storybook source.

RoachaelRoadmunk · 2020-07-17T04:23:50Z

@johno It didn't 😭 I went ahead and tested it and got a fix. PR is here

Yes!! I tested this in my repo and looks like it will be the solution for me as well! Thanks @dustinsavery and everyone else with their help as well! Ship it :)

RoachaelRoadmunk · 2020-07-17T04:32:31Z

@johno 1.6.10 won't work because toJSX is called inside storybook source.

@tylergaw's suggestion of adding the desired version to resolutions worked for me to override storybook @JounQin, in case that helps you!

filipesperandio · 2020-07-17T04:40:18Z

I've added the resolutions to 1.6.10 and I still get issues in storybook

filipesperandio · 2020-07-17T04:49:01Z

Forcing resolution back to 1.6.6 fixes it

JounQin · 2020-07-17T06:13:36Z

@mdx-js/mergers A patch version need to be released.

silvenon · 2020-07-17T13:30:16Z

Released 1.6.11 🚀

johno · 2020-07-17T13:32:21Z

The latest version should now fix it. Please let us know if that isn't the case. Thanks all!

silvenon · 2020-07-17T13:49:12Z

I just want to add that toJSX is (currently) internal API. We didn't document it and we don't test it as a plugin, we only test it implicitly through mdx.

wooorm · 2020-07-17T13:54:48Z

Yeah, want to second @silvenon. It’s an internal function that Storybook is depending on. So while the exception is now gone, Storybook should still provide a virtual file, and It’ll all change again completely in next!

pvds · 2020-07-17T13:58:46Z

@silvenon tested with Storybook 5.3.19 I can confirm version 1.6.11 fixed the issue.

shilman · 2020-07-17T14:07:43Z

Thanks so much for the fix. If it's fine by you, we'll make the fix on the Storybook side (along with any other breaking fixes needed) when MDX 2.0 drops. Really looking forward to that---you guys are doing amazing work!!!

RoachaelRoadmunk · 2020-07-17T14:17:27Z

@silvenon tested with Storybook 5.3.19 I can confirm version 1.6.11 fixed the issue.

Same here! Thanks for your help everyone!

ghost · 2020-07-17T15:20:58Z

Thanks @RoachaelRoadmunk for reporting this issue.

RoachaelRoadmunk added 🐛 type/bug 🙉 open/needs-info labels Jul 16, 2020

johno mentioned this issue Jul 16, 2020

Default file to an object #1154

Merged

alvarezmario mentioned this issue Jul 16, 2020

Latest @mdx-js/mdx breaks @storybook/addon-docs storybookjs/storybook#11589

Closed

johno closed this as completed in #1154 Jul 16, 2020

johno reopened this Jul 16, 2020

johno mentioned this issue Jul 16, 2020

Ensure all falsy values for file are addressed #1155

Merged

johno closed this as completed Jul 17, 2020

wooorm added 🏡 area/internal and removed 🐛 type/bug 🙉 open/needs-info labels Jul 23, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Sponsors

toJSX does not have a default for `options.file` #1153

toJSX does not have a default for `options.file` #1153

RoachaelRoadmunk commented Jul 16, 2020

wooorm commented Jul 16, 2020

RoachaelRoadmunk commented Jul 16, 2020 •

edited

Loading

owenallenaz commented Jul 16, 2020

wooorm commented Jul 16, 2020

tylergaw commented Jul 16, 2020 •

edited

Loading

johno commented Jul 16, 2020

johno commented Jul 16, 2020

dusave commented Jul 16, 2020

johno commented Jul 16, 2020

johno commented Jul 16, 2020

dusave commented Jul 16, 2020

dusave commented Jul 16, 2020

johno commented Jul 16, 2020

johno commented Jul 17, 2020

dusave commented Jul 17, 2020

JounQin commented Jul 17, 2020

RoachaelRoadmunk commented Jul 17, 2020 •

edited

Loading

RoachaelRoadmunk commented Jul 17, 2020 •

edited

Loading

filipesperandio commented Jul 17, 2020

filipesperandio commented Jul 17, 2020

JounQin commented Jul 17, 2020

silvenon commented Jul 17, 2020

johno commented Jul 17, 2020

silvenon commented Jul 17, 2020 •

edited

Loading

wooorm commented Jul 17, 2020 •

edited

Loading

pvds commented Jul 17, 2020

shilman commented Jul 17, 2020

RoachaelRoadmunk commented Jul 17, 2020

ghost commented Jul 17, 2020

toJSX does not have a default for options.file #1153

toJSX does not have a default for options.file #1153

Comments

RoachaelRoadmunk commented Jul 16, 2020

Subject of the issue

Your environment

Steps to reproduce

Expected behaviour

Actual behaviour

wooorm commented Jul 16, 2020

RoachaelRoadmunk commented Jul 16, 2020 • edited Loading

owenallenaz commented Jul 16, 2020

wooorm commented Jul 16, 2020

tylergaw commented Jul 16, 2020 • edited Loading

johno commented Jul 16, 2020

johno commented Jul 16, 2020

dusave commented Jul 16, 2020

johno commented Jul 16, 2020

johno commented Jul 16, 2020

dusave commented Jul 16, 2020

dusave commented Jul 16, 2020

johno commented Jul 16, 2020

johno commented Jul 17, 2020

dusave commented Jul 17, 2020

JounQin commented Jul 17, 2020

RoachaelRoadmunk commented Jul 17, 2020 • edited Loading

RoachaelRoadmunk commented Jul 17, 2020 • edited Loading

filipesperandio commented Jul 17, 2020

filipesperandio commented Jul 17, 2020

JounQin commented Jul 17, 2020

silvenon commented Jul 17, 2020

johno commented Jul 17, 2020

silvenon commented Jul 17, 2020 • edited Loading

wooorm commented Jul 17, 2020 • edited Loading

pvds commented Jul 17, 2020

shilman commented Jul 17, 2020

RoachaelRoadmunk commented Jul 17, 2020

ghost commented Jul 17, 2020

toJSX does not have a default for `options.file` #1153

toJSX does not have a default for `options.file` #1153

RoachaelRoadmunk commented Jul 16, 2020 •

edited

Loading

tylergaw commented Jul 16, 2020 •

edited

Loading

RoachaelRoadmunk commented Jul 17, 2020 •

edited

Loading

RoachaelRoadmunk commented Jul 17, 2020 •

edited

Loading

silvenon commented Jul 17, 2020 •

edited

Loading

wooorm commented Jul 17, 2020 •

edited

Loading