refactor(l10n): add time zone translations and update time zone data generation #2612

ByronDWall · 2022-05-13T13:35:14Z

Summary

This PR adds translations for long form time zone names to l10n/data/time-zones/core.json and l10n/data/time-zones/en.json. And updates the generate-l10n-data and getTimeZonesForLocale method.

Description

The generate-l10n-data script will get the most recent IANA timezone list by running moment.tz.names(), remove any time zones that are in the EXCLUDED_TIME_ZONES constant from that array, then make sure that every remaining timezone has a corresponding translation string in core.json. If a timezone is not in EXCLUDED_TIME_ZONES or core.json, the script will prompt the user to either add any "new" time zones that should be translated to core.json, or to exclude them from being added to the time zone list by adding them to the EXCLUDED_TIME_ZONES constant in src/constants.ts.

The getTimeZonesForLocale function in src/time-zone-information.ts builds a normalized object using the locale-specific translation from <locale>.json for the label value, and the offset and abbr from moment-timezone. This allows for us to generate the offset value at runtime, which will insure that the offset for all time zones that have daylight/offset time is accurate. Previously, the offset value was only set when the generate-l10n-data script was run, leading to some timezones showing inaccurate offset values when they moved from daylight to standard time or vice-versa.

A SCREEN RECORDING OF THE FINAL CLI WORKFLOW IS HERE:

Screen.Recording.2022-06-15.at.4.55.56.PM.mov

changeset-bot · 2022-05-13T13:35:16Z

🦋 Changeset detected

Latest commit: 28ab4e0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 8 packages

Name	Type
@commercetools-frontend/l10n	Minor
@commercetools-frontend/application-components	Minor
@commercetools-frontend/application-shell	Minor
playground	Patch
merchant-center-application-template-starter	Patch
@commercetools-local/visual-testing-app	Patch
@commercetools-website/components-playground	Patch
@commercetools-frontend/cypress	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2022-05-13T13:42:10Z

Deploy preview for merchant-center-application-kit ready!

✅ Preview
https://merchant-center-application-m5xw634t5-commercetools.vercel.app
https://appkit-sha-3b0bf6fc585fcc0f8bba1c73a1faa693bd1d3885.commercetools.vercel.app
https://appkit-pr-2612.commercetools.vercel.app

Built with commit 28ab4e0.
This pull request is being automatically deployed with vercel-action

stephsprinkle

I erred on the side of caution here, feel free to disregard if too nitpicky

stephsprinkle · 2022-05-13T13:58:54Z

packages/l10n/data/time-zones/core.json

+  "America/Cancun": "Eastern Standard Time - Cancun",
+  "America/Jamaica": "Eastern Standard Time - Jamaica",
+  "America/Panama": "Eastern Standard Time - Panama",
+  "America/Guayaquil": "Eastern Standard Time - Guayaquil",


Suggested change

"America/Guayaquil": "Eastern Standard Time - Guayaquil",

"America/Guayaquil": "Ecuador Time - Guayaquil",

The regional name and clean data columns don't match on this one, is that intended?

This is something I will have to ask Diane - we've found a few other duplicated or missed time zones, so I will add this to the list

packages/l10n/data/time-zones/core.json

stephsprinkle · 2022-05-13T14:00:21Z

packages/l10n/data/time-zones/core.json

+  "America/Thunder_Bay": "Eastern Time - Thunder Bay",
+  "America/Toronto": "Eastern Time - Toronto",
+  "America/Guyana": "Guyana Time ",
+  "America/Asuncion": "Paraguay Time - Asuncion",


Suggested change

"America/Asuncion": "Paraguay Time - Asuncion",

"America/Asuncion": "Paraguay Time - Asunción",

Not sure about this one, there are others too that have been standardized out in the clean data column.

I have asked Diane about accent marks as well, and will add/remove them as she requires once she gets back to me

stephsprinkle · 2022-05-13T14:08:22Z

packages/l10n/data/time-zones/core.json

+  "Europe/Prague": "Central European Time - Prague",
+  "Europe/Rome": "Central European Time - Rome",
+  "Europe/Stockholm": "Central European Time - Stockholm",
+  "Europe/Tirana": "Central European Time - Tirane",


