MWPW-134799: MEP On/Off #1580

3ch023 · 2023-11-27T14:03:34Z

MEP On/Off

This PR introduces a client-side on/off feature for MEP manifests.
Related Discussion
More details below.

Resolves:

Test URLs:

Details

Promotions.xlsx

Promotions.xlsx - a separate global metadata file, configured in .helix/config.xlsx

located in root (milo folder)
holds connection folder/page-manifest and on/off date times.
serves metadata from the 'helix-default' tab
has the 'schedule' tab to configure on/off dates
The 'helix-default' has a hidden column called 'scheduled'. It is auto-generated from the 'schedule' tab and only visible when you preview promotions.xlsx.

Why a separate metadata file?

avoid conflicts & risks when GWP is modifying the main metadata file to configure promotions
easier overview & troubleshooting for promo issues
potential automation data file

Schedule Tab

no row/column can be deleted -> that would break generation functions in the 'concut' tab
datepicker & formatting for date fields
time formating for time fields
active/inactive controls if the schedule line is applied to metadata. GWP can set a line to inactive if they want to re-enable it later.

Priority

Promotions.xlsx is higher priority than metdata.xlsx
Promotions.xlsx only allows 2 fields to be configured, 'personalization' and 'events'. Its protected, so no other column from global metadata can be overwritten. On the contrary, global metadata should not be able to overwrite the 'personalization' and 'events' data in promotions.xlsx.
Priority is achieved due to order in .helix/config.xlsx

'manifestnames' and 'schedule' meta tags

'manifestnames' contains manifests attached to this particular page (similar to 'personalization' field, but instead of path GWP can use a so-called manifest nickname, from the schedule tab)
'schedule' contains all active promo schedule lines
'schedule' line format: manifest name | start datetime (GMT) | end datetime (GMT) | manifest path
Sample page

<meta name="manifestnames" content="pre-black-friday-global,black-friday-global,cyber-monday">
<meta name="schedule" content="pre-black-friday-global | 2023-11-01T00:00:00 | 2023-12-15T00:00:00 | https://main--milo--adobecom.hlx.page/promos/2023/black-friday/pre-black-friday/manifest-global.json, black-friday-global | 2023-12-15T00:00:00 | 2023-12-31T00:00:00 | https://main--milo--adobecom.hlx.page/promos/2023/black-friday/black-friday/manifest-global.json">

MEP behavior

MEP will read 'schedule' metadata
MEP will sort out of 'schedule' promo manifests attached to this page
For each manifest it will decide if its enabled (scheduled for current time) or disabled (scheduled outside of current time or the schedule is missing at all)
MEP will handle the manifests from 'personalization' and the ones from 'promo' in the same way. The 'personalization' manifests are lower priority - to be discussed.
if 'bts' event is found, the start and end datetime are converted to a local browser time, then compared with the current time. If it's on - manifest is enabled, if not - disabled.
disabled manifest is NOT preloaded and NOT fetched. This is true for both hlx.page and hlx.live.
Preview for promo manifests work the same as for usual personalization.

Preview

'Scheduled - inactive/active' shows if the current browser time is within the manifest's on/off period.
On and Off date time is shown in the local timezone, NOT in GMT.
When there is a manifest overwrite in the URL, MEP will disregard the schedule. This is needed for QA-ing inactive changes.

aem-code-sync · 2023-11-27T14:03:37Z

Hello, I'm the AEM Code Sync Bot and I will run some test suites that validate the page speed.
In case there are problems, just click the checkbox below to rerun the respective action.

Re-run PSI Checks

aem-code-sync · 2023-11-27T14:03:53Z

Page	Scores	Audits	Google
/fr/special-offers/special-offers?martech=off

npeltier · 2023-11-28T13:20:20Z

libs/features/personalization/manifest-utils.js

