feat: add parity between ga4 and gtm for main

Farfetch · Feb 6, 2024 · 7359ea3 · 7359ea3
1 parent bc7bc5d
commit 7359ea3
Show file tree

Hide file tree

Showing 16 changed files with 604 additions and 219 deletions.
diff --git a/packages/analytics/src/__tests__/__snapshots__/index.test.ts.snap b/packages/analytics/src/__tests__/__snapshots__/index.test.ts.snap
@@ -53,7 +53,6 @@ Object {
     "ProductUpdatedWishlist": "Product Updated In Wishlist",
     "ProductViewed": "Product Viewed",
     "PromocodeApplied": "Promocode Applied",
-    "ReviewCheckout": "Review Checkout",
     "SelectContent": "Select Content",
     "Share": "Share",
     "ShippingInfoAdded": "Shipping Info Added",

diff --git a/...analytics/src/integrations/Omnitracking/__tests__/__snapshots__/Omnitracking.test.ts.snap b/...analytics/src/integrations/Omnitracking/__tests__/__snapshots__/Omnitracking.test.ts.snap
@@ -268,22 +268,6 @@ Object {
 }
 `;
 
-exports[`Omnitracking track events definitions \`Review Checkout\` return should match the snapshot 1`] = `
-Object {
-  "basketCurrency": "USD",
-  "basketValue": 24.64,
-  "checkoutOrderId": 15338048,
-  "checkoutStep": "2",
-  "deliveryInformationDetails": "{\\"deliveryType\\":\\"Standard/Standard\\",\\"courierType\\":\\"Next Day\\",\\"packagingType\\":\\"foo\\"}",
-  "orderCode": "50314b8e9bcf000000000000",
-  "orderVAT": 2.04,
-  "paymentType": "credit",
-  "promoCode": "ACME2019",
-  "shippingTotalValue": 3.6,
-  "tid": 3648,
-}
-`;
-
 exports[`Omnitracking track events definitions \`Select Content\` return should match the snapshot 1`] = `
 Object {
   "contentType": "biz",

diff --git a/packages/analytics/src/integrations/Omnitracking/definitions.ts b/packages/analytics/src/integrations/Omnitracking/definitions.ts
@@ -820,18 +820,6 @@ export const trackEventsMapper: Readonly<OmnitrackingTrackEventsMapper> = {
 
     return;
   },
-  [EventType.ReviewCheckout]: data => ({
-    tid: 3648,
-    ...getCheckoutEventGenericProperties(data),
-    basketCurrency: data.properties?.currency,
-    basketValue: data.properties?.total,
-    checkoutStep: data.properties?.step,
-    deliveryInformationDetails: getDeliveryInformationDetails(data),
-    orderVAT: data.properties?.tax,
-    paymentType: data.properties?.paymentType,
-    promoCode: data.properties?.coupon,
-    shippingTotalValue: data.properties?.shipping,
-  }),
 } as const;
 
 /**

diff --git a/packages/analytics/src/types/EventType.ts b/packages/analytics/src/types/EventType.ts
@@ -128,11 +128,6 @@ enum EventType {
    * checkout.
    */
   PromocodeApplied = 'Promocode Applied',
-  /**
-   * Review Checkout should be tracked when the user reaches the review checkout
-   * step page.
-   */
-  ReviewCheckout = 'Review Checkout',
   /**
    * Select Content should be tracked when the user selects a content, i.e., a
    * product item.

diff --git a/packages/analytics/src/types/__tests__/__snapshots__/EventType.test.ts.snap b/packages/analytics/src/types/__tests__/__snapshots__/EventType.test.ts.snap
@@ -30,7 +30,6 @@ Object {
   "ProductUpdatedWishlist": "Product Updated In Wishlist",
   "ProductViewed": "Product Viewed",
   "PromocodeApplied": "Promocode Applied",
-  "ReviewCheckout": "Review Checkout",
   "SelectContent": "Select Content",
   "Share": "Share",
   "ShippingInfoAdded": "Shipping Info Added",

diff --git a/packages/analytics/src/types/analytics.types.ts b/packages/analytics/src/types/analytics.types.ts
@@ -119,21 +119,21 @@ export type UseContextFn = () => CommonContextData & { event?: never } & Record<
   >;
 
 export type AnalyticsProduct = {
+  affiliation?: string;
+  brand?: string;
+  category?: string;
+  coupon?: string;
+  currency?: string;
+  discountValue?: number;
   id?: string;
+  list?: string;
+  listId?: string;
   name?: string;
-  currency?: string;
-  category?: string;
-  brand?: string;
-  variant?: string;
+  position?: number;
   price?: number;
   priceWithoutDiscount?: number;
   quantity?: number;
-  affiliation?: string;
-  position?: number;
-  discountValue?: number;
-  coupon?: string;
-  list?: string;
-  listId?: string;
   size?: string;
   unitSalePrice?: number;
+  variant?: string;
 } & Record<string, unknown>;
diff --git a/packages/react/src/__tests__/__snapshots__/index.test.ts.snap b/packages/react/src/__tests__/__snapshots__/index.test.ts.snap
@@ -73,7 +73,6 @@ Object {
     "ProductUpdatedWishlist": "Product Updated In Wishlist",
     "ProductViewed": "Product Viewed",
     "PromocodeApplied": "Promocode Applied",
-    "ReviewCheckout": "Review Checkout",
     "SelectContent": "Select Content",
     "Share": "Share",
     "ShippingInfoAdded": "Shipping Info Added",

diff --git a/packages/react/src/analytics/integrations/GA4/__tests__/__snapshots__/GA4.test.ts.snap b/packages/react/src/analytics/integrations/GA4/__tests__/__snapshots__/GA4.test.ts.snap
@@ -984,33 +984,6 @@ Array [
 ]
 `;
 
