Proxy rewrite function no longer called in 1.15.0

Hey there,

in 1.14.1 the following rewrite function worked

  proxy: {
      '/api/**': {
        target: 'http://localhost:9001',
        rewrite: function(req) {
          req.url = req.url.replace(/^\/api(.+)$/, '$1');
          return req.url;
        },
        ignorePath: false,
        changeOrigin: true,
        secure: false
      }
    }

As of 1.15.0 The rewrite function doesn’t get called anymore.

Was there a breaking change with how the rewrite function works? I understand there was a switch in how proxy works but I figured I would have to update to 2.x.x for those changes to manifest.

Thoughts?

[chimurai]

@SpaceK33z @jdkrebs

This line in http-proxy-middleware kind of ignores/reverts the rewritten path in your fix. (source)

// http-proxy-middleware
req.url = (req.originalUrl || req.url);

Not sure what the best approach would be to make it backwards compatible.

As alternative, you could use the .pathRewrite option offered by HPM. The syntax is slightly different…

    proxy: {
      '/api/**': {
        target: 'http://localhost:9001',
        pathRewrite: function (path, req) {
          return path.replace('/api/foo', '/api/bar');
        }
      }
    }

For more info on pathRewrite: http-proxy-middleware/recipes/pathRewrite.md

---

@SpaceK33z

I noticed a sudden surge in downloads since v1.15.0 got released and with it also a number of proxy related issues. Feel free to cc me if you need any assistance.

[SpaceK33z]

Closing this. This breaking change was not intended to be released in a minor release, but to completely revert this we’d need to revert the whole PR that introduced http-proxy-middleware. This also brought us websocket proxy support, and a lot of other nice options. Also, not that many people seem to use rewrite. Documentation for the dev-server is updated to reflect this.

Thanks for your help @jdkrebs and @chimurai

TL;DR - use pathRewrite, as documented in http-proxy-middleware.