feat: client identification headers #224
Merged
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
kwasniew
commented
Jan 20, 2025
| @@ -54,6 +54,9 @@ def http_headers | |||
| 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]", | |||
| 'UNLEASH-INSTANCEID' => self.instance_id, | |||
| 'UNLEASH-APPNAME' => self.app_name, | |||
| 'X-UNLEASH-APPNAME' => self.app_name, | |||
| 'X-UNLEASH-CONNECTION-ID' => @connection_id, | |||
There was a problem hiding this comment.
we want this one to be private internal detail of each SDK
kwasniew
commented
Jan 20, 2025
| @@ -54,6 +54,9 @@ def http_headers | |||
| 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]", | |||
| 'UNLEASH-INSTANCEID' => self.instance_id, | |||
| 'UNLEASH-APPNAME' => self.app_name, | |||
| 'X-UNLEASH-APPNAME' => self.app_name, | |||
| 'X-UNLEASH-CONNECTION-ID' => @connection_id, | |||
| 'X-UNLEASH-SDK' => "unleash-ruby@#{Unleash::VERSION}", | |||
There was a problem hiding this comment.
common naming convention across SDKs
kwasniew
commented
Jan 20, 2025
| @@ -54,6 +54,9 @@ def http_headers | |||
| 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]", | |||
| 'UNLEASH-INSTANCEID' => self.instance_id, | |||
| 'UNLEASH-APPNAME' => self.app_name, | |||
| 'X-UNLEASH-APPNAME' => self.app_name, | |||
There was a problem hiding this comment.
this will replace UNLEASH-APPNAME over time
kwasniew
commented
Jan 20, 2025
| RSpec.describe Unleash::Client do | ||
| after do | ||
| WebMock.reset! | ||
| File.delete(Unleash.configuration.backup_file) if File.exist?(Unleash.configuration.backup_file) | ||
| end | ||
|
|
||
| it "Uses custom http headers when initializing client" do | ||
| fixed_uuid = "123e4567-e89b-12d3-a456-426614174000" | ||
| allow(SecureRandom).to receive(:uuid).and_return(fixed_uuid) |
There was a problem hiding this comment.
since we don't expose connection id we need to mock the generation
Pull Request Test Coverage Report for Build 12867886511Details
💛 - Coveralls |
sighphyre
approved these changes
Jan 20, 2025
lib/unleash/configuration.rb
Outdated
| @@ -87,6 +90,7 @@ def set_defaults | |||
| self.environment = 'default' | |||
| self.url = nil | |||
| self.instance_id = SecureRandom.uuid | |||
| @connection_id = SecureRandom.uuid | |||
There was a problem hiding this comment.
This is the dumbest comment I've ever left on a PR ever but the change in syntax here is a bit jarring. Any chance we can move this line either to the top of the bottom of this function?
Honestly I won't even be offended if you just ignore me
There was a problem hiding this comment.
It actually makes perfect sense to me. Had the same thought :) Moving it to the bottom
There was a problem hiding this comment.
Thank you! I appreciate you haha
rarruda
reviewed
Jan 20, 2025
There was a problem hiding this comment.
Mostly bike shedding, but since you ask:
- Any reasons why you use uppercase for the headers here in the Ruby SDK but lowercase in the node SDK? (IIRC the mocks ignore the case in the headers, but that doesn't mean that we should have them different across different SDKs, if the point is to standardize)
- Any links to any more formal docs/specs? I think a link to the PR in the node SDK is ok too, but would be even better if there was a link to something a tiny bit more formal.
- In an ideal world the commit message would include:
- the migration path between the headers (which header is going to be replacing which),
- the rationale ("standardization across SDKs" should suffice, but "client identification headers" is a bit on the opaque side for my taste).
- Ideally also add a link/hook to point 2. (either which commit in the node SDK is used as a base, or a link to the docs/spec).
But the code itself is quite sane and i enjoy nit-picking. So if you feel like merging as is, I don't frown for a moment either.
|
@rarruda Thanks so much for taking the time to review this PR.
|
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.
About the changes
This PR adds standardised client identification headers to the feature and metrics calls that the client makes to Unleash. The headers are:
x-unleash-appname: the name of the application that is using the client.UNLEASH-APPNAMEwill be deleted in another PR (expand/contract pattern)x-unleash-connection-id: an internal unique identifier for the current instance of the client generated by the built-in crypto libx-unleash-sdk: sdk information in the formatunleash-ruby@<version>following referenceunleash-node@<version>naming patternAll the headers are intended for the Unleash team so clients should not be affected.
The main use cases we have are:
Reference implementation: Unleash/unleash-client-node#690
Important files
Discussion points