Portable Stories: Warn when rendering stories without cleaning up first

[JReinhold]

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 />);
});

2. cd test-storybooks/portable-stories-kitchen-sink/react && yarn install && yarn jest
3. See only one warning
4. yarn playwright
5. 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 [email protected] sandbox or in an existing project with npx [email protected] 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

[nx-cloud]

☁️ 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

• nx run-many -t build -c production --parallel=3

---

Sent with 💌 from NxCloud.

[yannbf]

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

[kylegach]

Docs are good! 🙏