The city name on this one is Tirana in the doc

stephsprinkle · 2022-05-13T14:09:45Z

packages/l10n/data/time-zones/core.json

+  "Europe/Tallinn": "Eastern European Time - Tallinn",
+  "Europe/Uzhgorod": "Eastern European Time - Uzhgorod",
+  "Europe/Vilnius": "Eastern European Time - Vilnius",
+  "Europe/Zaporozhye": "Eastern European Time - Zaporozhskoye",


The city name on this one is Zaporozhye in the doc

packages/l10n/data/time-zones/core.json

stephsprinkle · 2022-05-13T14:11:55Z

packages/l10n/data/time-zones/core.json

+  "Asia/Baku": "Azerbaijan Time - Baku",
+  "Asia/Tbilisi": "Georgia Standard Time - Tbilisi",
+  "Indian/Mauritius": "Mauritius Time",
+  "Indian/Reunion": "Réunion Time",


We should definitely align on accent marks

packages/l10n/data/time-zones/core.json

tdeekens

Nice the shape of the file looks good. Wondering how: was this generated by the script or hand? 🤔

ByronDWall · 2022-05-16T12:51:22Z

Nice the shape of the file looks good. Wondering how: was this generated by the script or hand? 🤔

the original constant was, core.json was created by running a reduce over that constant.

emmenko

Thanks for working on this!
I left some early feedback, also to clarify a couple of things.

packages/l10n/data/time-zones/core.json

packages/l10n/scripts/generate-l10n-data.js

emmenko

Some quick feedback to simplify things a bit more.

packages/l10n/scripts/parse-new-time-zones.js

emmenko · 2022-05-16T19:15:43Z

packages/l10n/src/time-zone-information.ts

