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

Next.js: Update validateData function for next/font compatibility #25061

Merged
merged 3 commits into from
Dec 1, 2023
Merged

Next.js: Update validateData function for next/font compatibility #25061

merged 3 commits into from
Dec 1, 2023

Conversation

kkirby
Copy link
Contributor

@kkirby kkirby commented Nov 30, 2023

What I did

Refactored the method of deriving the correct validateData function to improve handling of different Next.js version compatibilities. Replaced multiple try-catch blocks with a trials array containing objects with module, export, and description properties. This array is used to dynamically attempt loading the required functions and generate a detailed error message if all attempts fail. This approach simplifies future updates for new Next.js versions and makes the error message more informative for users.

Checklist for Contributors

I will update the following when I have time.

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>

Refactored the method of deriving the correct validateData function to improve handling of different Next.js version compatibilities. Replaced multiple try-catch blocks with a trials array containing objects with module, export, and description properties. This array is used to dynamically attempt loading the required functions and generate a detailed error message if all attempts fail. This approach simplifies future updates for new Next.js versions and makes the error message more informative for users.
@valentinpalkovic valentinpalkovic added maintenance User-facing maintenance tasks nextjs ci:daily Run the CI jobs that normally run in the daily job. ci:normal and removed ci:normal labels Dec 1, 2023
@valentinpalkovic valentinpalkovic changed the title refactor: Update validateData function for next/font compatibility Next.js: Update validateData function for next/font compatibility Dec 1, 2023
Copy link
Contributor

@valentinpalkovic valentinpalkovic left a comment

Choose a reason for hiding this comment

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

LGMT! Thanks for the cleanup. The code is much better and more readable.

@valentinpalkovic valentinpalkovic merged commit c3fa95b into storybookjs:next Dec 1, 2023
97 of 107 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:daily Run the CI jobs that normally run in the daily job. maintenance User-facing maintenance tasks nextjs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants