feat: Custom user agent enhancement for api-rest #11457
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -382,7 +400,10 @@ | |||
| await api.get('apiName', '/items', init); | |||
| const expectedParams = { | |||
| data: null, | |||
| headers: { Authorization: 'apikey' }, | |||
| headers: { | |||
| Authorization: 'apikey', | |||
Check failure
Code scanning / CodeQL
Hard-coded credentials
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. @@ Coverage Diff @@
## feat/user-agent-enhancements/main #11457 +/- ##
=====================================================================
+ Coverage 83.14% 83.15% +0.01%
=====================================================================
Files 260 260
Lines 20429 20437 +8
Branches 4402 4400 -2
=====================================================================
+ Hits 16985 16995 +10
+ Misses 3158 3156 -2
Partials 286 286
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
| Get = '2', | ||
| Post = '3', | ||
| Put = '4', | ||
| Patch = '5', | ||
| Del = '6', | ||
| Head = '7', |
There was a problem hiding this comment.
Non-blocker, but I should have asked on previous PR: Is there a ref link we can include from which these numbers originate? (And against which they can be validated?) Or, is this the canonical source?
There was a problem hiding this comment.
This will be an after-release task, we are setting the canon, but there will be a source of truth external to this. We are just the first library on this.
| let libraryHeaders = {}; | ||
|
|
||
| if (Platform.isReactNative) { | ||
| const userAgent = Platform.userAgent || 'aws-amplify/0.1.x'; | ||
| libraryHeaders = { | ||
| 'User-Agent': userAgent, | ||
| }; | ||
| } | ||
| const libraryHeaders = { | ||
| [USER_AGENT_HEADER]: getAmplifyUserAgentString( | ||
| init.customUserAgentDetails | ||
| ), | ||
| }; |
| return this._restApi.head( | ||
| apiName, | ||
| path, | ||
| this.getInitWithCustomUserAgentDetails(init, ApiAction.Head) |
There was a problem hiding this comment.
Somewhat of a verbose function. Would it be simpler and more readable to separate the object merging from the user agent construction?
{...init, ...this.userAgentFor(ApiAction.Head))Or
this.mergeInit(init, this.userAgentFor(ApiAction.Head))Or similar?
Not even remotely a blocker. Just pondering "aloud" on this one.
Description of changes
Custom user agent enhancement for api-rest
Description of how you validated changes
Test improvements to the API category.
This testing doesn't confirm inclusion in the client, which I will verify manually. Test augmented in
api-restto cover passing UserAgentDetails out to the client call header.Checklist
yarn testpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.