fix: set canonical User-Agent header format#476
Draft
gjtorikian wants to merge 1 commit intomainfrom
Draft
Conversation
Use the User-Agent format from the 6.x line:
`WorkOS; {engine}/{ruby_version}; {platform}; v{VERSION}`. The
7.0.0 release inadvertently shipped a different shape that no
longer conformed to WorkOS' canonical SDK User-Agent format.
Includes the Ruby engine name (e.g. "ruby", "jruby",
"truffleruby") via RUBY_ENGINE, which the 7.x format dropped.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or 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
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.
Summary
Sets the outgoing
User-Agentheader toWorkOS; {engine}/{ruby_version}; {platform}; v{VERSION}— the canonical WorkOS Ruby SDK format used through the 6.x line. The 7.0.0 release inadvertently shipped a different shape (workos-ruby/{VERSION} ruby/{ruby_version} ({platform})) that no longer conformed.The new format also includes the Ruby engine name via
RUBY_ENGINE, so traffic from JRuby and TruffleRuby is now distinguishable from MRI in theUser-Agentheader.Example UAs:
WorkOS; ruby/3.3.11; arm64-darwin25; v7.1.1WorkOS; jruby/9.4.0.0; java; v7.1.1WorkOS; truffleruby/24.0.0; arm64-darwin; v7.1.1Test plan
bundle exec rake test(870 runs, 4395 assertions, 0 failures)🤖 Generated with Claude Code