Core: added .entries property to error thrown when duplicate stories are present

[YuriScarbaci]

Issue:

What I did

As per #19094 I extended the Error thrown at StoryIndexGenerator.ts > chooseDuplicate method to include the full information from the entries being compared

How to test

• Is this testable with Jest or Chromatic screenshots?
• Does this need a new example in the kitchen sink apps?
• Does this need an update to the documentation?

If your answer is yes to any of these, please make sure to include it in your PR.

Extra info

I tried running the process as per https://github.com/storybookjs/storybook/blob/next/CONTRIBUTING.md and yarn start is failing

Failed tasks:
   
   - @storybook/theming:prep

   See Nx Cloud run details at https://nx.app/runs/uGNl2rIURN

    at makeError (file:///([path/to/my/local/fork/escaped]/storybook/scripts/node_modules/execa/lib/error.js:59:11)
    at handlePromise (file:///([path/to/my/local/fork/escaped]/storybook/scripts/node_modules/execa/index.js:119:26)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async exec ([path/to/my/local/fork]/storybook/scripts/utils/exec.ts:58:7)
    at async runTask ([path/to/my/local/fork]/storybook/scripts/task.ts:286:24)
    at async run ([path/to/my/local/fork]/storybook/scripts/task.ts:420:28) {
  shortMessage: 'Command failed with exit code 1: nx run-many --target="prep" --all --parallel --exclude=@storybook/addon-storyshots,@storybook/addon-storyshots-puppeteer -- --reset',
  command: 'nx run-many --target="prep" --all --parallel --exclude=@storybook/addon-storyshots,@storybook/addon-storyshots-puppeteer -- --reset',
  escapedCommand: 'nx run-many "--target=\\"prep\\"" --all --parallel "--exclude=@storybook/addon-storyshots,@storybook/addon-storyshots-puppeteer" -- --reset',
  exitCode: 1,
  signal: undefined,
  signalDescription: undefined,

also, since this failed, I could not run yarn test either

This PR is pretty straightforward couple liners anyway, so maybe we don't need those steps?

[tmeasday]

Hey @yuri-scarbaci-lenio looks like maybe you need to re-install in code/ perhaps.

I'm not sure attaching that extra field to the error will show up the node console will it?

[yuri-scarbaci-lenio]

Hello @tmeasday

I tested plain unhandled error throwing in node 16 and the extra information is actually printed in my installation,
After your comment I double checked on stack-blitz just to confirm and it looks like it's also being showed

https://stackblitz.com/edit/vitejs-vite-97fard?file=src%2Fmain.jsx,src%2FApp.jsx,package.json,throwError.js&terminal=dev

am I missing some sort of error handling that storybook core-server is doing under the hood that I should look out for?

[yuri-scarbaci-lenio]

also, regarding why the contribuiting.md is failing I have some news

looks like the scripts that are being run doesn't support folder names including spaces
so in my case I have the following path
/Users/yuri.scarbaci/Desktop/personal github/storybook and it's causing some script to look for /Users/yuri.scarbaci/Desktop/personal instead 🤔

[yuri-scarbaci-lenio]

Since I got atleast yarn test to work by renaming my folders to not contain white spaces I added a unit test and created a custom error class for duplicated entries since it's better practice to handle it that way instead of relying on new Error being an object...

@tmeasday

regarding wheter or not the entries will get logged it all dependes on the logging mechanism,
unhandle execptions, at least for as far as I could test, do print all the properties along the .trace and .message of an Error object

If Storybook does have a custom logger that will instead only log the .trace and .message let me know how would you expect the .message to look like to provide meaningful informations ( imho, at the very least the import path of both entries is a must-have to make the error any useful, but in general I think that a project as big as storybook should have a dedicated error handling layer that allows for extra information in a non string format... )

[tmeasday]

LGTM!

[tmeasday]

Oh, nice pickup @YuriScarbaci. Perhaps you could open an issue about the space thing and someone from the community could take a look at it.

Thanks for this PR, it is great! If the logging is working for you I think we are good.