@segment/analytics-browser-actions-google-analytics-4 1.32.0 → 1.34.0

package/src/__tests__/addToCart.test.ts

@@ -15,6 +15,9 @@ const subscriptions: Subscription[] = [
       value: {
         '@path': '$.properties.value'
       },
+      send_to: {
+        '@path': '$.properties.send_to'
+      },
       items: [
         {
           item_name: {
@@ -61,13 +64,14 @@ describe('GoogleAnalytics4Web.addToCart', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 addToCart Event', async () => {
+  test('GA4 addToCart Event when send to is false', async () => {
     const context = new Context({
       event: 'Add To Cart',
       type: 'track',
       properties: {
         currency: 'USD',
         value: 10,
+        send_to: false,
         products: [
           {
             product_id: '12345',
@@ -85,7 +89,68 @@ describe('GoogleAnalytics4Web.addToCart', () => {
       expect.objectContaining({
         currency: 'USD',
         items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
-        value: 10
+        value: 10,
+        send_to: 'default'
+      })
+    )
+  })
+  test('GA4 addToCart Event when send to is true', async () => {
+    const context = new Context({
+      event: 'Add To Cart',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        send_to: true,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+    await addToCartEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('add_to_cart'),
+      expect.objectContaining({
+        currency: 'USD',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: settings.measurementID
+      })
+    )
+  })
+
+  test('GA4 addToCart Event when send to is undefined', async () => {
+    const context = new Context({
+      event: 'Add To Cart',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+    await addToCartEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('add_to_cart'),
+      expect.objectContaining({
+        currency: 'USD',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: 'default'
       })
     )
   })

package/src/__tests__/addToWishlist.test.ts

@@ -15,6 +15,9 @@ const subscriptions: Subscription[] = [
       value: {
         '@path': '$.properties.value'
       },
+      send_to: {
+        '@path': '$.properties.send_to'
+      },
       items: [
         {
           item_name: {
@@ -61,13 +64,45 @@ describe('GoogleAnalytics4Web.addToWishlist', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('Track call without parameters', async () => {
+  test('Track call without parameters when send to is false', async () => {
+    const context = new Context({
+      event: 'Add To Wishlist',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        send_to: false,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+    await addToWishlistEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('add_to_wishlist'),
+      expect.objectContaining({
+        currency: 'USD',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: 'default'
+      })
+    )
+  })
+
+  test('Track call without parameters when send to is true', async () => {
     const context = new Context({
       event: 'Add To Wishlist',
       type: 'track',
       properties: {
         currency: 'USD',
         value: 10,
+        send_to: true,
         products: [
           {
             product_id: '12345',
@@ -85,7 +120,38 @@ describe('GoogleAnalytics4Web.addToWishlist', () => {
       expect.objectContaining({
         currency: 'USD',
         items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
-        value: 10
+        value: 10,
+        send_to: settings.measurementID
+      })
+    )
+  })
+
+  test('Track call without parameters when send to is undefined', async () => {
+    const context = new Context({
+      event: 'Add To Wishlist',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+    await addToWishlistEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('add_to_wishlist'),
+      expect.objectContaining({
+        currency: 'USD',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: 'default'
       })
     )
   })

package/src/__tests__/beginCheckout.test.ts

@@ -18,6 +18,9 @@ const subscriptions: Subscription[] = [
       coupon: {
         '@path': '$.properties.coupon'
       },
+      send_to: {
+        '@path': '$.properties.send_to'
+      },
       items: [
         {
           item_name: {
@@ -64,7 +67,73 @@ describe('GoogleAnalytics4Web.beginCheckout', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 beginCheckout Event', async () => {
+  test('GA4 beginCheckout Event when send to is false', async () => {
+    const context = new Context({
+      event: 'Begin Checkout',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        coupon: 'SUMMER_123',
+        payment_method: 'Credit Card',
+        send_to: false,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+    await beginCheckoutEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('begin_checkout'),
+      expect.objectContaining({
+        coupon: 'SUMMER_123',
+        currency: 'USD',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: 'default'
+      })
+    )
+  })
+  test('GA4 beginCheckout Event when send to is true', async () => {
+    const context = new Context({
+      event: 'Begin Checkout',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        coupon: 'SUMMER_123',
+        payment_method: 'Credit Card',
+        send_to: true,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+    await beginCheckoutEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('begin_checkout'),
+      expect.objectContaining({
+        coupon: 'SUMMER_123',
+        currency: 'USD',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: settings.measurementID
+      })
+    )
+  })
+  test('GA4 beginCheckout Event when send to is undefined', async () => {
     const context = new Context({
       event: 'Begin Checkout',
       type: 'track',
@@ -91,7 +160,8 @@ describe('GoogleAnalytics4Web.beginCheckout', () => {
         coupon: 'SUMMER_123',
         currency: 'USD',
         items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
-        value: 10
+        value: 10,
+        send_to: 'default'
       })
     )
   })

package/src/__tests__/customEvent.test.ts

@@ -12,6 +12,9 @@ const subscriptions: Subscription[] = [
       name: {
         '@path': '$.event'
       },
+      send_to: {
+        '@path': '$.properties.send_to'
+      },
       params: {
         '@path': '$.properties.params'
       }
@@ -42,7 +45,34 @@ describe('GoogleAnalytics4Web.customEvent', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 customEvent Event', async () => {
+  test('GA4 customEvent Event when send_to is false', async () => {
+    const context = new Context({
+      event: 'Custom Event',
+      type: 'track',
+      properties: {
+        send_to: false,
+        params: [
+          {
+            paramOne: 'test123',
+            paramTwo: 'test123',
+            paramThree: 123
+          }
+        ]
+      }
+    })
+    await customEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('Custom_Event'),
+      expect.objectContaining({
+        send_to: 'default',
+        ...[{ paramOne: 'test123', paramThree: 123, paramTwo: 'test123' }]
+      })
+    )
+  })
+
+  test('GA4 customEvent Event when send_to is undefined', async () => {
     const context = new Context({
       event: 'Custom Event',
       type: 'track',
@@ -61,7 +91,37 @@ describe('GoogleAnalytics4Web.customEvent', () => {
     expect(mockGA4).toHaveBeenCalledWith(
       expect.anything(),
       expect.stringContaining('Custom_Event'),
-      expect.objectContaining([{ paramOne: 'test123', paramThree: 123, paramTwo: 'test123' }])
+      expect.objectContaining({
+        send_to: 'default',
+        ...[{ paramOne: 'test123', paramThree: 123, paramTwo: 'test123' }]
+      })
+    )
+  })
+
+  test('GA4 customEvent Event when send_to is true', async () => {
+    const context = new Context({
+      event: 'Custom Event',
+      type: 'track',
+      properties: {
+        params: [
+          {
+            paramOne: 'test123',
+            paramTwo: 'test123',
+            paramThree: 123
+          }
+        ],
+        send_to: true
+      }
+    })
+    await customEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('Custom_Event'),
+      expect.objectContaining({
+        send_to: settings.measurementID,
+        ...[{ paramOne: 'test123', paramThree: 123, paramTwo: 'test123' }]
+      })
     )
   })
 })

package/src/__tests__/generateLead.test.ts

@@ -14,6 +14,9 @@ const subscriptions: Subscription[] = [
       },
       value: {
         '@path': '$.properties.value'
+      },
+      send_to: {
+        '@path': '$.properties.send_to'
       }
     }
   }
@@ -42,13 +45,36 @@ describe('GoogleAnalytics4Web.generateLead', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 generateLead Event', async () => {
+  test('GA4 generateLead Event when send to is false', async () => {
     const context = new Context({
       event: 'Generate Lead',
       type: 'track',
       properties: {
         currency: 'USD',
-        value: 10
+        value: 10,
+        send_to: false
+      }
+    })
+    await generateLeadEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('generate_lead'),
+      expect.objectContaining({
+        currency: 'USD',
+        value: 10,
+        send_to: 'default'
+      })
+    )
+  })
+  test('GA4 generateLead Event when send to is true', async () => {
+    const context = new Context({
+      event: 'Generate Lead',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        send_to: true
       }
     })
     await generateLeadEvent.track?.(context)
@@ -57,8 +83,30 @@ describe('GoogleAnalytics4Web.generateLead', () => {
       expect.anything(),
       expect.stringContaining('generate_lead'),
       expect.objectContaining({
+        currency: 'USD',
+        value: 10,
+        send_to: settings.measurementID
+      })
+    )
+  })
+  test('GA4 generateLead Event when send to is undefined', async () => {
+    const context = new Context({
+      event: 'Generate Lead',
+      type: 'track',
+      properties: {
         currency: 'USD',
         value: 10
+      }
+    })
+    await generateLeadEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('generate_lead'),
+      expect.objectContaining({
+        currency: 'USD',
+        value: 10,
+        send_to: 'default'
       })
     )
   })

package/src/__tests__/login.test.ts

@@ -11,6 +11,9 @@ const subscriptions: Subscription[] = [
     mapping: {
       method: {
         '@path': '$.properties.method'
+      },
+      send_to: {
+        '@path': '$.properties.send_to'
       }
     }
   }
@@ -39,12 +42,33 @@ describe('GoogleAnalytics4Web.login', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 login Event', async () => {
+  test('GA4 login Event when send to is false', async () => {
     const context = new Context({
       event: 'Login',
       type: 'track',
       properties: {
-        method: 'Google'
+        method: 'Google',
+        send_to: false
+      }
+    })
+    await loginEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('login'),
+      expect.objectContaining({
+        method: 'Google',
+        send_to: 'default'
+      })
+    )
+  })
+  test('GA4 login Event when send to is true', async () => {
+    const context = new Context({
+      event: 'Login',
+      type: 'track',
+      properties: {
+        method: 'Google',
+        send_to: true
       }
     })
     await loginEvent.track?.(context)
@@ -53,7 +77,28 @@ describe('GoogleAnalytics4Web.login', () => {
       expect.anything(),
       expect.stringContaining('login'),
       expect.objectContaining({
+        method: 'Google',
+        send_to: settings.measurementID
+      })
+    )
+  })
+
+  test('GA4 login Event when send to is undefined', async () => {
+    const context = new Context({
+      event: 'Login',
+      type: 'track',
+      properties: {
         method: 'Google'
+      }
+    })
+    await loginEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('login'),
+      expect.objectContaining({
+        method: 'Google',
+        send_to: 'default'
       })
     )
   })

package/src/__tests__/purchase.test.ts

@@ -21,6 +21,9 @@ const subscriptions: Subscription[] = [
       transaction_id: {
         '@path': '$.properties.transaction_id'
       },
+      send_to: {
+        '@path': '$.properties.send_to'
+      },
       items: [
         {
           item_name: {
@@ -67,7 +70,7 @@ describe('GoogleAnalytics4Web.purchase', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 purchase Event', async () => {
+  test('GA4 purchase Event when send to is false', async () => {
     const context = new Context({
       event: 'Purchase',
       type: 'track',
@@ -75,6 +78,7 @@ describe('GoogleAnalytics4Web.purchase', () => {
         currency: 'USD',
         value: 10,
         transaction_id: 12321,
+        send_to: false,
         products: [
           {
             product_id: '12345',
@@ -93,7 +97,72 @@ describe('GoogleAnalytics4Web.purchase', () => {
         currency: 'USD',
         transaction_id: 12321,
         items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
-        value: 10
+        value: 10,
+        send_to: 'default'
+      })
+    )
+  })
+  test('GA4 purchase Event when send to is true', async () => {
+    const context = new Context({
+      event: 'Purchase',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        transaction_id: 12321,
+        send_to: true,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+    await purchaseEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('purchase'),
+      expect.objectContaining({
+        currency: 'USD',
+        transaction_id: 12321,
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: settings.measurementID
+      })
+    )
+  })
+
+  test('GA4 purchase Event when send to is undefined', async () => {
+    const context = new Context({
+      event: 'Purchase',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        transaction_id: 12321,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+    await purchaseEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('purchase'),
+      expect.objectContaining({
+        currency: 'USD',
+        transaction_id: 12321,
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: 'default'
       })
     )
   })