@pack/hydrogen 3.1.1 → 3.2.1

package/README.md

@@ -1 +1,54 @@
-# hydrogen
+# `@pack/hydrogen`
+
+Hydrogen runtime integration for Pack content, preview, A/B testing, and server-side error tracking.
+
+## Install
+
+```bash
+npm install @pack/hydrogen
+```
+
+## Main exports
+
+- `createPackClient`
+- `handleRequest`
+- `PackSession`, `PackTestSession`
+- `previewModeAction`, `previewModeLoader`
+- A/B test helpers (`PackTestProvider`, `useAbTest`, etc.)
+
+## Minimal setup
+
+```ts
+import {
+  createPackClient,
+  handleRequest,
+} from '@pack/hydrogen';
+import { createServerErrorHandler } from '@pack/errors';
+
+// Optional if you want route-level error capture in addition to handleRequest wrapping.
+// Duplicate reports for the same Error instance are deduplicated automatically.
+export const handleError = createServerErrorHandler();
+
+export default async function fetch(request: Request, env: Env, ctx: ExecutionContext) {
+  const pack = createPackClient({
+    cache: caches.default,
+    waitUntil: ctx.waitUntil.bind(ctx),
+    storeId: env.PACK_STORE_ID,
+    token: env.PACK_API_TOKEN,
+    errorTracking: {
+      dsn: env.PUBLIC_PACK_ERROR_TRACKING_DSN,
+    },
+    session,
+    testSession,
+  });
+
+  return handleRequest(pack, request, (req) => storefrontHandler(req));
+}
+```
+
+## Development
+
+```bash
+yarn
+yarn build
+```

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { PackClient } from '@pack/client';
+import { ErrorTrackingOptions } from '@pack/errors';
 import { CacheCustom } from '@shopify/hydrogen';
 import { SessionStorage, Session, ActionFunctionArgs, LoaderFunctionArgs } from 'react-router';
 import * as react from 'react';
