refactor(server): improve structure

Author: JeanMeijer

packages/analytics/src/server/interfaces.ts

@@ -40,10 +40,10 @@ export interface IgnoredMetrics {
   language?: boolean | undefined;
 }
 
-export type ServerComponentSearchParamsProp = Record<string, string | string[] | undefined>;
+export type ServerContext = ServerContextWithRequest | ServerContextWithPath;
 
-export type ServerContextWithPath =
-  | { request: Request }
-  | { path: string; headers: Headers, searchParams?: Record<string, string | string[] | undefined> };
+export type ServerContextWithRequest = { request: Request };
 
-export type PageviewServerContext = { path: string; headers: Headers, searchParams: URLSearchParams };
+export type HeaderOnlyContext = { headers: Headers };
+
+export type ServerContextWithPath = { path: string; headers: Headers, searchParams?: Record<string, string | string[] | undefined> };

packages/analytics/src/server/simple-analytics.ts

@@ -1,19 +1,16 @@
 import "server-only";
 
-import type { AnalyticsEvent, AnalyticsPageview, ServerContextWithPath } from "./interfaces";
+import { AnalyticsEvent, AnalyticsPageview, HeaderOnlyContext, ServerContext } from "./interfaces";
 import type { AnalyticsMetadata } from "../interfaces";
-import { isDoNotTrackEnabled, parseServerContext } from "./utils";
+import { isDoNotTrackEnabled, parseRequest } from "./utils";
 import { parseHeaders } from "./headers";
 import { parseUtmParameters } from "./utm";
 
-type ServerContext = { request: Request } | { headers: Headers };
-
 type TrackEventOptions = {
-  path?: string | undefined;
   hostname?: string | undefined;
   collectDnt?: boolean | undefined;
   metadata?: AnalyticsMetadata;
-} & ServerContext;
+} & (ServerContext | HeaderOnlyContext);
 
 export async function trackEvent(
   eventName: string,
@@ -69,7 +66,7 @@ type TrackPageviewOptions = {
   hostname?: string | undefined;
   metadata?: AnalyticsMetadata;
   collectDnt?: boolean | undefined;
-} & ServerContextWithPath;
+} & ServerContext;
 
 export async function trackPageview(options: TrackPageviewOptions) {
   const hostname = options.hostname ?? process.env.SIMPLE_ANALYTICS_HOSTNAME;
@@ -84,7 +81,8 @@ export async function trackPageview(options: TrackPageviewOptions) {
     return;
   }
 
-  const { path, headers, searchParams } = parseServerContext(options);
+  const { path, searchParams } = "path" in options ? options : parseRequest(options.request);
+  const headers = "headers" in options ? options.headers : options.request.headers;
 
   if (isDoNotTrackEnabled(headers) && !options.collectDnt) {
     console.log("Do not track enabled, not tracking pageview");
@@ -101,7 +99,7 @@ export async function trackPageview(options: TrackPageviewOptions) {
     event: "pageview",
     path,
     ...(parseHeaders(headers, {})),
-    ...(parseUtmParameters(searchParams, { strictUtm: false })),
+    ...(searchParams ? parseUtmParameters(searchParams, { strictUtm: false }) : {}),
   };
 
   console.log("Tracking pageview", payload);

packages/analytics/src/server/utils.ts

@@ -1,67 +1,12 @@
-import { NextRequest } from "next/server";
-import type { PageviewServerContext, ServerContextWithPath, ServerComponentSearchParamsProp } from "./interfaces";
-
 export function isDoNotTrackEnabled(headers: Headers) {
   return headers.has("DNT") && headers.get("DNT") === "1";
 }
 
-function parseSearchParameters(params: ServerComponentSearchParamsProp | undefined) {
-  const searchParams = new URLSearchParams();
-
-  if (!params) {
-    return searchParams;
-  }
-
-  for (const [key, value] of Object.entries(params)) {
-    if (value === undefined) {
-      continue;
-    }
-
-    if (typeof value === "string") {
-      searchParams.append(key, value);
-      continue;
-    }
-
-  
-    for (const item of value) {
-      searchParams.append(key, item);
-    }
-  }
-
-  return searchParams;
-}
-
-export function parseServerContext(options: ServerContextWithPath): PageviewServerContext {
-  if ("request" in options) {
-    const searchParams = getSearchParameters(options.request);
-
-    return {
-      path: getPath(options.request),
-      headers: options.request.headers,
-      searchParams,
-    }
-  }
+export function parseRequest(request: Request) {
+  const url = new URL(request.url);
 
   return {
-    path: options.path,
-    headers: options.headers,
-    searchParams: parseSearchParameters(options.searchParams),
-  }
-}
-
-function getPath(request: Request) {
-  // When request is an NextRequest, the URL will already be parsed (see Next.js implementation)
-  if (request instanceof NextRequest) {
-    return request.nextUrl.pathname;
-  }
-
-  return new URL(request.url).pathname;
-}
-
-function getSearchParameters(request: Request) {
-  if (request instanceof NextRequest) {
-    return request.nextUrl.searchParams;
+    path: url.pathname,
+    searchParams: url.searchParams,
   }
-
-  return new URL(request.url).searchParams;
-}
+}

packages/analytics/src/server/utm.ts

@@ -24,14 +24,27 @@ interface UtmParameters {
   term?: string | undefined;
 }
 
-export function parseUtmParameters(searchParams: URLSearchParams, options: UtmOptions) {
+export function parseUtmParameters(searchParams: URLSearchParams | Record<string, string | string[] | undefined>, options: UtmOptions) {
   const params: UtmParameters = {};
 
-  for (const [name, value] of searchParams.entries()) {
+  if (searchParams instanceof URLSearchParams) {
+    for (const [name, value] of searchParams.entries()) {
+      const param = parseUtmParameter(name, options.strictUtm);
+
+      if (param) {
+        params[param] = value;
+      }
+    }
+
+    return params;
+  }
+
+  for (const name in searchParams) {
+    const value = searchParams[name];
     const param = parseUtmParameter(name, options.strictUtm);
 
     if (param) {
-      params[param] = value;
+      params[param] = Array.isArray(value) ? value[0] : value;
     }
   }