DINT-974: include commerceScope in all AEP events (#109)

Co-authored-by: ani hammond <ani hammond>
adobe · Aug 16, 2023 · 322259c · 322259c
1 parent da39dfc
commit 322259c
Show file tree

Hide file tree

Showing 25 changed files with 128 additions and 7 deletions.
diff --git a/packages/storefront-events-collector/src/handlers/account/createAccountAEP.ts b/packages/storefront-events-collector/src/handlers/account/createAccountAEP.ts
@@ -4,17 +4,21 @@ import * as sdkSchemas from "@adobe/magento-storefront-events-sdk/src/types/sche
 
 import { sendEvent } from "../../alloy";
 import { createAccountPayload } from "../../../src/utils/aep/account";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "userAccount.createProfile";
 const aepHandler = async (event: Event): Promise<void> => {
-    const { debugContext, accountContext, customContext } = event.eventInfo;
+    const { debugContext, accountContext, storefrontInstanceContext, customContext } = event.eventInfo;
 
     const payload = createAccountPayload(customContext, accountContext as sdkSchemas.Account);
 
     payload.userAccount = {
         createProfile: 1,
     };
 
+    payload.commerce = payload.commerce || {};
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/packages/storefront-events-collector/src/handlers/account/editAccountAEP.ts b/packages/storefront-events-collector/src/handlers/account/editAccountAEP.ts
@@ -4,17 +4,21 @@ import * as sdkSchemas from "@adobe/magento-storefront-events-sdk/src/types/sche
 
 import { sendEvent } from "../../alloy";
 import { createAccountPayload } from "../../../src/utils/aep/account";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "userAccount.updateProfile";
 const aepHandler = async (event: Event): Promise<void> => {
-    const { debugContext, accountContext, customContext } = event.eventInfo;
+    const { debugContext, accountContext, storefrontInstanceContext, customContext } = event.eventInfo;
 
     const payload = createAccountPayload(customContext, accountContext as sdkSchemas.Account);
 
     payload.userAccount = {
         updateProfile: 1,
     };
 
+    payload.commerce = payload.commerce || {};
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/packages/storefront-events-collector/src/handlers/account/signInAEP.ts b/packages/storefront-events-collector/src/handlers/account/signInAEP.ts
@@ -4,17 +4,21 @@ import * as sdkSchemas from "@adobe/magento-storefront-events-sdk/src/types/sche
 
 import { sendEvent } from "../../alloy";
 import { createAccountPayload } from "../../../src/utils/aep/account";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "userAccount.login";
 const aepHandler = async (event: Event): Promise<void> => {
-    const { debugContext, accountContext, customContext } = event.eventInfo;
+    const { debugContext, accountContext, storefrontInstanceContext, customContext } = event.eventInfo;
 
     const payload = createAccountPayload(customContext, accountContext as sdkSchemas.Account);
 
     payload.userAccount = {
         login: 1,
     };
 
+    payload.commerce = payload.commerce || {};
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/packages/storefront-events-collector/src/handlers/account/signOutAEP.ts b/packages/storefront-events-collector/src/handlers/account/signOutAEP.ts
@@ -2,10 +2,11 @@ import { Event } from "@adobe/magento-storefront-events-sdk/dist/types/types/eve
 
 import { sendEvent } from "../../alloy";
 import { BeaconSchema } from "../../types/aep";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "userAccount.logout";
 const aepHandler = async (event: Event): Promise<void> => {
-    const { debugContext, customContext } = event.eventInfo;
+    const { debugContext, storefrontInstanceContext, customContext } = event.eventInfo;
 
     let payload: BeaconSchema = {};
     if (customContext && Object.keys(customContext as BeaconSchema).length !== 0) {
@@ -17,6 +18,9 @@ const aepHandler = async (event: Event): Promise<void> => {
         logout: 1,
     };
 
+    payload.commerce = payload.commerce || {};
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
     sendEvent(payload);

diff --git a/packages/storefront-events-collector/src/handlers/checkout/placeOrderAEP.ts b/packages/storefront-events-collector/src/handlers/checkout/placeOrderAEP.ts
@@ -4,6 +4,7 @@ import { sendEvent } from "../../alloy";
 import { BeaconSchema } from "../../types/aep";
 import { createOrder } from "../../utils/aep/order";
 import { createProductListItems } from "../../utils/aep/productListItems";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "commerce.purchases";
 
@@ -48,6 +49,8 @@ const aepHandler = async (event: Event): Promise<void> => {
         value: 1,
     };
 
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/packages/storefront-events-collector/src/handlers/product/addToCartAEP.ts b/packages/storefront-events-collector/src/handlers/product/addToCartAEP.ts
@@ -3,6 +3,7 @@ import { Event } from "@adobe/magento-storefront-events-sdk/dist/types/types/eve
 import { sendEvent } from "../../alloy";
 import { BeaconSchema } from "../../types/aep";
 import { createProductListItems } from "../../utils/aep/productListItems";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "commerce.productListAdds";
 
@@ -32,6 +33,8 @@ const aepHandler = async (event: Event): Promise<void> => {
         value: 1,
     };
 
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
     sendEvent(payload);

diff --git a/packages/storefront-events-collector/src/handlers/product/removeFromCartAEP.ts b/packages/storefront-events-collector/src/handlers/product/removeFromCartAEP.ts
@@ -3,6 +3,7 @@ import { Event } from "@adobe/magento-storefront-events-sdk/dist/types/types/eve
 import { sendEvent } from "../../alloy";
 import { BeaconSchema } from "../../types/aep";
 import { createProductListItems } from "../../utils/aep/productListItems";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "commerce.productListRemovals";
 
@@ -32,6 +33,8 @@ const aepHandler = async (event: Event): Promise<void> => {
         value: 1,
     };
 
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/packages/storefront-events-collector/src/handlers/product/viewAEP.ts b/packages/storefront-events-collector/src/handlers/product/viewAEP.ts
@@ -3,6 +3,7 @@ import { Event } from "@adobe/magento-storefront-events-sdk/dist/types/types/eve
 import { sendEvent } from "../../alloy";
 import { BeaconSchema, ProductListItem } from "../../types/aep";
 import { getDiscountAmount } from "../../utils/discount";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "commerce.productViews";
 
@@ -38,6 +39,8 @@ const aepHandler = async (event: Event): Promise<void> => {
         value: 1,
     };
 
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/packages/storefront-events-collector/src/handlers/requisitionList/addToRequisitionListAEP.ts b/packages/storefront-events-collector/src/handlers/requisitionList/addToRequisitionListAEP.ts
@@ -3,6 +3,7 @@ import { sendEvent } from "../../alloy";
 import { BeaconSchema } from "../../types/aep";
 import { createProductListItems } from "../../utils/aep/productListItems";
 import { createRequisitionList } from "../../utils/aep/requisitionList";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "commerce.requisitionListAdds";
 
@@ -41,6 +42,8 @@ const handler = async (event: Event): Promise<void> => {
         value: 1,
     };
 
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/...ages/storefront-events-collector/src/handlers/requisitionList/createRequisitionListAEP.ts b/...ages/storefront-events-collector/src/handlers/requisitionList/createRequisitionListAEP.ts
@@ -4,11 +4,13 @@ import { sendEvent } from "../../alloy";
 import { BeaconSchema } from "../../types/aep";
 
 import { createRequisitionList } from "../../utils/aep/requisitionList";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "commerce.requisitionListOpens";
 
 const handler = async (event: Event): Promise<void> => {
-    const { accountContext, debugContext, requisitionListContext, customContext } = event.eventInfo;
+    const { accountContext, debugContext, requisitionListContext, customContext, storefrontInstanceContext } =
+        event.eventInfo;
     let payload: BeaconSchema = {};
     if (customContext && Object.keys(customContext as BeaconSchema).length !== 0) {
         // override payload on custom context
@@ -25,6 +27,8 @@ const handler = async (event: Event): Promise<void> => {
         value: 1,
     };
 
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/.../storefront-events-collector/src/handlers/requisitionList/removeFromRequisitionListAEP.ts b/.../storefront-events-collector/src/handlers/requisitionList/removeFromRequisitionListAEP.ts
@@ -4,6 +4,7 @@ import { sendEvent } from "../../alloy";
 import { BeaconSchema } from "../../types/aep";
 import { createRequisitionList } from "../../utils/aep/requisitionList";
 import { createProductListItems } from "../../utils/aep/productListItems";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "commerce.requisitionListRemovals";
 
@@ -42,6 +43,8 @@ const aepHandler = async (event: Event): Promise<void> => {
         value: 1,
     };
 
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
     sendEvent(payload);

diff --git a/packages/storefront-events-collector/src/handlers/search/searchRequestSentAEP.ts b/packages/storefront-events-collector/src/handlers/search/searchRequestSentAEP.ts
@@ -4,11 +4,13 @@ import { SearchFilter, SearchSort } from "@adobe/magento-storefront-events-sdk/d
 import { sendEvent } from "../../alloy";
 import { createSearchInputCtx } from "../../contexts";
 import { BeaconSchema, Filter, Sort } from "../../types/aep";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "searchRequest";
 
 const handler = async (event: Event): Promise<void> => {
-    const { searchUnitId, searchInputContext, debugContext, customContext } = event.eventInfo;
+    const { searchUnitId, searchInputContext, debugContext, storefrontInstanceContext, customContext } =
+        event.eventInfo;
 
     let payload: BeaconSchema = {};
 
@@ -63,6 +65,9 @@ const handler = async (event: Event): Promise<void> => {
         payload.searchRequest.id = searchInputCtx.data.searchRequestId as string;
     }
 
+    payload.commerce = payload.commerce || {};
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/packages/storefront-events-collector/src/handlers/search/searchResponseReceivedAEP.ts b/packages/storefront-events-collector/src/handlers/search/searchResponseReceivedAEP.ts
@@ -5,11 +5,13 @@ import { sendEvent } from "../../alloy";
 import { createSearchResultsCtx } from "../../contexts";
 import { BeaconSchema } from "../../types/aep";
 import { SearchResultProduct } from "../../types/contexts";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "searchResponse";
 
 const handler = async (event: Event): Promise<void> => {
-    const { searchUnitId, searchResultsContext, debugContext, customContext } = event.eventInfo;
+    const { searchUnitId, searchResultsContext, debugContext, storefrontInstanceContext, customContext } =
+        event.eventInfo;
 
     const searchResultsCtx = createSearchResultsCtx(searchUnitId as string, searchResultsContext);
 
@@ -44,6 +46,9 @@ const handler = async (event: Event): Promise<void> => {
         payload.searchResponse.id = searchResultsCtx.data.searchRequestId as string;
     }
 
+    payload.commerce = payload.commerce || {};
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/packages/storefront-events-collector/src/handlers/shoppingCart/initiateCheckoutAEP.ts b/packages/storefront-events-collector/src/handlers/shoppingCart/initiateCheckoutAEP.ts
@@ -3,6 +3,7 @@ import { Event } from "@adobe/magento-storefront-events-sdk/dist/types/types/eve
 import { sendEvent } from "../../alloy";
 import { BeaconSchema } from "../../types/aep";
 import { createProductListItems } from "../../utils/aep/productListItems";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "commerce.checkouts";
 
@@ -26,10 +27,13 @@ const handler = async (event: Event): Promise<void> => {
         undefined,
         storefrontInstanceContext,
     );
+
     payload.commerce.checkouts = {
         value: 1,
     };
 
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/packages/storefront-events-collector/src/handlers/shoppingCart/openCartAEP.ts b/packages/storefront-events-collector/src/handlers/shoppingCart/openCartAEP.ts
@@ -3,6 +3,7 @@ import { Event } from "@adobe/magento-storefront-events-sdk/dist/types/types/eve
 import { sendEvent } from "../../alloy";
 import { BeaconSchema } from "../../types/aep";
 import { createProductListItems } from "../../utils/aep/productListItems";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "commerce.productListOpens";
 
@@ -31,6 +32,8 @@ const handler = async (event: Event): Promise<void> => {
         value: 1,
     };
 
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/packages/storefront-events-collector/src/handlers/shoppingCart/viewAEP.ts b/packages/storefront-events-collector/src/handlers/shoppingCart/viewAEP.ts
@@ -3,6 +3,7 @@ import { Event } from "@adobe/magento-storefront-events-sdk/dist/types/types/eve
 import { sendEvent } from "../../alloy";
 import { BeaconSchema } from "../../types/aep";
 import { createProductListItems } from "../../utils/aep/productListItems";
+import { createCommerceScope } from "../../utils/aep/commerceScope";
 
 const XDM_EVENT_TYPE = "commerce.productListViews";
 
@@ -32,6 +33,8 @@ const aepHandler = async (event: Event): Promise<void> => {
         value: 1,
     };
 
+    payload.commerce.commerceScope = createCommerceScope(storefrontInstanceContext);
+
     payload._id = debugContext?.eventId;
     payload.eventType = XDM_EVENT_TYPE;
 

diff --git a/packages/storefront-events-collector/src/types/aep/commerce.ts b/packages/storefront-events-collector/src/types/aep/commerce.ts
@@ -6,6 +6,7 @@ export type Commerce = {
     productListViews?: ProductListViews;
     cart?: Cart;
     checkouts?: Checkout;
+    commerceScope?: CommerceScope;
     purchases?: Purchases;
     order?: Order;
     promotionID?: string;
@@ -17,6 +18,13 @@ export type Commerce = {
     shipping?: Shipping;
 };
 
+export type CommerceScope = {
+    environmentID: string;
+    storeCode?: string;
+    storeViewCode?: string;
+    websiteCode?: string;
+};
+
 export type ProductView = {
     value: number;
 };

diff --git a/packages/storefront-events-collector/src/utils/aep/commerceScope.ts b/packages/storefront-events-collector/src/utils/aep/commerceScope.ts
@@ -0,0 +1,13 @@
+import { StorefrontInstance } from "@adobe/magento-storefront-events-sdk/src/types/schemas";
+import { CommerceScope } from "../../types/aep";
+
+const createCommerceScope = (storefrontInstanceContext: StorefrontInstance): CommerceScope => {
+    return {
+        environmentID: storefrontInstanceContext.environmentId,
+        storeCode: storefrontInstanceContext.storeCode,
+        storeViewCode: storefrontInstanceContext.storeViewCode,
+        websiteCode: storefrontInstanceContext.websiteCode,
+    };
+};
+
+export { createCommerceScope };
diff --git a/packages/storefront-events-collector/tests/handlers/checkout/placeOrderAEP.test.ts b/packages/storefront-events-collector/tests/handlers/checkout/placeOrderAEP.test.ts
@@ -13,6 +13,12 @@ test("correctly structures AEP event and calls alloy.sendEvent", () => {
 
     expect(sendEvent).toHaveBeenCalledWith({
         commerce: {
+            commerceScope: {
+                environmentID: "aaaaaa",
+                storeCode: "magento",
+                storeViewCode: "default",
+                websiteCode: "website",
+            },
             order: {
                 purchaseID: "111111",
                 currencyCode: "USD",

diff --git a/packages/storefront-events-collector/tests/handlers/product/addToCartAEP.test.ts b/packages/storefront-events-collector/tests/handlers/product/addToCartAEP.test.ts
@@ -13,6 +13,12 @@ test("correctly structures AEP event and calls alloy.sendEvent", () => {
 
     expect(sendEvent).toHaveBeenCalledWith({
         commerce: {
+            commerceScope: {
+                environmentID: "aaaaaa",
+                storeCode: "magento",
+                storeViewCode: "default",
+                websiteCode: "website",
+            },
             cart: {
                 cartID: "111111",
             },

diff --git a/packages/storefront-events-collector/tests/handlers/product/removeFromCartAEP.test.ts b/packages/storefront-events-collector/tests/handlers/product/removeFromCartAEP.test.ts
@@ -13,6 +13,12 @@ test("correctly structures AEP event and calls alloy.sendEvent", () => {
 
     expect(sendEvent).toHaveBeenCalledWith({
         commerce: {
+            commerceScope: {
+                environmentID: "aaaaaa",
+                storeCode: "magento",
+                storeViewCode: "default",
+                websiteCode: "website",
+            },
             cart: {
                 cartID: "111111",
             },