@growthbook/edge-utils 0.2.4 → 0.2.6

package/dist/types.d.ts

@@ -11,6 +11,8 @@ export interface Config {
     forwardProxyHeaders: boolean;
     useDefaultContentType: boolean;
     processTextHtmlOnly: boolean;
+    autoInflate: boolean;
+    nocacheOrigin: boolean;
     environment: string;
     maxPayloadSize?: string;
     routes?: Route[];
@@ -21,6 +23,7 @@ export interface Config {
     runCrossOriginUrlRedirectExperiments: ExperimentRunEnvironment;
     injectRedirectUrlScript: boolean;
     maxRedirects: number;
+    experimentUrlTargeting?: ExperimentUrlTargeting;
     scriptInjectionPattern: string;
     disableInjections: boolean;
     enableStreaming: boolean;
@@ -36,6 +39,7 @@ export interface Config {
         clientKey: string;
         headers?: Record<string, string>;
     }) => Promise<any>;
+    emitTraceHeaders?: boolean;
     apiHost: string;
     clientKey: string;
     decryptionKey?: string;
@@ -51,12 +55,16 @@ export interface Config {
     skipAutoAttributes: boolean;
 }
 export type ExperimentRunEnvironment = "everywhere" | "edge" | "browser" | "skip";
+export type ExperimentUrlTargeting = "request" | "origin";
+export type FetchOptions = {
+    additionalHeaders?: Record<string, any>;
+};
 export interface Helpers<Req, Res> {
     getRequestURL: (req: Req) => string;
     getRequestMethod: (req: Req) => string;
     getRequestHeader?: (req: Req, key: string) => string | undefined;
     sendResponse: (ctx: Context<Req, Res>, res?: Res, headers?: Record<string, any>, body?: string, cookies?: Record<string, string>, status?: number) => unknown;
-    fetch: (ctx: Context<Req, Res>, url: string, req: Req) => Promise<Res>;
+    fetch: (ctx: Context<Req, Res>, url: string, req: Req, options?: FetchOptions) => Promise<Res>;
     proxyRequest: (ctx: Context<Req, Res>, req: Req, res?: Res, next?: any) => Promise<unknown>;
     getCookie?: (req: Req, key: string) => string;
     setCookie?: (res: Res, key: string, value: string) => void;
@@ -68,6 +76,7 @@ export type BaseHookParams<Req, Res> = {
     next?: any;
     requestUrl: string;
     originUrl: string;
+    requestCount: number;
 };
 export type OnRouteParams<Req, Res> = BaseHookParams<Req, Res> & {
     route: Route;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@growthbook/edge-utils",
   "description": "Edge worker base app",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "main": "dist/index.js",
   "license": "MIT",
   "repository": {
@@ -19,7 +19,7 @@
     "dev": "node scripts/generate-sdk-wrapper.js && tsc --watch"
   },
   "dependencies": {
-    "@growthbook/growthbook": "^1.4.1",
+    "@growthbook/growthbook": "^1.6.1",
     "node-html-parser": "^7.0.1",
     "pako": "^2.1.0"
   },

package/src/app.ts

@@ -5,7 +5,17 @@ import {
   setPolyfills,
   StickyBucketService
 } from "@growthbook/growthbook";
-import { Context } from "./types";
+import {
+  BaseHookParams,
+  Context,
+  OnRouteParams,
+  OnUserAttributesParams,
+  OnGrowthBookInitParams,
+  OnBeforeOriginFetchParams,
+  OnOriginFetchParams,
+  OnBodyReadyParams,
+  OnBeforeResponseParams
+} from "./types";
 import { getUserAttributes } from "./attributes";
 import { getCspInfo, injectScript } from "./inject";
 import { applyDomMutations } from "./domMutations";
@@ -42,9 +52,20 @@ export async function edgeApp<Req, Res>(
   const setRespCookie = (key: string, value: string) => {
     respCookies[key] = value;
   };
+
+  // Loop check
+  const requestCount = parseInt(context.helpers?.getRequestHeader?.(req, "x-gb-request-count") || "0") + 1;
+  if (requestCount > 1) {
+    console.error("Edge request loop detected. Count: " + requestCount, requestUrl);
+  }
+  if (requestCount > context.config.maxRedirects) {
+    throw new Error("Edge request loop: max requests reached: " + requestCount);
+  }
+
   // Initial hook:
   let hookResp: Res | undefined | void;
-  hookResp = await context?.hooks?.onRequest?.({ context, req, res, next, requestUrl, originUrl });
+  let onRequestParams: BaseHookParams<Req, Res> = { context, req, res, next, requestUrl, originUrl, requestCount };
+  hookResp = await context?.hooks?.onRequest?.(onRequestParams);
   if (hookResp) return hookResp;
 
   // DOM mutations
@@ -72,7 +93,8 @@ export async function edgeApp<Req, Res>(
     return context.helpers.proxyRequest(context, req, res, next);
   }
   // Custom route behavior via hook:
-  hookResp = await context?.hooks?.onRoute?.({ context, req, res, next, requestUrl, originUrl, route });
+  const onRouteParams: OnRouteParams<Req, Res> = { ...onRequestParams, route };
+  hookResp = await context?.hooks?.onRoute?.(onRouteParams);
   if (hookResp) return hookResp;
 
   /**
@@ -81,7 +103,8 @@ export async function edgeApp<Req, Res>(
   const attributes = getUserAttributes(context, req, requestUrl, setRespCookie);
 
   // Hook to allow enriching user attributes, etc
-  hookResp = await context?.hooks?.onUserAttributes?.({ context, req, res, next, requestUrl, originUrl, route, attributes });
+  const onUserAttributesParams: OnUserAttributesParams<Req, Res> = { ...onRouteParams, attributes };
+  hookResp = await context?.hooks?.onUserAttributes?.(onUserAttributesParams);
   if (hookResp) return hookResp;
 
   /**
@@ -116,7 +139,7 @@ export async function edgeApp<Req, Res>(
       return () => {
       };
     },
-    url: requestUrl,
+    url: context.config.experimentUrlTargeting === "origin" ? originUrl: requestUrl,
     disableVisualExperiments: ["skip", "browser"].includes(
       context.config.runVisualEditorExperiments,
     ),
@@ -136,7 +159,8 @@ export async function edgeApp<Req, Res>(
   });
 
   // Hook to perform any custom logic given the initialized SDK
-  hookResp = await context?.hooks?.onGrowthbookInit?.({ context, req, res, next, requestUrl, originUrl, route, attributes, growthbook });
+  const onGrowthbookInitParams: OnGrowthBookInitParams<Req, Res> = { ...onUserAttributesParams, growthbook };
+  hookResp = await context?.hooks?.onGrowthbookInit?.(onGrowthbookInitParams);
   if (hookResp) return hookResp;
 
   /**
@@ -147,14 +171,15 @@ export async function edgeApp<Req, Res>(
     req,
     setRespCookie,
     growthbook,
-    previousUrl: requestUrl,
+    previousUrl: context.config.experimentUrlTargeting === "origin" ? originUrl : requestUrl,
     resetDomChanges,
     setPreRedirectChangeIds: setPreRedirectChangeIds,
   });
   originUrl = getOriginUrl(context, redirectRequestUrl, redirectRequestUrl !== requestUrl);
 
   // Pre-origin-fetch hook (after redirect logic):
-  hookResp = await context?.hooks?.onBeforeOriginFetch?.({ context, req, res, next, requestUrl, redirectRequestUrl, originUrl, route, attributes, growthbook });
+  const onBeforeOriginFetchParams: OnBeforeOriginFetchParams<Req, Res> = { ...onGrowthbookInitParams, redirectRequestUrl, originUrl };
+  hookResp = await context?.hooks?.onBeforeOriginFetch?.(onBeforeOriginFetchParams);
   if (hookResp) return hookResp;
 
   /**
@@ -165,6 +190,12 @@ export async function edgeApp<Req, Res>(
       context,
       originUrl,
       req,
+      context.config.emitTraceHeaders ? {
+        additionalHeaders: {
+          "x-gb-request-count": ("" + requestCount),
+          "x-gbuuid": growthbook.getAttributes()?.[context.config.uuidKey],
+        }
+      } : undefined,
     ) as OriginResponse & Res;
   } catch (e) {
     console.error(e);
@@ -172,12 +203,12 @@ export async function edgeApp<Req, Res>(
   const originStatus = originResponse ? parseInt(originResponse.status ? originResponse.status + "" : "400") : 500;
 
   // On fetch hook (for custom response processing, etc)
-  hookResp = await context?.hooks?.onOriginFetch?.({ context, req, res, next, requestUrl, redirectRequestUrl, originUrl, route, attributes, growthbook, originResponse, originStatus });
+  const onOriginFetchParams: OnOriginFetchParams<Req, Res> = { ...onBeforeOriginFetchParams, originResponse, originStatus };
+  hookResp = await context?.hooks?.onOriginFetch?.(onOriginFetchParams);
   if (hookResp) return hookResp;
 
   // Standard error response handling
   if (originStatus >= 500 || !originResponse) {
-    console.error("Fetch: 5xx status returned");
     return context.helpers.sendResponse(context, res, {}, "Error fetching page", {}, 500);
   }
   if (originStatus >= 400) {
@@ -204,18 +235,29 @@ export async function edgeApp<Req, Res>(
     resHeaders["content-security-policy"] = csp;
   }
 
-  let body = await originResponse.text() ?? "";
-  // Check if content-encoding is gzip
-  if (originHeaders["content-encoding"] === "gzip") {
-    delete resHeaders["content-encoding"]; // do not forward this header since it's now unzipped
-    if (!body) {
-      try {
-        const buffer = await originResponse.arrayBuffer();
+  const autoInflate = context.config.autoInflate; // fastly only!!!
+  let body = "";
+  const isGzipped = originHeaders["content-encoding"] === "gzip";
+  try {
+    const buffer = await originResponse.arrayBuffer();
+    try {
+      if (isGzipped && autoInflate) {
+        body = pako.inflate(new Uint8Array(buffer), { to: "string" });
+      } else {
+        body = new TextDecoder().decode(buffer);
+      }
+    } catch {
+      if (isGzipped) {
         body = pako.inflate(new Uint8Array(buffer), { to: "string" });
-      } catch (e) {
-        console.error(e);
+      } else {
+        throw new Error("Failed to decode response as text.");
       }
     }
+    if (isGzipped) {
+      delete resHeaders["content-encoding"]; // Remove to prevent double decompression
+    }
+  } catch (e) {
+    console.error("Response decoding error", e);
   }
   let setBody = (s: string) => {
     body = s;
@@ -227,7 +269,8 @@ export async function edgeApp<Req, Res>(
   }
 
   // Body ready hook (pre-DOM-mutations):
-  hookResp = await context?.hooks?.onBodyReady?.({ context, req, res, next, requestUrl, redirectRequestUrl, originUrl, route, attributes, growthbook, originResponse, originStatus, originHeaders, resHeaders, body, setBody, root });
+  const onBodyReadyParams: OnBodyReadyParams<Req, Res> = { ...onOriginFetchParams, originHeaders, resHeaders, body, setBody, root };
+  hookResp = await context?.hooks?.onBodyReady?.(onBodyReadyParams);
   if (hookResp) return hookResp;
 
   /**
@@ -257,7 +300,8 @@ export async function edgeApp<Req, Res>(
   });
 
   // Final hook (post-mutations) before sending back
-  hookResp = await context?.hooks?.onBeforeResponse?.({ context, req, res, next, requestUrl, redirectRequestUrl, originUrl, route, attributes, growthbook, originResponse, originStatus, originHeaders, resHeaders, body, setBody });
+  const onBeforeResponseParams: OnBeforeResponseParams<Req, Res> = { ...onOriginFetchParams, originHeaders, resHeaders, body, setBody };
+  hookResp = await context?.hooks?.onBeforeResponse?.(onBeforeResponseParams);
   if (hookResp) return hookResp;
 
   /**

package/src/attributes.ts

@@ -7,6 +7,7 @@ export function getUserAttributes<Req, Res>(
   req: Req,
   url: string,
   setRespCookie: (key: string, value: string) => void,
+  skipUuid: boolean = false,
 ): Attributes {
   const { config, helpers } = ctx;
 
@@ -14,16 +15,18 @@ export function getUserAttributes<Req, Res>(
   if (config.skipAutoAttributes) {
     return providedAttributes;
   }
-  // get any saved attributes from the cookie
-  const uuid = getUUID(ctx, req);
-  if (config.persistUuid && !config.noAutoCookies) {
-    if (!helpers?.setCookie) {
-      throw new Error("Missing required dependencies");
+  if (!skipUuid) {
+    // get any saved attributes from the cookie
+    const uuid = getUUID(ctx, req);
+    if (config.persistUuid && !config.noAutoCookies) {
+      if (!helpers?.setCookie) {
+        throw new Error("Missing required dependencies");
+      }
+      setRespCookie(config.uuidCookieName, uuid);
     }
-    setRespCookie(config.uuidCookieName, uuid);
   }
 
-  const autoAttributes = getAutoAttributes(ctx, req, url);
+  const autoAttributes = getAutoAttributes(ctx, req, url, skipUuid);
   return { ...autoAttributes, ...providedAttributes };
 }
 
@@ -50,7 +53,9 @@ export function getUUID<Req, Res>(ctx: Context<Req, Res>, req: Req) {
   };
 
   // get the existing UUID from cookie if set, otherwise create one
-  return helpers.getCookie(req, config.uuidCookieName) || genUUID();
+  return helpers.getCookie(req, config.uuidCookieName)
+    || helpers?.getRequestHeader?.(req, "x-gbuuid")
+    || genUUID();
 }
 
 // Infer attributes from the request
@@ -60,14 +65,17 @@ export function getAutoAttributes<Req, Res>(
   ctx: Context<Req, Res>,
   req: Req,
   url: string,
+  skipUuid: boolean = false,
 ): Attributes {
   const { config, helpers } = ctx;
 
   const getHeader = helpers?.getRequestHeader;
 
-  let autoAttributes: Attributes = {
-    [config.uuidKey]: getUUID(ctx, req),
-  };
+  let autoAttributes: Attributes = skipUuid
+    ? {}
+    : {
+      [config.uuidKey]: getUUID(ctx, req),
+    };
 
   const ua = getHeader?.(req, "user-agent") || "";
   autoAttributes.browser = ua.match(/Edg/)

package/src/config.ts

@@ -1,4 +1,4 @@
-import { Config, Context, ExperimentRunEnvironment } from "./types";
+import { Config, Context, ExperimentRunEnvironment, ExperimentUrlTargeting } from "./types";
 
 type Req = any; // placeholder
 type Res = any; // placeholder
@@ -10,6 +10,8 @@ export const defaultContext: Context<Req, Res> = {
     followRedirects: true,
     useDefaultContentType: false,
     processTextHtmlOnly: true,
+    autoInflate: false,
+    nocacheOrigin: false,
     environment: "production",
     maxPayloadSize: "2mb",
     runVisualEditorExperiments: "everywhere",
@@ -19,10 +21,12 @@ export const defaultContext: Context<Req, Res> = {
     runCrossOriginUrlRedirectExperiments: "browser",
     injectRedirectUrlScript: true,
     maxRedirects: 5,
+    experimentUrlTargeting: "request",
     scriptInjectionPattern: "</head>",
     disableInjections: false,
     enableStreaming: false,
     enableStickyBucketing: false,
+    emitTraceHeaders: true,
     apiHost: "",
     clientKey: "",
     persistUuid: false,
@@ -57,6 +61,8 @@ export interface ConfigEnv {
   FOLLOW_REDIRECTS?: string;
   USE_DEFAULT_CONTENT_TYPE?: string;
   PROCESS_TEXT_HTML_ONLY?: string;
+  AUTO_INFLATE?: string;
+  NOCACHE_ORIGIN?: string;
   NODE_ENV?: string;
   MAX_PAYLOAD_SIZE?: string;
 
@@ -71,6 +77,8 @@ export interface ConfigEnv {
   INJECT_REDIRECT_URL_SCRIPT?: string;
   MAX_REDIRECTS?: string;
 
+  EXPERIMENT_URL_TARGETING?: ExperimentUrlTargeting;
+
   SCRIPT_INJECTION_PATTERN?: string;
   DISABLE_INJECTIONS?: string;
 
@@ -80,6 +88,7 @@ export interface ConfigEnv {
 
   CONTENT_SECURITY_POLICY?: string;
   NONCE?: string;
+  EMIT_TRACE_HEADERS?: string;
 
   GROWTHBOOK_API_HOST?: string;
   GROWTHBOOK_CLIENT_KEY?: string;
@@ -116,6 +125,12 @@ export function getConfig(env: ConfigEnv): Config {
   config.processTextHtmlOnly = ["true", "1"].includes(
     env.PROCESS_TEXT_HTML_ONLY ?? "" + defaultContext.config.processTextHtmlOnly,
   );
+  config.autoInflate = ["true", "1"].includes(
+    env.AUTO_INFLATE ?? "" + defaultContext.config.autoInflate,
+  );
+  config.nocacheOrigin = ["true", "1"].includes(
+    env.NOCACHE_ORIGIN ?? "" + defaultContext.config.nocacheOrigin,
+  );
   config.environment = env.NODE_ENV ?? defaultContext.config.environment;
   config.maxPayloadSize =
     env.MAX_PAYLOAD_SIZE ?? defaultContext.config.maxPayloadSize;
@@ -152,6 +167,10 @@ export function getConfig(env: ConfigEnv): Config {
     env.MAX_REDIRECTS || "" + defaultContext.config.maxRedirects,
   );
 
+  config.experimentUrlTargeting = (env.EXPERIMENT_URL_TARGETING ??
+    defaultContext.config
+      .experimentUrlTargeting) as ExperimentUrlTargeting;
+
   config.scriptInjectionPattern =
     env.SCRIPT_INJECTION_PATTERN ||
     defaultContext.config.scriptInjectionPattern;
@@ -175,6 +194,10 @@ export function getConfig(env: ConfigEnv): Config {
 
   config.crypto = crypto;
 
+  config.emitTraceHeaders = ["true", "1"].includes(
+    env.EMIT_TRACE_HEADERS ?? "" + defaultContext.config.emitTraceHeaders,
+  );
+
   // growthbook
   config.apiHost = (env.GROWTHBOOK_API_HOST ?? "").replace(/\/*$/, "");
   config.clientKey = env.GROWTHBOOK_CLIENT_KEY ?? "";