feat(configureable-logger): add support of configurable logger #164

haseeb-mhr · 2024-04-09T06:20:04Z

Closes #163

thehappybug

Found quite a few issues. I've left feedback. Please add tests.

packages/core-interfaces/src/loggingOptions.ts

packages/core/src/logger/loggerConfiguration.ts

packages/core/src/logger/apiLogger.ts

packages/core/src/logger/loggerOptions.ts

packages/core/src/logger/apiLogger.ts

packages/core/src/logger/loggerConfiguration.ts

packages/core/src/logger/nullLogger.ts

thehappybug

I've requested code changes. Please see my comments.

Besides this, these things need to be fixed before the next review:

PR must pass checks, including tests and quality checks.
PR must not contain formatting changes. Unrelated formatting changes or refactoring can be done in a separate PR other than this feature PR.

packages/authentication-adapters/src/compositeAuthenticationAdapter.ts

packages/core/src/errors/responseValidationError.ts

packages/core/src/http/requestBuilder.ts

packages/core/src/logger/apiLogger.ts

packages/core/src/logger/defaultLogger.ts

packages/core/src/logger/loggerConfiguration.ts

… maskSensitiveHeaders headers

…om/apimatic/apimatic-js-runtime into configurable-logger-implementation

thehappybug

See my comments for the requested changes.

It seems like some of my previous feedback from the last review was not acted upon. Please ensure that all issues reported in this review are taken care of.

packages/core-interfaces/src/logging.ts

packages/core/src/http/requestBuilder.ts

packages/core/src/logger/apiLogger.ts

packages/core/src/logger/nullLogger.ts

packages/core/src/logger/defaultLogger.ts

packages/core/test/http/apiLogger.test.ts

…s used in APILogger

* mergeLoggingOptions provides a way for SDKs to safely override options while maintaining foward compatibility with future Core library releases. * PartialLoggingOptions interfaces can be used in SDK configuration interface.

thehappybug · 2024-04-18T18:46:51Z

Adding context about my latest commit here...

…ed vulnerability using regex

….ts tests to unit tests

thehappybug

I've left my feedback in multiple places.

Also, please create a separate issue for fixing the quality issues in ApiLogger if you do not intend to fix them in this PR and link it here. I see that you have it added to the .codeclimate.yaml ignore list.

packages/core-interfaces/package.json

packages/core/package.json

packages/core/src/logger/apiLogger.ts

packages/core-interfaces/src/logging.ts

MaryamAdnan3 · 2024-04-22T09:42:10Z

I've left my feedback in multiple places.

Also, please create a separate issue for fixing the quality issues in ApiLogger if you do not intend to fix them in this PR and link it here. I see that you have it added to the .codeclimate.yaml ignore list.

@thehappybug #165

…t accross languages

…nother access-control-allow-origin in headersToWhitelist

…use them in error-handling interceptor

thehappybug

Good work on finding the solution.

There are two minor changes requested.

packages/core/src/http/requestBuilder.ts

sonarqubecloud · 2024-04-23T14:34:59Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

MaryamAdnan3 and others added 11 commits April 7, 2024 08:16

basic logger implementation

1e6ee2c

improve design of logger builder

3ec0fc4

check for default configuration

d4b58d7

added new design for logger

778820c

adding formating changes.

ea50f60

logger interceptor logic to Api Logger

2e1174d

added core library suggestions

b47366b

removed custom logger provider

6bc642a

fixed compilation issue

8be7003

added changes to fix the import bug

f780a03

updated structure of params in Api logger

672e64c

haseeb-mhr added enhancement New feature or request good first issue Good for newcomers labels Apr 9, 2024

haseeb-mhr self-assigned this Apr 9, 2024

thehappybug reviewed Apr 9, 2024

View reviewed changes

Muhammad Haseeb and others added 13 commits April 9, 2024 17:06

changes to resolve the latest comments on PR.

cd508e2

added changes of Logger Interface

1153007

added changes for sructured logging

615e709

updated Guid generator function

ccd031d

added logging config into api logger

4fd56a3

style fixes

32294db

added finalized logging configuration structure

b8b7de7

fixed style in api logger

002f127

Some additional refactoring work

f1e0ed0

