From 5d078db2b0750b646c9ddefb9c74c31cf6c1b893 Mon Sep 17 00:00:00 2001
From: AlexisG <merkkur39@gmail.com>
Date: Fri, 20 Dec 2024 11:50:56 +0100
Subject: [PATCH] fix: Ensure use correct format locales
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Following version 115.0.0, the format of 3 locales has changed:
- `en -> en-US`
- `zh_cn -> zh-CN`
- `zh_tw -> zh-TW`

More details here:
https://github.com/date-fns/date-fns/blob/main/CHANGELOG.md#200---2019-08-20

The constant `DEFAULT_LANG=“en”` is not changed
because it is used by Polyglot, which must not change.
This is directly related to the folder names in our apps..
---
 react/providers/I18n/format.jsx      | 28 ++++++++++++++++++++++++----
 react/providers/I18n/format.spec.jsx | 12 ++++++++++++
 2 files changed, 36 insertions(+), 4 deletions(-)

diff --git a/react/providers/I18n/format.jsx b/react/providers/I18n/format.jsx
index bb11a0f80c..4837b825ea 100644
--- a/react/providers/I18n/format.jsx
+++ b/react/providers/I18n/format.jsx
@@ -6,18 +6,38 @@ import { DEFAULT_LANG } from '.'
 const locales = {}
 let lang = DEFAULT_LANG
 
+/**
+ * Ensure that the locale is in the correct format for date-fns (see 2.0.0 BC https://github.com/date-fns/date-fns/blob/main/CHANGELOG.md#200---2019-08-20)
+ * @param {string} lang
+ */
+const ensureLocaleFormat = lang => {
+  switch (lang) {
+    case 'en':
+      return 'en-US'
+    case 'zh_cn':
+      return 'zh-CN'
+    case 'zh_tw':
+      return 'zh-TW'
+    default:
+      return lang
+  }
+}
+
 const getWarningMessage = lang =>
   `The "${lang}" locale isn't supported by date-fns. or has not been included in the build. Check if you have configured a ContextReplacementPlugin that is too restrictive.`
 
 export const provideDateFnsLocale = (userLang, defaultLang = DEFAULT_LANG) => {
-  lang = userLang
+  lang = ensureLocaleFormat(userLang)
+  const ensureDefaultLang = ensureLocaleFormat(defaultLang)
   try {
-    locales[defaultLang] = require(`date-fns/locale/${defaultLang}/index.js`)
+    locales[
+      ensureDefaultLang
+    ] = require(`date-fns/locale/${ensureDefaultLang}/index.js`)
   } catch (err) {
-    console.warn(getWarningMessage(defaultLang))
+    console.warn(getWarningMessage(ensureDefaultLang))
   }
 
-  if (lang && lang !== defaultLang) {
+  if (lang && lang !== ensureDefaultLang) {
     try {
       locales[lang] = require(`date-fns/locale/${lang}/index.js`)
     } catch (e) {
diff --git a/react/providers/I18n/format.spec.jsx b/react/providers/I18n/format.spec.jsx
index 7fed59c4ab..2430feb1b5 100644
--- a/react/providers/I18n/format.spec.jsx
+++ b/react/providers/I18n/format.spec.jsx
@@ -10,6 +10,18 @@ describe('initFormat', () => {
   it('should not throw if a date-fns locale can not be found', () => {
     expect(() => initFormat('unknown-lang', 'unknown-default')).not.toThrow()
   })
+
+  it('should use the correct locale', () => {
+    const f = initFormat('fr', 'en')
+    const date = f(0, 'yyyy-LLLL-dd')
+    expect(date).toBe('1970-janvier-01')
+  })
+
+  it('should fallback english if a date-fns locale can not be found', () => {
+    const f = initFormat('unknown-lang', 'unknown-default')
+    const date = f(0, 'yyyy-LLLL-dd')
+    expect(date).toBe('1970-January-01')
+  })
 })
 
 describe('formatLocallyDistanceToNow', () => {