Introduce Client Hints API #864
Conversation
🦋 Changeset detectedLatest commit: 0df5553 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
|
||
| /** | ||
| * Array of high entropy Client Hints to request. These may be rejected by the user agent - only required hints should be requested. | ||
| * @return {Object} Object containing low entropy hints and successfully resolved high entropy hints |
There was a problem hiding this comment.
These jsdoc comments seem out of place :-)
There was a problem hiding this comment.
Oh you mentioned wanting a doc string and I thought you meant for this interface 😅 which did you mean?
There was a problem hiding this comment.
Oh, I see what you did. The docstring goes in the InitOptions interface, above the specific setting.
|
|
||
| // https://wicg.github.io/ua-client-hints/#navigatoruadata | ||
| export interface NavigatorUAData extends UALowEntropyJSON { | ||
| getHighEntropyValues(hints: string[]): Promise<UADataValues> |
There was a problem hiding this comment.
Should we use HighEntropyHint type here?
|
Just remembered, we should document this new userAgentData object like we do our other reserved properties in the public docs. |
| @@ -84,6 +85,10 @@ export function segmentio( | |||
| ? batch(apiHost, deliveryStrategy.config) | |||
| : standard(deliveryStrategy?.config as StandardDispatcherConfig) | |||
|
|
|||
| const userAgentData = await clientHints( | |||
There was a problem hiding this comment.
Thoughts on wrapping this in a try/catch?
You've got good error handling in clientHints already - my paranoia stems from the whole client hints API still being marked experimental, and safari/firefox haven't implemented it yet. My fear is they expose a partial implementation without toJSON (I think super unlikely scenario but a failure would mean the segment plugin fails to load which is pretty critical)
This PR introduces the Client Hints API. We will always request the low entropy hints, but each high entropy hint will only be requested as set in the options.
For example,
AnalyticsBrowser.load( ..., { highEntropyValues: ['bitness', 'architecture', 'model', 'platformVersion', 'fullVersionList'] } )Would populate
context.userAgentDatawith something like{ "architecture": "x86", "bitness": "64", "brands": [ { "brand": "Google Chrome", "version": "113" }, { "brand": "Chromium", "version": "113" }, { "brand": "Not-A.Brand", "version": "24" } ], "fullVersionList": [ { "brand": "Google Chrome", "version": "113.0.5672.92" }, { "brand": "Chromium", "version": "113.0.5672.92" }, { "brand": "Not-A.Brand", "version": "24.0.0.0" } ], "mobile": false, "model": "", "platform": "macOS", "platformVersion": "13.1.0" }[] I've included a changeset (psst. run
yarn changeset. Read about changesets here).