Skip to content

📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!

Client Hints support

Blue Mouseb6f9907ca428
diff --git a/backend/apps/cloud/src/analytics/analytics.controller.ts b/backend/apps/cloud/src/analytics/analytics.controller.ts
index e3d2cc7c0..d81af4530 100644
--- a/backend/apps/cloud/src/analytics/analytics.controller.ts
+++ b/backend/apps/cloud/src/analytics/analytics.controller.ts
@@ -27,7 +27,6 @@ import {
HttpException,
HttpStatus,
} from '@nestjs/common'
-import { UAParser } from '@ua-parser-js/pro-business'
import { OptionalJwtAccessTokenGuard } from '../auth/guards'
import { Auth, Public } from '../auth/decorators'
@@ -86,7 +85,6 @@ import {
MAX_METRICS_IN_VIEW,
ProjectViewCustomEventDto,
} from '../project/dto/create-project-view.dto'
-import { extensions } from './utils/ua-parser'
import { GetOverallStatsDto } from './dto/get-overall-stats.dto'
import { NoscriptDto } from './dto/noscript.dto'
import { LiveVisitorsDto } from './dto/live-visitors.dto'
@@ -1075,15 +1073,8 @@ export class AnalyticsController {
const { city, region, country } = getGeoDetails(ip, errorDTO.tz)
- const ua = UAParser(userAgent, extensions)
- const dv = ua.device.type || 'desktop'
- const br = ua.browser.name
- const brv = this.analyticsService.extractSoftwareVersion(
- ua.browser.version,
- ua.browser.name,
- )
- const os = ua.os.name
- const osv = this.analyticsService.extractSoftwareVersion(ua.os.version)
+ const { deviceType, browserName, browserVersion, osName, osVersion } =
+ await this.analyticsService.getRequestInformation(headers)
const { name, message, lineno, colno, filename } = errorDTO
@@ -1092,11 +1083,11 @@ export class AnalyticsController {
errorDTO.pid,
this.analyticsService.getHostFromOrigin(headers.origin),
errorDTO.pg,
- dv,
- br,
- brv,
- os,
- osv,
+ deviceType,
+ browserName,
+ browserVersion,
+ osName,
+ osVersion,
errorDTO.lc,
country,
region,
@@ -1186,15 +1177,8 @@ export class AnalyticsController {
const { city, region, country } = getGeoDetails(ip, eventsDTO.tz)
- const ua = UAParser(userAgent, extensions)
- const dv = ua.device.type || 'desktop'
- const br = ua.browser.name
- const brv = this.analyticsService.extractSoftwareVersion(
- ua.browser.version,
- ua.browser.name,
- )
- const os = ua.os.name
- const osv = this.analyticsService.extractSoftwareVersion(ua.os.version)
+ const { deviceType, browserName, browserVersion, osName, osVersion } =
+ await this.analyticsService.getRequestInformation(headers)
const [, psid] = await this.analyticsService.generateAndStoreSessionId(
eventsDTO.pid,
@@ -1208,11 +1192,11 @@ export class AnalyticsController {
this.analyticsService.getHostFromOrigin(headers.origin),
eventsDTO.ev,
eventsDTO.pg,
- dv,
- br,
- brv,
- os,
- osv,
+ deviceType,
+ browserName,
+ browserVersion,
+ osName,
+ osVersion,
eventsDTO.lc,
eventsDTO.ref,
eventsDTO.so,
@@ -1310,26 +1294,20 @@ export class AnalyticsController {
}
const { city, region, country } = getGeoDetails(ip, logDTO.tz)
- const ua = UAParser(userAgent, extensions)
- const dv = ua.device.type || 'desktop'
- const br = ua.browser.name
- const brv = this.analyticsService.extractSoftwareVersion(
- ua.browser.version,
- ua.browser.name,
- )
- const os = ua.os.name
- const osv = this.analyticsService.extractSoftwareVersion(ua.os.version)
+
+ const { deviceType, browserName, browserVersion, osName, osVersion } =
+ await this.analyticsService.getRequestInformation(headers)
const transformed = trafficTransformer(
psid,
logDTO.pid,
this.analyticsService.getHostFromOrigin(headers.origin),
logDTO.pg,
- dv,
- br,
- brv,
- os,
- osv,
+ deviceType,
+ browserName,
+ browserVersion,
+ osName,
+ osVersion,
logDTO.lc,
logDTO.ref,
logDTO.so,
@@ -1361,9 +1339,9 @@ export class AnalyticsController {
logDTO.pid,
this.analyticsService.getHostFromOrigin(headers.origin),
logDTO.pg,
- dv,
- br,
- brv,
+ deviceType,
+ browserName,
+ browserVersion,
country,
region,
city,
@@ -1440,26 +1418,20 @@ export class AnalyticsController {
await this.analyticsService.processInteractionSD(psid, logDTO.pid)
const { city, region, country } = getGeoDetails(ip)
- const ua = UAParser(userAgent, extensions)
- const dv = ua.device.type || 'desktop'
- const br = ua.browser.name
- const brv = this.analyticsService.extractSoftwareVersion(
- ua.browser.version,
- ua.browser.name,
- )
- const os = ua.os.name
- const osv = this.analyticsService.extractSoftwareVersion(ua.os.version)
+
+ const { deviceType, browserName, browserVersion, osName, osVersion } =
+ await this.analyticsService.getRequestInformation(headers)
const transformed = trafficTransformer(
psid,
logDTO.pid,
this.analyticsService.getHostFromOrigin(headers.origin),
null,
- dv,
- br,
- brv,
- os,
- osv,
+ deviceType,
+ browserName,
+ browserVersion,
+ osName,
+ osVersion,
null,
null,
null,
diff --git a/backend/apps/cloud/src/analytics/analytics.service.ts b/backend/apps/cloud/src/analytics/analytics.service.ts
index ba451c9b2..e43ab7307 100644
--- a/backend/apps/cloud/src/analytics/analytics.service.ts
+++ b/backend/apps/cloud/src/analytics/analytics.service.ts
@@ -101,6 +101,8 @@ import { ErrorDto } from './dto/error.dto'
import { GetPagePropertyMetaDto } from './dto/get-page-property-meta.dto'
import { ProjectViewCustomEventMetaValueType } from '../project/entity/project-view-custom-event.entity'
import { ProjectViewCustomEventDto } from '../project/dto/create-project-view.dto'
+import { UAParser } from '@ua-parser-js/pro-business'
+import { extensions } from './utils/ua-parser'
dayjs.extend(utc)
dayjs.extend(dayjsTimezone)
@@ -2757,6 +2759,21 @@ export class AnalyticsService {
return `${major}.${minor}`
}
+ async getRequestInformation(headers: any) {
+ const ua = await UAParser(headers, extensions).withClientHints()
+
+ return {
+ deviceType: ua.device.type || 'desktop',
+ browserName: ua.browser.name,
+ browserVersion: this.extractSoftwareVersion(
+ ua.browser.version,
+ ua.browser.name,
+ ),
+ osName: ua.os.name,
+ osVersion: this.extractSoftwareVersion(ua.os.version),
+ }
+ }
+
extractCaptchaChartData(result, x: string[]): any {
const count = Array(x.length).fill(0)
diff --git a/backend/apps/cloud/src/analytics/utils/ua-parser.ts b/backend/apps/cloud/src/analytics/utils/ua-parser.ts
index 0c9fd8087..fb2bb5c5e 100644
--- a/backend/apps/cloud/src/analytics/utils/ua-parser.ts
+++ b/backend/apps/cloud/src/analytics/utils/ua-parser.ts
@@ -5,8 +5,6 @@ const CUSTOM_BROWSERS = [
[UAParser.BROWSER.NAME, UAParser.BROWSER.VERSION],
]
-const extensions = {
+export const extensions = {
browser: CUSTOM_BROWSERS,
}
-
-export { extensions }
diff --git a/backend/apps/cloud/src/auth/auth.service.ts b/backend/apps/cloud/src/auth/auth.service.ts
index 884991798..c5567362d 100644
--- a/backend/apps/cloud/src/auth/auth.service.ts
+++ b/backend/apps/cloud/src/auth/auth.service.ts
@@ -12,7 +12,7 @@ import { genSalt, hash, compare } from 'bcrypt'
import { getCountry } from 'countries-and-timezones'
import { Auth } from 'googleapis'
import dayjs from 'dayjs'
-import { UAParser } from 'ua-parser-js'
+import { UAParser } from '@ua-parser-js/pro-business'
import _pick from 'lodash/pick'
import _split from 'lodash/split'
import _isEmpty from 'lodash/isEmpty'
@@ -249,7 +249,7 @@ export class AuthService {
}
private async getHeadersInfo(headers: unknown, ip: string) {
- const ua = UAParser(headers['user-agent'])
+ const ua = await UAParser(headers).withClientHints()
const browser = ua.browser.name || 'Unknown'
const device = ua.device.type || 'Desktop'
const os = ua.os.name || 'Unknown'
diff --git a/backend/apps/cloud/src/captcha/captcha.controller.ts b/backend/apps/cloud/src/captcha/captcha.controller.ts
index 362d01ae1..1235e2fa9 100644
--- a/backend/apps/cloud/src/captcha/captcha.controller.ts
+++ b/backend/apps/cloud/src/captcha/captcha.controller.ts
@@ -56,8 +56,6 @@ export class CaptchaController {
@Ip() reqIP,
): Promise<any> {
this.logger.log({ manualDTO: verifyDto }, 'POST /captcha/verify')
-
- const { 'user-agent': userAgent } = headers
// todo: add origin checks
const { code, hash, pid } = verifyDto
@@ -90,7 +88,7 @@ export class CaptchaController {
const ip = getIPFromHeaders(headers) || reqIP || ''
try {
- await this.captchaService.logCaptchaPass(pid, userAgent, timestamp, ip)
+ await this.captchaService.logCaptchaPass(pid, headers, timestamp, ip)
} catch (reason) {
this.logger.error(
`[CaptchaController -> verify] Failed to log captcha pass: ${reason}`,
diff --git a/backend/apps/cloud/src/captcha/captcha.service.ts b/backend/apps/cloud/src/captcha/captcha.service.ts
index 7e50397d8..85ee38c22 100644
--- a/backend/apps/cloud/src/captcha/captcha.service.ts
+++ b/backend/apps/cloud/src/captcha/captcha.service.ts
@@ -100,17 +100,24 @@ export class CaptchaService {
async logCaptchaPass(
pid: string,
- userAgent: string,
+ headers: string,
timestamp: number,
ip: string,
) {
- const ua = UAParser(userAgent)
- const dv = ua.device.type || 'desktop'
- const br = ua.browser.name
- const os = ua.os.name
+ const ua = await UAParser(headers).withClientHints()
+ const deviceType = ua.device.type || 'desktop'
+ const browserName = ua.browser.name
+ const osName = ua.os.name
const { country } = getGeoDetails(ip)
- const transformed = captchaTransformer(pid, dv, br, os, country, timestamp)
+ const transformed = captchaTransformer(
+ pid,
+ deviceType,
+ browserName,
+ osName,
+ country,
+ timestamp,
+ )
try {
await clickhouse.insert({
diff --git a/backend/apps/cloud/src/main.ts b/backend/apps/cloud/src/main.ts
index 3fd84254e..c420d3b10 100644
--- a/backend/apps/cloud/src/main.ts
+++ b/backend/apps/cloud/src/main.ts
@@ -49,6 +49,11 @@ async function bootstrap() {
res.header('Access-Control-Allow-Methods', 'GET,POST,PUT,DELETE,PATCH')
res.header('Access-Control-Allow-Headers', 'Authorization, *')
+ const getHighEntropyValues =
+ 'Sec-CH-UA-Full-Version-List, Sec-CH-UA-Mobile, Sec-CH-UA-Model, Sec-CH-UA-Platform, Sec-CH-UA-Platform-Version, Sec-CH-UA-Arch, Sec-CH-UA-Bitness, Sec-CH-UA-Form-Factors'
+ res.header('Accept-CH', getHighEntropyValues)
+ res.header('Critical-CH', getHighEntropyValues)
+
if (req.method === 'OPTIONS') {
return await res.sendStatus(204)
}
diff --git a/backend/apps/community/src/analytics/analytics.controller.ts b/backend/apps/community/src/analytics/analytics.controller.ts
index 1800bbb90..28b32567e 100644
--- a/backend/apps/community/src/analytics/analytics.controller.ts
+++ b/backend/apps/community/src/analytics/analytics.controller.ts
@@ -23,7 +23,6 @@ import {
Response,
} from '@nestjs/common'
import { ApiTags } from '@nestjs/swagger'
-import { UAParser } from '@ua-parser-js/pro-business'
import { OptionalJwtAccessTokenGuard } from '../auth/guards'
import { Auth, Public } from '../auth/decorators'
@@ -73,7 +72,6 @@ import {
trafficTransformer,
} from './utils/transformers'
import { MAX_METRICS_IN_VIEW } from '../project/dto/create-project-view.dto'
-import { extensions } from './utils/ua-parser'
import { GetOverallStatsDto } from './dto/get-overall-stats.dto'
import { GetHeartbeatStatsDto } from './dto/get-heartbeat-stats'
import { LiveVisitorsDto } from './dto/live-visitors.dto'
@@ -891,15 +889,8 @@ export class AnalyticsController {
}
}
- const ua = UAParser(userAgent, extensions)
- const dv = ua.device.type || 'desktop'
- const br = ua.browser.name
- const brv = this.analyticsService.extractSoftwareVersion(
- ua.browser.version,
- ua.browser.name,
- )
- const os = ua.os.name
- const osv = this.analyticsService.extractSoftwareVersion(ua.os.version)
+ const { deviceType, browserName, browserVersion, osName, osVersion } =
+ await this.analyticsService.getRequestInformation(headers)
const { city, region, country } = getGeoDetails(ip, eventsDTO.tz)
@@ -915,11 +906,11 @@ export class AnalyticsController {
this.analyticsService.getHostFromOrigin(headers.origin),
eventsDTO.ev,
eventsDTO.pg,
- dv,
- br,
- brv,
- os,
- osv,
+ deviceType,
+ browserName,
+ browserVersion,
+ osName,
+ osVersion,
eventsDTO.lc,
eventsDTO.ref,
eventsDTO.so,
@@ -1017,26 +1008,19 @@ export class AnalyticsController {
const { city, region, country } = getGeoDetails(ip, logDTO.tz)
- const ua = UAParser(userAgent, extensions)
- const dv = ua.device.type || 'desktop'
- const br = ua.browser.name
- const brv = this.analyticsService.extractSoftwareVersion(
- ua.browser.version,
- ua.browser.name,
- )
- const os = ua.os.name
- const osv = this.analyticsService.extractSoftwareVersion(ua.os.version)
+ const { deviceType, browserName, browserVersion, osName, osVersion } =
+ await this.analyticsService.getRequestInformation(headers)
const transformed = trafficTransformer(
psid,
logDTO.pid,
this.analyticsService.getHostFromOrigin(headers.origin),
logDTO.pg,
- dv,
- br,
- brv,
- os,
- osv,
+ deviceType,
+ browserName,
+ browserVersion,
+ osName,
+ osVersion,
logDTO.lc,
logDTO.ref,
logDTO.so,
@@ -1068,9 +1052,9 @@ export class AnalyticsController {
logDTO.pid,
this.analyticsService.getHostFromOrigin(headers.origin),
logDTO.pg,
- dv,
- br,
- brv,
+ deviceType,
+ browserName,
+ browserVersion,
country,
region,
city,
@@ -1145,15 +1129,8 @@ export class AnalyticsController {
await this.analyticsService.processInteractionSD(psid, logDTO.pid)
- const ua = UAParser(userAgent, extensions)
- const dv = ua.device.type || 'desktop'
- const br = ua.browser.name
- const brv = this.analyticsService.extractSoftwareVersion(
- ua.browser.version,
- ua.browser.name,
- )
- const os = ua.os.name
- const osv = this.analyticsService.extractSoftwareVersion(ua.os.version)
+ const { deviceType, browserName, browserVersion, osName, osVersion } =
+ await this.analyticsService.getRequestInformation(headers)
const { city, region, country } = getGeoDetails(ip, null)
@@ -1162,11 +1139,11 @@ export class AnalyticsController {
logDTO.pid,
this.analyticsService.getHostFromOrigin(headers.origin),
null,
- dv,
- br,
- brv,
- os,
- osv,
+ deviceType,
+ browserName,
+ browserVersion,
+ osName,
+ osVersion,
null,
null,
null,
@@ -1427,15 +1404,8 @@ export class AnalyticsController {
const { city, region, country } = getGeoDetails(ip, errorDTO.tz)
- const ua = UAParser(userAgent, extensions)
- const dv = ua.device.type || 'desktop'
- const br = ua.browser.name
- const brv = this.analyticsService.extractSoftwareVersion(
- ua.browser.version,
- ua.browser.name,
- )
- const os = ua.os.name
- const osv = this.analyticsService.extractSoftwareVersion(ua.os.version)
+ const { deviceType, browserName, browserVersion, osName, osVersion } =
+ await this.analyticsService.getRequestInformation(headers)
const { name, message, lineno, colno, filename } = errorDTO
@@ -1444,11 +1414,11 @@ export class AnalyticsController {
errorDTO.pid,
this.analyticsService.getHostFromOrigin(headers.origin),
errorDTO.pg,
- dv,
- br,
- brv,
- os,
- osv,
+ deviceType,
+ browserName,
+ browserVersion,
+ osName,
+ osVersion,
errorDTO.lc,
country,
region,
diff --git a/backend/apps/community/src/analytics/analytics.service.ts b/backend/apps/community/src/analytics/analytics.service.ts
index 7f208cad6..4a19545c7 100644
--- a/backend/apps/community/src/analytics/analytics.service.ts
+++ b/backend/apps/community/src/analytics/analytics.service.ts
@@ -93,6 +93,8 @@ import { ErrorDto } from './dto/error.dto'
import { GetPagePropertyMetaDto } from './dto/get-page-property-meta.dto'
import { ProjectViewCustomEventMetaValueType } from '../project/entity/project-view-custom-event.entity'
import { ProjectViewCustomEventDto } from '../project/dto/create-project-view.dto'
+import { UAParser } from '@ua-parser-js/pro-business'
+import { extensions } from './utils/ua-parser'
dayjs.extend(utc)
dayjs.extend(dayjsTimezone)
@@ -2565,6 +2567,21 @@ export class AnalyticsService {
return `${major}.${minor}`
}
+ async getRequestInformation(headers: any) {
+ const ua = await UAParser(headers, extensions).withClientHints()
+
+ return {
+ deviceType: ua.device.type || 'desktop',
+ browserName: ua.browser.name,
+ browserVersion: this.extractSoftwareVersion(
+ ua.browser.version,
+ ua.browser.name,
+ ),
+ osName: ua.os.name,
+ osVersion: this.extractSoftwareVersion(ua.os.version),
+ }
+ }
+
async groupErrorsByTimeBucket(
timeBucket: TimeBucketType,
from: string,
diff --git a/backend/apps/community/src/analytics/utils/ua-parser.ts b/backend/apps/community/src/analytics/utils/ua-parser.ts
index 0c9fd8087..fb2bb5c5e 100644
--- a/backend/apps/community/src/analytics/utils/ua-parser.ts
+++ b/backend/apps/community/src/analytics/utils/ua-parser.ts
@@ -5,8 +5,6 @@ const CUSTOM_BROWSERS = [
[UAParser.BROWSER.NAME, UAParser.BROWSER.VERSION],
]
-const extensions = {
+export const extensions = {
browser: CUSTOM_BROWSERS,
}
-
-export { extensions }
diff --git a/backend/apps/community/src/main.ts b/backend/apps/community/src/main.ts
index f00db231b..8dab4ada1 100644
--- a/backend/apps/community/src/main.ts
+++ b/backend/apps/community/src/main.ts
@@ -41,6 +41,11 @@ async function bootstrap() {
res.header('Access-Control-Allow-Methods', 'GET,POST,PUT,DELETE,PATCH')
res.header('Access-Control-Allow-Headers', 'Authorization, *')
+ const getHighEntropyValues =
+ 'Sec-CH-UA-Full-Version-List, Sec-CH-UA-Mobile, Sec-CH-UA-Model, Sec-CH-UA-Platform, Sec-CH-UA-Platform-Version, Sec-CH-UA-Arch, Sec-CH-UA-Bitness, Sec-CH-UA-Form-Factors'
+ res.header('Accept-CH', getHighEntropyValues)
+ res.header('Critical-CH', getHighEntropyValues)
+
if (req.method === 'OPTIONS') {
return await res.sendStatus(204)
}
diff --git a/backend/package-lock.json b/backend/package-lock.json
index f4b556ee1..c0f75d63b 100644
--- a/backend/package-lock.json
+++ b/backend/package-lock.json
@@ -86,7 +86,6 @@
"@types/node": "^22.14.1",
"@types/nodemailer": "^6.4.17",
"@types/passport-jwt": "^4.0.1",
- "@types/ua-parser-js": "^0.7.39",
"@typescript-eslint/eslint-plugin": "^8.30.1",
"@typescript-eslint/parser": "^8.30.1",
"eslint": "^9.24.0",
@@ -3367,13 +3366,6 @@
"@types/node": "*"
}
},
- "node_modules/@types/ua-parser-js": {
- "version": "0.7.39",
- "resolved": "https://registry.npmjs.org/@types/ua-parser-js/-/ua-parser-js-0.7.39.tgz",
- "integrity": "sha512-P/oDfpofrdtF5xw433SPALpdSchtJmY7nsJItf8h3KXqOslkbySh8zq4dSWXH2oTjRvJ5PczVEoCZPow6GicLg==",
- "dev": true,
- "license": "MIT"
- },
"node_modules/@types/validator": {
"version": "13.15.0",
"resolved": "https://registry.npmjs.org/@types/validator/-/validator-13.15.0.tgz",
diff --git a/backend/package.json b/backend/package.json
index 607b3b56f..02dbdedd6 100644
--- a/backend/package.json
+++ b/backend/package.json
@@ -109,7 +109,6 @@
"@types/node": "^22.14.1",
"@types/nodemailer": "^6.4.17",
"@types/passport-jwt": "^4.0.1",
- "@types/ua-parser-js": "^0.7.39",
"@typescript-eslint/eslint-plugin": "^8.30.1",
"@typescript-eslint/parser": "^8.30.1",
"eslint": "^9.24.0",