-exports[`GA4 Integration GA4 instance When it is instantiated correctly Event Mappings Track events Should map the Review Checkout event correctly 1`] = `
-Array [
-  Array [
-    "event",
-    "review_checkout",
-    Object {
-      "affiliation": undefined,
-      "analytics_package_version": "0.1.0",
-      "blackoutAnalyticsEventId": "4eabf689-96e3-4952-8176-248a848f1e1f",
-      "checkout_step": "2",
-      "coupon": "ACME2019",
-      "currency": "USD",
-      "delivery_type": "Standard/Standard",
-      "packaging_type": "foo",
-      "page_path": "/en-pt/?utm_term=utm_term&utm_source=utm_source&utm_medium=utm_medium&utm_content=utm_content&utm_campaign=utm_campaign",
-      "path_clean": "/en-pt/",
-      "payment_type": "credit",
-      "shipping": 3.6,
-      "shipping_tier": "Next Day",
-      "tax": 2.04,
-      "transaction_id": "50314b8e9bcf000000000000",
-      "value": 24.64,
-    },
-  ],
-]
-`;
-
 exports[`GA4 Integration GA4 instance When it is instantiated correctly Event Mappings Track events Should map the Select Content event correctly 1`] = `
 Array [
   Array [

diff --git a/packages/react/src/analytics/integrations/GA4/eventMapping.ts b/packages/react/src/analytics/integrations/GA4/eventMapping.ts
@@ -54,7 +54,6 @@ const eventMapping = {
   [EventType.ShippingMethodAdded]: 'add_shipping_method',
   [EventType.InteractContent]: 'interact_content',
   [EventType.SignupNewsletter]: 'sign_up_newsletter',
-  [EventType.ReviewCheckout]: 'review_checkout',
   // internal ga4 cases
   [InternalEventTypes.ProductUpdated.CHANGE_QUANTITY]:
     InternalEventTypes.ProductUpdated.CHANGE_QUANTITY,
@@ -776,32 +775,6 @@ const getCheckoutStepEditingParametersFromEvent = (
   };
 };
 
-/**
- * Returns the review checkout custom event properties formatted for the GA4 event.
- *
- * @param eventProperties - Properties from a track event.
- *
- * @returns Properties formatted for the GA4's review checkout custom event.
- */
-const getReviewCheckoutParametersFromEvent = (
-  eventProperties: EventProperties,
-) => {
-  return {
-    affiliation: eventProperties.affiliation,
-    checkout_step: eventProperties.step,
-    coupon: eventProperties.coupon,
-    currency: eventProperties.currency,
-    delivery_type: eventProperties.deliveryType,
-    packaging_type: eventProperties.packagingType,
-    payment_type: eventProperties.paymentType,
-    shipping_tier: eventProperties.shippingTier,
-    shipping: eventProperties.shipping,
-    tax: eventProperties.tax,
-    transaction_id: eventProperties.orderId,
-    value: eventProperties.total,
-  };
-};
-
 /**
  * Returns the share properties formatted for the GA4 event.
  *
@@ -952,9 +925,6 @@ export function getEventProperties(
     case EventType.CheckoutAbandoned:
       return getCheckoutAbandonedParametersFromEvent(eventProperties);
 
-    case EventType.ReviewCheckout:
-      return getReviewCheckoutParametersFromEvent(eventProperties);
-
     case EventType.PlaceOrderStarted:
       return getPlaceOrderStartedParametersFromEvent(eventProperties);
 

diff --git a/packages/react/src/analytics/integrations/GA4/validation/eventSchemas.ts b/packages/react/src/analytics/integrations/GA4/validation/eventSchemas.ts
@@ -206,19 +206,6 @@ const checkoutAbandonedSchema = currencySchema
 const promocodeAppliedSchema =
   checkoutShippingStepSchema.concat(couponRequiredSchema);
 
-const reviewCheckoutSchema = currencySchema
-  .concat(couponSchema)
-  .concat(totalSchema)
-  .concat(orderIdSchema)
-  .concat(affiliationSchema)
-  .concat(shippingSchema)
-  .concat(taxSchema)
-  .concat(deliveryTypeSchema)
-  .concat(packagingTypeSchema)
-  .concat(shippingTierSchema)
-  .concat(checkoutStepEditingSchema)
-  .concat(checkoutPaymentStepSchema);
-
 const placeOrderStartedSchema = currencyRequiredSchema
   .concat(couponSchema)
   .concat(totalRequiredSchema)
@@ -345,7 +332,6 @@ const eventSchemas = {
   [EventType.ProductUpdated]: productUpdatedSchema,
   [EventType.InteractContent]: interactContentSchema,
   [EventType.SignupNewsletter]: signupNewsletterSchema,
-  [EventType.ReviewCheckout]: reviewCheckoutSchema,
 };
 
 export default eventSchemas;
diff --git a/packages/react/src/analytics/integrations/GTM/__tests__/GTM.test.ts b/packages/react/src/analytics/integrations/GTM/__tests__/GTM.test.ts
@@ -405,8 +405,14 @@ describe('GTM', () => {
         tax: 23,
         total: 1000,
         paymentType: 'paypal',
+        deliveryType: 'Standard/standard',
+        shippingTier: 'Next Day',
+        packagingType: 'dummy',
         value: 123123,
         orderId: 'OFH1213',
+        method: 'guest',
+        coupon: 'ACME2019',
+        currency: 'EUR',
         // product generic properties - Array of products
         products: [
           {