Scheduled price rule time zone correction #28973

AntonEvers · 2020-07-02T16:04:26Z

Description (*)

Apply the same logic for time zone correction on \Magento\CatalogRule\Model\Indexer\IndexBuilder::assignProductToRule as in \Magento\CatalogRule\Model\Indexer\ReindexRuleProduct::execute.

The problem here is that Magento 2.3 uses the method \Magento\CatalogRule\Model\Indexer\IndexBuilder::assignProductToRule. In Magento 2.4 this method is no longer used, but it is also not deprecated. So we can expect customers to use this method through the @api method \Magento\CatalogRule\Model\Indexer\IndexBuilder::reindexById. So even though the code in this PR is not used anywhere in vanilla M2.4, it is an @api method that could result in catalog rules starting and ending at wrong time which is equal to the configured timezone offset.

Applying this PR makes sure that time zones are applied equally in \Magento\CatalogRule\Model\Indexer\IndexBuilder::reindexById as they are in \Magento\CatalogRule\Model\Indexer\IndexBuilder::reindexByIds. Currently they differ.

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Set time zone to Europe/Amsterdam
Set indexers to scheduled
Deleta all present Catalog Price Rules
Create a Catalog Price Rule for 50% off on all products, but disabled
Schedule the price rule to be enabled at a minute or so in the future using catalog staging
Wait until catalog stating rules are active and indexer is up to date
Run this query: SELECT DISTINCT from_time, to_time FROM catalogrule_product;
It should output only one row, after all, the rule is applied on all product at the same time.
Install app.zip
Run bin/magento reindex:product 10
Run this query: SELECT DISTINCT from_time, to_time FROM catalogrule_product;
Now you see two rows: one from before and one with a time offset 2 hours into the future. The Europe/Amsterdam timezone is not converted to UTC here. This is the issue.

Questions or comments

\Magento\CatalogRule\Model\Indexer\IndexBuilder::assignProductToRule and \Magento\CatalogRule\Model\Indexer\ReindexRuleProduct::execute do contain duplicate code. Maybe, after approving this PR, it would be worth while to deprecate or merge some of the methods.

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] Scheduled price rule time zone correction #29549: Scheduled price rule time zone correction

m2-assistant · 2020-07-02T16:04:28Z

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

AntonEvers · 2020-07-02T16:08:19Z

@magento run Unit Tests
@magento run Static Tests

AntonEvers · 2020-07-03T09:32:13Z

@magento run all tests

AntonEvers · 2020-07-03T19:26:43Z

@magento run all tests

AntonEvers · 2020-07-16T11:04:16Z

@magento run all tests

sidolov · 2020-08-14T20:24:42Z

@magento create issue

sidolov

Please, cover your changes with any kind of automated tests.

sidolov · 2020-08-19T19:01:01Z

