Hide sensitive info when inspecting client #517
Merged
+41
−0
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
samwaree
commented
Sep 13, 2024
lib/openai/client.rb
Outdated
| @@ -107,5 +107,17 @@ def beta(apis) | |||
| client.add_headers("OpenAI-Beta": apis.map { |k, v| "#{k}=#{v}" }.join(";")) | |||
| end | |||
| end | |||
|
|
|||
| def inspect | |||
| sensitive_attributes = %i[@access_token @organization_id @extra_headers] | |||
There was a problem hiding this comment.
I included extra_headers, since my thinking was this may contain other API keys and it is better to hide too much than potentially show something sensitive. Let me know if others disagree
|
Thanks @samwaree - would you say this is a breaking change? I tend towards not, surely nobody is relying on |
@alexrudall That's my thought as well, more of a bug fix/minor update since it's just hiding certain values that shouldn't be shown anyway |
alexrudall
reviewed
Sep 13, 2024
|
Thanks @samwaree ! |
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.
Updates the
.inspectmethod forOpenAI::Clientto obfuscate sensitive values by replace them with[REDACTED]. This should prevent accidental logging of API keys, etc.Resolves #513
All Submissions: