feat: EDS personalization using AEP Segments #54

rpapani · 2024-01-16T11:10:15Z

Please always provide the GitHub issue(s) your PR is for, as well as test URLs where your change can be observed (before and after):

Allows authors to configure the RTCDP audience in the metadata for personalization

- If the user consent is available and user qualifies for the segment, personalized content will be shown - Allows to send the cookie data to alloy in customer namespace so that developers can set the cookie and mapping will send this data to AEP, to qualify the user for the required segment - Until the user consent is available, the alloy renderDecisions API call will not happen, so the default page will be shown, which doesn't make call to alloy, so the LHS won't show the impact. - For improving the connection to AEP url, preconnect domains can be configured

Demo:

Navigate to https://aep-personalization-v2--wknd--hlxsites.hlx.live/drafts/ravi/home, check the default experience is provided
Accept the cookies, this will enable the tracking
Go to https://aep-personalization-v2--wknd--hlxsites.hlx.live/drafts/ravi/products, this will send the custom data that the user is interested in photoshop
Navigate back to https://aep-personalization-v2--wknd--hlxsites.hlx.live/drafts/ravi/home, since the user is interested in photoshop, the personalized page will be shown

Test URLs:

… alloy

aem-code-sync · 2024-01-16T11:10:19Z

Hello, I'm the AEM Code Sync Bot and I will run some actions to deploy your branch and validate page speed.
In case there are problems, just click a checkbox below to rerun the respective action.

Re-run PSI checks
Re-sync branch

Commits

63b20a1 ✅ (latest)
1b7811a ✅
10e912b ✅
2c09291 ✅
6558635 ✅
244fb98 ✅
6d7559b ❌
6c832bd ❌

aem-code-sync · 2024-01-16T11:10:33Z

Page	Scores	Audits	Google
/drafts/ravi/home
/drafts/ravi/products

ramboz · 2024-01-16T13:47:09Z

data/segment-mappings.json

@@ -0,0 +1 @@
+[{"id":"a44525f4-e115-41d3-a650-eaad3fa2a458","name":"Franklin Feedback Funnel State Lapsed Segment","description":"audience whose membership is lapsed"},{"id":"609b90e4-5306-4c37-b64b-e3026ad1f768","name":"Franklin Feedback photoshop Segment"},{"id":"e52f5a05-0f03-46e7-96a3-74446971af8e","name":"Franklin Feedback Interests segment"},{"id":"c2ba55f2-b327-4c5e-84b0-49df613cd71b","name":"Email Opened Segment"},{"id":"e0eab159-2464-4f93-b3c9-455ce5b5102a","name":"Test Alina2"},{"id":"78ef77be-bbf3-444d-bd15-f51043ce1f8f","name":"All test profiles"},{"id":"f8eeb1c4-42f0-4db5-a209-dc27c1224f23","name":"SitesNewsletterAudience"},{"id":"c891dba5-b7d0-4962-8152-f2463ebf408c","name":"ExpSuccess country segment"},{"id":"60c8669b-b9be-4242-b0ef-c3175808187b","name":"Visited Surf Product Detail Pages"},{"id":"de150daf-4bc5-4132-a550-dcea643cecee","name":"Female Surfers"},{"id":"f1972801-fd98-40b4-a313-18f1a3c84acb","name":"AlinaSegment"},{"id":"12af8939-12f2-4b41-a961-dba44b1e02d6","name":"SitesNewsletterv2"},{"id":"1ff20223-5239-4370-b887-6e69c28e5d28","name":"Cedric Huesler","description":"Person ID equals [email protected]"},{"id":"ef677d6f-44f9-4ac7-8827-c9ff745d1658","name":"Latha","description":"Latha Ramasamy"},{"id":"93f15377-5d55-4f1d-96f8-729ca4308d09","name":"Damian Test"},{"id":"50c89ea1-a3f8-4827-a61f-01ae6711c572","name":"AndreiP-segment"},{"id":"301fb79b-98ba-49ac-aafd-1b3b9e9066c2","name":"Demo segment"},{"id":"f417df3c-dbb0-40eb-8719-3d769d66917f","name":"Subscription - KFTest","description":"test (system generated segment for subscription - do NOT edit)"},{"id":"8ed561e9-bee2-45cf-988c-584f83d3ab96","name":"People who ordered in the last 30 days","description":"Last 30 days"},{"id":"6d7ac2f9-a806-4b90-a0f2-13cdee438acf","name":"Keara Only"},{"id":"f9aad193-fc81-4d1f-8bd0-7e4dcc6ff8ed","name":"Milestone Updates (All)"},{"id":"1946eedb-5372-42bc-85ad-673e0b6172cb","name":"WKND Adventure - Surfing","description":"A test segment of WKND adventurers that enjoy surfing"},{"id":"0839e05b-efff-485f-bbf3-13a533e15bd1","name":"demo"},{"id":"bbf00d86-ab3e-4e87-b77d-7cff7a4cfd36","name":"DX Summit Segment"},{"id":"be0d4fc6-e8f1-49cd-b247-57782f1c58f2","name":"Hemingway-Segment"},{"id":"f119b6e7-1814-4b86-99c6-1fefcca9c638","name":"Customer Journey"}]


