add support for collectHighEntropyUserAgentHints (#702)

Author: rhall-twilio

integrations/adobe-analytics/HISTORY.md

@@ -1,3 +1,8 @@
+1.17.0 / 2022-10-24
+===================
+* Bump AppMeasurement to 2.23.0
+* Add support for `collectHighEntropyUserAgentHints` setting, which allows richer User Agent data passed in as Client Hints.
+
 1.16.6 / 2022-07-26
 ===================
 * Drop support for `assetId` for `StandardVideoMetadata`

integrations/adobe-analytics/lib/index.js

@@ -83,6 +83,7 @@ AdobeAnalytics.global('s')
   .option('preferVisitorId', false)
   .option('heartbeatTrackingServerUrl', '')
   .option('ssl', false)
+  .option('collectHighEntropyUserAgentHints', false)
 
   .sOption('visitorID')
   .sOption('channel')
@@ -112,11 +113,11 @@ AdobeAnalytics.global('s')
   .sOption('usePlugins', true)
   .tag(
     'default',
-    '<script src="//cdn.segment.com/integrations/adobe-analytics/appmeasurement-2.20.0.js">'
+    '<script src="//cdn.segment.com/integrations/adobe-analytics/appmeasurement-2.23.0.js">'
   )
   .tag(
     'heartbeat',
-    '<script src="//cdn.segment.com/integrations/adobe-analytics/appmeasurement-2.20.0-heartbeat.js">'
+    '<script src="//cdn.segment.com/integrations/adobe-analytics/appmeasurement-2.23.0-heartbeat.js">'
   );
 
 /**
@@ -189,6 +190,10 @@ AdobeAnalytics.prototype.initialize = function() {
         };
       }
 
+      if (options.collectHighEntropyUserAgentHints) {
+        s.collectHighEntropyUserAgentHints = true;
+      }
+
       self.ready();
     });
   } else {
@@ -212,6 +217,10 @@ AdobeAnalytics.prototype.initialize = function() {
             window.s.trackingServerSecure || options.trackingServerSecureUrl
         });
       }
+
+      if (options.collectHighEntropyUserAgentHints) {
+        s.collectHighEntropyUserAgentHints = true;
+      }
       self.ready();
     });
   }

integrations/adobe-analytics/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-integration-adobe-analytics",
   "description": "The Adobe Analytics analytics.js integration.",
-  "version": "1.16.6",
+  "version": "1.17.0",
   "keywords": [
     "analytics.js",
     "analytics.js-integration",

integrations/adobe-analytics/test/index.test.js

@@ -56,7 +56,8 @@ describe('Adobe Analytics', function() {
     enableTrackPageName: true,
     disableVisitorId: false,
     preferVisitorId: false,
-    enableHeartbeat: true
+    enableHeartbeat: true,
+    collectHighEntropyUserAgentHints: true
   };
 
   beforeEach(function() {
@@ -94,6 +95,7 @@ describe('Adobe Analytics', function() {
         .option('marketingCloudOrgId', null)
         .option('heartbeatTrackingServerUrl', '')
         .option('ssl', false)
+        .option('collectHighEntropyUserAgentHints', false)
     );
   });
 
@@ -165,6 +167,21 @@ describe('Adobe Analytics', function() {
           options.marketingCloudOrgId
         );
       });
+
+      it('should set window.s.collectHighEntropyUserAgentHints', function() {
+        analytics.equal(
+          window.s.collectHighEntropyUserAgentHints,
+          options.collectHighEntropyUserAgentHints
+        );
+      });
+
+      it('should set window.s.collectHighEntropyUserAgentHints when heartbeatServerUrl is set', function() {
+        adobeAnalytics.options.heartbeatTrackingServerUrl = 'test url';
+        analytics.equal(
+          window.s.collectHighEntropyUserAgentHints,
+          options.collectHighEntropyUserAgentHints
+        );
+      });
     });
 
     describe('#track', function() {