Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Fix MSW snippets #27365

Merged
merged 1 commit into from
May 24, 2024
Merged

Docs: Fix MSW snippets #27365

merged 1 commit into from
May 24, 2024

Conversation

jonniebigodes
Copy link
Contributor

Closes N/A

What I did

With this pull request, the snippets used in the Mocking Network requests were updated to prevent misconceptions when a user tries to use them with either Rest requests or GraphQL requests, and both the MSW and the Storybook addon effectively throw errors. For example, with a Rest request, the addon throws the following error in the IDE, and when a user tries to boot up Storybook

msw-storybook-8-rest-mocked-sucess-error

msw-storybook-8-rest-sucess-error-devtools

When a GraphQL request is set up the following happens:

msw-storybook-8-graphql-error

Would appreciate it when a change to the examples, I would be consulted and asked for a review, so that I have time to vet the examples and avoid this type of scenario. More even as we have them already in place here and here.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels May 24, 2024
@jonniebigodes jonniebigodes self-assigned this May 24, 2024
Copy link

nx-cloud bot commented May 24, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b84b9c7. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@jonniebigodes jonniebigodes merged commit d5a20ab into next May 24, 2024
17 checks passed
@jonniebigodes jonniebigodes deleted the docs_fix_msw_snippets branch May 24, 2024 20:23
storybook-bot pushed a commit that referenced this pull request May 27, 2024
Docs: Fix MSW snippets
(cherry picked from commit d5a20ab)
@github-actions github-actions bot mentioned this pull request May 27, 2024
13 tasks
storybook-bot pushed a commit that referenced this pull request May 27, 2024
Docs: Fix MSW snippets
(cherry picked from commit d5a20ab)
@github-actions github-actions bot mentioned this pull request May 27, 2024
25 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant