Fix issue with logging each cookie as separate context #31334

aleksinoleg · 2020-12-18T08:47:51Z

Description (*)

When the number of cookies becomes more than 50 the warning log is written: "Unable to send the cookie. Maximum number of cookies would be exceeded." And each cookie is converting to a separate log context. And in the case of using the Graylog app, it is converting to a separate field.
By this pull request, the $_COOKIE array is converting to a string and writing as 'cookie' context while writing the log

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Exceed the number of cookies > 50
Watch the log

Questions or comments

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:

resolves [Issue] Fix issue with logging each cookie as separate context #31471: Fix issue with logging each cookie as separate context

m2-assistant · 2020-12-18T08:47:54Z

Hi @aleksinoleg. 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:

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

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.

⚠️ 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, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

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

aleksinoleg · 2020-12-18T08:49:01Z

This PR is #31259 variant for 2.4

ihor-sviziev · 2020-12-18T08:52:17Z

@magento run all tests

ihor-sviziev · 2020-12-18T09:13:30Z

lib/internal/Magento/Framework/Stdlib/Cookie/PhpCookieManager.php

+                array_merge(
+                    ['user-agent' => $this->httpHeader->getHttpUserAgent()],
+                    [
+                        'cookies' => implode(
+                            ', ',
+                            array_map(
+                                function ($v, $k) {
+                                    return sprintf("%s='%s'", $k, $v);
+                                },
+                                $_COOKIE,
+                                array_keys($_COOKIE)
+                            )
+                        )
+                    ]
+                )


We don't really need to have array_merge here. Could you remove it?

ihor-sviziev · 2020-12-18T10:07:54Z

@magento run all tests

ihor-sviziev · 2020-12-18T10:08:46Z

Finally, someone will fix that! 👍

We also were having this issue - we're sending logs to some Elasticsearch based tool, and it was hunting because of too many fields (each key is sent as a separate key). Also, it doesn't have any value for sending all cookies as separate values, so PR, in general, looks good to me.

magento-engcom-team · 2020-12-21T16:28:31Z

Hi @ihor-sviziev, thank you for the review.
ENGCOM-8557 has been created to process this Pull Request

engcom-Bravo · 2020-12-28T09:50:46Z

✔️ QA Passed

Manual testing scenario

Open web browser Firefox
Navigate to about:config
Find dom.storage.enabled option and change to false
Open Storefront in a new tab
Duplicate the tab, open the same page in another tab
Duplicate the tabs several times (3-4 new tabs)
Open debug.log file from ./var/log folder
Find the text "main.WARNING: Unable to send the cookie. Maximum number of cookies would be exceeded"

BEFORE switching to the PR

AFTER applying changes from the PR,

engcom-Bravo · 2020-12-28T09:54:04Z

@magento create issue

…31334

m2-assistant · 2021-01-06T17:32:15Z

Hi @aleksinoleg, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

magento-engcom-team added Component: Stdlib Release Line: 2.4 labels Dec 18, 2020

ihor-sviziev self-assigned this Dec 18, 2020

m2-community-project bot added this to Review in Progress in Pull Requests Dashboard Dec 18, 2020

m2-community-project bot added the Progress: review label Dec 18, 2020

ihor-sviziev mentioned this pull request Dec 18, 2020

fix issue with logging each cookie as separate context #31259

Closed

4 tasks

ihor-sviziev added the Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests label Dec 18, 2020

ihor-sviziev requested changes Dec 18, 2020

View reviewed changes

m2-community-project bot moved this from Review in Progress to Changes Requested in Pull Requests Dashboard Dec 18, 2020

m2-community-project bot added Progress: needs update and removed Progress: review labels Dec 18, 2020

Fix issue with logging each cookie as separate context

01eb682

ihor-sviziev added the Progress: review label Dec 18, 2020

m2-community-project bot moved this from Changes Requested to Review in Progress in Pull Requests Dashboard Dec 18, 2020

m2-community-project bot removed the Progress: needs update label Dec 18, 2020

ihor-sviziev approved these changes Dec 18, 2020

View reviewed changes

m2-community-project bot moved this from Review in Progress to Ready for Testing in Pull Requests Dashboard Dec 18, 2020

m2-community-project bot added Progress: ready for testing and removed Progress: review labels Dec 18, 2020

sidolov added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Dec 23, 2020

m2-community-project bot added this to Ready for Testing in High Priority Pull Requests Dashboard Dec 23, 2020

m2-community-project bot removed this from Ready for Testing in Pull Requests Dashboard Dec 23, 2020

engcom-Bravo self-assigned this Dec 24, 2020

engcom-Bravo moved this from Ready for Testing to Testing in Progress in High Priority Pull Requests Dashboard Dec 24, 2020

m2-community-project bot moved this from Testing in Progress to Ready for Testing in High Priority Pull Requests Dashboard Dec 24, 2020

m2-community-project bot moved this from Ready for Testing to Testing in Progress in High Priority Pull Requests Dashboard Dec 24, 2020

m2-community-project bot added Progress: testing in progress and removed Progress: ready for testing labels Dec 24, 2020

m2-assistant bot mentioned this pull request Dec 28, 2020

[Issue] Fix issue with logging each cookie as separate context #31471

Closed

m2-community-project bot moved this from Testing in Progress to Ready for Testing in High Priority Pull Requests Dashboard Dec 28, 2020

m2-community-project bot added Progress: ready for testing and removed Progress: testing in progress labels Dec 28, 2020

engcom-Bravo moved this from Ready for Testing to Testing in Progress in High Priority Pull Requests Dashboard Dec 28, 2020

m2-community-project bot added Progress: testing in progress and removed Progress: ready for testing labels Dec 28, 2020

engcom-Bravo added Progress: ready for testing QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope and removed Progress: testing in progress labels Dec 28, 2020

m2-community-project bot moved this from Testing in Progress to Ready for Testing in High Priority Pull Requests Dashboard Dec 28, 2020

engcom-Bravo moved this from Ready for Testing to Merge in Progress in High Priority Pull Requests Dashboard Dec 28, 2020

m2-community-project bot added Progress: accept and removed Progress: ready for testing labels Dec 28, 2020

magento-engcom-team pushed a commit that referenced this pull request Jan 6, 2021

ENGCOM-8557: Fix issue with logging each cookie as separate context #…

77f9ee5

…31334

magento-engcom-team merged commit 9100d80 into magento:2.4-develop Jan 6, 2021

gabrieldagama moved this from Merge in Progress to Recently Merged in High Priority Pull Requests Dashboard Jan 7, 2021

magento-engcom-team removed this from Recently Merged in High Priority Pull Requests Dashboard Oct 14, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix issue with logging each cookie as separate context #31334

Fix issue with logging each cookie as separate context #31334

aleksinoleg commented Dec 18, 2020 •

edited by m2-assistant bot

Loading

m2-assistant bot commented Dec 18, 2020

aleksinoleg commented Dec 18, 2020

ihor-sviziev commented Dec 18, 2020

ihor-sviziev Dec 18, 2020

ihor-sviziev commented Dec 18, 2020

ihor-sviziev commented Dec 18, 2020

magento-engcom-team commented Dec 21, 2020

engcom-Bravo commented Dec 28, 2020

engcom-Bravo commented Dec 28, 2020

m2-assistant bot commented Jan 6, 2021

Fix issue with logging each cookie as separate context #31334

Fix issue with logging each cookie as separate context #31334

Conversation

aleksinoleg commented Dec 18, 2020 • edited by m2-assistant bot Loading

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Resolved issues:

m2-assistant bot commented Dec 18, 2020

aleksinoleg commented Dec 18, 2020

ihor-sviziev commented Dec 18, 2020

ihor-sviziev Dec 18, 2020

Choose a reason for hiding this comment

ihor-sviziev commented Dec 18, 2020

ihor-sviziev commented Dec 18, 2020

magento-engcom-team commented Dec 21, 2020

engcom-Bravo commented Dec 28, 2020

Manual testing scenario

engcom-Bravo commented Dec 28, 2020

m2-assistant bot commented Jan 6, 2021

aleksinoleg commented Dec 18, 2020 •

edited by m2-assistant bot

Loading