running style check

9635c83

fix style changes

4e01486

revert the responseValidationError

61e7a6f

some more refactoring in apiLogger to fix code climate reported issues

653d265

thehappybug requested changes Apr 16, 2024

View reviewed changes

update refactored code with tests

e80d9ba

MaryamAdnan3 and others added 3 commits April 17, 2024 12:46

Update apiLogger.test.ts

afc150c

modified customLogger and console logger behavior & added support for…

43cbd77

… maskSensitiveHeaders headers

Merge branch 'configurable-logger-implementation' of https://github.c…

f3778ed

…om/apimatic/apimatic-js-runtime into configurable-logger-implementation

thehappybug requested changes Apr 17, 2024

View reviewed changes

MaryamAdnan3 and others added 2 commits April 18, 2024 14:58

Expose a different interface for sdk logger options and logger option…

8a93670

…s used in APILogger

Implement logging options interfaces and utilities.

0a7960c

* mergeLoggingOptions provides a way for SDKs to safely override options while maintaining foward compatibility with future Core library releases. * PartialLoggingOptions interfaces can be used in SDK configuration interface.

MaryamAdnan3 and others added 5 commits April 19, 2024 10:13

update requesbuilder with feedback, clean more code in APILogger, fix…

e2fabd0

…ed vulnerability using regex

Add docblock comments for public methods interfaces

411ce39

added implementation of whitelist headers and convert apilLogger.test…

3ffa3cb

….ts tests to unit tests

disabling code climate for logger classes

63558a5

Update requestBuilder.test.ts

f230a5f

thehappybug requested changes Apr 22, 2024

View reviewed changes

MaryamAdnan3 added 3 commits April 22, 2024 13:08

remove sdk logging options as its not consumed anymore

e34f1f9

resolve PR comments

1498596

rename headerstoWhiteList to headerstoWhitelist

55ffed1

MaryamAdnan3 added 3 commits April 22, 2024 15:51

update string template in APILogger to make hardcoded names consisten…

cef07e1

…t accross languages

Update the string template for request and response logging and add a…

3783d7f

…nother access-control-allow-origin in headersToWhitelist

correct version update of core and core-interfaces

7101735

thehappybug previously approved these changes Apr 23, 2024

View reviewed changes

refactor error handling in RequestBuilder to collect error types and …

b0ed637

…use them in error-handling interceptor

MaryamAdnan3 dismissed thehappybug’s stale review via b0ed637 April 23, 2024 13:46

thehappybug requested changes Apr 23, 2024

View reviewed changes

packages/core/src/http/requestBuilder.ts Outdated Show resolved Hide resolved

packages/core/src/http/requestBuilder.ts Outdated Show resolved Hide resolved

resolve PR comments

7ca8f6d

thehappybug approved these changes Apr 23, 2024

View reviewed changes

MaryamAdnan3 merged commit 2b0a57a into master Apr 23, 2024
10 checks passed

MaryamAdnan3 self-assigned this Apr 23, 2024

asadali214 deleted the configurable-logger-implementation branch July 19, 2024 14:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(configureable-logger): add support of configurable logger #164

feat(configureable-logger): add support of configurable logger #164

haseeb-mhr commented Apr 9, 2024

thehappybug left a comment

thehappybug left a comment

thehappybug left a comment

thehappybug commented Apr 18, 2024

thehappybug left a comment

MaryamAdnan3 commented Apr 22, 2024 •

edited

Loading

thehappybug left a comment

sonarqubecloud bot commented Apr 23, 2024

feat(configureable-logger): add support of configurable logger #164

feat(configureable-logger): add support of configurable logger #164

Conversation

haseeb-mhr commented Apr 9, 2024

thehappybug left a comment

Choose a reason for hiding this comment

thehappybug left a comment

Choose a reason for hiding this comment

thehappybug left a comment

Choose a reason for hiding this comment

thehappybug commented Apr 18, 2024

thehappybug left a comment

Choose a reason for hiding this comment

MaryamAdnan3 commented Apr 22, 2024 • edited Loading

thehappybug left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Apr 23, 2024

Quality Gate passed

MaryamAdnan3 commented Apr 22, 2024 •

edited

Loading