docs: add breaking change documentation for server-core v0.10.0 UA parser #3576
Conversation
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
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=80&v=4){kind=small}
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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.
Description
Added a "Breaking Changes" section to the server-core documentation to document a user agent parser change in version 0.10.0. The new section explains that the default UA parser switches from a third-party library to a new experimental parser that offers better performance and memory usage, along with migration instructions for users who need the old behavior.
Best practice checklist
Critical Review Items
Version number accuracy: Confirm that 0.10.0 is the correct version for this breaking change (current codebase shows 0.9.4-rc.2509300136)
Default behavior change: Verify that the experimental parser actually becomes the default in 0.10.0 (current code shows
__experimental_ua_parsing_enableddefaults tofalse)API examples: Validate that the configuration syntax is correct for each language binding:
__experimental_ua_parsing_enabled: false__experimental_ua_parsing_enabled=False.setExperimentalUaParsingEnabled(false)Performance claims: Confirm the "faster and uses significantly less memory" claims are accurate
Context
This change was requested by @xinlili-statsig via Slack (#bot-devin-ai) to document a breaking change in the server-core SDK regarding the default user agent parser.
Link to Devin run: https://app.devin.ai/sessions/49c5711fc461409e92ab520a753c18ca
Requested by: @xinlili-statsig
Questions?
Reach out to Brock or Tore on Slack!