feat: unleash-interval header #236
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
Pull Request Test Coverage Report for Build 13585837720Details
💛 - Coveralls |
kwasniew
commented
Feb 28, 2025
| @@ -116,6 +116,7 @@ def info | |||
| { | |||
| 'appName': Unleash.configuration.app_name, | |||
| 'instanceId': Unleash.configuration.instance_id, | |||
| 'connectionId': Unleash.configuration.connection_id, | |||
There was a problem hiding this comment.
added to registration payload
kwasniew
commented
Feb 28, 2025
| @@ -23,6 +23,7 @@ class Configuration | |||
| :bootstrap_config, | |||
| :strategies, | |||
| :use_delta_api | |||
| attr_reader :connection_id | |||
There was a problem hiding this comment.
exposing as read only for metrics payload and registration payload
kwasniew
commented
Feb 28, 2025
| @@ -102,7 +103,7 @@ def set_defaults | |||
| self.project_name = nil | |||
| self.disable_client = false | |||
| self.disable_metrics = false | |||
| self.refresh_interval = 10 | |||
| self.refresh_interval = 15 | |||
kwasniew
commented
Feb 28, 2025
| @@ -23,6 +23,7 @@ def generate_report | |||
| 'specVersion': Unleash::CLIENT_SPECIFICATION_VERSION, | |||
| 'appName': Unleash.configuration.app_name, | |||
| 'instanceId': Unleash.configuration.instance_id, | |||
| 'connectionId': Unleash.configuration.connection_id, | |||
There was a problem hiding this comment.
metrics payload includes connectionId
kwasniew
commented
Feb 28, 2025
| @@ -37,7 +38,9 @@ def post | |||
| return | |||
| end | |||
|
|
|||
| response = Unleash::Util::Http.post(Unleash.configuration.client_metrics_uri, report.to_json) | |||
| headers = (Unleash.configuration.http_headers || {}).dup | |||
| headers.merge!({ 'UNLEASH-INTERVAL' => Unleash.configuration.metrics_interval.to_s }) | |||
There was a problem hiding this comment.
it was the best "seam" that I found for adding a new header without branching
There was a problem hiding this comment.
we need to change number to string
There was a problem hiding this comment.
I was also considering using header_overrides but I learned that they erase existing headers instead of merging
kwasniew
commented
Feb 28, 2025
| @@ -37,7 +37,9 @@ def fetch | |||
| Unleash.logger.debug "fetch()" | |||
| return if Unleash.configuration.disable_client | |||
|
|
|||
| response = Unleash::Util::Http.get(Unleash.configuration.fetch_toggles_uri, etag) | |||
| headers = (Unleash.configuration.http_headers || {}).dup | |||
| headers.merge!({ 'UNLEASH-INTERVAL' => Unleash.configuration.refresh_interval.to_s }) | |||
There was a problem hiding this comment.
this is another "seam"
kwasniew
commented
Feb 28, 2025
| @@ -12,10 +12,10 @@ def self.get(uri, etag = nil, headers_override = nil) | |||
| http.request(request) | |||
| end | |||
|
|
|||
| def self.post(uri, body) | |||
| def self.post(uri, body, headers_override = nil) | |||
There was a problem hiding this comment.
making it symmetrical with get
kwasniew
commented
Feb 28, 2025
| http = http_connection(uri) | ||
|
|
||
| request = Net::HTTP::Post.new(uri.request_uri, http_headers) | ||
| request = Net::HTTP::Post.new(uri.request_uri, http_headers(nil, headers_override)) |
There was a problem hiding this comment.
no etag for post, only headers_override
kwasniew
commented
Feb 28, 2025
| @@ -29,7 +29,8 @@ | |||
| 'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', | |||
| 'Content-Type' => 'application/json', | |||
| 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]", | |||
| 'Unleash-Sdk' => "unleash-client-ruby:#{Unleash::VERSION}" | |||
| 'Unleash-Sdk' => "unleash-client-ruby:#{Unleash::VERSION}", | |||
| 'Unleash-Interval' => '60' | |||
There was a problem hiding this comment.
test metrics interval reported correctly
kwasniew
commented
Feb 28, 2025
| @@ -56,7 +57,8 @@ | |||
| 'Unleash-Connection-Id' => fixed_uuid, | |||
| 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]", | |||
| 'Unleash-Sdk' => "unleash-client-ruby:#{Unleash::VERSION}", | |||
| 'X-Api-Key' => '123' | |||
| 'X-Api-Key' => '123', | |||
| 'Unleash-Interval' => '15' | |||
There was a problem hiding this comment.
test fetch toggles interval reported correctly
kwasniew
commented
Feb 28, 2025
| @@ -213,7 +213,8 @@ | |||
| yggdrasilVersion: anything, | |||
| specVersion: anything, | |||
| platformName: anything, | |||
| platformVersion: anything | |||
| platformVersion: anything, | |||
| connectionId: anything | |||
There was a problem hiding this comment.
test connectionId included in the registration payload
kwasniew
commented
Feb 28, 2025
| @@ -158,7 +159,8 @@ | |||
| yggdrasilVersion: anything, | |||
| specVersion: anything, | |||
| platformName: anything, | |||
| platformVersion: anything | |||
| platformVersion: anything, | |||
| connectionId: anything | |||
There was a problem hiding this comment.
test connectionId included in the metrics payload
sjaanus
approved these changes
Feb 28, 2025
sighphyre
approved these changes
Feb 28, 2025
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
refresh_intervalto be identical to other SDKs (15s for fetch toggles, it was 10s before despite docs claiming it's 15s)unleash-intervalheader to fetch toggles call and send metric call (they are different so can't share HTTP header setting)connectionIdto registration payload and send metrics payloadImportant files
Please check toggle_fetcher and metrics_reporter since I added "seams" in those 2 in order to inject different metrics interval headers.
Discussion points