Skip to content

Commit

Permalink
Update the string template for request and response logging and add a…
Browse files Browse the repository at this point in the history 
…nother access-control-allow-origin in headersToWhitelist
  • Loading branch information
MaryamAdnan3 committed Apr 23, 2024
1 parent cef07e1 commit 3783d7f
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 29 deletions.
21 changes: 9 additions & 12 deletions packages/core/src/logger/apiLogger.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,17 @@ export class ApiLogger implements ApiLoggerInterface {
* @param request The HTTP request to log.
*/
public logRequest(request: HttpRequest): void {
const logLevel = this._loggingOptions.logLevel ?? LogLevel.Info;
const logLevel = this._loggingOptions.logLevel;
const contentTypeHeader = this._getContentType(request.headers);
const url = this._loggingOptions.logRequest.includeQueryInPath
? request.url
: this._removeQueryParams(request.url);

this._logger.log(
logLevel,
'Request method ${method} url ${url} contentType ${contentType}',
{
method: request.method,
url,
contentType: contentTypeHeader,
}
);
this._logger.log(logLevel, 'Request ${method} ${url} ${contentType}', {
method: request.method,
url,
contentType: contentTypeHeader,
});

this._applyLogRequestOptions(logLevel, request);
}
Expand All @@ -61,13 +57,13 @@ export class ApiLogger implements ApiLoggerInterface {
* @param response The HTTP response to log.
*/
public logResponse(response: HttpResponse): void {
const logLevel = this._loggingOptions.logLevel ?? LogLevel.Info;
const logLevel = this._loggingOptions.logLevel;
const contentTypeHeader = this._getContentType(response.headers);
const contentLengthHeader = this._getContentLength(response.headers);

this._logger.log(
logLevel,
'Response statusCode ${statusCode} contentLength ${contentLength} contentType ${contentType}',
'Response ${statusCode} ${contentLength} ${contentType}',
{
statusCode: response.statusCode,
contentLength: contentLengthHeader,
Expand Down Expand Up @@ -287,6 +283,7 @@ export class ApiLogger implements ApiLoggerInterface {
'accept-charset',
'accept-encoding',
'accept-language',
'access-control-allow-origin',
'cache-control',
'connection',
'content-encoding',
Expand Down
34 changes: 17 additions & 17 deletions packages/core/test/http/apiLogger.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ describe('Test APILogger with Request ConsoleLogging', () => {
const loggingOpts = mergeLoggingOptions({});

const expectedConsoleLogs = [
'info: Request method GET url https://apimatic.hopto.org:3000/test/requestBuilder contentType content-type',
'info: Request GET https://apimatic.hopto.org:3000/test/requestBuilder content-type',
];

await mockClient(loggingOpts);
Expand All @@ -37,7 +37,7 @@ describe('Test APILogger with Request ConsoleLogging', () => {
});

const expectedConsoleLogs = [
'debug: Request method GET url https://apimatic.hopto.org:3000/test/requestBuilder contentType content-type',
'debug: Request GET https://apimatic.hopto.org:3000/test/requestBuilder content-type',
];

await mockClient(loggingOpts);
Expand All @@ -51,7 +51,7 @@ describe('Test APILogger with Request ConsoleLogging', () => {
});

const expectedConsoleLogs = [
'info: Request method GET url https://apimatic.hopto.org:3000/test/requestBuilder?param1=test contentType content-type',
'info: Request GET https://apimatic.hopto.org:3000/test/requestBuilder?param1=test content-type',
];

await mockClient(loggingOpts);
Expand All @@ -65,7 +65,7 @@ describe('Test APILogger with Request ConsoleLogging', () => {
});

const expectedConsoleLogs = [
'info: Request method GET url https://apimatic.hopto.org:3000/test/requestBuilder contentType content-type',
'info: Request GET https://apimatic.hopto.org:3000/test/requestBuilder content-type',
'info: Request body {"type":"text","content":"some req content"}',
];

Expand All @@ -80,7 +80,7 @@ describe('Test APILogger with Request ConsoleLogging', () => {
});

const expectedConsoleLogs = [
'info: Request method GET url https://apimatic.hopto.org:3000/test/requestBuilder contentType content-type',
'info: Request GET https://apimatic.hopto.org:3000/test/requestBuilder content-type',
'info: Request headers {"Content-type":"content-type","Content-length":"Content-length","Authorization":"**Redacted**"}',
];

Expand All @@ -97,7 +97,7 @@ describe('Test APILogger with Request ConsoleLogging', () => {
});

const expectedConsoleLogs = [
'info: Request method GET url https://apimatic.hopto.org:3000/test/requestBuilder contentType content-type',
'info: Request GET https://apimatic.hopto.org:3000/test/requestBuilder content-type',
'info: Request headers {"Content-type":"content-type"}',
];

Expand All @@ -114,7 +114,7 @@ describe('Test APILogger with Request ConsoleLogging', () => {
});

const expectedConsoleLogs = [
'info: Request method GET url https://apimatic.hopto.org:3000/test/requestBuilder contentType content-type',
'info: Request GET https://apimatic.hopto.org:3000/test/requestBuilder content-type',
'info: Request headers {"Content-length":"Content-length","Authorization":"**Redacted**"}',
];

Expand All @@ -132,7 +132,7 @@ describe('Test APILogger with Request ConsoleLogging', () => {
});

const expectedConsoleLogs = [
'info: Request method GET url https://apimatic.hopto.org:3000/test/requestBuilder contentType content-type',
'info: Request GET https://apimatic.hopto.org:3000/test/requestBuilder content-type',
'info: Request headers {"Content-type":"content-type","Content-length":"Content-length","Authorization":"Bearer EAAAEFZ2r-rqsEBBB0s2rh210e18mspf4dzga"}',
];

Expand All @@ -150,7 +150,7 @@ describe('Test APILogger with Request ConsoleLogging', () => {
});

const expectedConsoleLogs = [
'info: Request method GET url https://apimatic.hopto.org:3000/test/requestBuilder contentType content-type',
'info: Request GET https://apimatic.hopto.org:3000/test/requestBuilder content-type',
'info: Request headers {"Content-type":"content-type","Content-length":"Content-length","Authorization":"Bearer EAAAEFZ2r-rqsEBBB0s2rh210e18mspf4dzga"}',
];

Expand All @@ -165,7 +165,7 @@ describe('Test APILogger with Response ConsoleLogging', () => {

const expectedConsoleLogs = [
'value should not matter',
'info: Response statusCode 200 contentLength Content-length contentType content-type',
'info: Response 200 Content-length content-type',
];

await mockClient(loggingOpts);
Expand All @@ -178,7 +178,7 @@ describe('Test APILogger with Response ConsoleLogging', () => {

const expectedConsoleLogs = [
'ignore value',
'debug: Response statusCode 200 contentLength Content-length contentType content-type',
'debug: Response 200 Content-length content-type',
];

await mockClient(loggingOpts);
Expand All @@ -193,7 +193,7 @@ describe('Test APILogger with Response ConsoleLogging', () => {

const expectedConsoleLogs = [
'ignore value',
'info: Response statusCode 200 contentLength Content-length contentType content-type',
'info: Response 200 Content-length content-type',
'info: Response body testBody',
];

Expand All @@ -209,7 +209,7 @@ describe('Test APILogger with Response ConsoleLogging', () => {

const expectedConsoleLogs = [
'ignore value',
'info: Response statusCode 200 contentLength Content-length contentType content-type',
'info: Response 200 Content-length content-type',
'info: Response headers {"Set-Cookies":"**Redacted**","Content-length":"Content-length","Content-Type":"content-type"}',
];

Expand All @@ -227,7 +227,7 @@ describe('Test APILogger with Response ConsoleLogging', () => {

const expectedConsoleLogs = [
'ignore value',
'info: Response statusCode 200 contentLength Content-length contentType content-type',
'info: Response 200 Content-length content-type',
'info: Response headers {"Content-Type":"content-type"}',
];

Expand All @@ -245,7 +245,7 @@ describe('Test APILogger with Response ConsoleLogging', () => {

const expectedConsoleLogs = [
'ignore value',
'info: Response statusCode 200 contentLength Content-length contentType content-type',
'info: Response 200 Content-length content-type',
'info: Response headers {"Set-Cookies":"**Redacted**","Content-length":"Content-length"}',
];

Expand All @@ -264,7 +264,7 @@ describe('Test APILogger with Response ConsoleLogging', () => {

const expectedConsoleLogs = [
'ignore value',
'info: Response statusCode 200 contentLength Content-length contentType content-type',
'info: Response 200 Content-length content-type',
'info: Response headers {"Set-Cookies":"some value","Content-length":"Content-length","Content-Type":"content-type"}',
];

Expand All @@ -283,7 +283,7 @@ describe('Test APILogger with Response ConsoleLogging', () => {

const expectedConsoleLogs = [
'ignore value',
'info: Response statusCode 200 contentLength Content-length contentType content-type',
'info: Response 200 Content-length content-type',
'info: Response headers {"Set-Cookies":"some value","Content-length":"Content-length","Content-Type":"content-type"}',
];

Expand Down

0 comments on commit 3783d7f

Please sign in to comment.