Skip to content

fix: Add webpack fallbacks for Node.js core modules in static export #6469

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

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

Conversation

chojuninengu
Copy link

@chojuninengu chojuninengu commented Apr 29, 2025

This PR fixes the webpack configuration to properly handle Node.js built-in modules during static export builds. The changes include:

  • Added proper fallbacks for Node.js core modules (process, child_process, path, fs, os, util, stream)
  • Integrated buffer and events polyfills
  • Added webpack ProvidePlugin for Buffer and process support

Related Issue

Fixes #6468

Changes Made

  • Enhanced webpack configuration in next.config.mjs
  • Added proper module fallbacks for Node.js built-in modules
  • Integrated necessary polyfills for browser environment

Testing

  • Tested static export build
  • Verified no more "UnhandledSchemeError" for node:process and node:child_process
  • Confirmed application builds successfully in export mode

Summary by CodeRabbit

  • Chores
    • Improved compatibility and stability for browser environments by enhancing support for Node.js modules in the client-side build.

…dules and integrating ProvidePlugin for Buffer and process support.
Copy link

vercel bot commented Apr 29, 2025

@chojuninengu is attempting to deploy a commit to the NextChat Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Apr 29, 2025

Walkthrough

The webpack configuration in next.config.mjs has been updated to enhance compatibility with Node.js core modules in the client-side bundle. The resolve.fallback property now explicitly disables several Node.js modules and maps buffer and events to browser-compatible polyfills. Additionally, the webpack.ProvidePlugin is configured to globally provide Buffer and process shims, ensuring these globals are available during the build. No changes were made to exported or public entities, and all modifications are internal to the webpack configuration.

Changes

File(s) Change Summary
next.config.mjs Updated webpack config: expanded resolve.fallback for Node.js modules, added ProvidePlugin for Buffer and process polyfills.

Sequence Diagram(s)

sequenceDiagram
    participant Webpack
    participant ProvidePlugin
    participant BrowserApp

    Webpack->>ProvidePlugin: Register Buffer and process shims
    Webpack->>BrowserApp: Bundle with polyfilled Node.js modules
    BrowserApp->>ProvidePlugin: Access Buffer/process as globals
Loading

Assessment against linked issues

Objective Addressed Explanation
Fix UnhandledSchemeError for "node:process" and "node:child_process" in webpack build (#6468)

Poem

In the warren where configs dwell,
A rabbit patched webpack quite well.
With Buffer and process now in the air,
Node shims abound, no more despair!
The build hops forward, errors at bay—
Polyfills guide the bunny’s way.
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3809375 and d5c86ce.

📒 Files selected for processing (1)
  • next.config.mjs (1 hunks)
🔇 Additional comments (2)
next.config.mjs (2)

24-34: Good implementation of Node.js module fallbacks.

This change properly addresses the webpack configuration for Node.js core modules in the browser environment. You've:

  • Preserved existing fallbacks with the spread operator
  • Explicitly disabled Node.js-specific modules (process, path, fs, os, util, stream)
  • Added proper polyfills for buffer and events using require.resolve

This approach follows webpack best practices for handling Node.js core modules in browser environments.


36-41: Good use of webpack.ProvidePlugin for global variables.

Adding the ProvidePlugin is the correct approach to ensure Buffer and process are available globally in the client-side bundle. This addresses potential reference errors that could occur when code assumes these globals are available (as they would be in Node.js).

The implementation correctly:

  • Maps Buffer to the buffer package's Buffer implementation
  • Uses process/browser as a lightweight process shim

This complements the fallback configuration above and should resolve the "UnhandledSchemeError" issues mentioned in the PR description.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] Module build failed: UnhandledSchemeError: Reading from "node:process" is not handled by plugins (Unhandled scheme).
1 participant