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

Portable Stories: Warn when rendering stories without cleaning up first #27008

Merged
merged 12 commits into from
May 4, 2024

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented May 2, 2024

Closes #26994

What I did

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!

  1. Make the following modifications:
// test-storybooks/portable-stories-kitchen-sink/react/stories/Button.stories.tsx

export const WarnTester1: CSF3Story = {
  beforeEach: () => {
    console.log('beforeEach1');
    return () => {
      console.log('cleanup1');
    }
  },
};

export const WarnTester2: CSF3Story = {
  beforeEach: () => {
    console.log('beforeEach2');
    return () => {
      console.log('cleanup2');
    }
  },
};
// test-storybooks/portable-stories-kitchen-sink/react/stories/Button.test.tsx

const { CSF3Primary, WarnTester1, WarnTester2 } = composeStories(stories);

describe.only('cleanup warnings', () => {
  it('should warn about missing cleanup', async () => {
    await WarnTester1.load();
    render(<WarnTester1 />);
    render(<WarnTester2 />);
  });
  it('should NOT warn about missing cleanup', async () => {
    await WarnTester1.load();
    render(<WarnTester1 />);
    await WarnTester2.load();
    render(<WarnTester2 />);
  });
});
// test-storybooks/portable-stories-kitchen-sink/react/stories/Button.playwright.tsx

test.only('does not warn in playwright1', async ({ mount }) => {
  await mount(<stories.WarnTester1 />);
});
test.only('does not warn in playwright2', async ({ mount }) => {
  await mount(<stories.WarnTester2 />);
});
  1. cd test-storybooks/portable-stories-kitchen-sink/react && yarn install && yarn jest
  2. See only one warning
  3. yarn playwright
  4. See no warning, since PW always calls load (and maybe because would appear in the browser console and not the terminal 🤷)

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 pull request has been released as version 0.0.0-pr-27008-sha-307d4fb3. Try it out in a new sandbox by running npx storybook@0.0.0-pr-27008-sha-307d4fb3 sandbox or in an existing project with npx storybook@0.0.0-pr-27008-sha-307d4fb3 upgrade.

More information
Published version 0.0.0-pr-27008-sha-307d4fb3
Triggered by @JReinhold
Repository storybookjs/storybook
Branch jeppe/warn-cleanup-ps
Commit 307d4fb3
Datetime Thu May 2 12:09:48 UTC 2024 (1714651788)
Workflow run 8923550795

To request a new release of this pull request, mention the @storybookjs/core team.

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

@JReinhold JReinhold self-assigned this May 2, 2024
@JReinhold JReinhold requested review from kasperpeulen, yannbf and kylegach and removed request for kasperpeulen and yannbf May 2, 2024 11:49
@JReinhold JReinhold added maintenance User-facing maintenance tasks ci:normal portable stories labels May 2, 2024
@JReinhold JReinhold marked this pull request as ready for review May 2, 2024 11:51
Copy link

nx-cloud bot commented May 2, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit eebfd15. 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.

@yannbf
Copy link
Member

yannbf commented May 2, 2024

This looks good! I think we should prepare a canary and test this out before merging.

Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Docs are good! 🙏

@JReinhold JReinhold merged commit ef1d144 into next May 4, 2024
61 checks passed
@JReinhold JReinhold deleted the jeppe/warn-cleanup-ps branch May 4, 2024 05:42
@github-actions github-actions bot mentioned this pull request May 4, 2024
44 tasks
@JReinhold JReinhold added the needs qa Indicates that this needs manual QA during the upcoming minor/major release label May 9, 2024
@JReinhold JReinhold removed the needs qa Indicates that this needs manual QA during the upcoming minor/major release label May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal maintenance User-facing maintenance tasks portable stories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Warn when a story is rendered in portable stories when there are lingering cleanup functions
3 participants