IntentIq ID Module: AB group updates, bug fixes (prebid#14136)

* 0.33 version

* AGT-705: AB group by TC (prebid#49)

* AGT-705: AB group by TC

* Remove extra param in utils method

* AGT-705: abTestUuid and abPercentage by user

* AGT-705: Fix tests, refactoring

* AGT-705: Changes after review

* text changes

---------

Co-authored-by: DimaIntentIQ <dmytro.piskun@intentiq.com>

* partner callback encrypted string (prebid#47)

Co-authored-by: Eyvaz Ahmadzada <eyvazahmadzada@gmail.com>
Co-authored-by: DimaIntentIQ <139111483+DimaIntentIQ@users.noreply.github.com>

* Change communication way between modules. (prebid#50)

* Change communication way between modules.

* Log error refactoring

* fix waiting for CH in tests

* move action file to action/save folder

* fix  "success" process in getting Partner data  from global object

* Share abGroup between modules thru a global object instead of using function in both ones

* fix failed test in CI/CD

* group related updates

* add new parameters related to group

* Analytical adapter config updates, GAM fixes

---------

Co-authored-by: dmytro-po <dmytro.po@intentiq.com>
Co-authored-by: Eyvaz <62054743+eyvazahmadzada@users.noreply.github.com>
Co-authored-by: Eyvaz Ahmadzada <eyvazahmadzada@gmail.com>
Co-authored-by: Patrick McCann <patmmccann@gmail.com>
Co-authored-by: JulianRSL <88969792+JulianRSL@users.noreply.github.com>

Author: 6 people

libraries/intentIqConstants/intentIqConstants.js

@@ -1,19 +1,19 @@
-export const FIRST_PARTY_KEY = '_iiq_fdata';
+export const FIRST_PARTY_KEY = "_iiq_fdata";
 
-export const SUPPORTED_TYPES = ['html5', 'cookie']
+export const SUPPORTED_TYPES = ["html5", "cookie"];
 
-export const WITH_IIQ = 'A';
-export const WITHOUT_IIQ = 'B';
-export const NOT_YET_DEFINED = 'U';
-export const BLACK_LIST = 'L';
-export const CLIENT_HINTS_KEY = '_iiq_ch';
-export const EMPTY = 'EMPTY';
-export const GVLID = '1323';
-export const VERSION = 0.32;
-export const PREBID = 'pbjs';
+export const WITH_IIQ = "A";
+export const WITHOUT_IIQ = "B";
+export const DEFAULT_PERCENTAGE = 95;
+export const BLACK_LIST = "L";
+export const CLIENT_HINTS_KEY = "_iiq_ch";
+export const EMPTY = "EMPTY";
+export const GVLID = "1323";
+export const VERSION = 0.33;
+export const PREBID = "pbjs";
 export const HOURS_24 = 86400000;
 
-export const INVALID_ID = 'INVALID_ID';
+export const INVALID_ID = "INVALID_ID";
 
 export const SYNC_REFRESH_MILL = 3600000;
 export const META_DATA_CONSTANT = 256;
@@ -25,10 +25,24 @@ export const MAX_REQUEST_LENGTH = {
   opera: 2097152,
   edge: 2048,
   firefox: 65536,
-  ie: 2048
+  ie: 2048,
 };
 
 export const CH_KEYS = [
-  'brands', 'mobile', 'platform', 'bitness', 'wow64', 'architecture',
-  'model', 'platformVersion', 'fullVersionList'
+  "brands",
+  "mobile",
+  "platform",
+  "bitness",
+  "wow64",
+  "architecture",
+  "model",
+  "platformVersion",
+  "fullVersionList",
 ];
+
+export const AB_CONFIG_SOURCE = {
+  PERCENTAGE: "percentage",
+  GROUP: "group",
+  IIQ_SERVER: "IIQServer",
+  DISABLED: "disabled",
+};

libraries/intentIqUtils/defineABTestingGroupUtils.js

@@ -0,0 +1,74 @@
+import {
+  WITH_IIQ,
+  WITHOUT_IIQ,
+  DEFAULT_PERCENTAGE,
+  AB_CONFIG_SOURCE,
+} from "../intentIqConstants/intentIqConstants.js";
+
+/**
+ * Fix percentage if provided some incorrect data
+ * clampPct(150) => 100
+ * clampPct(-5) => 0
+ * clampPct('abc') => DEFAULT_PERCENTAGE
+ */
+function clampPct(val) {
+  const n = Number(val);
+  if (!Number.isFinite(n)) return DEFAULT_PERCENTAGE; // fallback = 95
+  return Math.max(0, Math.min(100, n));
+}
+
+/**
+ * Randomly assigns a user to group A or B based on the given percentage.
+ * Generates a random number (1–100) and compares it with the percentage.
+ *
+ * @param {number} pct The percentage threshold (0–100).
+ * @returns {string} Returns WITH_IIQ for Group A or WITHOUT_IIQ for Group B.
+ */
+function pickABByPercentage(pct) {
+  const percentageToUse =
+  typeof pct === "number" ? pct : DEFAULT_PERCENTAGE;
+  const percentage = clampPct(percentageToUse);
+  const roll = Math.floor(Math.random() * 100) + 1;
+  return roll <= percentage ? WITH_IIQ : WITHOUT_IIQ; // A : B
+}
+
+function configurationSourceGroupInitialization(group) {
+  return typeof group === 'string' && group.toUpperCase() === WITHOUT_IIQ ? WITHOUT_IIQ : WITH_IIQ;
+}
+
+/**
+ * Determines the runtime A/B testing group without saving it to Local Storage.
+ * 1. If terminationCause (tc) exists:
+ *      - tc = 41 → Group B (WITHOUT_IIQ)
+ *      - any other value → Group A (WITH_IIQ)
+ * 2. Otherwise, assigns the group randomly based on DEFAULT_PERCENTAGE (default 95% for A, 5% for B).
+ *
+ * @param {number} [tc] The termination cause value returned by the server.
+ * @param {number} [abPercentage] A/B percentage provided by partner.
+ * @returns {string} The determined group: WITH_IIQ (A) or WITHOUT_IIQ (B).
+ */
+
+function IIQServerConfigurationSource(tc, abPercentage) {
+  if (typeof tc === "number" && Number.isFinite(tc)) {
+    return tc === 41 ? WITHOUT_IIQ : WITH_IIQ;
+  }
+
+  return pickABByPercentage(abPercentage);
+}
+
+export function defineABTestingGroup(configObject, tc) {
+  switch (configObject.ABTestingConfigurationSource) {
+    case AB_CONFIG_SOURCE.GROUP:
+      return configurationSourceGroupInitialization(
+        configObject.group
+      );
+    case AB_CONFIG_SOURCE.PERCENTAGE:
+      return pickABByPercentage(configObject.abPercentage);
+    default: {
+      if (!configObject.ABTestingConfigurationSource) {
+        configObject.ABTestingConfigurationSource = AB_CONFIG_SOURCE.IIQ_SERVER;
+      }
+      return IIQServerConfigurationSource(tc, configObject.abPercentage);
+    }
+  }
+}

libraries/intentIqUtils/gamPredictionReport.js

@@ -55,6 +55,7 @@ export function gamPredictionReport (gamObjectReference, sendData) {
                 dataToSend.originalCurrency = bid.originalCurrency;
                 dataToSend.status = bid.status;
                 dataToSend.prebidAuctionId = element.args?.auctionId;
+                if (!dataToSend.bidderCode) dataToSend.bidderCode = 'GAM';
               };
               if (dataToSend.bidderCode) {
                 const relevantBid = element.args?.bidsReceived.find(
@@ -86,12 +87,12 @@ export function gamPredictionReport (gamObjectReference, sendData) {
       gamObjectReference.pubads().addEventListener('slotRenderEnded', (event) => {
         if (event.isEmpty) return;
         const data = extractWinData(event);
-        if (data?.cpm) {
+        if (data) {
           sendData(data);
         }
       });
     });
   } catch (error) {
-    this.logger.error('Failed to subscribe to GAM: ' + error);
+    logError('Failed to subscribe to GAM: ' + error);
   }
 };