fix: urlResolver and route queries error in Varnish when url has certain queryParams

[damienwebdev]

Preconditions and environment

1. Any Magento version
2. Using Varnish 6 VCL

Steps to reproduce

curl $'https://venia.magento.com/graphql?operationName=MagentoResolveUrlv243&variables=%7B%22url%22:%22/shop-the-look/carefree-days.html?utm_medium=email%22%7D&query=query%20MagentoResolveUrlv243($url:String\u0021)%7Broute(url:$url)%7Brelative_url%20redirect_code%20type%20...on%20CategoryInterface%7Buid%20name%20meta_description%20meta_title%20canonical_url%20__typename%7D...on%20ProductInterface%7Buid%20name%20meta_description%20meta_title%20canonical_url%20__typename%7D__typename%7D%7D' \
  -H 'accept: application/json, text/plain, /' \
  -H 'accept-language: en-US,en;q=0.9' \
  --compressed 

Replace the above domain with your domain.

Note the param ?utm_medium. This matches the VCL linked above, causing an over-aggressive removal of string contents.

The request being sent to Magento has a url encoded variables key in the queryParams that is supposed to look like this decoded:

{"url":"/shop-the-look/carefree-days.html?utm_medium=email"}

Instead, due to the over-matching, it looks like:

{"url":"/shop-the-look/carefree-days.html?utm_medium=email

Expected result

A successful response like:

{"data":{"route":{"relative_url":"shop-the-look\/carefree-days.html?utm_medium=email","redirect_code":0,"type":"CATEGORY","uid":"NDg=","name":"Carefree Days","meta_description":"Carefree Days","meta_title":null,"canonical_url":null,"__typename":"CategoryTree"}}}

Actual result

Unable to unserialize value. Error: Control character error, possibly incorrectly encoded","1":"#1 Magento\GraphQl\Controller\GraphQl->getDataFromRequest() called at [vendor/magento/module-graph-ql/Controller/GraphQl.php:175

Additional information

No response

Release note

No response

Triage and priority

• Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant]

Hi @damienwebdev. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

• @magento give me 2.4-develop instance - upcoming 2.4.x release
• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues 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 issues 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.

[m2-assistant]

Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• 5. Add label Issue: Confirmed once verification is complete.
• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-Hotel]

Hello @damienwebdev,

Thanks for the report and collaboration!

We have tried to reproduce the issue in the latest 2.4-develop branch with Varnish enable. But it seems the issue is not reproducible for us. We are getting the below response:

Might be this is due to we do not have a proper URL. Can you please let us know how do you get the below URL:

curl $'https://venia.magento.com/graphql?operationName=MagentoResolveUrlv243&variables=%7B%22url%22:%22/shop-the-look/carefree-days.html?utm_medium=email%22%7D&query=query%20MagentoResolveUrlv243($url:String\u0021)%7Broute(url:$url)%7Brelative_url%20redirect_code%20type%20...on%20CategoryInterface%7Buid%20name%20meta_description%20meta_title%20canonical_url%20__typename%7D...on%20ProductInterface%7Buid%20name%20meta_description%20meta_title%20canonical_url%20__typename%7D__typename%7D%7D' \
  -H 'accept: application/json, text/plain, /' \
  -H 'accept-language: en-US,en;q=0.9' \
  --compressed 

Thanks

[damienwebdev]

@engcom-Hotel can you post:

1. The Varnish VCL in use
2. The log, via varnishlog, indicating that you are routed through Varnish

[engcom-Hotel]

Hello @damienwebdev,

Please find attached the VCL file we are using:

default.vcl.txt

And we are not able to get any logs in the varnish.log file.

Thanks

[damienwebdev]

Ok. Well I think you should figure out how to get your Varnish log before proceeding further.

[engcom-Hotel]

Hello @damienwebdev,

We have tried again to reproduce this issue, now we are getting the logs in varnishlog, please have a look into the below screenshot for reference:

We are able to reproduce the issue:

Hence confirming the issue.

Thanks

[github-jira-sync-bot]

✅ Jira issue https://jira.corp.adobe.com/browse/AC-11858 is successfully created for this GitHub issue.

[m2-assistant]

✅ Confirmed by @engcom-Hotel. Thank you for verifying the issue.
Issue Available: @engcom-Hotel, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.