app/code/Magento/CatalogRule/Model/Indexer/IndexBuilder.php

        $sortOrder = (int)$rule->getSortOrder();
        $actionOperator = $rule->getSimpleAction();
        $actionAmount = $rule->getDiscountAmount();
        $actionStop = $rule->getStopRulesProcessing();

        $rows = [];
        foreach ($websiteIds as $websiteId) {
+            $scopeTz = new \DateTimeZone(


Please, use framework TimeZone and DateTime object instead of generic PHP.

I have removed the entire method, as it appears to be duplicate code. Instead I have done this: https://github.com/magento/magento2/pull/28973/files#r474752002

This reverts commit 5972daa.

AntonEvers · 2020-08-21T14:58:03Z

app/code/Magento/CatalogRule/Model/Indexer/IndexBuilder.php

-            }
-
-            $this->reindexRuleGroupWebsite->execute();
+            $this->doReindexByIds([$id]);


This is the main change in this file, the rest is removal of unused private methods (containing also duplicate code) after this change and adding of imports.

AntonEvers · 2020-08-21T14:59:46Z

@magento run all tests

engcom-Charlie · 2020-08-26T06:52:07Z

Hi, @AntonEvers could you please merge conflict and cover changes with the automated tests?
Thank you.

# Conflicts: # app/code/Magento/CatalogRule/Model/Indexer/IndexBuilder.php

engcom-Foxtrot · 2020-09-09T13:27:33Z

@magento run all tests

…n test fix.

engcom-Foxtrot · 2020-09-10T10:29:08Z

@magento run all tests

gabrieldagama · 2021-02-19T14:41:45Z

@magento run all tests

engcom-Bravo

❌ QA Failed

Switched to the PR and Performed the steps from the Manual Testing scenario
After the last step, still, only one row is displayed in the SQL query

engcom-Bravo · 2021-03-05T14:00:26Z

Further investigation discovered that the previous comment #28973 (review) is actually the Expected behavior

✔️ QA Passed

Manual testing scenario

Set time zone to Europe/Amsterdam
Set indexers to scheduled
Deleta all present Catalog Price Rules
Create a Catalog Price Rule for 50% off on all products, but disabled
Schedule the price rule to be enabled at a minute or so in the future using catalog staging
Wait until catalog stating rules are active and indexer is up to date
Run this query: SELECT DISTINCT from_time, to_time FROM catalogrule_product;
It should output only one row, after all, the rule is applied on all product at the same time.
Install app.zip
Run bin/magento reindex:product 10
Run this query: SELECT DISTINCT from_time, to_time FROM catalogrule_product;

Actual Result
Only one row is displayed in the SQL query

m2-assistant · 2021-03-18T17:18:42Z

Hi @AntonEvers, 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.

WIP Scheduled price rule time zone correction

5972daa

ghost added the Progress: pending review label Jul 2, 2020

magento-engcom-team added Component: CatalogRule Release Line: 2.4 labels Jul 2, 2020

AntonEvers changed the title ~~WIP Scheduled price rule time zone correction~~ Scheduled price rule time zone correction Jul 3, 2020

AntonEvers force-pushed the index-time branch from 210ba48 to 5972daa Compare July 16, 2020 11:04

m2-assistant bot mentioned this pull request Aug 14, 2020

[Issue] Scheduled price rule time zone correction #29549

Closed

sidolov 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 Aug 14, 2020

sidolov requested changes Aug 19, 2020

View reviewed changes

ghost assigned sidolov Aug 19, 2020

ghost added Progress: needs update and removed Progress: pending review labels Aug 19, 2020

AntonEvers added 3 commits August 21, 2020 16:46

reindexById and reindexByIds should be functionally equal

0e68e70

Revert "WIP Scheduled price rule time zone correction"

c7def24

This reverts commit 5972daa.

remove unused code

c614f89

AntonEvers commented Aug 21, 2020

View reviewed changes

engcom-Foxtrot self-assigned this Sep 9, 2020

Merge branch '2.4-develop' into index-time

3cbc4f6

# Conflicts: # app/code/Magento/CatalogRule/Model/Indexer/IndexBuilder.php

magento#29549: Scheduled price rule time zone correction - integratio…

46a769f

…n test fix.

engcom-Bravo self-assigned this Feb 19, 2021

m2-community-project bot added Progress: testing in progress and removed Progress: ready for testing labels Feb 19, 2021

Merge branch '2.4-develop' into index-time

ee7176f

engcom-Bravo requested changes Feb 19, 2021

View reviewed changes

m2-community-project bot added Progress: needs update and removed Progress: testing in progress labels Feb 19, 2021

m2-community-project bot added Progress: ready for testing and removed Progress: needs update labels Mar 5, 2021

engcom-Bravo added Progress: needs update and removed Progress: needs update labels Mar 5, 2021

m2-community-project bot added Progress: needs update Progress: ready for testing and removed Progress: ready for testing labels Mar 5, 2021

engcom-Bravo added QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope and removed Progress: needs update labels Mar 5, 2021

m2-community-project bot added Progress: needs update Progress: ready for testing Progress: extended testing Progress: accept and removed Progress: ready for testing Progress: needs update Progress: extended testing labels Mar 5, 2021

magento-engcom-team pushed a commit that referenced this pull request Mar 18, 2021

ENGCOM-8785: Scheduled price rule time zone correction #28973

19916b6

magento-engcom-team merged commit b23165a into magento:2.4-develop Mar 18, 2021

gabrieldagama added the Type: Bug Fix label Mar 18, 2021

Scheduled price rule time zone correction #28973

Scheduled price rule time zone correction #28973

Uh oh!

Conversation

AntonEvers commented Jul 2, 2020 • edited by m2-assistant bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Resolved issues:

Uh oh!

m2-assistant bot commented Jul 2, 2020

Uh oh!

AntonEvers commented Jul 2, 2020

Uh oh!

AntonEvers commented Jul 3, 2020

Uh oh!

AntonEvers commented Jul 3, 2020

Uh oh!

AntonEvers commented Jul 16, 2020

Uh oh!

sidolov commented Aug 14, 2020

Uh oh!

sidolov left a comment

Choose a reason for hiding this comment

Uh oh!

sidolov Aug 19, 2020

Choose a reason for hiding this comment

Uh oh!

AntonEvers Aug 21, 2020

Choose a reason for hiding this comment

Uh oh!

AntonEvers Aug 21, 2020

Choose a reason for hiding this comment

Uh oh!

AntonEvers commented Aug 21, 2020

Uh oh!

engcom-Charlie commented Aug 26, 2020

Uh oh!

engcom-Foxtrot commented Sep 9, 2020

Uh oh!

engcom-Foxtrot commented Sep 10, 2020

Uh oh!

gabrieldagama commented Feb 19, 2021

Uh oh!

engcom-Bravo left a comment

Choose a reason for hiding this comment

Uh oh!

engcom-Bravo commented Mar 5, 2021

Manual testing scenario

Uh oh!

m2-assistant bot commented Mar 18, 2021

Uh oh!

Uh oh!

AntonEvers commented Jul 2, 2020 •

edited by m2-assistant bot

Loading