@@ -85,6 +86,8 @@ interface CreatePackClientOptions extends EnvironmentOptions {
     i18n?: I18nOptions;
     /** Default theme data to use when no token is provided */
     defaultThemeData?: DefaultThemeData;
+    /** Configuration for server-side error tracking */
+    errorTracking?: ErrorTrackingOptions;
     /**
      * Initial request to extract query parameters from.
      * If not provided, it will be captured from the first handleRequest call.
@@ -142,12 +145,14 @@ interface Pack {
         packAbTest: Test$1 | null | undefined;
         packIsPreviewMode: boolean;
         packCustomizerMeta: PackCustomizerMeta | null;
+        packErrorTracking?: ErrorTrackingOptions;
     };
     handleRequest(request: Request): Promise<(response: Response) => void>;
     isPreviewModeEnabled: () => boolean;
     isValidEditToken: PackClient["isValidEditToken"];
     query: <T = any>(query: string, options: QueryOptions) => Promise<QueryResponse<T>>;
     session: PackSession;
+    errorTracking?: ErrorTrackingOptions;
     testSession: PackTestSession;
 }
 interface DefaultThemeData {

package/dist/index.js

@@ -4356,6 +4356,9 @@ var require_dist = __commonJS({
   }
 });
 
+// src/handle-request.ts
+import { sendServerErrorEvent } from "@pack/errors";
+
 // ../packlytics/dist/utils/get-packlytics-id.js
 function sha256(ascii) {
   function rightRotate(value, amount) {
@@ -4668,11 +4671,28 @@ async function packlytics(pack, request, next) {
 }
 
 // src/handle-request.ts
+function getServerStatusError(request, status) {
+  let pathname = request.url;
+  try {
+    pathname = new URL(request.url).pathname;
+  } catch {
+  }
+  return new Error(`HTTP ${status} response for ${request.method} ${pathname}`);
+}
 async function handleRequest(pack, request, handleRequest2) {
   const packHandleResponse = await pack.handleRequest(request);
-  const response = await packlytics(pack, request, () => {
-    return handleRequest2(request);
-  });
+  let response;
+  try {
+    response = await packlytics(pack, request, () => {
+      return handleRequest2(request);
+    });
+  } catch (error) {
+    sendServerErrorEvent(error, request, pack);
+    throw error;
+  }
+  if (response.status >= 500 && !request.signal.aborted) {
+    sendServerErrorEvent(getServerStatusError(request, response.status), request, pack);
+  }
   packHandleResponse(response);
   response.headers.append("powered-by", "Shopify, Hydrogen + Pack Digital");
   response.headers.append("Set-Cookie", await pack.session.commit());
@@ -5026,11 +5046,26 @@ var cookie2 = __toESM(require_cookie(), 1);
 // src/tests/local-test-resolver.ts
 var import_json_rules_engine = __toESM(require_dist(), 1);
 var import_debug2 = __toESM(require_browser(), 1);
-var debug2 = (0, import_debug2.default)("pack:ab-testing:local-resolver");
-function getImpressionSectionIds(testVariant) {
+
+// src/tests/impression.ts
+function getVariantImpressionSectionIds(testVariant) {
   const sectionIds = testVariant?.sectionTestVariants?.map((variant) => variant?.section?.id).filter((id) => Boolean(id)) || [];
   return [...new Set(sectionIds)];
 }
+function getImpressionSectionIdsForVariant(test, testVariant) {
+  const selectedVariantSectionIds = getVariantImpressionSectionIds(testVariant);
+  if (selectedVariantSectionIds.length > 0) {
+    return selectedVariantSectionIds;
+  }
+  if (testVariant?.handle !== "control") {
+    return [];
+  }
+  const fallbackSectionIds = test?.testVariants?.filter((variant) => variant.handle !== "control").flatMap((variant) => getVariantImpressionSectionIds(variant)) || [];
+  return [...new Set(fallbackSectionIds)];
+}
+
+// src/tests/local-test-resolver.ts
+var debug2 = (0, import_debug2.default)("pack:ab-testing:local-resolver");
 var LocalTestResolver = class {
   testRules = [];
   constructor() {
@@ -5134,7 +5169,10 @@ var LocalTestResolver = class {
         })
       );
       if (accumulatedPercentage >= randomPercentage) {
-        const impressionSectionIds = getImpressionSectionIds(variant);
+        const impressionSectionIds = getImpressionSectionIdsForVariant(
+          selectedTest,
+          variant
+        );
         const result = {
           id: selectedTest.id,
           handle: selectedTest.handle,
@@ -5346,10 +5384,6 @@ var QUERY_TESTS_BY_RULES = `#graphql
     }
   }
 `;
-function getImpressionSectionIds2(testVariant) {
-  const sectionIds = testVariant?.sectionTestVariants?.map((variant) => variant?.section?.id).filter((id) => Boolean(id)) || [];
-  return [...new Set(sectionIds)];
-}
 var localTestResolver = new LocalTestResolver();
 function generateTestRulesCacheKey(storeId, contentEnvironment) {
   return `pack-tests:${storeId}:${contentEnvironment || "default"}`;
@@ -5563,7 +5597,10 @@ async function packClientFetchTestByRules(packClient, testTargetAudienceAttribut
                 (v) => v.id === currentTestData.testVariant.id
               );
               if (currentVariant) {
-                const impressionSectionIds = getImpressionSectionIds2(currentVariant);
+                const impressionSectionIds = getImpressionSectionIdsForVariant(
+                  freshTestData,
+                  currentVariant
+                );
                 const refreshedTest = {
                   id: freshTestData.id,
                   handle: freshTestData.handle,
@@ -5575,7 +5612,10 @@ async function packClientFetchTestByRules(packClient, testTargetAudienceAttribut
                   impression: impressionSectionIds.length > 0 ? { sectionIds: impressionSectionIds } : void 0,
                   isFirstExposure: void 0
                 };
-                const { isFirstExposure: isFirstExposure2, ...testDataWithoutFlag2 } = refreshedTest;
+                const {
+                  isFirstExposure: _isFirstExposure2,
+                  ...testDataWithoutFlag2
+                } = refreshedTest;
                 testSession.setTestData(testDataWithoutFlag2);
                 testSession.setExpireAt(getExpireAtDate().toISOString());
                 return refreshedTest;
@@ -5620,7 +5660,10 @@ async function packClientFetchTestByRules(packClient, testTargetAudienceAttribut
           (v) => v.id === exposedTest.testVariant?.id
         );
         if (exposedVariant) {
-          const impressionSectionIds = getImpressionSectionIds2(exposedVariant);
+          const impressionSectionIds = getImpressionSectionIdsForVariant(
+            freshTestData,
+            exposedVariant
+          );
           const result2 = {
             id: freshTestData.id,
             handle: freshTestData.handle,
@@ -5632,7 +5675,7 @@ async function packClientFetchTestByRules(packClient, testTargetAudienceAttribut
             impression: impressionSectionIds.length > 0 ? { sectionIds: impressionSectionIds } : void 0,
             isFirstExposure: void 0
           };
-          const { isFirstExposure: isFirstExposure2, ...testDataWithoutFlag2 } = result2;
+          const { isFirstExposure: _isFirstExposure2, ...testDataWithoutFlag2 } = result2;
           testSession.setTestData(testDataWithoutFlag2);
           testSession.setExpireAt(getExpireAtDate().toISOString());
           return result2;
@@ -5687,7 +5730,7 @@ async function packClientFetchTestByRules(packClient, testTargetAudienceAttribut
         variantHandle: result.testVariant.handle
       })
     );
-    const { isFirstExposure, ...testDataWithoutFlag } = result;
+    const { isFirstExposure: _isFirstExposure, ...testDataWithoutFlag } = result;
     testSession.setTestData(testDataWithoutFlag);
     testSession.setExpireAt(getExpireAtDate().toISOString());
     debug3("[Pack Test] Returning test info with first exposure flag");
@@ -6160,6 +6203,7 @@ function createPackClient(options) {
     token,
     apiUrl,
     defaultThemeData,
+    errorTracking,
     i18n,
     request
   } = options;
@@ -6234,7 +6278,8 @@ function createPackClient(options) {
             previewEnabled
           ),
           packIsPreviewMode: previewEnabled,
-          packCustomizerMeta: session.get("customizerMeta")
+          packCustomizerMeta: session.get("customizerMeta"),
+          packErrorTracking: errorTracking
         };
       },
       isPreviewModeEnabled: () => previewEnabled,
@@ -6249,6 +6294,7 @@ function createPackClient(options) {
         return { data, error: null };
       },
       session,
+      errorTracking,
       testSession
     };
   }
@@ -6298,7 +6344,8 @@ function createPackClient(options) {
           previewEnabled
         ),
         packIsPreviewMode: previewEnabled,
-        packCustomizerMeta: session.get("customizerMeta")
+        packCustomizerMeta: session.get("customizerMeta"),
+        packErrorTracking: errorTracking
       };
     },
     handleRequest: handleRequest2,
@@ -6363,7 +6410,7 @@ function createPackClient(options) {
           }
         }
         if (testInfoForRequest?.isFirstExposure) {
-          const { isFirstExposure, ...testInfo } = testInfoForRequest;
+          const { isFirstExposure: _isFirstExposure, ...testInfo } = testInfoForRequest;
           testInfoForLoader = testInfo;
         }
         headers = setTestHeaders(headers, {
@@ -6425,6 +6472,7 @@ function createPackClient(options) {
       }
     },
     session,
+    errorTracking,
     testSession
   };
 }