[vcl] Better debug

[gquintard]

Detecting if the response is a hit usingthe x-varnish header is flaky
and notably doesn't work in a multi-tier setup.

On top of this, HIT/MISS is a false dichotomy (https://info.varnish-software.com/blog/using-obj-hits)
and while I'd like something more detailed like
https://docs.varnish-software.com/tutorials/hit-miss-logging/ (tech
version of the blog), I recognize that it's "a lot" of VCL, so this
commit only differentiates between hits, misses and passes, the latter
being pretty useful to identify while debugging.

note: all versions have been changed for the sake of consistency
but both the 4.x and 5.x series have been EOL'd a (long) while ago and users
should be encouraged to upgraded as soon as possible.

edit: I've added a test that you can run with varnishtest dev/tests/varnish/*.vtc since the current php suite doesn't correctly test the committed VCL. It would probably be smart to run that command as part of the test suite, but I'll leave that to more knowledgeable people than myself.

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)
• All automated tests passed successfully (all builds are green)

Resolved issues:

1. resolves [Issue] [vcl] Better debug #37912: [vcl] Better debug

[m2-assistant]

Hi @gquintard. Thank you for your contribution
Here is 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:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE,
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

[gquintard]

@magento run all tests

[lbajsarowicz]

@magento run Unit Tests

[lbajsarowicz]

✔️ Thank you for your expertise!

[magento-engcom-team]

Hi @lbajsarowicz, thank you for the review.
ENGCOM-7766 has been created to process this Pull Request
✳️ @lbajsarowicz, could you please add one of the following labels to the Pull Request?

Label	Description
Auto-Tests: Covered	All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered	Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required	Changes in Pull Request does not require coverage by auto-tests

[lbajsarowicz]

@magento run Integration Tests, Functional Tests CE

[gquintard]

@lbajsarowicz, apologies for my ignorance, is there anything I should do here?

[lbajsarowicz]

@gquintard No. Now we wait for the process of the merge to be performed.

[lbajsarowicz]

Automated Tests are not applicable, as the change is related to infrastructure configuration.

[engcom-Bravo]

Dev experience is required for testing of this PR. Please note that Manual testing has not been performed.

[andrewbess]

@magento run all tests

[magento-automated-testing]

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.

[andrewbess]

Hello @gquintard
Thank you for your contribution
Could you please change commit messages to more relevant?
I think the message: "[varnish] fix debug.vtc on mac" is not clear and doesn't describe your fixes.
Thank you in advance

[gquintard]

hi @andrewbess, sure. Can I do that once we are just about to merge? I'll rebase an squash at that time.

[andrewbess]

hi @andrewbess, sure. Can I do that once we are just about to merge? I'll rebase an squash at that time.

Yes, of course
Thank you

[andrewbess]

The fixes look nice for me
Approved

[andrewbess]

@magento run Functional Tests EE, Functional Tests B2B

[magento-automated-testing]

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-Hotel]

@magento run Functional Tests B2B

[magento-automated-testing]

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-Hotel]

✔️ QA Passed

Preconditions:
This PR differentiates between hits, misses, and passes, the latter being pretty useful to identify while debugging.

Manual testing scenario:
Run the below varnishtest command to check whether it is working fine or not:

varnishtest dev/tests/varnish/debug.vtc

Actual Result: ✔️

The above test should show passed as below:

Failed Test seems flaky to me hence moving this PR in merge in progress

Tested all the manual scenarios, no impact on regression testing.

[engcom-Hotel]

@magento run Functional Tests B2B

[magento-automated-testing]

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-Hotel]

@magento run Functional Tests B2B

[magento-automated-testing]

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-Hotel]

The failed B2B test seems flaky to me. Please refer to the below screenshots:

**B2B Failed Test 1 **

B2B Failed Test 2

[gquintard]

We've established earlier that the VCL code changes aren't taken into account by automated tests (the test used the system-wide VCL which doesn't match the in-repository code). I do believe it's an issue in itself, but I'm fairly confident the flaky tests aren't caused by this change.