114 lines
19 KiB
JavaScript
114 lines
19 KiB
JavaScript
|
"use strict";
|
||
|
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
||
|
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
||
|
|
};
|
||
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||
|
|
const testcafe_hammerhead_1 = require("testcafe-hammerhead");
|
||
|
|
const hook_1 = __importDefault(require("./hook"));
|
||
|
|
const parse_user_agent_1 = require("../../utils/parse-user-agent");
|
||
|
|
const test_run_tracker_1 = __importDefault(require("../test-run-tracker"));
|
||
|
|
const re_executable_promise_1 = __importDefault(require("../../utils/re-executable-promise"));
|
||
|
|
const runtime_1 = require("../../errors/runtime");
|
||
|
|
const types_1 = require("../../errors/types");
|
||
|
|
const DEFAULT_OPTIONS = {
|
||
|
|
logRequestHeaders: false,
|
||
|
|
logRequestBody: false,
|
||
|
|
stringifyRequestBody: false,
|
||
|
|
logResponseHeaders: false,
|
||
|
|
logResponseBody: false,
|
||
|
|
stringifyResponseBody: false,
|
||
|
|
};
|
||
|
|
const REQUEST_LOGGER_CLASS_NAME = 'RequestLogger';
|
||
|
|
class RequestLoggerImplementation extends hook_1.default {
|
||
|
|
constructor(requestFilterRuleInit, options) {
|
||
|
|
const effectiveOptions = Object.assign({}, DEFAULT_OPTIONS, options);
|
||
|
|
RequestLoggerImplementation._assertLogOptions(effectiveOptions);
|
||
|
|
const configureResponseEventOptions = new testcafe_hammerhead_1.ConfigureResponseEventOptions(effectiveOptions.logResponseHeaders, effectiveOptions.logResponseBody);
|
||
|
|
super(requestFilterRuleInit, configureResponseEventOptions);
|
||
|
|
this._className = REQUEST_LOGGER_CLASS_NAME;
|
||
|
|
this._options = effectiveOptions;
|
||
|
|
this._internalRequests = {};
|
||
|
|
}
|
||
|
|
static _assertLogOptions(logOptions) {
|
||
|
|
if (!logOptions.logRequestBody && logOptions.stringifyRequestBody)
|
||
|
|
throw new runtime_1.APIError('RequestLogger', types_1.RUNTIME_ERRORS.requestHookConfigureAPIError, 'RequestLogger', 'Cannot stringify the request body because it is not logged. Specify { logRequestBody: true } in log options.');
|
||
|
|
if (!logOptions.logResponseBody && logOptions.stringifyResponseBody)
|
||
|
|
throw new runtime_1.APIError('RequestLogger', types_1.RUNTIME_ERRORS.requestHookConfigureAPIError, 'RequestLogger', 'Cannot stringify the response body because it is not logged. Specify { logResponseBody: true } in log options.');
|
||
|
|
}
|
||
|
|
async onRequest(event) {
|
||
|
|
const loggedReq = {
|
||
|
|
id: event._requestInfo.requestId,
|
||
|
|
testRunId: event._requestInfo.sessionId,
|
||
|
|
userAgent: (0, parse_user_agent_1.parseUserAgent)(event._requestInfo.userAgent).prettyUserAgent,
|
||
|
|
request: {
|
||
|
|
timestamp: Date.now(),
|
||
|
|
url: event._requestInfo.url,
|
||
|
|
method: event._requestInfo.method,
|
||
|
|
},
|
||
|
|
};
|
||
|
|
if (this._options.logRequestHeaders)
|
||
|
|
loggedReq.request.headers = Object.assign({}, event._requestInfo.headers);
|
||
|
|
if (this._options.logRequestBody)
|
||
|
|
loggedReq.request.body = this._options.stringifyRequestBody ? event._requestInfo.body.toString() : event._requestInfo.body;
|
||
|
|
this._internalRequests[loggedReq.id] = loggedReq;
|
||
|
|
}
|
||
|
|
async onResponse(event) {
|
||
|
|
const loggedReq = this._internalRequests[event.requestId];
|
||
|
|
// NOTE: If the 'clear' method is called during a long running request,
|
||
|
|
// we should not save a response part - request part has been already removed.
|
||
|
|
if (!loggedReq)
|
||
|
|
return;
|
||
|
|
loggedReq.response = {
|
||
|
|
statusCode: event.statusCode,
|
||
|
|
timestamp: Date.now(),
|
||
|
|
};
|
||
|
|
if (this._options.logResponseHeaders)
|
||
|
|
loggedReq.response.headers = Object.assign({}, event.headers);
|
||
|
|
if (this._options.logResponseBody) {
|
||
|
|
loggedReq.response.body = this._options.stringifyResponseBody && event.body
|
||
|
|
? event.body.toString()
|
||
|
|
: event.body;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
_prepareInternalRequestInfo() {
|
||
|
|
const testRun = test_run_tracker_1.default.resolveContextTestRun();
|
||
|
|
let preparedRequests = Object.values(this._internalRequests);
|
||
|
|
if (testRun)
|
||
|
|
preparedRequests = preparedRequests.filter(r => r.testRunId === testRun.id);
|
||
|
|
return preparedRequests;
|
||
|
|
}
|
||
|
|
_getCompletedRequests() {
|
||
|
|
return this._prepareInternalRequestInfo().filter(r => r.response);
|
||
|
|
}
|
||
|
|
// API
|
||
|
|
contains(predicate) {
|
||
|
|
return re_executable_promise_1.default.fromFn(async () => {
|
||
|
|
return !!this._getCompletedRequests().find(predicate);
|
||
|
|
});
|
||
|
|
}
|
||
|
|
count(predicate) {
|
||
|
|
return re_executable_promise_1.default.fromFn(async () => {
|
||
|
|
return this._getCompletedRequests().filter(predicate).length;
|
||
|
|
});
|
||
|
|
}
|
||
|
|
clear() {
|
||
|
|
const testRun = test_run_tracker_1.default.resolveContextTestRun();
|
||
|
|
if (testRun) {
|
||
|
|
Object.keys(this._internalRequests).forEach(id => {
|
||
|
|
if (this._internalRequests[id].testRunId === testRun.id)
|
||
|
|
delete this._internalRequests[id];
|
||
|
|
});
|
||
|
|
}
|
||
|
|
else
|
||
|
|
this._internalRequests = {};
|
||
|
|
}
|
||
|
|
get requests() {
|
||
|
|
return this._prepareInternalRequestInfo();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
function createRequestLogger(requestFilterRuleInit, logOptions) {
|
||
|
|
return new RequestLoggerImplementation(requestFilterRuleInit, logOptions);
|
||
|
|
}
|
||
|
|
exports.default = createRequestLogger;
|
||
|
|
module.exports = exports.default;
|
||
|
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVxdWVzdC1sb2dnZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvYXBpL3JlcXVlc3QtaG9va3MvcmVxdWVzdC1sb2dnZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw2REFLNkI7QUFFN0Isa0RBQWlDO0FBQ2pDLG1FQUE4RDtBQUM5RCwyRUFBaUQ7QUFDakQsOEZBQW9FO0FBQ3BFLGtEQUFnRDtBQUNoRCw4Q0FBb0Q7QUFVcEQsTUFBTSxlQUFlLEdBQTBCO0lBQzNDLGlCQUFpQixFQUFNLEtBQUs7SUFDNUIsY0FBYyxFQUFTLEtBQUs7SUFDNUIsb0JBQW9CLEVBQUcsS0FBSztJQUM1QixrQkFBa0IsRUFBSyxLQUFLO0lBQzVCLGVBQWUsRUFBUSxLQUFLO0lBQzVCLHFCQUFxQixFQUFFLEtBQUs7Q0FDL0IsQ0FBQztBQXlCRixNQUFNLHlCQUF5QixHQUFHLGVBQWUsQ0FBQztBQUVsRCxNQUFNLDJCQUE0QixTQUFRLGNBQVc7SUFJakQsWUFBb0IscUJBQXVFLEVBQUUsT0FBbUM7UUFDNUgsTUFBTSxnQkFBZ0IsR0FBRyxNQUFNLENBQUMsTUFBTSxDQUFDLEVBQUUsRUFBRSxlQUFlLEVBQUUsT0FBTyxDQUEwQixDQUFDO1FBRTlGLDJCQUEyQixDQUFDLGlCQUFpQixDQUFDLGdCQUFnQixDQUFDLENBQUM7UUFFaEUsTUFBTSw2QkFBNkIsR0FBRyxJQUFJLG1EQUE2QixDQUFDLGdCQUFnQixDQUFDLGtCQUFrQixFQUFFLGdCQUFnQixDQUFDLGVBQWUsQ0FBQyxDQUFDO1FBRS9JLEtBQUssQ0FBQyxxQkFBcUIsRUFBRSw2QkFBNkIsQ0FBQyxDQUFDO1FBRTVELElBQUksQ0FBQyxVQUFVLEdBQVUseUJBQXlCLENBQUM7UUFDbkQsSUFBSSxDQUFDLFFBQVEsR0FBWSxnQkFBZ0IsQ0FBQztRQUMxQyxJQUFJLENBQUMsaUJBQWlCLEdBQUcsRUFBRSxDQUFDO0lBQ2hDLENBQUM7SUFFTyxNQUFNLENBQUMsaUJBQWlCLENBQUUsVUFBaUM7UUFDL0QsSUFBSSxDQUFDLFVBQVUsQ0FBQyxjQUFjLElBQUksVUFBVSxDQUFDLG9CQUFvQjtZQUM3RCxNQUFNLElBQUksa0JBQVEsQ0FBQyxlQUFlLEVBQUUsc0JBQWMsQ0FBQyw0QkFBNEIsRUFBRSxlQUFlLEVBQUUsOEdBQThHLENBQUMsQ0FBQztRQUV0TixJQUFJLENBQUMsVUFBVSxDQUFDLGVBQWUsSUFBSSxVQUFVLENBQUMscUJBQXFCO1lBQy9ELE1BQU0sSUFBSSxrQkFBUSxDQUFDLGVBQWUsRUFBRSxzQkFBYyxDQUFDLDRCQUE0QixFQUFFLGVBQWUsRUFBRSxnSEFBZ0gsQ0FBQyxDQUFDO0lBQzVOLENBQUM7SUFFTSxLQUFLLENBQUMsU0FBUyxDQUFFLEtBQW1CO1FBQ3ZDLE1BQU0sU0FBUyxHQUFrQjtZQUM3QixFQUFFLEVBQVMsS0FBSyxDQUFDLFlBQVksQ0FBQyxTQUFTO1lBQ3ZDLFNBQVMsRUFBRSxLQUFLLENBQUMsWUFBWSxDQUFDLFNBQVM7WUFDdkMsU0FBUyxFQUFFLElBQUEsaUNBQWMsRUFBQyxLQUFLLENBQUMsWUFBWSxDQUFDLFNBQVMsQ0FBQyxDQUFDLGVBQWU7WUFDdkUsT0FBTyxFQUFJO2dCQUNQLFNBQVMsRUFBRSxJQUFJLENBQUMsR0FBRyxFQUFFO2dCQUNyQixHQUFHLEVBQVEsS0FBSyxDQUFDLFlBQVksQ0FBQyxHQUFHO2dCQUNqQyxNQUFNLEVBQUssS0FBSyxDQUFDLFlBQVksQ0FBQyxNQUFNO2FBQ3ZDO1NBQ0osQ0FBQztRQUVGLElBQUksSUFBSSxDQUFDLFFBQVEsQ0FBQyxpQkFBaUI7WUFDL0IsU0FBUyxDQUFDLE9BQU8sQ0FBQyxPQUFPLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxFQUFFLEVBQUUsS0FBSyxDQUFDLFlBQVksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUU5RSxJQUFJLElBQUksQ0FBQyxRQUFRLENBQUMsY0FBYztZQUM1QixTQUFTLENBQUMsT0FBTyxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLG9CQUFvQixDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUM7UUFFL0gsSUFBSSxDQUFDLGlCQUFpQixDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsR0FBRyxTQUFTLENBQUM7SUFDckQsQ0FBQztJQUVNLEtBQUssQ0FBQyxVQUFVLENBQUUsS0FBb0I7UUFDekMsTUFBTSxTQUFTLEdBQUcsSUFBSSxDQUFDLGlCQUFpQixDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQztRQUUxRCx1RUFBdUU7UUFDdkUsOEVBQThFO1FBQzlFLElBQUksQ0FBQyxTQUFTO1lBQ1YsT0FBTztRQUVYLFNBQVMsQ0FBQyxRQUFRLEdBQUc7WUFDakIsVUFBVSxFQUFFLEtBQUssQ0FBQyxVQUFVO1lBQzVCLFNBQVMsRUFBRyxJQUFJLENBQUMsR0FBRyxFQUFFO1NBQ3pCLENBQUM7UUFFRixJQUFJLElBQUksQ0FBQyxRQUFRLENBQUMsa0JBQWtCO1lBQ2hDLFNBQVMsQ0FBQyxRQUFRLENBQUMsT0FBTyxHQUFHLE1BQU0sQ0FBQyxNQUFNLENBQUMsRUFBRSxFQUFFLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUVsRSxJQUFJLElBQUksQ0FBQyxRQUFRLENBQUMsZUFBZSxFQUFFO1lBQy9CLFNBQVMsQ0FBQyxRQUFRLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxRQUFRLENBQUMscUJBQXFCLElBQUksS0FBSyxDQUFDLElBQUk7Z0JBQ3ZFLENBQUMsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLFFBQVEsRUFBRTtnQkFDdkIsQ0FBQyxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUM7U0FDcEI7SUFDTCxDQUFDO0lBRU8sMkJBQTJCO1FBQy9CLE1BQU0sT0FBTyxHQUFVLDBCQUFjLENBQUMscUJBQXFCLEVBQUUsQ0FBQztRQUM5RCxJQUFJLGdCQUFnQixHQUFHLE1BQU0sQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLGlCQUFpQixDQUFDLENBQUM7UUFFN0QsSUFBSSxPQUFPO1lBQ1AsZ0JBQWdCLEdBQUcsZ0JBQWdCLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLFNBQVMsS0FBSyxPQUFPLENBQUMsRUFBRSxDQUFDLENBQUM7UUFFaEYsT0FBTyxnQkFBZ0IsQ0FBQztJQUM1QixDQUFDO0lBRU8scUJBQXFCO1FBQ3pCLE9BQU8sSUFBSSxDQUFDLDJCQUEyQixFQUFFLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ3RFLENBQUM7SUFFRCxNQUFNO0lBQ0MsUUFBUSxDQUFFLFNBQThDO1FBQzNELE9BQU8sK0JBQ
|