-
Notifications
You must be signed in to change notification settings - Fork 101
feat(SDK-2217): add logger with loglevel support #1005
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
Open
JagadeeshKaricherla-branch
wants to merge
3
commits into
main
Choose a base branch
from
feature/add-log-level
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| 'use strict'; | ||
| goog.provide('Logger'); | ||
| // jscs:disable validateIndentation | ||
| /** | ||
| * @constructor | ||
| */ | ||
|
|
||
| Logger = function() { | ||
| /** | ||
| * @private | ||
| * @type {string} | ||
| */ | ||
| this.level_ = 'error'; | ||
| this.levelsOrdered = [ 'verbose', 'info', 'warn', 'error', 'none' ]; | ||
| }; | ||
|
|
||
| /** | ||
| * Sets the logging level. | ||
| * @param {string} level - The logging level to set. | ||
| */ | ||
| Logger.prototype.setLevel = function(level) { | ||
| if (this.levelsOrdered.indexOf(level) !== -1) { | ||
| this.level_ = level; | ||
| } | ||
| else { | ||
| console.error(`Invalid log level: ${level}`); | ||
gdeluna-branch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * Logs a message to the console if the log level allows it. | ||
| * @param {string} level - The logging level of the message. | ||
| * @param {...*} args - The message to log. | ||
| */ | ||
| Logger.prototype.log = function(level) { | ||
| var args = Array.prototype.slice.call(arguments, 1); | ||
| if (this.shouldLog(level)) { | ||
| switch (level) { | ||
| case 'info': | ||
JagadeeshKaricherla-branch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| this.logInfo_(args); | ||
| break; | ||
| case 'warn': | ||
| this.logWarning_(args); | ||
| break; | ||
| case 'error': | ||
| this.logError_(args); | ||
| break; | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * Checks if a message with the given level should be logged. | ||
| * @private | ||
| * @param {string} level - The logging level of the message. | ||
| * @return {boolean} True if the message should be logged, false otherwise. | ||
| */ | ||
| Logger.prototype.shouldLog = function(level) { | ||
| if (this.level_ === 'none') { | ||
| return false; | ||
| } | ||
| let currentLevelIndex = this.levelsOrdered.indexOf(this.level_); | ||
| let logLevelIndex = this.levelsOrdered.indexOf(level); | ||
| return logLevelIndex >= currentLevelIndex; | ||
| }; | ||
|
|
||
| /** | ||
| * Logs an info message to the console. | ||
| * @private | ||
| * @param {Array} args - The message to log. | ||
| */ | ||
| Logger.prototype.logInfo_ = function(args) { | ||
| console.info.apply(console, args); | ||
| }; | ||
|
|
||
| /** | ||
| * Logs a warning message to the console. | ||
| * @private | ||
| * @param {Array} args - The message to log. | ||
| */ | ||
| Logger.prototype.logWarning_ = function(args) { | ||
| console.warn.apply(console, args); | ||
| }; | ||
|
|
||
| /** | ||
| * Logs an error message to the console. | ||
| * @private | ||
| * @param {Array} args - The message to log. | ||
| */ | ||
| Logger.prototype.logError_ = function(args) { | ||
| console.error.apply(console, args); | ||
| }; | ||
| // jscs:enable validateIndentation | ||
|
|
||
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is a wrapper over the native
console, should we include a tag or namespace likeBranchSDK, so that messages emitted from this logger are easily filterable?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
something like
BranchSDK::<error message>?