Skip to content

Fix issue with logging each cookie as separate context #31334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 6, 2021
Merged

Fix issue with logging each cookie as separate context #31334

merged 1 commit into from
Jan 6, 2021

Conversation

aleksinoleg
Copy link
Contributor

@aleksinoleg aleksinoleg commented Dec 18, 2020

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 (*)

  1. Exceed the number of cookies > 50
  2. 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:

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

@m2-assistant
Copy link

m2-assistant bot commented Dec 18, 2020

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:

  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.

⚠️ 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
Copy link
Contributor Author

This PR is #31259 variant for 2.4

@ihor-sviziev
Copy link
Contributor

@magento run all tests

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

@magento run all tests

@ihor-sviziev ihor-sviziev added Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: bug fix Severity: S2 Major restrictions or short-term circumventions are required until a fix is available. and removed Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests labels Dec 18, 2020
@ihor-sviziev
Copy link
Contributor

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
Copy link
Contributor

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

@sidolov sidolov added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Dec 23, 2020
@engcom-Bravo engcom-Bravo self-assigned this Dec 24, 2020
@engcom-Bravo
Copy link
Contributor

✔️ QA Passed

Manual testing scenario

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

BEFORE switching to the PR
unable_to send_coockie

AFTER applying changes from the PR,
unable_to send_coockie_after

@engcom-Bravo
Copy link
Contributor

@magento create issue

@m2-assistant
Copy link

m2-assistant bot commented Jan 6, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: bug fix Component: Stdlib Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope Release Line: 2.4 Severity: S2 Major restrictions or short-term circumventions are required until a fix is available.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Issue] Fix issue with logging each cookie as separate context
5 participants