storybookjs/storybook

[Bug]: optimizePackageImports do not work in @storybook/nextjs

Open

#30,126 opened on Dec 23, 2024

View on GitHub
 (2 comments) (1 reaction) (0 assignees)TypeScript (10,058 forks)batch import
bughelp wantednextjssev:S3

Repository metrics

Stars
 (89,909 stars)
PR merge metrics
 (Avg merge 9d 3h) (173 merged PRs in 30d)

Description

Describe the bug

Some server code exported from barrel file. It works in nextjs itself because of optimizePackageImports, but fails to resolve some node packages in storybook.

Reproduction link

https://stackblitz.com/edit/github-dvxhuih6-cb6t3t3m?file=src%2Fshared%2Findex.ts

Reproduction steps

No response

System

System:
    OS: Linux 5.0 undefined
    CPU: (8) x64 Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
    Shell: 1.0 - /bin/jsh
  Binaries:
    Node: 18.20.3 - /usr/local/bin/node
    Yarn: 1.22.19 - /usr/local/bin/yarn
    npm: 10.2.3 - /usr/local/bin/npm <----- active
    pnpm: 8.15.6 - /usr/local/bin/pnpm
  npmPackages:
    @storybook/addon-essentials: ^8.5.0-beta.4 => 8.5.0-beta.4 
    @storybook/addon-interactions: ^8.5.0-beta.4 => 8.5.0-beta.4 
    @storybook/addon-onboarding: ^8.5.0-beta.4 => 8.5.0-beta.4 
    @storybook/blocks: ^8.5.0-beta.4 => 8.5.0-beta.4 
    @storybook/nextjs: ^8.5.0-beta.4 => 8.5.0-beta.4 
    @storybook/react: ^8.5.0-beta.4 => 8.5.0-beta.4 
    @storybook/test: ^8.5.0-beta.4 => 8.5.0-beta.4 
    storybook: ^8.5.0-beta.4 => 8.5.0-beta.4

Additional context

No response

Contributor guide

Research direction
This bug occurs because optimizePackageImports from Next.js is not applied in Storybook's webpack configuration, causing server side code to fail when imported from barrel files. To address, investigate how @storybook/nextjs merges the user's next.config.js (especially the experimental.optimizePackageImports field) into its own webpack config. The reproduction at StackBlitz shows the setup; check the shared/index.ts and see how the error arises. Look at the code in packages/storybook nextjs that handles webpack configuration merging, particularly the part that should respect nextConfig.experimental.optimizePackageImports. A potential fix would be to ensure that optimization is included in the final webpack config used by Storybook.
Tech stack
typescriptnextjsreact
Domain
frontendtesting
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Next.jsStorybookTypeScriptbarrel files
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30