feat: add User-Agent header to all HTTP requests (DIS-41)#34
Open
feat: add User-Agent header to all HTTP requests (DIS-41)#34
Conversation
Add User-Agent: opensea-cli/<version> header to all requests made by OpenSeaClient. Version is dynamically read from package.json using createRequire. Updates both get() and post() methods and corresponding test assertions. Co-Authored-By: Chris K <ckorhonen@gmail.com>
Contributor
Original prompt from Chris K |
Contributor
🤖 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:
|
Co-Authored-By: Chris K <ckorhonen@gmail.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.
Add User-Agent header to all HTTP requests
Summary
Adds a
User-Agent: opensea-cli/<version>header to every HTTP request made byOpenSeaClient, enabling server-side traffic segmentation by channel (CLI vs MCP vs other consumers) in Datadog/analytics.package.jsonat module load time usingcreateRequire(standard ESM pattern to avoidrootDirissues with direct JSON imports)get()andpost()methodsConfidence: 🟢 High — small, well-scoped change. Lint, type-check, and all 151 tests pass locally.
Review & Testing Checklist for Human
createRequire("../package.json")resolves correctly afternpm run build— the relative path../package.jsonmust resolve fromdist/at runtime, not justsrc/. Run:npm run build && node -e "import('./dist/index.js').then(m => console.log('ok'))"to confirm no runtime import error. This is the primary risk since tests mockfetchand don't exercise the actualcreateRequirepath.Notes
expect.objectContainingto accommodate the new header without breaking if header order changes. This is marginally less strict than before./^opensea-cli\/\d+\.\d+\.\d+/to validate semver format rather than just a leading digit.