feat: added debug flag in the SuperTokenConfig in the init() for logging
#732
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for precious-marshmallow-968a81 canceled.
|
❌ Deploy Preview for astounding-pegasus-21c111 failed.
|
rishabhpoddar
requested changes
Oct 26, 2023
lib/ts/supertokens.ts
Outdated
| @@ -49,6 +50,9 @@ export default class SuperTokens { | |||
| telemetryEnabled: boolean; | |||
|
|
|||
| constructor(config: TypeInput) { | |||
| if (config.debug) { | |||
There was a problem hiding this comment.
- we also want it to work for with the env var like before (backwards compatibility)
- Doing implicit if is not a good idea. Make it
if (config.debug === true)
rishabhpoddar
requested changes
Oct 31, 2023
lib/ts/supertokens.ts
Outdated
| @@ -48,7 +48,16 @@ export default class SuperTokens { | |||
|
|
|||
| telemetryEnabled: boolean; | |||
|
|
|||
| debugEnabled: boolean; | |||
There was a problem hiding this comment.
this variable should not be required, and even if it is, it should be in the logger.ts file
There was a problem hiding this comment.
It was only used in the tests, removed it.
lib/ts/logger.ts
Outdated
| ); | ||
| console.log(); | ||
| } | ||
| debug(SUPERTOKENS_DEBUG_NAMESPACE)( |
There was a problem hiding this comment.
why aren't you checking for if (debug.enabled(SUPERTOKENS_DEBUG_NAMESPACE)) {?
There was a problem hiding this comment.
We already call debug.enable() when initialising the logger, so ideally this should always return true. Added this check, just for safety.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of change
debugflag in theinit(). Debug logs will be printed if this flag is set to true.DEBUG=com.supertokenswill continue to work.Related issues
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
Documentation changes
(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)
Checklist for important updates
coreDriverInterfaceSupported.jsonfile has been updated (if needed)lib/ts/version.tsfrontendDriverInterfaceSupported.jsonfile has been updated (if needed)package.jsonpackage-lock.jsonlib/ts/version.tsnpm run build-prettyrecipe/thirdparty/providers/configUtils.tsfile,createProviderfunction.git tag) in the formatvX.Y.Z, and then find the latest branch (git branch --all) whoseX.Yis greater than the latest released tag.add-ts-no-check.jsfile to include thatsomeFunc: function () {..}).Remaining TODOs for this PR