Skip to content

Define log location; mask API credentials #69

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

Merged
merged 1 commit into from
Jul 18, 2023

Conversation

n7studios
Copy link
Contributor

Summary

Adds a debugLogFileLocation parameter to the class constructor, allowing developers to specify where the log file should be written to, instead of the default src/logs/debug.log, which may be public facing.

Masks the API Key and Secret in the log file if detected in the create_log() message.

Testing

  • testDebugEnabledWithCustomLogFile: Test that debug logging works when enabled, a custom debug log file and path is specified and an API call is made.
  • testDebugAPIKeyAndSecretAreMasked: Test that debug logging works when enabled and an API call is made, with the API Key and Secret masked in the log file.

Checklist

@n7studios n7studios added this to the 1.3.0 milestone Jul 17, 2023
@n7studios n7studios self-assigned this Jul 17, 2023
@n7studios n7studios requested review from a team, noelherrick and corydhmiller and removed request for a team July 17, 2023 13:35
@n7studios n7studios marked this pull request as ready for review July 17, 2023 13:35
@n7studios n7studios merged commit eda6d82 into master Jul 18, 2023
@n7studios n7studios deleted the log-destination-and-masking branch September 11, 2023 11:03
@n7studios n7studios mentioned this pull request Mar 20, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants