Add Klaviyo query parameter to the list of stripped parameters in VCLs #35228

Gelmo · 2022-03-25T00:54:28Z

Description (*)

Related to Issue The Varnish configs do not strip Klaviyo marketing parameter #35227
Klaviyo's emails include the _kx query parameter.
Klaviyo's services and modules are becoming more popular, so this query parameter should be stripped in the default Varnish configs provided with Magento.
This PR adds _kx to the list of stripped parameters in the VCLs for Varnish 4, 5, and 6.

Related Pull Requests

None

Fixed Issues (if relevant)

Fixes The Varnish configs do not strip Klaviyo marketing parameter #35227

Manual testing scenarios (*)

Use a VCL that is included with Magento.
Send a marketing email via Klaviyo.
Watch varnishlog.
Visit the site using a link that is included in a Klaviyo-generated email.
Visit the site using a similar link that does not include the _kx query parameter.
Compare the results shown by varnishlog.
Without this change in place, the request with the _kx parameter is served an uncached page.
With this change in place, the request with the _kx parameter is served a cached page.

Questions or comments

Our company (JetRails) has several clients that utilize Klaviyo's services for sending marketing emails. We noticed that visitors who came to the site from those emails were being served uncached pages. The adjustment in this PR has successfully resolved this issue for our clients.
Klaviyo's services and modules are becoming more popular, so this query parameter should be stripped in the default Varnish configs provided with Magento.
Please list myself and JetRails as the contributors once this has been merged.

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

- Related to Issue magento#35227 - Klaviyo's emails include the `_kx` query parameter. - Klaviyo's services and modules are becoming more popular, so this query parameter should be stripped in the default Varnish configs provided with Magento.

m2-assistant · 2022-03-25T00:54:31Z

Hi @Gelmo. Thank you for your contribution
Here are some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here

ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

Gelmo · 2022-03-25T02:51:26Z

I am discussing the CLA with my employer, and I will re-create the PR as advised once the CLA has been read and signed.

dzmitry-vasileuski · 2023-11-17T12:20:42Z

Hello @sdzhepa!
Could you please advise how to get this pull request and ticket off the ground?
I can take it upon myself and complete all the required steps.

dzmitry-vasileuski · 2023-11-20T21:11:51Z

@magento run all tests

magento-automated-testing · 2023-11-20T21:12:01Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

dzmitry-vasileuski · 2023-11-21T08:42:51Z

@magento run Functional Tests CE

magento-automated-testing · 2023-11-21T08:43:01Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

dzmitry-vasileuski · 2023-11-22T08:46:22Z

@magento run Sample Data Tests CE, Sample Data Tests EE, Sample Data Tests B2B, Functional Tests CE

magento-automated-testing · 2023-11-22T08:46:28Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Dash · 2024-10-16T08:14:21Z

@magento run all tests

engcom-Dash · 2024-10-16T13:10:56Z

Hi @Gelmo ,

Thanks for the collaboration & contribution!

✔️ QA Passed
Preconditions:

Install fresh Magento 2.4-develop
Steps to reproduce

As per the description or The Varnish configs do not strip Klaviyo marketing parameter #35227 (comment)

Before: ✖️

Each request with the _kx parameter was served as uncached.

After: ✔️

Each request with the _kx parameter is served from cache.

Got the green build, so moving it to merge in progress.

hostep · 2024-10-16T18:07:27Z

@engcom-Dash: it's probably better to continue with #39188 instead, as that one contains the fix from here + a bunch of other extra parameters. The commit from this PR got cherry picked so the author is kept in git history.
Also, the varnish7.vcl file didn't get updated in this PR, while it did get updated in the other one.

engcom-Dash · 2024-10-17T09:17:54Z

Hello @Gelmo,

Thanks for your contributions.

As per #35228 (comment), we are putting this PR on hold since the changes have been cherry-picked into another PR with some additional code changes. We will update you here once the other PR is merged.

Thanks!

ihor-sviziev · 2024-11-15T10:54:23Z

Hi @Gelmo,
Thank you so much for your contribution!

I see that #39188 was already merged, and it contained a cherry-picked commit from this PR (a3b85c9).

Since all changes have already been merged, I'm closing this PR.

magento-engcom-team added Component: PageCache Release Line: 2.4 labels Mar 25, 2022

m2-community-project bot added the Progress: pending review label Mar 25, 2022

sdzhepa added the Priority: P3 May be fixed according to the position in the backlog. label Apr 14, 2022

