Core/CLI: Add extract function to PreviewWeb and use it in sb extract if available
#17447
Conversation
☁️ Nx Cloud ReportCI ran the following commands for commit 609a595. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
tmeasday
added
bug
core
patch:yes
shilman
changed the title
extract function to PreviewWebextract function to PreviewWeb and use it in sb extract if available
lib/cli/src/extract.ts
Outdated
| @@ -12,7 +12,7 @@ const read = async (url: string) => { | |||
| await page.goto(url); | |||
|
|
|||
| await page.waitForFunction( | |||
| 'window.__STORYBOOK_STORY_STORE__ && window.__STORYBOOK_STORY_STORE__.extract && window.__STORYBOOK_STORY_STORE__.extract()' | |||
| 'window.__STORYBOOK_PREVIEW__ && window.__STORYBOOK_PREVIEW__.extract && window.__STORYBOOK_PREVIEW__.extract()' | |||
There was a problem hiding this comment.
@tmeasday we should fall back to __STORYBOOK_STORY_STORE__ if window.__STORYBOOK_PREVIEW__.extract doesn't exist so that if user runs npx sb extract on an older version of SB, it doesn't error.
There was a problem hiding this comment.
But aren't they by definition using the right version of SB?
There was a problem hiding this comment.
No. extract runs puppeteer against a running storybook. That storybook could be any version AFAIK.
Meanwhile we encourage people to run npx sb so that they get the latest version of the CLI. So as soon as we release this as stable, npx sb will assume that the Storybook it's running against has the changes from this PR (unless the user has installed a specific version of the sb or @storybook/cli package, which we discourage). And that wouldn't be the case unless they've also upgraded their Storybook, which is a completely separate operation.
There was a problem hiding this comment.
@shilman perhaps what we could do is add a test for sb extract targeting a bunch of chromatic storybook URLs, of various versions, this way we can assert we stay compatible?
There was a problem hiding this comment.
Sounds like a good idea @ndelangen. Would be good to do the same for Chromatic's version of extract also TBH. I'll get the set of uploaded SBs together.
There was a problem hiding this comment.
I've updated the code for now and will let somebody follow up with extra tests
shilman
added
the
patch:done
Core/CLI: Add `extract` function to `PreviewWeb` and use it in `sb extract` if available
Issue: #13561 (related)
StoryStore.extract()would hang if there was an error inpreview.js, as the store doesn't know about errors at that level. This would trip up the extract script and tools like Chromatic.What I did
Add
PreviewWeb.extract()which encapsulates a bunch of different logic required to callextract()+ co on the store:extract()on the store.How to test
Yes I added tests.
I am not quite sure how to test the
extractscript ahead of time. Can you help me here @ndelangen?