MWPW-156867 [MILO][MEP][ANALYTICS] Support Column nicknames

libs/features/personalization/personalization.js

@@ -47,8 +47,8 @@ let isPostLCP = false;
 
 export const TRACKED_MANIFEST_TYPE = 'personalization';
 
-// Replace any non-alpha chars except comma, space, ampersand and hyphen
-const RE_KEY_REPLACE = /[^a-z0-9\- _,&=]/g;
+// Replace any non-alpha chars except comma, space, ampersand, colon, and hyphen
+const RE_KEY_REPLACE = /[^a-z0-9\- _,&=:]/g;
 
 const MANIFEST_KEYS = [
   'action',
@@ -574,7 +574,7 @@ const getVariantInfo = (line, variantNames, variants, manifestPath, fTargetId) =
   if (!config.mep?.preview) manifestId = false;
   const { origin } = PAGE_URL;
   variantNames.forEach((vn) => {
-    const targetManifestId = vn.startsWith(TARGET_EXP_PREFIX) ? targetId : false;
+    const targetManifestId = vn.includes(TARGET_EXP_PREFIX) ? targetId : false;
     if (!line[vn] || line[vn].toLowerCase() === 'false') return;
 
     const variantInfo = {
@@ -784,14 +784,16 @@ async function getPersonalizationVariant(manifestPath, variantNames = [], varian
   }
 
   const hasMatch = (name) => {
-    if (name === '') return true;
+    if (!name) return true;
     if (name === variantLabel?.toLowerCase()) return true;
     if (name.startsWith('param-')) return checkForParamMatch(name);
     if (userEntitlements?.includes(name)) return true;
     return PERSONALIZATION_KEYS.includes(name) && PERSONALIZATION_TAGS[name]();
   };
 
-  const matchVariant = (name) => {
+  const matchVariant = (n) => {
+    // split before checks
+    const name = n.includes(':') ? n.split(':')[1] : n;
     if (name.startsWith(TARGET_EXP_PREFIX)) return hasMatch(name);
     const processedList = name.split('&').map((condition) => {
       const reverse = condition.trim().startsWith(COLUMN_NOT_OPERATOR);
@@ -1078,7 +1080,12 @@ export async function applyPers(manifests) {
 
   const pznVariants = pznList.map((r) => {
     const val = r.experiment.selectedVariantName.replace(TARGET_EXP_PREFIX, '').trim().slice(0, 15);
-    return val === 'default' ? 'nopzn' : val;
+    const arr = val.split(':');
+    if (arr.length > 2 || arr[0]?.trim() === '' || arr[1]?.trim() === '') {
+      log('MEP Error: When using (optional) column nicknames, please use the following syntax: "<nickname>: <original audience>"');
+    }
+    if (!val.includes(':') || val.startsWith(':')) return val === 'default' ? 'nopzn' : val;
+    return arr[0].trim();
   });
   const pznManifests = pznList.map((r) => r.experiment.analyticsTitle);
   config.mep.martech = `|${pznVariants.join('--')}|${pznManifests.join('--')}`;

test/features/personalization/mocks/manifestWithAmpersand.json

@@ -23,7 +23,7 @@
         "action":"replaceContent",
         "selector":"#notthere",
         "page filter (optional)":"",
-        "chrome & loggedout":"https://main--milo--adobecom.hlx.page/drafts/vgoodrich/fragments/139173-mep-and/android"
+        "my nickname: chrome & loggedout":"https://main--milo--adobecom.hlx.page/drafts/vgoodrich/fragments/139173-mep-and/android"
       }
     ]
   },

test/features/personalization/mocks/manifestWithNicknames.json

@@ -0,0 +1,53 @@
+{
+  "info": {
+    "total": 3,
+    "offset": 0,
+    "limit": 3,
+    "data": [
+      {
+        "key": "manifest-type",
+        "value": "Personalization"
+      },
+      {
+        "key": "manifest-override-name",
+        "value": ""
+      },
+      {
+        "key": "manifest-execution-order",
+        "value": "Normal"
+      }
+    ]
+  },
+  "experiences": {
+    "total": 1,
+    "offset": 0,
+    "limit": 1,
+    "data": [
+      {
+        "action": "replace",
+        "selector": "any-header",
+        "page filter (optional)": "",
+        "target-var1": "target-var1",
+        "challenger 2: target-var2": "challenger 2: target-var2",
+        "param-nickname=false": "param-nickname=false",
+        "pzn2: param-nickname=true": "pzn2: param-nickname=true",
+        "pzn2: param-nickname=double:": "pzn2: param-nickname=double:",
+        "param-nickname=end:": "param-nickname=end:",
+        ":param-nickname=start": ":param-nickname=start"
+      }
+    ]
+  },
+  "placeholders": {
+    "total": 0,
+    "offset": 0,
+    "limit": 0,
+    "data": []
+  },
+  ":version": 3,
+  ":names": [
+    "experiences",
+    "info",
+    "placeholders"
+  ],
+  ":type": "multi-sheet"
+}

test/features/personalization/personalization.test.js

@@ -35,6 +35,7 @@ describe('Functional Test', () => {
     // Add custom keys so tests doesn't rely on real data
     const config = getConfig();
     config.env = { name: 'prod' };
+    config.locale = { ietf: 'en-US', prefix: '' };
     config.consumerEntitlements = {
       '11111111-aaaa-bbbb-6666-cccccccccccc': 'my-special-app',
       '22222222-xxxx-bbbb-7777-cccccccccccc': 'fireflies',
@@ -152,11 +153,11 @@ describe('Functional Test', () => {
     expect(config.mep?.martech).to.be.undefined;
   });
 
-  it('should choose chrome & logged out', async () => {
+  it('should choose chrome & logged out (using nickname)', async () => {
     await loadManifestAndSetResponse('./mocks/manifestWithAmpersand.json');
     await init(mepSettings);
     const config = getConfig();
-    expect(config.mep?.martech).to.equal('|chrome & logged|ampersand');
+    expect(config.mep?.martech).to.equal('|my nickname|ampersand');
   });
 
   it('should choose not firefox', async () => {
@@ -166,6 +167,52 @@ describe('Functional Test', () => {
     expect(config.mep?.martech).to.equal('|not firefox|not');
   });
 
+  it('should not error when nickname has multiple colons', async () => {
+    await loadManifestAndSetResponse('./mocks/manifestWithNicknames.json');
+    const tempMepSettings = {
+      mepParam: '/path/to/manifest.json--pzn2: param-nickname=double:',
+      mepHighlight: false,
+      mepButton: false,
+      pzn: '/path/to/manifest.json',
+      promo: false,
+      target: false,
+    };
+    await init(tempMepSettings);
+    const config = getConfig();
+    console.log('test: ', config);
+    expect(config.mep?.martech).to.equal('|pzn2|manifest');
+  });
+
+  it('should not error when name nickname is empty', async () => {
+    await loadManifestAndSetResponse('./mocks/manifestWithNicknames.json');
+    const tempMepSettings = {
+      mepParam: '/path/to/manifest.json--:param-nickname=start',
+      mepHighlight: false,
+      mepButton: false,
+      pzn: '/path/to/manifest.json',
+      promo: false,
+      target: false,
+    };
+    await init(tempMepSettings);
+    const config = getConfig();
+    expect(config.mep?.martech).to.equal('|:param-nickname|manifest');
+  });
+
+  it('should show nickname instead of original audience when using nicknames syntax', async () => {
+    await loadManifestAndSetResponse('./mocks/manifestWithNicknames.json');
+    const tempMepSettings = {
+      mepParam: '/path/to/manifest.json--pzn2: param-nickname=true',
+      mepHighlight: false,
+      mepButton: false,
+      pzn: '/path/to/manifest.json',
+      promo: false,
+      target: false,
+    };
+    await init(tempMepSettings);
+    const config = getConfig();
+    expect(config.mep?.martech).to.equal('|pzn2|manifest');
+  });
+
   it('should read and use entitlement data', async () => {
     setConfig(getConfig());
     const config = getConfig();