@wordpress/date: Fix ordinal token (S), RFC2822 token (r), and timezone offset handling #39670
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
noisysocks
added
[Type] Bug
noisysocks
changed the title
noisysocks
changed the title
|
Size Change: +66 B (0%) Total Size: 1.21 MB
ℹ️ View Unchanged
|
noisysocks
commented
Mar 23, 2022
| // Does moment already have a locale with the right name? | ||
| if ( momentLib.locales().includes( dateSettings.l10n.locale ) ) { | ||
| // Is that locale misconfigured, e.g. because we are on a site running | ||
| // WordPress < 6.0? |
There was a problem hiding this comment.
Noting to myself that I need to submit a Core patch that makes this same fix there. Should also add a comment here to delete this code when the minimum WP version is 6.0.
talldan
approved these changes
Mar 24, 2022
5 tasks
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.
What?
Fixes three bugs in
@wordpress/dateincluding #15221.wp.date.dateI18n( 'jS' )should output e.g.23rd, but it was outputting23.wp.date.dateI18n( 'r' )should be in English (per RFC822 spec) when site language is set to a non-English language.wp.date.format( 'P' )should be'+00:00'when site's timezone offset is'0'.I've also added unit tests for all of the format string characters that
dateand its friends accept.The fix for #15221 was my intention. The other two bugs I noticed while writing unit tests.
Why?
WordPress doesn't have enough information about the current locale to translate a date's ordinal, which is why
wp_date( 'jS' )in PHP always outputs e.g.23rdin English even if the site's language is a non-English language.wp.date.date()should match the behaviour ofwp_date()so I did not attempt to fix this. (I have ideas on how we could...)Because there isn't any information about the ordinal, we don't set
ordinalwhen defining our locale in Moment.js. This means that when Moment.js renders thejStoken, it will look at the parent locale for information on how to output the ordinal.Gutenberg is passing
parentLocaletomoment.updateLocale(), but this does not work. Onlymoment.defineLocale()acceptsparentLocale.We were naively translating the
rtoken toddd, DD MMM YYYY HH:mm:ss ZZbut that's not right as the day and month shouldn't be localised.moment.utcOffset()accepts a string like'+00:00'or an integer like0. A string like'0'is invalid and will cause the created moment instance to be in whatever timezone the user is in.How?
The fix is to use
defineLocale()instead ofupdateLocale().Because Core might have already defined the locale, we must delete any existing locale before creating it. We can detect whether it's a locale created by Core or not based on whether it's incorrectly configured. Core (and Gutenberg, until this PR) is setting
LTS,LandLLLLtonullin the locale config, which is not permitted, according to the type definitions.Calling
locale( 'en' )on the moment instance before rendering it will ensure it's in English.Coercing the site's timezone offset to a number before passing it to
utcOffsetwill ensure Moment.js is happy.Testing Instructions
Unit tests are included. You could also follow the steps in #15221 and #39569.
You could also set your site to a few different languages and make sure dates e.g. in the Publish dropdown look correct.
I ordered the commits in a TDD way so you can
git checkout HEAD^if you want to see that the new tests I added fail ontrunk.