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.

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

Native automation: fix incorrect headers logging (closes #7764) #7763

Merged
merged 2 commits into from
Jun 7, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
try
  • Loading branch information
AlexKamaev committed Jun 5, 2023
commit af616979bc18955402b74f954ab63d80fef36513
3 changes: 2 additions & 1 deletion src/api/request-hooks/request-logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
} from './interfaces';

import { Dictionary } from '../../configuration/interfaces';
import lowercaseObjectKeys from '../../utils/lowercase-object-keys';


const DEFAULT_OPTIONS: RequestHookLogOptions = {
Expand Down Expand Up @@ -93,7 +94,7 @@ class RequestLoggerImplementation extends RequestHook {
};

if (this._options.logRequestHeaders)
loggedReq.request.headers = Object.assign({}, event._requestInfo.headers);
loggedReq.request.headers = Object.assign({}, lowercaseObjectKeys(event._requestInfo.headers as Dictionary<string>));

if (this._options.logRequestBody)
loggedReq.request.body = this._options.stringifyRequestBody ? event._requestInfo.body.toString() : event._requestInfo.body;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import RequestPausedEvent = Protocol.Fetch.RequestPausedEvent;
import Request = Protocol.Network.Request;
import HeaderEntry = Protocol.Fetch.HeaderEntry;
import { StatusCodes } from 'http-status-codes';
import { convertToOutgoingHttpHeaders, lowerCaseHeaderNames } from '../../utils/headers';
import { convertToOutgoingHttpHeaders } from '../../utils/headers';


export default class RequestPausedEventBasedEventFactory extends BaseRequestHookEventFactory {
Expand Down Expand Up @@ -83,7 +83,7 @@ export default class RequestPausedEventBasedEventFactory extends BaseRequestHook
userAgent: RequestInfo.getUserAgent(request.headers),
url: request.url,
method: request.method.toLowerCase(),
headers: lowerCaseHeaderNames(request.headers),
headers: request.headers,
body: RequestPausedEventBasedEventFactory._getRequestData(request),
isAjax: RequestPausedEventBasedEventFactory._getIsAjaxRequest(this._event),
});
Expand Down
11 changes: 0 additions & 11 deletions src/native-automation/utils/headers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import Protocol from 'devtools-protocol';
import HeaderEntry = Protocol.Fetch.HeaderEntry;
import Headers = Protocol.Network.Headers;
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';


Expand All @@ -26,13 +25,3 @@ export function convertToOutgoingHttpHeaders (headers: HeaderEntry[] | undefined
}, {});
}

export function lowerCaseHeaderNames (headers: Headers): Headers {
const result: Headers = {};

Object.keys(headers).forEach(name => {
result[name.toLowerCase()] = headers[name];
});

return result;
}

11 changes: 11 additions & 0 deletions src/utils/lowercase-object-keys.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Dictionary } from '../configuration/interfaces';

export default function (headers: Dictionary<string>): Dictionary<string> {
const result: Dictionary<string> = {};

Object.keys(headers).forEach(name => {
result[name.toLowerCase()] = headers[name];
});

return result;
}
9 changes: 9 additions & 0 deletions test/functional/fixtures/regression/gh-7764/pages/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>gh-7764</title>
</head>
<body>
</body>
</html>
7 changes: 7 additions & 0 deletions test/functional/fixtures/regression/gh-7764/test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
describe('[Regression](GH-7764)', function () {
it('Request logger should contain actual headers if RequestHook modified them', function () {
return runTests('testcafe-fixtures/index.js');
});
});


Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { RequestLogger, RequestHook } from 'testcafe';

fixture`Set a Custom Referer`
.page`http://localhost:3000/fixtures/regression/gh-7748/pages/index.html`;

export class MyRequestHook extends RequestHook {
constructor (requestFilterRules, responseEventConfigureOpts) {
super(requestFilterRules, responseEventConfigureOpts);
}

async onRequest (event) {
event.requestOptions.headers['referer'] = 'http://my-modified-referer.com';
}

async onResponse () {
}
}

const hook = new MyRequestHook();

const logger = RequestLogger('http://localhost:3000/fixtures/regression/gh-7748/pages/index.html', {
logRequestHeaders: true,
});

test
.requestHooks([hook, logger])
('Request logger should contain actual headers if RequestHook modified themd', async t => {
await t.expect(logger.requests[0].request.headers['referer']).eql('http://my-modified-referer.com');
});