Skip to content
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.

Sign up for GitHub

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

Fix proxy bypass return false #1696

Merged
merged 8 commits into from
Mar 19, 2019
Merged

Fix proxy bypass return false #1696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
41d4d18
fix(na): proxy.bypass when return false.
mistic Feb 27, 2019
53f1380
fix(NA): logic for server bypass. test(NA): fix logic for the tests.
mistic Feb 27, 2019
53bf54e
test(NA): change test proxy configs.
mistic Feb 28, 2019
6c07574
Merge branch 'master' into fix-proxy-bypass-return-false
mistic Mar 7, 2019
6311172
refact(NA): make the bypass logic more clear.
mistic Mar 7, 2019
07c7c59
Merge branch 'master' into fix-proxy-bypass-return-false
evilebottnawi Mar 11, 2019
e518fc5
Merge branch 'master' into fix-proxy-bypass-return-false
mistic Mar 19, 2019
5f3fa33
Merge branch 'fix-proxy-bypass-return-false' of github.com:mistic/web…
mistic Mar 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions lib/Server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,14 +381,22 @@ class Server {
}
}

const bypass = typeof proxyConfig.bypass === 'function';

const bypassUrl =
(bypass && proxyConfig.bypass(req, res, proxyConfig)) || false;

if (bypassUrl) {
// - Check if we have a bypass function defined
// - In case the bypass function is defined we'll retrieve the
// bypassUrl from it otherwise byPassUrl would be null
const isByPassFuncDefined =
typeof proxyConfig.bypass === 'function';
const bypassUrl = isByPassFuncDefined
mistic marked this conversation as resolved.
Show resolved Hide resolved
? proxyConfig.bypass(req, res, proxyConfig)
: null;

if (typeof bypassUrl === 'boolean') {
Copy link

Choose a reason for hiding this comment

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

This is not aligning to the documentation

In the function you get access to the request, response and proxy options. It must return either false or a path that will be served instead of continuing to proxy the request.

Copy link
Member

Choose a reason for hiding this comment

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

PR welcome to webpack docs

Copy link

Choose a reason for hiding this comment

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

@evilebottnawi webpack/webpack.js.org#3211

// skip the proxy
req.url = null;
next();
} else if (typeof bypassUrl === 'string') {
// byPass to that url
req.url = bypassUrl;

next();
} else if (proxyMiddleware) {
return proxyMiddleware(req, res, next);
Expand Down
13 changes: 13 additions & 0 deletions test/Proxy.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ const proxyOptionPathsAsProperties = {
if (/\.html$/.test(req.path)) {
return '/index.html';
}

return null;
},
},
'/proxyfalse': {
bypass(req) {
if (/\/proxyfalse$/.test(req.path)) {
return false;
}
},
},
};
Expand Down Expand Up @@ -116,6 +125,10 @@ describe('Proxy', () => {
it('should pass through a proxy when a bypass function returns null', (done) => {
req.get('/foo.js').expect(200, /Hey/, done);
});

it('should not pass through a proxy when a bypass function returns false', (done) => {
req.get('/proxyfalse').expect(404, done);
});
});
});

Expand Down