Skip to content

Conversation

@jonniebigodes
Copy link
Contributor

@jonniebigodes jonniebigodes commented Oct 23, 2025

Closes #32595

What I did

With this pull request the documentation was updated to include a small troubleshooting entry to provide some context on the issue

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-storybook/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 publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

  • Documentation
    • Added troubleshooting guidance addressing conflicts between Storybook's mocking system and other testing tools, with recommendations for identifying and resolving overlapping mock configurations.

@jonniebigodes jonniebigodes self-assigned this Oct 23, 2025
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Oct 23, 2025
@nx-cloud
Copy link

nx-cloud bot commented Oct 23, 2025

View your CI Pipeline Execution ↗ for commit f472ebf

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 47s View ↗

☁️ Nx Cloud last updated this comment at 2025-10-23 11:05:53 UTC

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 23, 2025

📝 Walkthrough

Walkthrough

A new troubleshooting subsection titled "Mocking conflicts with other testing tools" was added to documentation explaining potential conflicts between Storybook's mocking system and other testing tools (e.g., Jest), risks of overlapping configurations, and recommended resolution approaches. The subsection appears twice in the document.

Changes

Cohort / File(s) Summary
Documentation: Mocking troubleshooting guidance
docs/writing-stories/mocking-data-and-modules/mocking-modules.mdx
Added new troubleshooting subsection "Mocking conflicts with other testing tools" explaining potential conflicts with other testing frameworks, risks of overlapping mock configurations, and guidance for resolving conflicts by identifying the responsible tool and avoiding mock duplication. Subsection appears in two locations within the document.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs_fix_mocking_modules

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/writing-stories/mocking-data-and-modules/mocking-modules.mdx (1)

335-337: Troubleshooting guidance could be more specific and actionable.

The new subsection addresses the right problem (conflicts between Storybook and other test-runner mocks per issue #32595), but the recommended solution is somewhat generic. Users may benefit from more concrete guidance—for example:

  • How to identify which tool owns a particular __mocks__ file
  • Specific naming or directory patterns to distinguish Storybook mocks from Jest mocks
  • Examples of what "non-overlapping configurations" looks like

Consider adding a brief example or link to show how users can organize mocks to avoid conflicts (e.g., separate mock strategies per tool, or tool-specific mock directories).

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aa8a708 and f472ebf.

📒 Files selected for processing (1)
  • docs/writing-stories/mocking-data-and-modules/mocking-modules.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Update documentation under docs/ for significant changes, including migration guides for breaking changes

Files:

  • docs/writing-stories/mocking-data-and-modules/mocking-modules.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Core Unit Tests, windows-latest
🔇 Additional comments (1)
docs/writing-stories/mocking-data-and-modules/mocking-modules.mdx (1)

335-337: Verify that the new subsection is not duplicated elsewhere in the document.

The AI-generated summary indicates that this "Mocking conflicts with other testing tools" subsection appears in two locations within the document (once here and again at the end of the Troubleshooting section). The provided code shows only one instance, making it unclear whether this is an oversight or intentional repetition. Please confirm whether duplication exists and, if so, whether it should be consolidated into a single location to avoid redundancy.

@jonniebigodes jonniebigodes merged commit b68fa4a into next Oct 23, 2025
11 checks passed
@jonniebigodes jonniebigodes deleted the docs_fix_mocking_modules branch October 23, 2025 11:23
@github-actions github-actions bot mentioned this pull request Oct 24, 2025
12 tasks
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: When re-using mocks, the mock might be for a different test-runner or environment

2 participants