-
Notifications
You must be signed in to change notification settings - Fork 135
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fb6811c
commit 6cba535
Showing
14 changed files
with
338 additions
and
66 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
'@segment/analytics-next': minor | ||
'@segment/analytics-core': minor | ||
--- | ||
|
||
Add Client Hints API support |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
86 changes: 86 additions & 0 deletions
86
packages/browser/src/lib/client-hints/__tests__/index.test.ts
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
import { clientHints } from '..' | ||
import { UADataValues, UALowEntropyJSON } from '../interfaces' | ||
|
||
export const lowEntropyTestData: UALowEntropyJSON = { | ||
brands: [ | ||
{ | ||
brand: 'Google Chrome', | ||
version: '113', | ||
}, | ||
{ | ||
brand: 'Chromium', | ||
version: '113', | ||
}, | ||
{ | ||
brand: 'Not-A.Brand', | ||
version: '24', | ||
}, | ||
], | ||
mobile: false, | ||
platform: 'macOS', | ||
} | ||
|
||
export const highEntropyTestData: UADataValues = { | ||
architecture: 'x86', | ||
bitness: '64', | ||
} | ||
|
||
describe('Client Hints API', () => { | ||
beforeEach(() => { | ||
;(window.navigator as any).userAgentData = { | ||
...lowEntropyTestData, | ||
getHighEntropyValues: jest | ||
.fn() | ||
.mockImplementation((hints: string[]): Promise<UADataValues> => { | ||
let result = {} | ||
Object.entries(highEntropyTestData).forEach(([k, v]) => { | ||
if (hints.includes(k)) { | ||
result = { | ||
...result, | ||
[k]: v, | ||
} | ||
} | ||
}) | ||
return Promise.resolve({ | ||
...lowEntropyTestData, | ||
...result, | ||
}) | ||
}), | ||
toJSON: jest.fn(() => { | ||
return lowEntropyTestData | ||
}), | ||
} | ||
}) | ||
|
||
it('uses API when available', async () => { | ||
let userAgentData = await clientHints() | ||
expect(userAgentData).toEqual(lowEntropyTestData) | ||
;(window.navigator as any).userAgentData = undefined | ||
userAgentData = await clientHints() | ||
expect(userAgentData).toBe(undefined) | ||
}) | ||
|
||
it('always gets low entropy hints', async () => { | ||
const userAgentData = await clientHints() | ||
expect(userAgentData).toEqual(lowEntropyTestData) | ||
}) | ||
|
||
it('gets low entropy hints when client rejects high entropy promise', async () => { | ||
;(window.navigator as any).userAgentData = { | ||
...lowEntropyTestData, | ||
getHighEntropyValues: jest.fn(() => Promise.reject()), | ||
toJSON: jest.fn(() => lowEntropyTestData), | ||
} | ||
|
||
const userAgentData = await clientHints(['bitness']) | ||
expect(userAgentData).toEqual(lowEntropyTestData) | ||
}) | ||
|
||
it('gets specified high entropy hints', async () => { | ||
const userAgentData = await clientHints(['bitness']) | ||
expect(userAgentData).toEqual({ | ||
...lowEntropyTestData, | ||
bitness: '64', | ||
}) | ||
}) | ||
}) |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
import { HighEntropyHint, NavigatorUAData, UADataValues } from './interfaces' | ||
|
||
export async function clientHints( | ||
hints?: HighEntropyHint[] | ||
): Promise<UADataValues | undefined> { | ||
const userAgentData = (navigator as any).userAgentData as | ||
| NavigatorUAData | ||
| undefined | ||
|
||
if (!userAgentData) return undefined | ||
|
||
if (!hints) return userAgentData.toJSON() | ||
return userAgentData | ||
.getHighEntropyValues(hints) | ||
.catch(() => userAgentData.toJSON()) | ||
} |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
// https://wicg.github.io/ua-client-hints/#dictdef-navigatoruabrandversion | ||
export interface NavigatorUABrandVersion { | ||
readonly brand: string | ||
readonly version: string | ||
} | ||
|
||
// https://wicg.github.io/ua-client-hints/#dictdef-uadatavalues | ||
export interface UADataValues { | ||
readonly brands?: NavigatorUABrandVersion[] | ||
readonly mobile?: boolean | ||
readonly platform?: string | ||
readonly architecture?: string | ||
readonly bitness?: string | ||
readonly model?: string | ||
readonly platformVersion?: string | ||
/** @deprecated in favour of fullVersionList */ | ||
readonly uaFullVersion?: string | ||
readonly fullVersionList?: NavigatorUABrandVersion[] | ||
readonly wow64?: boolean | ||
} | ||
|
||
// https://wicg.github.io/ua-client-hints/#dictdef-ualowentropyjson | ||
export interface UALowEntropyJSON { | ||
readonly brands: NavigatorUABrandVersion[] | ||
readonly mobile: boolean | ||
readonly platform: string | ||
} | ||
|
||
// https://wicg.github.io/ua-client-hints/#navigatoruadata | ||
export interface NavigatorUAData extends UALowEntropyJSON { | ||
getHighEntropyValues(hints: HighEntropyHint[]): Promise<UADataValues> | ||
toJSON(): UALowEntropyJSON | ||
} | ||
|
||
export type HighEntropyHint = | ||
| 'architecture' | ||
| 'bitness' | ||
| 'model' | ||
| 'platformVersion' | ||
| 'uaFullVersion' | ||
| 'fullVersionList' | ||
| 'wow64' |
This file contains 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
Oops, something went wrong.