Since this file is supposed to be cached by the sync action, I'd rather have the GH workflow as part of that PR as well, instead of a static version of the file

@ramboz I don't have access to settings on this repo, can you please help setting the secrets sent to you?

ramboz · 2024-01-16T13:48:16Z

plugins/experimentation/src/index.js

@@ -63,6 +65,10 @@ export async function getResolvedAudiences(applicableAudiences, options, context
  const results = await Promise.all(
    applicableAudiences
      .map((key) => {
+        if (key.indexOf(RTCDP_AUDIENCE_PREFIX) !== -1 && options.audiences[RTCDP_AUDIENCE_PREFIX]) {


I'd be tempted to remove this logic and just have the segment name in the document, and then mapped properly in the audiences Franklin Feedback photoshop Segment and franklin-feedback-photoshop-segment: () => { … }

If the goal was to have more dynamic mappings without having to specify the exact name, I'd be tempted to use a generic audience resolver then as a fallback, instead of a specific RTCDP one.

if (!options.audiences[key] && typeof options.audiences.default === 'function') { return options.audiences.default(key); }

Put probably best opened as a PR against https://github.com/adobe/aem-experimentation/ directly

@ramboz

I'd be tempted to remove this logic and just have the segment name in the document, and then mapped properly in the audiences Franklin Feedback photoshop Segment and franklin-feedback-photoshop-segment: () => { … }

want to use a generic name so that there's no development required to use the feature.

If the goal was to have more dynamic mappings without having to specify the exact name,

yes, this is the goal.

I'd be tempted to use a generic audience resolver then as a fallback, instead of a specific RTCDP one.

Does it make sense if these default/fallback audience resolve the audience from AEP? Should we document that? How about using the default/fallback audience, which will resolve the RTCDP audience if the rtcdp prefix is there. Does it make sense?

probably best opened as a PR against https://github.com/adobe/aem-experimentation/ directly

Yes, I'll do that. I can't easily verify things in aem-experimentation repo. So, I've opened here. Once this is complete, I'll submit the changes to aem-experimentation
Should I keep the default/fallback audience implementation in scripts.js or move that also to aem-experimentation and merge the DEFAULT_AUDIENCE from aem-experimentation to customer defined audiences?

Does it make sense if these default/fallback audience resolve the audience from AEP?

That would be dependent on the project. they would be responsible of implementing a default audience resolver and can decide how they map this

ramboz · 2024-01-16T13:53:46Z

scripts/scripts.js

@@ -32,6 +41,18 @@ const AUDIENCES = {
  desktop: () => window.innerWidth >= 600,
  'new-visitor': () => !localStorage.getItem('franklin-visitor-returning'),
  'returning-visitor': () => !!localStorage.getItem('franklin-visitor-returning'),
+  rtcdp: async (rtcdpAudience) => {


I'd use a default/generic/fallback instead so it's not specifically for RTCDP but more generic

ramboz · 2024-01-16T13:55:18Z

scripts/scripts.js

@@ -181,7 +202,9 @@ export function decorateMain(main) {
 */
 async function loadEager(doc) {
  document.documentElement.lang = 'en';
+  establishPreConnections();


I wonder if the preconnect meta is the best option. if we do want to optimize that way, I'd be tempted to go the extra mile and have that directly in the HTTP headers.

yeah, make sense. This can be added to head.html, I'll remove from here.

ramboz · 2024-01-17T09:22:21Z

head.html

+<link rel="preconnect" href="https://edge.adobedc.net">
+<link rel="preconnect" href="https://adobedc.demdex.net">


I wouldn't do this globally, but only for the pages that actually need it and inject this via the headers.xslx or metadata.xslx instead

rpapani added 6 commits January 16, 2024 00:16

feat: EDS personalization using AEP Segments

6c832bd

fix: adding support for mapping cookie data to schema

6d7559b

fix: using alloy renderDecisions for obtaining the segments

244fb98

fix: checking if the cookie consent is provided before making call to…

6558635

… alloy

fix: removing the cached segments

2c09291

fix: adding segment mappings

10e912b

rpapani requested review from ramboz and iuliag January 16, 2024 11:10

ramboz reviewed Jan 16, 2024

View reviewed changes

fix: review feedback

1b7811a

aem-code-sync bot temporarily deployed to aep-personalization-v2 January 17, 2024 04:34 Inactive

rpapani marked this pull request as ready for review January 17, 2024 04:34

ramboz reviewed Jan 17, 2024

View reviewed changes

fix: review feedback

63b20a1

aem-code-sync bot deployed to aep-personalization-v2 January 22, 2024 01:19 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: EDS personalization using AEP Segments #54

feat: EDS personalization using AEP Segments #54

rpapani commented Jan 16, 2024

aem-code-sync bot commented Jan 16, 2024 •

edited

Loading

aem-code-sync bot commented Jan 16, 2024 •

edited

Loading

ramboz Jan 16, 2024

rpapani Jan 17, 2024

ramboz Jan 16, 2024

rpapani Jan 17, 2024

ramboz Jan 17, 2024

ramboz Jan 16, 2024

ramboz Jan 16, 2024

rpapani Jan 17, 2024

ramboz Jan 17, 2024

		@@ -0,0 +1 @@
		[{"id":"a44525f4-e115-41d3-a650-eaad3fa2a458","name":"Franklin Feedback Funnel State Lapsed Segment","description":"audience whose membership is lapsed"},{"id":"609b90e4-5306-4c37-b64b-e3026ad1f768","name":"Franklin Feedback photoshop Segment"},{"id":"e52f5a05-0f03-46e7-96a3-74446971af8e","name":"Franklin Feedback Interests segment"},{"id":"c2ba55f2-b327-4c5e-84b0-49df613cd71b","name":"Email Opened Segment"},{"id":"e0eab159-2464-4f93-b3c9-455ce5b5102a","name":"Test Alina2"},{"id":"78ef77be-bbf3-444d-bd15-f51043ce1f8f","name":"All test profiles"},{"id":"f8eeb1c4-42f0-4db5-a209-dc27c1224f23","name":"SitesNewsletterAudience"},{"id":"c891dba5-b7d0-4962-8152-f2463ebf408c","name":"ExpSuccess country segment"},{"id":"60c8669b-b9be-4242-b0ef-c3175808187b","name":"Visited Surf Product Detail Pages"},{"id":"de150daf-4bc5-4132-a550-dcea643cecee","name":"Female Surfers"},{"id":"f1972801-fd98-40b4-a313-18f1a3c84acb","name":"AlinaSegment"},{"id":"12af8939-12f2-4b41-a961-dba44b1e02d6","name":"SitesNewsletterv2"},{"id":"1ff20223-5239-4370-b887-6e69c28e5d28","name":"Cedric Huesler","description":"Person ID equals [email protected]"},{"id":"ef677d6f-44f9-4ac7-8827-c9ff745d1658","name":"Latha","description":"Latha Ramasamy"},{"id":"93f15377-5d55-4f1d-96f8-729ca4308d09","name":"Damian Test"},{"id":"50c89ea1-a3f8-4827-a61f-01ae6711c572","name":"AndreiP-segment"},{"id":"301fb79b-98ba-49ac-aafd-1b3b9e9066c2","name":"Demo segment"},{"id":"f417df3c-dbb0-40eb-8719-3d769d66917f","name":"Subscription - KFTest","description":"test (system generated segment for subscription - do NOT edit)"},{"id":"8ed561e9-bee2-45cf-988c-584f83d3ab96","name":"People who ordered in the last 30 days","description":"Last 30 days"},{"id":"6d7ac2f9-a806-4b90-a0f2-13cdee438acf","name":"Keara Only"},{"id":"f9aad193-fc81-4d1f-8bd0-7e4dcc6ff8ed","name":"Milestone Updates (All)"},{"id":"1946eedb-5372-42bc-85ad-673e0b6172cb","name":"WKND Adventure - Surfing","description":"A test segment of WKND adventurers that enjoy surfing"},{"id":"0839e05b-efff-485f-bbf3-13a533e15bd1","name":"demo"},{"id":"bbf00d86-ab3e-4e87-b77d-7cff7a4cfd36","name":"DX Summit Segment"},{"id":"be0d4fc6-e8f1-49cd-b247-57782f1c58f2","name":"Hemingway-Segment"},{"id":"f119b6e7-1814-4b86-99c6-1fefcca9c638","name":"Customer Journey"}]

		<link rel="preconnect" href="https://edge.adobedc.net">
		<link rel="preconnect" href="https://adobedc.demdex.net">

feat: EDS personalization using AEP Segments #54

Are you sure you want to change the base?

feat: EDS personalization using AEP Segments #54

Conversation

rpapani commented Jan 16, 2024

aem-code-sync bot commented Jan 16, 2024 • edited Loading

aem-code-sync bot commented Jan 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aem-code-sync bot commented Jan 16, 2024 •

edited

Loading

aem-code-sync bot commented Jan 16, 2024 •

edited

Loading