Apostrophe 3.38.1: hotfix for an issue with certain locale names

[boutell]

The Problem

Version 3.38.0 introduced a regression that temporarily broke support for user-edited content in locales with names like de-de (note the lowercase country name). Only hyphenated locale names in all lower case were affected.

This bug was inadvertently introduced in an effort to improve support for locale fallback when generating static translations of the admin interface.

As a result, content for those locales seemed to disappear with version 3.38.0, although it was never removed from the database.

We apologize for the error.

The Fix

Version 3.38.1 brings back the content that temporarily appeared to be missing for these locales (it was never removed from the database), and also achieves the original goal. However, if you created content for such locales using 3.38.0 (released five days ago) and wish to keep that content, rather than reverting to the content from before 3.38.0, see below.

The Edge Case

A small number of users might prefer the content they created for these locales while 3.38.0 was available to what they had before.

The new i18n:rename-locale task can be used to move all content from one locale name to another, using the --old and --new options. By default, any duplicate keys for content existing in both locales will stop the process. However you can specify which content to keep in the event of a duplicate key error using the --keep=localename option. Note that the value of --new should match the a locale name that is currently configured for the @apostrophecms/i18n module.

Example:

# If you always had de-de configured as a locale, but created
# a lot of content with Apostrophe 3.38.0 which incorrectly stored
# it under de-DE, you can copy that content. In this case we opt
# to keep de-de content in the event of any conflicts
node app @apostrophecms/i18n:rename-locale --old=de-DE --new=de-de --keep=de-de