Doc Tools: Signature Type Error Handling

[ethriel3695]

Closes #

What I did

I added a custom server error for the doc tools convertSig function for the signature type handling.
Previously, the error was generic and appeared like this:

Error: Unknown: [object Object]
    at convertSig (23558.77dfc7ad.iframe.bundle.js:52138:513)

The change outputs the error like this:

We detected a type {"name":"signature","type":"number","signature":1} in your configuration.
    Your custom type does not match the TSFuncSigType or TSObjectSigType
    Please check your Storybook configuration and ensure you have defined a valid type.

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!

Manual testing should not be required, as the unit test verifies that the error message is output correctly.

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>

[nx-cloud]

☁️ Nx Cloud Report

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

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

---

Sent with 💌 from NxCloud.

[yannbf]

From our conversation, the potential issue is when having a type like:

type Props = {
  myValue: SomeType['someProperty']
}

where internally it looks like this:

{
  name: 'signature',
  raw: 'SomeType['someProperty']'
}

1 - it could be an import from node_module which somehow is not available for docgen
2 - it could be an aliased/absolute import from a monorepo package which somehow is not available for docgen

we should really try to reproduce this bug so we can fix it as well