+};
+/**
+ * TODO:
+ * - handle fallback to 'default'/core.json when there are no translations for a locale


There are different ways to handle this.

For example, we could remove all "empty" locale files and omit the locale in the switch-case, so that the fallback/default en locale is used.

This also means that at least the en.json should be defined

I was thinking that we could lazy-load the locale first, and if the length locale.default is zero then lazy-load en, that way we wouldn't necessarily always have to define en.json

packages/l10n/src/time-zone-information.ts

packages/l10n/scripts/generate-l10n-data.js

stephsprinkle · 2022-05-17T19:35:33Z

packages/l10n/scripts/parse-unhandled-time-zones.js

+        title: 'Translate',
+        description: `Add ${timeZone} to core.json for translation`,
+        value: ANSWER_TYPES.ADD,


Could be interesting to add the option for the user to enter the text to be added in core.json for the new/unhandled time zone.

tdeekens · 2022-05-18T09:24:38Z

packages/l10n/src/time-zone-information.ts

+  let localeTranslations = await getImportChunk(supportedLocale);
+  // if there are no translations for the desired locale, fall back to en/default
+  if (
+    !localeTranslations.default ||
+    Object.keys(localeTranslations.default).length === 0
+  ) {
+    localeTranslations = await getImportChunk('en');
+  }
+  // create time zone object with abbreviations and offsets


Don't we have to handle this on a per timezone basis also and not on a chunk basis? What if we also add the new timezone name (EN version) to any <locale.>json file if the timezone is new. That would have it default to EN until we pull in something else from transifex.

This works for me if it works for you

Otherwise I don't see how we can show anything if we have say 22 translations in en.json and 20 in de.json (as two are new). I don't see how de.json being loaded then (as it's not empty) would then mean that it can never show anything for the two new TZs if I am not mistaken.

I didn't know whether it'd be better to wait for a translation before making a 'new' timezone available in a locale's tz list, or to add the tz to the locale files immediately.

We can talk more about the workflow when we meet about transifex, but I think there are pros and cons to each approach. If we decide to add the translation using the CLI tool, I will refactor it so that it writes to all locale files as well as core.json.

I didn't know whether it'd be better to wait for a translation before making a 'new' timezone available in a locale's tz list, or to add the tz to the locale files immediately.

I think that's a 🐔 🥚 problem if I understand your concern right. Let's talk tomorrow.

tdeekens · 2022-05-18T11:10:52Z

packages/l10n/scripts/generate-l10n-data.js

+            ...previousTimeZones,
+            [timeZoneId]: translatedTimeZones[timeZoneId]
+              ? translatedTimeZones[timeZoneId]
+              : 'ADD TRANSLATION',


👋🏼 When can this actually happen?

… from constants file to json file in l10n/data/time-zones to be able to write changes to file from cli, change timezone translations based on UX input and current moment data, begin work on updateTimezoneTranslations method of generate-l10n-data.js, run generate-l10n-data

…ta/time-zones to l10n/scripts and change it to js file, create l10n/scripts/parse-time-zones.js to handle asking cli questions about time zones, update updateTimeZoneData method to write to new translated and excluded timezones to file based on cli input in scripts/generate-l10n-data.js

…on PR feedback and with comments

…nhandled-timezones using 'prompts' to get user input, update time-zone-information.js to fallback to default/en translations when translations do not exist for a given locale and update getTimeZoneData to sort timeZones by offset

…t user for timezone translation string if adding a timezone, and a valid IANA identifier for a currently translated time zone to map to when excluding a time zone, add excluded-time-zones-fallback-map for handling excluded timezone fallbacks, add .d.ts for fallback map

…les, update spacing

…ezone map

…lback map

…to translation map, handle adding excluded timezones to translation map, add warning when translation map ids and translated tz ids are out of sync

…ax for TRANSLATIONS_FOR_EXCLUDED_TIME_ZONES_MAP in l10n/src/time-zone-information.ts

…zone-information

…s, remove mock tz ids from updateTimeZoneData

… to docs, move prompts to devDependencies

ByronDWall self-assigned this May 13, 2022

ByronDWall requested a review from a team May 13, 2022 13:35

ByronDWall force-pushed the PANGOLIN-1253-timezone-handling branch from b248d2a to d64df68 Compare May 13, 2022 13:36

github-actions bot temporarily deployed to Preview May 13, 2022 13:40 Destroyed

stephsprinkle reviewed May 13, 2022

View reviewed changes

tdeekens reviewed May 13, 2022

View reviewed changes

github-actions bot temporarily deployed to Preview May 13, 2022 17:18 Destroyed

github-actions bot temporarily deployed to Preview May 13, 2022 17:20 Destroyed

github-actions bot temporarily deployed to Preview May 13, 2022 17:23 Destroyed

emmenko reviewed May 16, 2022

View reviewed changes

ByronDWall force-pushed the PANGOLIN-1668-timezone-list-generation branch from c506c00 to 218e061 Compare May 16, 2022 16:18

github-actions bot temporarily deployed to Preview May 16, 2022 16:23 Destroyed

github-actions bot temporarily deployed to Preview May 16, 2022 16:49 Destroyed

github-actions bot temporarily deployed to Preview May 16, 2022 16:53 Destroyed

ByronDWall requested review from emmenko and tdeekens May 16, 2022 18:25

github-actions bot temporarily deployed to Preview May 16, 2022 18:27 Destroyed

github-actions bot temporarily deployed to Preview May 16, 2022 18:34 Destroyed

emmenko reviewed May 16, 2022

View reviewed changes

tdeekens reviewed May 17, 2022

View reviewed changes

github-actions bot temporarily deployed to Preview May 17, 2022 16:28 Destroyed

github-actions bot temporarily deployed to Preview May 17, 2022 16:37 Destroyed

stephsprinkle reviewed May 17, 2022

View reviewed changes

tdeekens reviewed May 18, 2022

View reviewed changes

github-actions bot temporarily deployed to Preview May 18, 2022 10:57 Destroyed

tdeekens reviewed May 18, 2022

View reviewed changes

ByronDWall and others added 25 commits June 28, 2022 08:55

feat(timezone list update): add excluded time zones list

da866aa

feat(timezone list update): update updateTimeZoneData function based …

09e07b6

…on PR feedback and with comments

feat(timezone list update): update updateTimeZoneData function based …

062c52c

…on PR feedback and with comments

feat(timezone list update): update updateTimeZoneData function based …

013334d

…on PR feedback and with comments

feat(timezone list update): remove unnecessary test data in locale fi…

607c572

…les, update spacing

feat(timezone list update): add new translations, create excluded tim…

1192c30

…ezone map

feat(timezone list update): initial fallback map complete

d541593

feat(timezone list update): remove excluded timezones in favor of fal…

396eb46

…lback map

feat(timezone list update): handle adding newly translated timezones …

515dd12

…to translation map, handle adding excluded timezones to translation map, add warning when translation map ids and translated tz ids are out of sync

feat(timezone list update): add file extension to import

6874fbb

feat(timezone list update): add translations map file in git

1e80540

feat(timezone list update): use require syntax instead of import synt…

4f4162b

…ax for TRANSLATIONS_FOR_EXCLUDED_TIME_ZONES_MAP in l10n/src/time-zone-information.ts

feat(timezone list update): more fun with module syntax and types

6cd9f76

feat(timezone list update): more fun with module syntax and types

9109825

feat(timezone list update): more fun with module syntax and types

ff39d00

feat(timezone list update): update types for translationsMap in time-…

18d0a43

…zone-information

feat(timezone list update): update all locales with final translation…

70ee1c7

…s, remove mock tz ids from updateTimeZoneData

feat(timezone list update): update timezone shape

c32eb4e

feat(timezone list update): add changeset

ef341ea

refactor(l10n): refine types and simplify logic

722a4ff

feat(timezone list update): shorten changeset, add tz generation info…

28ab4e0

… to docs, move prompts to devDependencies

ByronDWall force-pushed the PANGOLIN-1668-timezone-list-generation branch from c150505 to 28ab4e0 Compare June 28, 2022 12:55

github-actions bot deployed to Preview June 28, 2022 13:00 View deployment

ByronDWall merged commit c56498c into main Jun 28, 2022

ByronDWall deleted the PANGOLIN-1668-timezone-list-generation branch June 28, 2022 13:10

ghost mentioned this pull request Jun 28, 2022

Version Packages #2643

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(l10n): add time zone translations and update time zone data generation #2612

refactor(l10n): add time zone translations and update time zone data generation #2612

ByronDWall commented May 13, 2022 •

edited

Loading

changeset-bot bot commented May 13, 2022 •

edited

Loading

github-actions bot commented May 13, 2022 •

edited

Loading

stephsprinkle left a comment

stephsprinkle May 13, 2022

ByronDWall May 13, 2022

stephsprinkle May 13, 2022

ByronDWall May 13, 2022

stephsprinkle May 13, 2022

stephsprinkle May 13, 2022

stephsprinkle May 13, 2022

tdeekens left a comment

ByronDWall commented May 16, 2022

emmenko left a comment

emmenko left a comment

emmenko May 16, 2022

ByronDWall May 17, 2022

stephsprinkle May 17, 2022

tdeekens May 18, 2022

ByronDWall May 18, 2022

tdeekens May 18, 2022

ByronDWall May 18, 2022 •

edited

Loading

tdeekens May 18, 2022

tdeekens May 18, 2022

	"America/Guayaquil": "Eastern Standard Time - Guayaquil",
	"America/Guayaquil": "Ecuador Time - Guayaquil",

	"America/Asuncion": "Paraguay Time - Asuncion",
	"America/Asuncion": "Paraguay Time - Asunción",

refactor(l10n): add time zone translations and update time zone data generation #2612

refactor(l10n): add time zone translations and update time zone data generation #2612

Conversation

ByronDWall commented May 13, 2022 • edited Loading

Summary

Description

changeset-bot bot commented May 13, 2022 • edited Loading

🦋 Changeset detected

github-actions bot commented May 13, 2022 • edited Loading

stephsprinkle left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tdeekens left a comment

Choose a reason for hiding this comment

ByronDWall commented May 16, 2022

emmenko left a comment

Choose a reason for hiding this comment

emmenko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ByronDWall May 18, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ByronDWall commented May 13, 2022 •

edited

Loading

changeset-bot bot commented May 13, 2022 •

edited

Loading

github-actions bot commented May 13, 2022 •

edited

Loading

ByronDWall May 18, 2022 •

edited

Loading