Issue 36563: Remember Category Pagination causes a Document Expired/form submission error #36595

rogerdz · 2022-12-11T17:29:25Z

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Fixes Remember Category Pagination causes a Document Expired/form submission error when using the browser's Back button on the product page #36563

Manual testing scenarios (*)

...
...

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

…orm submission error

m2-assistant · 2022-12-11T17:29:27Z

Hi @rogerdz. 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

rogerdz · 2022-12-11T17:30:04Z

@magento run all tests

magento-automated-testing · 2022-12-11T17:30:12Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

aplapana · 2022-12-21T10:05:07Z

Hello @rogerdz ! It is nice to see that you are willing to help out with this issue.

I took a look at your current implementation and it is partially working. From what i can see, it does indeed resolve the bug, but it alters the core functionality and basically disregarding the "Remember Category pagination" configuration option by adding the "product_list_limit" parameter to the URL.

I wouldn't recommend this approach, especially since it can have an impact on other areas (SEO for example) as well. Fortunately we do have an option that would address this. Lets digg a little deeper into what is actually happing:

changing the product list limit triggers a POST action
note that after the page reload, the POST is still active
accessing a different page (in this case a product page, but it can be other page types as well) and then going back to it will cause the browser to error out because it can't restore the previous document state

In such scenarios, a common practice is to apply a POST/REDIRECT/GET pattern. Nothing fancy about it - we just need to redirect to the same page after the POST action has been processed. We can controll this behaviour from the Magento controller that is responsible for triggering the toolbar parameter saving - namely: app/code/Magento/Catalog/Controller/Category/View.php. Notice here the $this->toolbarMemorizer->memorizeParams() method call.

Let me know if you are willing to give this another go and refactor the solution a little bit.

Thank you for your time!

…xpired/form submission error" This reverts commit bf30926.

…orm submission error

rogerdz · 2022-12-22T17:13:51Z

@magento run all tests

magento-automated-testing · 2022-12-22T17:13:56Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

rogerdz · 2022-12-22T17:15:56Z

Hi @aplapana ,
I refactor the solution.

aplapana · 2022-12-23T10:34:10Z

@rogerdz i left some comments for you. Let me know if you have questions.

rogerdz · 2022-12-23T15:52:18Z

Hi @aplapana,
I read your comment, and changed solution in new commit. Can you review it ?

aplapana · 2022-12-23T16:41:44Z

@rogerdz are you sure you pushed the changes ? I am not seeing any new commits...

rogerdz · 2022-12-23T16:45:36Z

@aplapana , I changed a day ago and in PR it show my new changed.
New logic is redirect same page after the POST action has been processed.

aplapana · 2022-12-23T10:28:06Z

app/code/Magento/Catalog/view/frontend/web/js/product/list/toolbar.js

+                input.name = 'redirect_url';
+                input.value = this.options.url;
+                form.appendChild(input);
+


You don't actually need to create an input to pass the current URL to your request. You can do this with PHP, directly in app/code/Magento/Catalog/Controller/Category/View.php controller. Example:
$this->getResponse()->setRedirect($this->_redirect->getRedirectUrl()); .

You can set the respose redirect before the return $page; statement. Note that the above should be executed under certain conditions:

memorizing is allowed (see app/code/Magento/Catalog/Model/Product/ProductList/ToolbarMemorizer.php)

toolbar specific parameters reside in the request. The parameter names are available here: app/code/Magento/Catalog/Model/Product/ProductList/Toolbar.php (notice the declared constants)

Thank for your review. I added some change in new commit.

aplapana · 2022-12-23T10:31:42Z

app/code/Magento/Catalog/Controller/Category/View.php

+            }
+        }
+        return false;
+    }


You don't actually need this. I think a private method that would determine if you need to redirect or not (returns boolean) would be more suitable. Please also specify the method return type.

rogerdz · 2023-01-09T16:06:01Z

@magento run all tests

magento-automated-testing · 2023-01-09T16:06:08Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

aplapana · 2023-01-10T08:27:59Z

app/code/Magento/Catalog/Controller/Category/View.php

@@ -210,6 +209,9 @@ public function execute()
            return $this->resultRedirectFactory->create()->setUrl($this->_redirect->getRedirectUrl());
        }
        $category = $this->_initCategory();
