feat(server): add data collection from timezone and client hints header

Author: JeanMeijer

packages/analytics/src/server/client-hints.ts

@@ -0,0 +1,37 @@
+import type { AnalyticsEvent, IgnoredMetrics } from "./interfaces";
+
+export function parseViewportWidth(headers: Headers) {
+  const width = headers.get("Sec-CH-Viewport-Width") ?? headers.get("Viewport-Width");
+
+  return width ? Number.parseInt(width, 10) : undefined;
+}
+
+export function parseViewportHeight(headers: Headers) {
+  const height = headers.get("Sec-CH-Viewport-Height") ?? headers.get("Viewport-Height");
+  
+  return height ? Number.parseInt(height, 10) : undefined;
+}
+
+export function parseLanguage(headers: Headers) {
+  return headers.get("Sec-CH-Lang") ?? headers.get("Lang") ?? undefined;
+}
+
+export function parseTimezone(headers: Headers) {
+  return headers.get("X-Vercel-IP-Timezone") ?? headers.get("CloudFront-Viewer-Time-Zone") ?? undefined;
+}
+
+export function parseUserAgent(headers: Headers) {
+  return headers.get("User-Agent") ?? "";
+}
+
+export function parseHeaders(headers: Headers, ignoredMetrics: IgnoredMetrics) {
+  return {
+    ua: !ignoredMetrics.userAgent ? parseUserAgent(headers) : "",
+
+    viewport_width: !ignoredMetrics.viewportSize ? parseViewportWidth(headers) : undefined,
+    viewport_height: !ignoredMetrics.viewportSize ? parseViewportHeight(headers) : undefined,
+
+    language: !ignoredMetrics.language ? parseLanguage(headers) : undefined,
+    timezone: !ignoredMetrics.timezone ? parseTimezone(headers) : undefined,
+  } satisfies Partial<AnalyticsEvent>;
+}

packages/analytics/src/server/headers.ts

@@ -4,6 +4,7 @@ import { NextRequest } from "next/server";
 import type { AnalyticsEvent, AnalyticsPageview } from "./interfaces";
 import type { AnalyticsMetadata } from "../interfaces";
 import { isDoNotTrackEnabled } from "./utils";
+import { parseHeaders } from "./headers";
 
 type ServerContext = { request: Request } | { headers: Headers };
 
@@ -18,17 +19,17 @@ export async function trackEvent(
   eventName: string,
   options: TrackEventOptions,
 ) {
-  const headers =
-    "request" in options ? options.request.headers : options.headers;
-
   const hostname = options.hostname ?? process.env.SIMPLE_ANALYTICS_HOSTNAME;
 
   if (!hostname) {
     console.error("No hostname provided for Simple Analytics");
     return;
   }
 
+  const headers = "request" in options ? options.request.headers : options.headers;
+
   if (isDoNotTrackEnabled(headers) && !options.collectDnt) {
+    console.log("Do not track enabled, not tracking event");
     return;
   }
 
@@ -37,9 +38,11 @@ export async function trackEvent(
     hostname,
     event: eventName,
     metadata: options.metadata,
-    ua: headers.get("user-agent") ?? "",
+    ...(parseHeaders(headers, {})),
   };
 
+  console.log("Tracking event", payload);
+
   const response = await fetch("https://queue.simpleanalyticscdn.com/events", {
     method: "POST",
     headers: {
@@ -95,6 +98,7 @@ export async function trackPageview(options: TrackPageviewOptions) {
   }
 
   if (isDoNotTrackEnabled(headers) && !options.collectDnt) {
+    console.log("Do not track enabled, not tracking pageview");
     return;
   }
 
@@ -105,9 +109,11 @@ export async function trackPageview(options: TrackPageviewOptions) {
     hostname,
     event: "pageview",
     path,
-    ua: headers.get("user-agent") ?? "",
+    ...(parseHeaders(headers, {})),
   };
 
+  console.log("Tracking pageview", payload);
+
   const response = await fetch("https://queue.simpleanalyticscdn.com/events", {
     method: "POST",
     headers: {