@simplybusiness/services 1.5.0 → 1.6.1

package/dist/types/src/airbrake/index.d.ts

@@ -1,9 +1,10 @@
+export declare const getAirbrakeEnvironment: () => string;
 export type GetAirbrakeOptions = {
     projectId?: number;
     projectKey?: string;
     forceSend?: boolean;
 };
-export declare function getAirbrake(options: GetAirbrakeOptions): {
+export declare function getAirbrake(options?: GetAirbrakeOptions): {
     notify: jest.Mock<any, any, any> | {
         (...data: any[]): void;
         (message?: any, ...optionalParams: any[]): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@simplybusiness/services",
   "license": "UNLICENSED",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "description": "Internal library for services",
   "repository": {
     "type": "git",
@@ -46,7 +46,7 @@
     "@eslint/compat": "^2.0.0",
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.39.1",
-    "@simplybusiness/eslint-config": "^1.1.0",
+    "@simplybusiness/eslint-config": "^1.1.1",
     "@swc/core": "^1.12.5",
     "@swc/jest": "^0.2.39",
     "@testing-library/dom": "^10.4.1",
@@ -79,7 +79,7 @@
   },
   "dependencies": {
     "@airbrake/browser": "^2.1.9",
-    "@simplybusiness/mobius": "^6.9.5",
+    "@simplybusiness/mobius": "^6.9.7",
     "@snowplow/browser-tracker": "^3.24.6",
     "classnames": "^2.5.1"
   },

package/src/airbrake/index.test.ts

@@ -0,0 +1,127 @@
+import { Notifier } from "@airbrake/browser";
+import { getAirbrake, getAirbrakeEnvironment } from "./index";
+
+jest.mock("@airbrake/browser");
+
+const MockNotifier = Notifier as jest.MockedClass<typeof Notifier>;
+
+describe("getAirbrake", () => {
+  const originalEnv = process.env.AIRBRAKE_ENV;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    // Clear the notifier instances cache between tests
+    // by creating new notifiers with different projectIds
+  });
+
+  afterEach(() => {
+    if (originalEnv === undefined) {
+      delete process.env.AIRBRAKE_ENV;
+    } else {
+      process.env.AIRBRAKE_ENV = originalEnv;
+    }
+  });
+
+  describe("getAirbrakeEnvironment", () => {
+    it("returns AIRBRAKE_ENV when set", () => {
+      process.env.AIRBRAKE_ENV = "staging";
+      expect(getAirbrakeEnvironment()).toBe("staging");
+    });
+
+    it("returns 'development' when AIRBRAKE_ENV is not set", () => {
+      delete process.env.AIRBRAKE_ENV;
+      expect(getAirbrakeEnvironment()).toBe("development");
+    });
+  });
+
+  describe("environment-based routing", () => {
+    it("returns real notifier when AIRBRAKE_ENV is 'production'", () => {
+      process.env.AIRBRAKE_ENV = "production";
+      const result = getAirbrake({ projectId: 1001 });
+
+      expect(MockNotifier).toHaveBeenCalledWith(
+        expect.objectContaining({
+          projectId: 1001,
+          environment: "production",
+        }),
+      );
+      expect(result).toBeInstanceOf(Notifier);
+    });
+
+    it("returns real notifier when AIRBRAKE_ENV is 'staging'", () => {
+      process.env.AIRBRAKE_ENV = "staging";
+      const result = getAirbrake({ projectId: 1002 });
+
+      expect(MockNotifier).toHaveBeenCalledWith(
+        expect.objectContaining({
+          projectId: 1002,
+          environment: "staging",
+        }),
+      );
+      expect(result).toBeInstanceOf(Notifier);
+    });
+
+    it("returns fake notifier when AIRBRAKE_ENV is 'development'", () => {
+      process.env.AIRBRAKE_ENV = "development";
+      const result = getAirbrake({ projectId: 1003 });
+
+      expect(MockNotifier).not.toHaveBeenCalled();
+      // In test environment, notify is a jest.fn() to avoid console spam
+      expect(typeof result.notify).toBe("function");
+      expect(result).not.toBeInstanceOf(Notifier);
+    });
+
+    it("returns fake notifier when AIRBRAKE_ENV is 'integration'", () => {
+      process.env.AIRBRAKE_ENV = "integration";
+      const result = getAirbrake({ projectId: 1004 });
+
+      expect(MockNotifier).not.toHaveBeenCalled();
+      // In test environment, notify is a jest.fn() to avoid console spam
+      expect(typeof result.notify).toBe("function");
+      expect(result).not.toBeInstanceOf(Notifier);
+    });
+  });
+
+  describe("forceSend option", () => {
+    it("returns real notifier when forceSend is true regardless of environment", () => {
+      process.env.AIRBRAKE_ENV = "development";
+      const result = getAirbrake({ projectId: 1006, forceSend: true });
+
+      expect(MockNotifier).toHaveBeenCalledWith(
+        expect.objectContaining({
+          projectId: 1006,
+          environment: "development",
+        }),
+      );
+      expect(result).toBeInstanceOf(Notifier);
+    });
+  });
+
+  describe("multiple project support", () => {
+    it("returns separate notifiers for different projectIds", () => {
+      process.env.AIRBRAKE_ENV = "production";
+
+      const result1 = getAirbrake({ projectId: 2001, projectKey: "key1" });
+      const result2 = getAirbrake({ projectId: 2002, projectKey: "key2" });
+
+      expect(MockNotifier).toHaveBeenCalledTimes(2);
+      expect(MockNotifier).toHaveBeenCalledWith(
+        expect.objectContaining({ projectId: 2001 }),
+      );
+      expect(MockNotifier).toHaveBeenCalledWith(
+        expect.objectContaining({ projectId: 2002 }),
+      );
+      expect(result1).not.toBe(result2);
+    });
+
+    it("returns cached notifier for same projectId", () => {
+      process.env.AIRBRAKE_ENV = "production";
+
+      const result1 = getAirbrake({ projectId: 3001 });
+      const result2 = getAirbrake({ projectId: 3001 });
+
+      expect(MockNotifier).toHaveBeenCalledTimes(1);
+      expect(result1).toBe(result2);
+    });
+  });
+});

package/src/airbrake/index.ts

@@ -5,27 +5,25 @@ import { Notifier } from "@airbrake/browser";
 const defaultProjectId = 512949;
 const defaultProjectKey = "4e25197d8faea61c10fbb97702200780";
 
-let notifierInstance: Notifier | null;
-const fakeNotify = () => {
-  // Use jest.fn() for testing
-  if (process.env.NODE_ENV === "test") {
-    return jest.fn();
-  }
-
-  return console.error;
-};
+// Map of project IDs to notifier instances to support multiple Airbrake accounts
+const notifierInstances = new Map<number, Notifier>();
 
-// Fake signature which logs to console
+// Fake notifier which logs to console instead of sending to Airbrake
 const fakeAirbrake = {
-  notify: fakeNotify(),
+  notify:
+    globalThis.process?.env?.NODE_ENV === "test"
+      ? jest.fn()
+      : console.error.bind(console),
 };
 
-// We don't want to send real alerts on non-quote domains
-const shouldUseAirbrake = () => {
-  const { location } = globalThis;
-  const isTest = process.env.NODE_ENV === "test";
+// Get Airbrake environment from AIRBRAKE_ENV, defaulting to "development"
+export const getAirbrakeEnvironment = () =>
+  globalThis.process?.env?.AIRBRAKE_ENV ?? "development";
 
-  return isTest || location?.hostname.indexOf("quote.") > -1;
+// Only send real alerts in staging and production environments
+const shouldUseAirbrake = () => {
+  const env = getAirbrakeEnvironment();
+  return env === "staging" || env === "production";
 };
 
 export type GetAirbrakeOptions = {
@@ -34,22 +32,30 @@ export type GetAirbrakeOptions = {
   forceSend?: boolean;
 };
 
-export function getAirbrake(options: GetAirbrakeOptions) {
-  const { projectId, projectKey, forceSend } = options;
+export function getAirbrake(options: GetAirbrakeOptions = {}) {
+  const {
+    projectId = defaultProjectId,
+    projectKey = defaultProjectKey,
+    forceSend,
+  } = options;
 
-  if (!forceSend || !shouldUseAirbrake()) {
+  if (!forceSend && !shouldUseAirbrake()) {
     return fakeAirbrake;
   }
 
+  let notifierInstance = notifierInstances.get(projectId);
+
   if (!notifierInstance) {
     notifierInstance = new Notifier({
-      projectId: projectId ?? defaultProjectId,
-      projectKey: projectKey ?? defaultProjectKey,
-      environment: process.env.NODE_ENV,
+      projectId,
+      projectKey,
+      environment: getAirbrakeEnvironment(),
       instrumentation: {
         onerror: false,
+        unhandledrejection: false,
       },
     });
+    notifierInstances.set(projectId, notifierInstance);
   }
 
   return notifierInstance;

package/src/snowplow/event-definitions/questionnaire/questionnaire.test.ts

@@ -124,6 +124,7 @@ describe("questionnaireEventDefinitions", () => {
           vertical: "shop",
           primary_detail: "test-answer",
           selected_type: "trade_selector",
+          location: "/",
         },
       });
     });
@@ -143,6 +144,134 @@ describe("questionnaireEventDefinitions", () => {
 
       expect("data" in result && result.data.vertical).toBe("Landlord");
     });
+
+    it("should include trade selection metadata for US page", () => {
+      const params = {
+        context: {
+          site: "simplybusiness_us",
+          vertical: "shop",
+        },
+        answer: "Plumber",
+        searchId: "search-123",
+        selectedListPosition: 2,
+        selectionMethod: "genAI",
+      };
+
+      const result = findEventByName("primaryDetailSelected").makePayload(
+        params,
+      );
+
+      expect(result).toEqual({
+        schema:
+          "iglu:com.simplybusiness/primary_detail_selected/jsonschema/1-4-0",
+        data: {
+          site: "simplybusiness_us",
+          vertical: "shop",
+          primary_detail: "Plumber",
+          selected_type: "trade_selector",
+          location: "/",
+          search_id: "search-123",
+          selected_list_position: "3",
+          selected_location: "trade_selector_vertical",
+          selection_method: "genAI",
+          business_unit: "simplybusiness_us",
+        },
+      });
+    });
+
+    it("should include search_id but not US-only fields for non-US page", () => {
+      const params = {
+        context: {
+          site: "simplybusiness_uk",
+          vertical: "shop",
+        },
+        answer: "Plumber",
+        searchId: "search-456",
+        selectedListPosition: 1,
+        selectionMethod: "legacy",
+      };
+
+      const result = findEventByName("primaryDetailSelected").makePayload(
+        params,
+      );
+
+      expect(result).toEqual({
+        schema:
+          "iglu:com.simplybusiness/primary_detail_selected/jsonschema/1-4-0",
+        data: {
+          site: "simplybusiness_uk",
+          vertical: "shop",
+          primary_detail: "Plumber",
+          selected_type: "trade_selector",
+          location: "/",
+          search_id: "search-456",
+          selection_method: "legacy",
+        },
+      });
+    });
+
+    it("should handle selectedListPosition of 0 (first item)", () => {
+      const params = {
+        context: {
+          site: "simplybusiness_us",
+          vertical: "shop",
+        },
+        answer: "Plumber",
+        searchId: "search-789",
+        selectedListPosition: 0,
+        selectionMethod: "genAI",
+      };
+
+      const result = findEventByName("primaryDetailSelected").makePayload(
+        params,
+      );
+
+      expect(result).toEqual({
+        schema:
+          "iglu:com.simplybusiness/primary_detail_selected/jsonschema/1-4-0",
+        data: {
+          site: "simplybusiness_us",
+          vertical: "shop",
+          primary_detail: "Plumber",
+          selected_type: "trade_selector",
+          location: "/",
+          search_id: "search-789",
+          selected_list_position: "1",
+          selected_location: "trade_selector_vertical",
+          selection_method: "genAI",
+          business_unit: "simplybusiness_us",
+        },
+      });
+    });
+
+    it("should include US-only fields with null position when no metadata", () => {
+      const params = {
+        context: {
+          site: "simplybusiness_us",
+          vertical: "shop",
+        },
+        answer: "Electrician",
+      };
+
+      const result = findEventByName("primaryDetailSelected").makePayload(
+        params,
+      );
+
+      expect(result).toEqual({
+        schema:
+          "iglu:com.simplybusiness/primary_detail_selected/jsonschema/1-4-0",
+        data: {
+          site: "simplybusiness_us",
+          vertical: "shop",
+          primary_detail: "Electrician",
+          selected_type: "trade_selector",
+          location: "/",
+          selected_list_position: null,
+          selected_location: "trade_selector_vertical",
+          business_unit: "simplybusiness_us",
+        },
+      });
+    });
   });
 
   describe("helpTextOpened", () => {

package/src/snowplow/event-definitions/questionnaire/questionnaire.ts

@@ -35,8 +35,16 @@ export const questionnaireEventDefinitions: EventDefinition[] = [
     name: "primaryDetailSelected",
     type: "unstructured",
     makePayload: params => {
-      const { context, answer, vertical } = params as ParamsType;
+      const {
+        context,
+        answer,
+        vertical,
+        searchId,
+        selectedListPosition,
+        selectionMethod,
+      } = params as ParamsType;
       const { site } = context;
+      const isUSPage = site === "simplybusiness_us";
       let verticalName = vertical || context.vertical;
 
       if (verticalName.toLowerCase().indexOf("landlord") > -1) {
@@ -44,15 +52,37 @@ export const questionnaireEventDefinitions: EventDefinition[] = [
           answer === "residential" ? "Landlord" : "Commercial landlord";
       }
 
+      const data: Record<string, unknown> = {
+        site,
+        vertical: verticalName,
+        primary_detail: answer,
+        selected_type: "trade_selector",
+        location: window?.location?.pathname ?? "",
+      };
+
+      // Always include search_id if present
+      if (searchId) {
+        data.search_id = searchId;
+      }
+      // Always include selection_method if present
+      if (selectionMethod) {
+        data.selection_method = selectionMethod;
+      }
+
+      // US only fields
+      if (isUSPage) {
+        data.selected_list_position =
+          selectedListPosition !== undefined
+            ? (selectedListPosition + 1).toString()
+            : null;
+        data.selected_location = "trade_selector_vertical";
+        data.business_unit = site;
+      }
+
       return {
         schema:
           "iglu:com.simplybusiness/primary_detail_selected/jsonschema/1-4-0",
-        data: {
-          site,
-          vertical: verticalName,
-          primary_detail: answer,
-          selected_type: "trade_selector",
-        },
+        data,
       };
     },
     contexts: ["distributionChannelContext", "serviceChannelContext"],