feat(v2): adding support for multiple experiments, audiences and campaigns per page #28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
… the rum library in the future
… the rum library in the future
<!--- Provide a general summary of your changes in the Title above --> ## Description This feature allows authors to specify custom labels for **both page and section experiment variants** via metadata and section metadata. While the internal variant IDs remain in a predefined format (e.g., challenger-1, challenger-2), the labels in the overlay pill can be customized to provide more meaningful names.
## Description Fix the getMetadata function in extracting metadata tags from the document's head. The function now is able to handle meta tags with names or properties. (e.g. < meta property="campaign:-registration" content="https://main--wknd--hlxsites.hlx.page/drafts/xfeng/page-variants/page-variant1" >)
9 tasks
When the format `Audience: mobile `or `Campaign: c1` appears in the page metadata, the space after the colon will be read as a hyphen which could cause a potential issue when we extract the value by applying the substring based on the string length.
<!--- Provide a general summary of your changes in the Title above --> ## Description Fix making request failure caused by the difference between provided url in doc and the domain serving on webpage. <!--- Describe your changes in detail -->  <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [x] I have signed the [Adobe Open Source CLA](https://opensource.adobe.com/cla.html). - [x] My code follows the code style of this project. - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. - [x] I have read the **CONTRIBUTING** document. - [ ] I have added tests to cover my changes. - [x] All new and existing tests passed.
<!--- Provide a general summary of your changes in the Title above --> ## Description Leverage"Variant" entry in manifest to support variant name customization for fragment experimentation. <!--- Describe your changes in detail -->  ## Related Issue ## Related Issue <!--- This project only accepts pull requests related to open issues --> <!--- If suggesting a new feature or change, please discuss it in an issue first --> <!--- If fixing a bug, there should be an issue describing it with steps to reproduce --> <!--- Please link to the issue here: --> ## Motivation and Context <!--- Why is this change required? What problem does it solve? --> ## How Has This Been Tested? <!--- Please describe in detail how you tested your changes. --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> ## Screenshots (if appropriate): ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [x] I have signed the [Adobe Open Source CLA](https://opensource.adobe.com/cla.html). - [x] My code follows the code style of this project. - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. - [x] I have read the **CONTRIBUTING** document. - [ ] I have added tests to cover my changes. - [x] All new and existing tests passed. --------- Co-authored-by: Julien Ramboz <ramboz@adobe.com>
<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> The **branch** with preview files: https://github.com/adobe/aem-experimentation/tree/gh-pages **Todo:** Configure the adobe.github.io to point to the gh-pages branch. ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [x] I have signed the [Adobe Open Source CLA](https://opensource.adobe.com/cla.html). - [x] My code follows the code style of this project. - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. - [x] I have read the **CONTRIBUTING** document. - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed. --------- Co-authored-by: Julien Ramboz <ramboz@adobe.com>
<!--- Provide a general summary of your changes in the Title above -->
## Description
The fragment decoration needs more logic on handling decorations.
We leveraged Eventlistener, at the same time introduce decoration
handler on index.js to handle the logic of redecorating.
<!--- Describe your changes in detail -->
`reDecorateBlocks` function and `buildBlock` fucntion are defined inside
of project's script.js, where we need to pass from.
```
export function reDecorateBlocks(el) {
if (!el.classList.contains('block')) return;
decorateBlock(el);
loadBlock(el);
}
```
## Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an
issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps
to reproduce -->
<!--- Please link to the issue here: -->
## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->
## Screenshots (if appropriate):
## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
- [ ] I have signed the [Adobe Open Source
CLA](https://opensource.adobe.com/cla.html).
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
… page metadata (#41) <!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> In the demo, we agree that defining `Experiment Name` property for customizing variant name is not intuitive enough and can confuse with `Experiment` property. Therefore, I update the doc to `Experiment Variant Name` or `Experiment Variant Names` , that authors can define the variant name and also leverage the experimentsMetaTagPrefix. <img width="400" alt="Screenshot 2024-08-06 at 9 23 40 AM" src="https://github.com/user-attachments/assets/7ebb66f5-2977-45f2-a470-916928b4f2cc"> <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [x] I have signed the [Adobe Open Source CLA](https://opensource.adobe.com/cla.html). - [x] My code follows the code style of this project. - [x] My change requires a change to the documentation. - [x] I have updated the documentation accordingly. - [x] I have read the **CONTRIBUTING** document. - [ ] I have added tests to cover my changes. - [x] All new and existing tests passed.
<!--- Provide a general summary of your changes in the Title above --> ## Description The aim is to run full-page experimentation and personalization use cases that fully redirect to the target URL instead of just replacing the content for a marketer. The new properties are introduced: ``` Experiment Resolution | redirect Audience Resolution | redirect Campaign Resolution | redirect ``` <img width="624" alt="Screenshot 2024-08-13 at 7 44 24 AM" src="https://github.com/user-attachments/assets/60794d53-78f7-411e-9276-f6da3f165c7f"> When simulate the variant, rather than 'replace' the page, url is redirected by calling `window.location.replace(url)` API <img width="600" alt="Screenshot 2024-08-13 at 7 45 59 AM" src="https://github.com/user-attachments/assets/eefb3c7d-72ac-4a93-9c7b-45a9aa982c88"> ## How Has This Been Tested? **Test link:** - [wknd page](https://experimentation-v2-integration--wknd--hlxsites.hlx.page/drafts/xfeng/experiments/page) - [wknd doc](https://adobe.sharepoint.com/:w:/r/sites/HelixProjects/_layouts/15/Doc.aspx?sourcedoc=%7B316CD824-E05C-452D-92DD-506039911607%7D&file=page.docx&action=default&mobileredirect=true) ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [x] I have signed the [Adobe Open Source CLA](https://opensource.adobe.com/cla.html). - [x] My code follows the code style of this project. - [x] My change requires a change to the documentation. - [x] I have updated the documentation accordingly. - [x] I have read the **CONTRIBUTING** document. - [ ] I have added tests to cover my changes. - [x] All new and existing tests passed.
<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> **To test:** 1. RUM is fired before redirect 2. Page is successfully redirected in all three cases (experiments, campaigns, audiences) **Finding:** 1. Tried different ways to override the `window.location.replace () ` to let it do nothing when testing RUM is fired before redirect. However, some browsers have strict security restriction that don't allow certain function to be overridden, which leads to test fails. 2. Modify the script before its execution. The line with `window.location.replace () ` is commented out before the script is executed and security policies are applied. ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [x] I have signed the [Adobe Open Source CLA](https://opensource.adobe.com/cla.html). - [x] My code follows the code style of this project. - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. - [x] I have read the **CONTRIBUTING** document. - [x] I have added tests to cover my changes. - [x] All new and existing tests passed. --------- Co-authored-by: Julien Ramboz <ramboz@adobe.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a complete rewrite of the engine to support multiple experiments, audiences and campaigns per page, as well as hiding configurations behind named sheets.
Features:
window.hlx.experiments/window.hlx.audiences/window.hlx.campaignswhich are JS arrays containing the page modification details. The format is:window.hlx.experiment) are still around for backward compatibility but will only contain the page-level type modificationsBREAKING CHANGE:
<meta property="…">meta tags since only the<meta name="…"/>are used