Merge branch '2.4-develop' into klaviyo_vcl_35227

bfc017a

ihor-sviziev mentioned this pull request Jan 3, 2024

Improvement: Added additional marketing tags to be excluded in Varnish configuration #38302

Closed

5 tasks

ihor-sviziev approved these changes Jan 3, 2024

View reviewed changes

m2-community-project bot assigned ihor-sviziev Jan 3, 2024

m2-community-project bot added Progress: ready for testing and removed Progress: pending review labels Jan 3, 2024

ihor-sviziev changed the title ~~Issue #35227 - Add Klaviyo's query parameter to the list of stripped parameters in VCLs~~ Add Klaviyo query parameter to the list of stripped parameters in VCLs Jan 3, 2024

ihor-sviziev mentioned this pull request Jan 3, 2024

Add Klaviyo promotional parameter _kx to the Varnish config #38221

Closed

5 tasks

m2-community-project bot added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Jan 3, 2024

ihor-sviziev removed the Priority: P3 May be fixed according to the position in the backlog. label Jan 3, 2024

engcom-Delta added Progress: testing in progress Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it and removed Progress: ready for testing labels Jan 4, 2024

m2-community-project bot added Progress: ready for testing and removed Progress: testing in progress labels Jan 5, 2024

hostep mentioned this pull request Sep 19, 2024

Add Tracking Parameters to Varnish Configuration #39188

Merged

5 tasks

Priyakshic added the Project: Community Picked PRs upvoted by the community label Oct 15, 2024

engcom-Dash self-assigned this Oct 16, 2024

Merge branch '2.4-develop' into klaviyo_vcl_35227

cdcd53e

hostep mentioned this pull request Oct 16, 2024

Remove all marketing get parameters to minimize the cache using built-in FPC #39099

Merged

6 tasks

ihor-sviziev closed this Nov 15, 2024

m2-community-project bot removed the Progress: ready for testing label Nov 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Klaviyo query parameter to the list of stripped parameters in VCLs #35228

Add Klaviyo query parameter to the list of stripped parameters in VCLs #35228

Uh oh!

Gelmo commented Mar 25, 2022 •

edited

Loading

Uh oh!

m2-assistant bot commented Mar 25, 2022

Uh oh!

Gelmo commented Mar 25, 2022

Uh oh!

dzmitry-vasileuski commented Nov 17, 2023

Uh oh!

dzmitry-vasileuski commented Nov 20, 2023

Uh oh!

magento-automated-testing bot commented Nov 20, 2023

Uh oh!

dzmitry-vasileuski commented Nov 21, 2023

Uh oh!

magento-automated-testing bot commented Nov 21, 2023

Uh oh!

dzmitry-vasileuski commented Nov 22, 2023

Uh oh!

magento-automated-testing bot commented Nov 22, 2023

Uh oh!

engcom-Dash commented Oct 16, 2024

Uh oh!

engcom-Dash commented Oct 16, 2024

Uh oh!

hostep commented Oct 16, 2024 •

edited

Loading

Uh oh!

engcom-Dash commented Oct 17, 2024

Uh oh!

ihor-sviziev commented Nov 15, 2024

Uh oh!

Uh oh!

Add Klaviyo query parameter to the list of stripped parameters in VCLs #35228

Add Klaviyo query parameter to the list of stripped parameters in VCLs #35228

Uh oh!

Conversation

Gelmo commented Mar 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Uh oh!

m2-assistant bot commented Mar 25, 2022

Uh oh!

Gelmo commented Mar 25, 2022

Uh oh!

dzmitry-vasileuski commented Nov 17, 2023

Uh oh!

dzmitry-vasileuski commented Nov 20, 2023

Uh oh!

magento-automated-testing bot commented Nov 20, 2023

Uh oh!

dzmitry-vasileuski commented Nov 21, 2023

Uh oh!

magento-automated-testing bot commented Nov 21, 2023

Uh oh!

dzmitry-vasileuski commented Nov 22, 2023

Uh oh!

magento-automated-testing bot commented Nov 22, 2023

Uh oh!

engcom-Dash commented Oct 16, 2024

Uh oh!

engcom-Dash commented Oct 16, 2024

Uh oh!

hostep commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

engcom-Dash commented Oct 17, 2024

Uh oh!

ihor-sviziev commented Nov 15, 2024

Uh oh!

Uh oh!

Gelmo commented Mar 25, 2022 •

edited

Loading

hostep commented Oct 16, 2024 •

edited

Loading