Remove dependency of date renderer on global state locale #1469
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Summary == This patch introduces a test to reproduce the bug described in issue #1468. `\Magento\Reports\Test\Unit\Block\Adminhtml\Sales\Grid\Column\Renderer\DateTest::testDateIsRenderedIndependentOfSystemDefaultLocale` The existing test `testRender` was refactored a little to avoid code duplication with the new test. The patch also includes a fix for the issue, which simply is to pass the locale that was used to create the date format as a third argument to `\IntlDateFormatter::formatObject()`. The following contents of the commit message are a slightly abbreviated copy of the issue #1468. ----- The method `\Magento\Reports\Block\Adminhtml\Sales\Grid\Column\Renderer\Date::render()` creates it's return value by calling `\IntlDateFormatter::formatObject($date, $format);`. Please note that `formatObject()` is called without the optional third parameter specifying the locale, which means that the default ICU locale will be used. Here is the method signature from the [PHP manual](http://php.net/manual/en/intldateformatter.formatobject.php): ``` public static string IntlDateFormatter::formatObject ( object $object [, mixed $format = NULL [, string $locale = NULL ]] ) ``` If the third locale is not specified as an argument, the default ICU locale is used. If no default locale is set, this value will default to the system default. This causes the test `\Magento\Reports\Test\Unit\Block\Adminhtml\Sales\Grid\Column\Renderer\DateTest::testRender()` to fail sometimes, because it depends on the system locale. If the system locale is set to a **en_US** locale the test is green. If it is a non-english locale, the test fails, because the expected output does not match the expected format. `` 1) Magento\Reports\Test\Unit\Block\Adminhtml\Sales\Grid\Column\Renderer\DateTest::testRender with data set #4 ('2014-06-25', 'en_US', 'period', 'day', 'Jun 25, 2014') Failed asserting that two strings are equal. --- Expected +++ Actual @@ @@ -'Jun 25, 2014' +'Juni 25, 2014' ``` The above output is from a dev machine where the system locale is set to **de_DE.UTF-8**. To summarize: The date format is correctly constructed for a given locale. However, the date constants rendered do not necessarily match that locale.
|
@Vinai thank you for the contribution! Internal reference: MAGETWO-40651 |
magento-team
pushed a commit
that referenced
this pull request
Sep 8, 2017
[EngCom] Public Pull Requests - MAGETWO-72390: Remove the usage of the DataObject for response management #10808 - MAGETWO-71545: Added 'application/json' Content-Type to Ajax responses in the Magento_UI module. #10521 - MAGETWO-72388: Fix spelling mistake in AddressTest.php #10806 - MAGETWO-72283: Code generate: support variadic parameter #10771
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This does two things
1) Introduce new test to reproduce bug from Issue #1468
The new test is called
The existing test
testRenderwas refactored a little to avoid code duplication with the new test.2) Introduce fix for Issue #1468
The fix is to simply pass the locale that was used to create the date format string as a third argument to
\IntlDateFormatter::formatObject(), so it will be used to fetch the matching datetime constants also.