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

Manager: fix message when title of story ends with "/" and render all components in story that were correctly created. #26729

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

hmcostaa
Copy link

@hmcostaa hmcostaa commented Apr 3, 2024

Closes #26642

What I did

When creating a story with a title that ended with a "/", the explorer would catch that error and display the error with a message hard to parse.
Now, instead of displaying the message: "Invalid part '${name}', leading to id === parentId ('${id}'), inside title '${title}'", we have a better message that clarifies the error: "Invalid title "${title}" ending in slash: ${id}" and additionaly all other components created correctly will be displayed along side the error message.

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>

…render all components in story that were correctly created.

Instead of displaying the message: "Invalid part '${name}', leading to id === parentId ('${id}'), inside title '${title}'", now we have a better message that clarifys the error and then all other components created correctly will be displayed along side the error message
@valentinpalkovic valentinpalkovic changed the title #26642: fix message when title of story ends with "/" and render all components in story that were correctly created. Manager: fix message when title of story ends with "/" and render all components in story that were correctly created. Apr 8, 2024
@valentinpalkovic
Copy link
Contributor

Hi @hmcostaa

Thank you so much for opening this PR.

Could you please look at whether this is a duplicate of #26711?

Much appreciated!

Copy link

nx-cloud bot commented Apr 8, 2024

☁️ Nx Cloud Report

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

@hmcostaa
Copy link
Author

hmcostaa commented Apr 8, 2024

Hi @valentinpalkovic!

Thanks for the comment. #26711 implemented a solution that is not inline with the desired behaviour for an error. Basically It's solution was that whenever a title for a story ends with a "/" it will remove it so we don't have an error.
What I did was to keep the error but clarify the message of the error.
Previously was: "Invalid part '${name}', leading to id === parentId ('${id}'), inside title '${title}",
Now is: Invalid title "${title}" ending in slash: ${id}

I also made the explorer render all other components that were correctly created below the error message and only the story with the error will not be rendered.

I'm hoping to have this fix merged so if you need extra clarification or want some change to be made, I will answer as quickly as I can.

Thanks!

@yannbf yannbf added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug builder-manager ci:normal 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.

[Bug]: accidentally ending a title with a / breaks storybook
4 participants