Skip to content

Commit

Permalink
fix: webRequest should be able to modify CORS headers (#21099)
Browse files Browse the repository at this point in the history
  • Loading branch information
zcbenz committed Nov 15, 2019
1 parent b6a3404 commit 6ee79fc
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 6 deletions.
4 changes: 4 additions & 0 deletions shell/browser/api/atom_api_web_request_ns.cc
Expand Up @@ -332,6 +332,10 @@ void WebRequestNS::OnCompleted(extensions::WebRequestInfo* info,
HandleSimpleEvent(kOnCompleted, info, request, net_error);
}

void WebRequestNS::OnRequestWillBeDestroyed(extensions::WebRequestInfo* info) {
callbacks_.erase(info->id);
}

template <WebRequestNS::SimpleEvent event>
void WebRequestNS::SetSimpleListener(gin::Arguments* args) {
SetListener<SimpleListener>(event, &simple_listeners_, args);
Expand Down
1 change: 1 addition & 0 deletions shell/browser/api/atom_api_web_request_ns.h
Expand Up @@ -87,6 +87,7 @@ class WebRequestNS : public gin::Wrappable<WebRequestNS>, public WebRequestAPI {
void OnCompleted(extensions::WebRequestInfo* info,
const network::ResourceRequest& request,
int net_error) override;
void OnRequestWillBeDestroyed(extensions::WebRequestInfo* info) override;

enum SimpleEvent {
kOnSendHeaders,
Expand Down
28 changes: 22 additions & 6 deletions shell/browser/net/proxying_url_loader_factory.cc
Expand Up @@ -47,9 +47,10 @@ ProxyingURLLoaderFactory::InProgressRequest::InProgressRequest(
proxied_loader_binding_(this, std::move(loader_request)),
target_client_(std::move(client)),
proxied_client_binding_(this),
// TODO(zcbenz): We should always use "extraHeaders" mode to be compatible
// with old APIs.
has_any_extra_headers_listeners_(false) {
// Always use "extraHeaders" mode to be compatible with old APIs, except
// when the |request_id_| is zero, which is not supported in Chromium and
// only happens in Electron when the request is started from net module.
has_any_extra_headers_listeners_(network_service_request_id != 0) {
// If there is a client error, clean up the request.
target_client_.set_connection_error_handler(base::BindOnce(
&ProxyingURLLoaderFactory::InProgressRequest::OnRequestError,
Expand All @@ -58,7 +59,19 @@ ProxyingURLLoaderFactory::InProgressRequest::InProgressRequest(
}

ProxyingURLLoaderFactory::InProgressRequest::~InProgressRequest() {
// TODO(zcbenz): Do cleanup here.
// This is important to ensure that no outstanding blocking requests continue
// to reference state owned by this object.
if (info_) {
factory_->web_request_api()->OnRequestWillBeDestroyed(&info_.value());
}
if (on_before_send_headers_callback_) {
std::move(on_before_send_headers_callback_)
.Run(net::ERR_ABORTED, base::nullopt);
}
if (on_headers_received_callback_) {
std::move(on_headers_received_callback_)
.Run(net::ERR_ABORTED, base::nullopt, GURL());
}
}

void ProxyingURLLoaderFactory::InProgressRequest::Restart() {
Expand All @@ -82,8 +95,7 @@ void ProxyingURLLoaderFactory::InProgressRequest::UpdateRequestInfo() {

current_request_uses_header_client_ =
factory_->url_loader_header_client_receiver_.is_bound() &&
network_service_request_id_ != 0 &&
false /* TODO(zcbenz): HasExtraHeadersListenerForRequest */;
network_service_request_id_ != 0 && has_any_extra_headers_listeners_;
}

void ProxyingURLLoaderFactory::InProgressRequest::RestartInternal() {
Expand Down Expand Up @@ -715,6 +727,10 @@ void ProxyingURLLoaderFactory::CreateLoaderAndStart(
// don't use it for identity here.
const uint64_t web_request_id = ++g_request_id;

// Notes: Chromium assumes that requests with zero-ID would never use the
// "extraHeaders" code path, however in Electron requests started from
// the net module would have zero-ID because they do not have renderer process
// associated.
if (request_id)
network_request_id_to_web_request_id_.emplace(request_id, web_request_id);

Expand Down
1 change: 1 addition & 0 deletions shell/browser/net/proxying_url_loader_factory.h
Expand Up @@ -63,6 +63,7 @@ class WebRequestAPI {
virtual void OnCompleted(extensions::WebRequestInfo* info,
const network::ResourceRequest& request,
int net_error) = 0;
virtual void OnRequestWillBeDestroyed(extensions::WebRequestInfo* info) = 0;
};

// This class is responsible for following tasks when NetworkService is enabled:
Expand Down
23 changes: 23 additions & 0 deletions spec-main/api-web-request-spec.ts
Expand Up @@ -20,6 +20,9 @@ describe('webRequest module', () => {
if (req.headers.accept === '*/*;test/header') {
content += 'header/received'
}
if (req.headers.origin === 'http://new-origin') {
content += 'new/origin'
}
res.end(content)
}
})
Expand Down Expand Up @@ -144,6 +147,16 @@ describe('webRequest module', () => {
expect(data).to.equal('/header/received')
})

it('can change CORS headers', async () => {
ses.webRequest.onBeforeSendHeaders((details, callback) => {
const requestHeaders = details.requestHeaders
requestHeaders.Origin = 'http://new-origin'
callback({ requestHeaders: requestHeaders })
})
const { data } = await ajax(defaultURL)
expect(data).to.equal('/new/origin')
})

it('resets the whole headers', async () => {
const requestHeaders = {
Test: 'header'
Expand Down Expand Up @@ -198,6 +211,16 @@ describe('webRequest module', () => {
expect(headers).to.match(/^custom: Changed$/m)
})

it('can change CORS headers', async () => {
ses.webRequest.onHeadersReceived((details, callback) => {
const responseHeaders = details.responseHeaders!
responseHeaders['access-control-allow-origin'] = ['http://new-origin'] as any
callback({ responseHeaders: responseHeaders })
})
const { headers } = await ajax(defaultURL)
expect(headers).to.match(/^access-control-allow-origin: http:\/\/new-origin$/m)
})

it('does not change header by default', async () => {
ses.webRequest.onHeadersReceived((details, callback) => {
callback({})
Expand Down

0 comments on commit 6ee79fc

Please sign in to comment.