-
Notifications
You must be signed in to change notification settings - Fork 92
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
Adds Request/Response Logging #220
Open
hayribakici
wants to merge
39
commits into
rinukkusu:master
Choose a base branch
from
hayribakici:#186_debug_tools
base: master
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
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
- for debugging purposes
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.
This PR fixes #186 and adds logging tools to inspect the interaction with the spotify-API.
In order to do this, a new class
SpotifyClient
has been added, that wraps theoauth2.Client
. This was necessary, since there are no interceptors out there for theoauth2.Client
. Thehttp_interceptor
would be a much cleaner solution for logging the requests and responses, however it is only compatible withhttp.Client
instances. Sinceoauth2.Client
is its ownhttp.BaseClient
implementation, there is no way around to build a customhttp.BaseClient
that logs the requests and responses, which this new class is doing.Regarding the logging, most of the code has been used from the interceptor_plus project, which has the MIT licence. I added some modifications regarding readability and code usability.
Example output (
simple
):The logging can be enabled by this new method
spotifyBase.enableLogging(bool enable, loggingDetail, logger)
. Furthermore, the amount of logging verbosity can be configured with theLoggingDetail
enum:simple
for basic request/response logging (url, statusCode), see above.medium
for basic request/response logging (url, statusCode), plus request/response headersfull
for basic request/response logging (url, statusCode), plus request/response headers and payloadOwn Logger: users of this library can use their own
logger
for e.g. storing the logs into a file. Per default, theDefaultSpotifyLogger
is used, which calls thelog()
function from thedart/developer
package. The logs are only visible in the debug console, when debugging a program. However, users can use their own logging method or library, simply by extending theabstract class SpotifyLogger
.