+  let event = null;
+  const scheduled = manifestPath.match(REGEX_PROMO);
+  if (scheduled) {
+    event = events.find((e) => e.name === scheduled[1]);


what is 1? could we use a talkative constant (PROMO_NAME_GRP?)

constant is now gone completely because of a changed approach

npeltier · 2023-11-28T13:22:48Z

libs/features/personalization/personalization.js

  for (const manifest of cleanedManifests) {
-    results.push(await runPersonalization(manifest, config));
+    const noOverride = !config.mep?.override;


wouldn't it be clearer to have an override flag, and then !override test?

npeltier · 2023-11-28T13:25:24Z

libs/features/personalization/manifest-utils.js


+const REGEX_PROMO = /\/promos\/(\w+)\//;


is \w+ enough for first level folder? characters like '-' or '_' are allowed, no?

very good point, this regex certainly needs more thinking.
let me research a bit more and fix it up

removed regex at all

npeltier · 2023-11-28T13:32:29Z

libs/features/personalization/manifest-utils.js

+      disabled = true;
+    } else {
+      const currentDate = new Date();
+      if (event.start && event.end


don't we want to manage "evergreen" promotion that are endless?

for now, i don't recall such use-case.
can you give more details?
how will it work?

never mind, just checked, and those use cases are not meant to leverage mep anyway.

don't we want to manage "evergreen" promotion that are endless?

Evergreen sounds like regular content then, no? Should not be tied to promotion anymore in that case.

aem-code-sync · 2023-11-30T15:00:08Z

Page	Scores	Audits	Google
/fr/special-offers/special-offers?martech=off

aem-code-sync · 2023-11-30T15:01:41Z

Page	Scores	Audits	Google
/fr/special-offers/special-offers?martech=off

aem-code-sync · 2023-11-30T15:02:57Z

Page	Scores	Audits	Google
/fr/special-offers/special-offers?martech=off
/products/special-offers?martech=off		Lighthouse returned error: ERRORED_DOCUMENT_REQUEST. Lighthouse was unable to reliably load the page you requested. Make sure you are testing the correct URL and that the server is properly responding to all requests. (Status code: 404)

aem-code-sync · 2023-11-30T15:07:52Z

Page	Scores	Audits	Google
/fr/special-offers/special-offers?martech=off
/products/special-offers?martech=off

aem-code-sync · 2023-11-30T15:27:03Z

Page	Scores	Audits	Google
/products/special-offers?martech=off

aem-code-sync · 2023-11-30T16:59:01Z

Page	Scores	Audits	Google
/products/special-offers?martech=off

aem-code-sync · 2023-12-01T13:38:26Z

Page	Scores	Audits	Google
/products/special-offers?martech=off

3ch023 · 2023-12-01T13:41:34Z

for now rebased on mwpw-138750-analytics2 as agreed with @vivgoodrich,
once pull/1531 is merged, this PR will be rebased to the main and ready to merge.

codecov · 2023-12-05T11:51:51Z

Codecov Report

Attention: 12 lines in your changes are missing coverage. Please review.

Comparison is base (951817c) 95.65% compared to head (60260f4) 95.05%.

Files	Patch %	Lines
.../features/personalization/add-preview-to-config.js	22.22%	7 Missing ⚠️
libs/features/personalization/preview.js	0.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1580      +/-   ##
==========================================
- Coverage   95.65%   95.05%   -0.60%     
==========================================
  Files         150      153       +3     
  Lines       38783    39170     +387     
==========================================
+ Hits        37097    37234     +137     
- Misses       1686     1936     +250

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

elevendozen · 2023-12-05T23:19:47Z

@3ch023 et al... as of today i finally have all my "tests" up and running in the new system, and so far it is a huge step forward! I have various promos (marquee, segment, medium promo, sticky, etc) for various campaigns (bf, bts, ste). I've updated the master "promotions" spreadsheet manifest with a matrix we can use for our yearly cycle... so yes... it all feels right, so far...
Small request: can we move "promotions" manifest from /www/ and into /www/promos/, that way all promo stuff is together under the promos directory? What is the impact?

3ch023 · 2023-12-06T15:27:37Z

can we move "promotions" manifest from /www/ and into /www/promos/

sure, moved it in both CC and Milo

npeltier

lgtm

As discussed offline, i would have preferred i think to leave promotion semantic out of mep completely. metadata name manifestpaths goes in that route. Ideally we could have mep having the feature to override bits of the site at schedule moments, and commerce users using that feature for promotion purpose.
I keep in mind though promotion is our main driver, and making things generic is not always the best route at the beginning. Let's see what usage gives us

* MWPW-134799: add on/off to MEP

3ch023 requested a review from a team as a code owner November 27, 2023 14:03

3ch023 requested review from npeltier and honstar November 27, 2023 14:03

3ch023 requested review from auniverseaway, chrischrischris and vgoodric November 27, 2023 14:03

3ch023 added run-nala Run Nala Test Automation against PR needs-verification PR requires E2E testing by a reviewer labels Nov 27, 2023

npeltier reviewed Nov 28, 2023

View reviewed changes

3ch023 added the do not merge PR should not be merged yet label Dec 1, 2023

3ch023 force-pushed the onoff branch from 1043802 to f19cfdf Compare December 1, 2023 13:37

3ch023 requested review from overmyheadandbody, mokimo, narcis-radu and ryanmparrish as code owners December 1, 2023 13:37

3ch023 changed the base branch from main to mwpw-138750-analytics2 December 1, 2023 13:39

Base automatically changed from mwpw-138750-analytics2 to main December 4, 2023 20:30

3ch023 added 2 commits December 5, 2023 12:46

MWPW-134799: add on/off to MEP

e93ae69

fix error

4103f1f

3ch023 force-pushed the onoff branch from f19cfdf to 4103f1f Compare December 5, 2023 11:49

fix untrimmed attached manifest

3620789

vgoodric approved these changes Dec 6, 2023

View reviewed changes

Merge branch 'main' into onoff

1809c43

3ch023 added verified PR has been E2E tested by a reviewer and removed do not merge PR should not be merged yet needs-verification PR requires E2E testing by a reviewer labels Dec 6, 2023

npeltier approved these changes Dec 6, 2023

View reviewed changes

chrischrischris approved these changes Dec 6, 2023

View reviewed changes

3ch023 added 4 commits December 7, 2023 16:02

add tests

de2ea63

Merge branch 'main' into onoff

f69e8fd

improve tests

6b72eac

add updated schedule

60260f4

3ch023 merged commit fb696a6 into main Dec 7, 2023
7 of 11 checks passed

3ch023 deleted the onoff branch December 7, 2023 15:21

yesil pushed a commit to yesil/milo that referenced this pull request Dec 14, 2023

MWPW-134799: MEP On/Off (adobecom#1580)

665a44f

* MWPW-134799: add on/off to MEP

VKniaz pushed a commit to VKniaz/milo that referenced this pull request Dec 15, 2023

MWPW-134799: MEP On/Off (adobecom#1580)

4a57dcc

* MWPW-134799: add on/off to MEP

vgoodric pushed a commit to vgoodric/bootcamp-milo that referenced this pull request Feb 1, 2024

MWPW-134799: MEP On/Off (adobecom#1580)

56496b5

* MWPW-134799: add on/off to MEP

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MWPW-134799: MEP On/Off #1580

MWPW-134799: MEP On/Off #1580

3ch023 commented Nov 27, 2023 •

edited

Loading

aem-code-sync bot commented Nov 27, 2023 •

edited

Loading

aem-code-sync bot commented Nov 27, 2023

npeltier Nov 28, 2023

3ch023 Nov 30, 2023

npeltier Nov 28, 2023

3ch023 Dec 1, 2023

npeltier Nov 28, 2023

3ch023 Nov 28, 2023

3ch023 Nov 30, 2023

npeltier Nov 28, 2023

3ch023 Nov 28, 2023

npeltier Nov 28, 2023 •

edited

Loading

honstar Dec 4, 2023

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Dec 1, 2023 •

edited

Loading

3ch023 commented Dec 1, 2023

codecov bot commented Dec 5, 2023 •

edited

Loading

elevendozen commented Dec 5, 2023

3ch023 commented Dec 6, 2023

npeltier left a comment

MWPW-134799: MEP On/Off #1580

MWPW-134799: MEP On/Off #1580

Conversation

3ch023 commented Nov 27, 2023 • edited Loading

MEP On/Off

Resolves:

Test URLs:

Details

Schedule Tab

Priority

'manifestnames' and 'schedule' meta tags

MEP behavior

Preview

aem-code-sync bot commented Nov 27, 2023 • edited Loading

aem-code-sync bot commented Nov 27, 2023

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

npeltier Nov 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Nov 30, 2023

aem-code-sync bot commented Dec 1, 2023 • edited Loading

3ch023 commented Dec 1, 2023

codecov bot commented Dec 5, 2023 • edited Loading

Codecov Report

elevendozen commented Dec 5, 2023

3ch023 commented Dec 6, 2023

npeltier left a comment

Choose a reason for hiding this comment

3ch023 commented Nov 27, 2023 •

edited

Loading

aem-code-sync bot commented Nov 27, 2023 •

edited

Loading

npeltier Nov 28, 2023 •

edited

Loading

aem-code-sync bot commented Dec 1, 2023 •

edited

Loading

codecov bot commented Dec 5, 2023 •

edited

Loading