LuizyHub commented 7 months ago

followed by new Version 3.0.0 breaking changes change sample code and description

Summary

This PR updates the proxy setup example in the Create React App documentation to align with the breaking changes introduced in http-proxy-middleware version 3.0.0. Specifically, it addresses the requirement that the proxy target path must explicitly include the path it is mounted on.

Background

As of http-proxy-middleware v3.0.0, the library has removed the req.url patching feature. This change requires that when a proxy is mounted on a specific path, this path must be explicitly included in the target URL. This update ensures that developers who follow the CRA documentation will implement proxying correctly according to the latest version of http-proxy-middleware.

Changes

Updated the proxy setup example to include the mounted path in the target property.
Added a note to emphasize the new requirement of including the mounted path in the target property for http-proxy-middleware v3.0.0 and above.

Updated Example

const { createProxyMiddleware } = require('http-proxy-middleware');

module.exports = function (app) {
  app.use(
    '/api',
    createProxyMiddleware({
      // Updated to include the path in the target URL
      target: 'http://localhost:5000/api',
      changeOrigin: true,
    })
  );
};

facebook-github-bot commented 7 months ago

Hi @LuizyHub!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!