+        if ($this->toolbarMemorizer->hasMemorizingParam()) {


You should also check if memorizing is allowed via $this->toolbarMemorizer->isMemorizingAllowed() method call.

I don't think it's necessary. $this->hasMemorizeParam is always false, only true when new category parameter is saved to the session (this only happens when memorizing is allowed)

I suspect it is necessary. You can implement the change and have the tests run again and see how it goes. We can always revert the change. Please bare in mind that in order for this to pass, all tests need to pass.

Also, once we have a stable solution, we will need to have testing coverage for the new code.

Issue 36563: Remember Category Pagination causes a Document Expired/f…

bf30926

…orm submission error

m2-community-project bot added Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Dec 11, 2022

m2-community-project bot added the Progress: pending review label Dec 11, 2022

rogerdz added 3 commits December 22, 2022 23:21

Merge branch '2.4-develop' into issue-36563

d0eb79f

Revert "Issue 36563: Remember Category Pagination causes a Document E…

9c67990

…xpired/form submission error" This reverts commit bf30926.

Issue 36563: Remember Category Pagination causes a Document Expired/f…

d0b0009

…orm submission error

Den4ik self-requested a review December 29, 2022 20:22

Den4ik self-assigned this Dec 29, 2022

m2-community-project bot added Progress: review and removed Progress: pending review labels Dec 29, 2022

aplapana suggested changes Jan 4, 2023

View reviewed changes

m2-community-project bot assigned aplapana Jan 4, 2023

m2-community-project bot added Progress: needs update and removed Progress: review labels Jan 4, 2023

Merge branch '2.4-develop' into issue-36563

3d4b5d9

rogerdz added 2 commits January 9, 2023 16:01

Issue 36563: update code

51033d3

Issue 36563: update code

1e155c7

m2-community-project bot added Progress: review and removed Progress: needs update labels Jan 9, 2023

aplapana suggested changes Jan 10, 2023

View reviewed changes

m2-community-project bot added Progress: needs update and removed Progress: review labels Jan 10, 2023

m2-community-project bot added Progress: review and removed Progress: needs update labels Jan 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue 36563: Remember Category Pagination causes a Document Expired/form submission error #36595

Issue 36563: Remember Category Pagination causes a Document Expired/form submission error #36595

rogerdz commented Dec 11, 2022

m2-assistant bot commented Dec 11, 2022

rogerdz commented Dec 11, 2022

magento-automated-testing bot commented Dec 11, 2022

aplapana commented Dec 21, 2022 •

edited

Loading

rogerdz commented Dec 22, 2022

magento-automated-testing bot commented Dec 22, 2022

rogerdz commented Dec 22, 2022 •

edited

Loading

aplapana commented Dec 23, 2022

rogerdz commented Dec 23, 2022

aplapana commented Dec 23, 2022

rogerdz commented Dec 23, 2022

aplapana Dec 23, 2022

rogerdz Jan 9, 2023 •

edited

Loading

aplapana Dec 23, 2022

rogerdz commented Jan 9, 2023

magento-automated-testing bot commented Jan 9, 2023

aplapana Jan 10, 2023

rogerdz Jan 10, 2023 •

edited

Loading

aplapana Jan 11, 2023

Issue 36563: Remember Category Pagination causes a Document Expired/form submission error #36595

Are you sure you want to change the base?

Issue 36563: Remember Category Pagination causes a Document Expired/form submission error #36595

Conversation

rogerdz commented Dec 11, 2022

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

m2-assistant bot commented Dec 11, 2022

rogerdz commented Dec 11, 2022

magento-automated-testing bot commented Dec 11, 2022

aplapana commented Dec 21, 2022 • edited Loading

rogerdz commented Dec 22, 2022

magento-automated-testing bot commented Dec 22, 2022

rogerdz commented Dec 22, 2022 • edited Loading

aplapana commented Dec 23, 2022

rogerdz commented Dec 23, 2022

aplapana commented Dec 23, 2022

rogerdz commented Dec 23, 2022

aplapana Dec 23, 2022

Choose a reason for hiding this comment

rogerdz Jan 9, 2023 • edited Loading

Choose a reason for hiding this comment

aplapana Dec 23, 2022

Choose a reason for hiding this comment

rogerdz commented Jan 9, 2023

magento-automated-testing bot commented Jan 9, 2023

aplapana Jan 10, 2023

Choose a reason for hiding this comment

rogerdz Jan 10, 2023 • edited Loading

Choose a reason for hiding this comment

aplapana Jan 11, 2023

Choose a reason for hiding this comment

aplapana commented Dec 21, 2022 •

edited

Loading

rogerdz commented Dec 22, 2022 •

edited

Loading

rogerdz Jan 9, 2023 •

edited

Loading

rogerdz Jan 10, 2023 •

edited

Loading