Skip to content

Comments

docs: update upgrade guide for http-proxy-middleware v3#7122

Merged
chenjiahan merged 3 commits intomainfrom
proxy_migration_guide_0202
Feb 3, 2026
Merged

docs: update upgrade guide for http-proxy-middleware v3#7122
chenjiahan merged 3 commits intomainfrom
proxy_migration_guide_0202

Conversation

@chenjiahan
Copy link
Member

@chenjiahan chenjiahan commented Feb 2, 2026

Summary

Added a new section to the upgrade guide explaining the upgrade to http-proxy-middleware v3, including explicit path requirements in target, replacement of context with pathFilter, and unified event configuration using the on option.

Related Links

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings February 2, 2026 14:13
@chatgpt-codex-connector
Copy link

chatgpt-codex-connector bot commented Feb 2, 2026

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Feb 2, 2026

Summary of Changes

Hello @chenjiahan, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily enhances the Rsbuild upgrade documentation by providing comprehensive guidance for migrating proxy configurations due to the update of http-proxy-middleware from v2 to v3. It clarifies critical changes in proxy behavior, option naming, and event handling, ensuring users can smoothly adapt their projects to the new version. Additionally, it includes minor textual improvements and organizational adjustments to the existing documentation.

Highlights

  • Proxy Middleware Upgrade Guide: A new section has been added to the upgrade guide to assist users in migrating from http-proxy-middleware v2 to v3, detailing breaking changes and new configurations.
  • Explicit Target Paths for Proxy: The target option for proxy configurations now requires explicit inclusion of the proxied path, as automatic appending is no longer supported in http-proxy-middleware v3.
  • context Option Replaced by pathFilter: The context option in proxy configurations has been replaced by pathFilter for defining proxy routes, aligning with the http-proxy-middleware v3 API.
  • Unified Proxy Event Configuration: Proxy event handlers (e.g., onOpen, onClose) are now consolidated under a single on option for a more unified and streamlined configuration approach in http-proxy-middleware v3.
  • Documentation Restructuring: The section detailing the removal of HTML template parameters has been relocated within the upgrade guide for better organization and clarity.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 2, 2026 •
edited
Loading

Deploying rsbuild with  Cloudflare Pages  Cloudflare Pages

Latest commit: dc68600
Status: ✅  Deploy successful!
Preview URL: https://55c1cb35.rsbuild-v2.pages.dev
Branch Preview URL: https://proxy-migration-guide-0202.rsbuild-v2.pages.dev

View logs

Copilot AI reviewed Feb 2, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the v1→v2 upgrade guides (EN & ZH) and related server proxy documentation to explain the http-proxy-middleware v3 migration details and reorganizes existing notes about removed HTML template parameters.

Changes:

  • Add a new "Proxy middleware upgraded" section to the EN and ZH v1-to-v2 upgrade guides, documenting http-proxy-middleware v3 changes: explicit target paths, context → pathFilter, and unified on event configuration.
  • Tweak the ZH server.proxy config doc wording around v2 vs v3 behavior to match the new upgrade guidance.
  • Move the HTML template parameter removal note from its own subsection into the "Others/其他" bullet list in both EN and ZH upgrade guides.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
website/docs/zh/guide/upgrade/v1-to-v2.mdx Adds Chinese upgrade guidance for http-proxy-middleware v3 (target path, pathFilter, on events) and relocates the HTML template parameter removal note into the “其他” section with minor wording improvements.
website/docs/zh/config/server/proxy.mdx Adjusts the ZH description of v2 vs v3 proxy path behavior to read more smoothly while remaining consistent with the new upgrade section.
website/docs/en/guide/upgrade/v1-to-v2.mdx Adds English upgrade guidance for http-proxy-middleware v3 and moves the HTML template parameter removal details into the “Others” section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

gemini-code-assist[bot]
gemini-code-assist bot reviewed Feb 2, 2026
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the upgrade guide to include breaking changes from http-proxy-middleware v3. The changes are clear and well-structured, covering the new requirements for target, the replacement of context with pathFilter, and the new event configuration. I've found a small inconsistency in one of the examples that could be misleading for users, and I've provided suggestions to correct it in both the English and Chinese documentation.

@chenjiahan chenjiahan mentioned this pull request Feb 2, 2026
Merged
3 tasks
@chenjiahan chenjiahan merged commit cca56ad into main Feb 3, 2026
6 checks passed
@chenjiahan chenjiahan deleted the proxy_migration_guide_0202 branch February 3, 2026 02:14
@chenjiahan chenjiahan mentioned this pull request Feb 3, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

release: document

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@chenjiahan