fix: ko language falls back to ko-KR #2102

SgtPooki · 2023-02-23T01:38:51Z

This PR adds tests for i18n, raw, without react.

It tests that the provided fallbacks are valid, and that they work properly.

Proof of the failing test at https://github.com/ipfs/ipfs-webui/actions/runs/4248889633/jobs/7388520133#step:7:351

fix #2097

Note: I needed to add a temporary translation for app.json's actions.add in order to ensure the test passed. lmk if someone has a better idea for how to confirm fallback, because this currently has an implicit dependency on translations between files being different, and we can't necessarily depend on that

english has 8 locale files: `ls -lhatr public/locales/en/*.json | wc -l # 8` before this change, ko-KR only had 4 `ls -lhatr public/locales/ko-KR/*.json | wc -l # 4` so I copied them over using `cp -n public/locales/en/*.json public/locales/ko-KR/` after this change `ls -lhatr public/locales/ko-KR/*.json | wc -l # 8`

Sends only a single request for lang via i18n-http-backend see i18next/i18next-http-backend#61

whizzzkid

@SgtPooki is this ready for review? I got assigned, but I am not sure as the title says WIP and the PR is draft.

SgtPooki · 2023-02-23T17:40:37Z

@SgtPooki is this ready for review? I got assigned, but I am not sure as the title says WIP and the PR is draft.

Yea, sorry. it's mostly ready, but I still need to confirm that the language is loading properly during runtime. The unit test seems to indicate that it's working fine.

fixes #2097

SgtPooki · 2023-02-23T23:43:45Z

@whizzzkid ready now. sorry for the extra noise

SgtPooki

self review

SgtPooki · 2023-02-23T23:44:40Z

public/locales/ko-KR/app.json

@@ -0,0 +1,106 @@
+{
+  "actions": {
+    "add": "추가하다",


This was the most common translation file, but one didn't exist for ko-KR yet. The only modification from en/app.json is that I added translation for actions.add based off of google translate.

SgtPooki · 2023-02-23T23:47:23Z

public/locales/ko-KR/notify.json

@@ -0,0 +1,30 @@
+{


removing. transifex already shows that these strings needs translated: https://www.transifex.com/ipfs/ipfs-webui/translate/#ko_KR/notify-json

SgtPooki · 2023-02-23T23:55:07Z

public/locales/ko-KR/settings.json

@@ -0,0 +1,184 @@
+{


removing. transifex already shows that these strings needs translated: https://www.transifex.com/ipfs/ipfs-webui/translate/#ko_KR/settings-json

SgtPooki · 2023-02-23T23:58:57Z

public/locales/ko-KR/welcome.json

@@ -0,0 +1,38 @@
+{


removing. transifex already shows that these strings needs translated: https://www.transifex.com/ipfs/ipfs-webui/translate/#ko_KR/welcome-json

SgtPooki

self review v2

SgtPooki · 2023-02-24T00:01:06Z

src/components/language-selector/LanguageSelector.js

+          <div className='pr4 flex items-center lh-copy charcoal f5 fw5 e2e-languageSelector-current' style={{ height: 40 }}>
            {getCurrentLanguage()}
          </div>
-          <Button className="tc" bg='bg-teal' minWidth={100} onClick={this.onLanguageEditOpen}>
+          <Button className="tc e2e-languageSelector-changeBtn" bg='bg-teal' minWidth={100} onClick={this.onLanguageEditOpen}>
            {t('app:actions.change')}
          </Button>
        </div>

        <Overlay show={this.state.isLanguageModalOpen} onLeave={this.onLanguageEditClose} >
-          <LanguageModal className='outline-0' onLeave={this.onLanguageEditClose} t={t} />
+          <LanguageModal className='outline-0 e2e-languageModal' onLeave={this.onLanguageEditClose} t={t} />


adding selectors for e2e tests

SgtPooki · 2023-02-24T00:01:21Z

src/components/language-selector/language-modal/LanguageModal.js

@@ -25,7 +25,7 @@ const LanguageModal = ({ t, tReady, onLeave, link, className, isIpfsDesktop, doD
          { localesList.map((lang) =>
            <button
              key={`lang-${lang.locale}`}
-              className='pa2 w-33 flex nowrap bg-transparent bn outline-0 blue justify-center'
+              className={`pa2 w-33 flex nowrap bg-transparent bn outline-0 blue justify-center e2e-languageModal-lang e2e-languageModal-lang_${lang.locale}`}


selectors for e2e tests

SgtPooki · 2023-02-24T00:03:12Z

src/i18n.js

@@ -16,6 +17,7 @@ i18n
  .use(Backend)
  .use(LanguageDetector)
  .init({
+    load: 'currentOnly', // see https://github.com/i18next/i18next-http-backend/issues/61


this is supposed to prevent the selection of multiple languages, but didn't, because i18n-http-backend doesn't know whether the code is valid until it goes to loadPath. The changes to loadPath below are where the real fix is.

SgtPooki · 2023-02-24T00:04:25Z

src/i18n.test.js

+  await i18n.init({
+    backend: {
+      ...i18n.options?.backend,
+      backendOptions: [
+        i18n.options?.backend?.backendOptions?.[0],
+        {
+          loadPath: `http://localhost:${backendListenerPort}/locales/{{lng}}/{{ns}}.json`
+        }
+      ]
+    }
+  })


force requests to our httpServer for i18n-http-backend requests.

SgtPooki · 2023-02-24T00:05:16Z

src/i18n.test.js

+        const langResult = await i18n.t('app:actions.add', { lng: lang })
+        expect(langResult).not.toBe('actions.add')


validate that i18n key is not returned, which means it's a recognized locale and key

SgtPooki · 2023-02-24T00:13:48Z

src/lib/i18n-localeParser.test.js

+    const fallbackResult = fallbackLanguages[prop]
+    if (fallbackResult != null) {
+      return fallbackResult[0]
+    }


but using fallbacks should be more common

SgtPooki · 2023-02-24T00:15:36Z

src/lib/i18n.test.js

+  it('should have a languages.json entry for each folder', function () {
+    const namedLocales = localesList.map(({ locale }) => locale)
+    expect(namedLocales).toEqual(allLanguages)
+  })


this will ensure our language selector is always up to date. i.e. this test fails if we haven't followed the steps from /docs/LOCALIZATION.md in the Pulling translations from Transifex section. specifically, the npx -q @olizilla/lol public/locales > src/lib/languages.json command.

SgtPooki · 2023-02-24T00:16:24Z

src/lib/i18n.test.js

+    it('returns unknown when given non-truthy input', () => {
+      expect(getLanguage()).toBe('Unknown')
+      expect(getLanguage('')).toBe('Unknown')
+      expect(getLanguage(null)).toBe('Unknown')
+      expect(getLanguage(undefined)).toBe('Unknown')
+    })


i don't know if we need this, but I didn't want to change it without knowing for sure.

SgtPooki · 2023-02-24T00:18:22Z

test/e2e/settings.test.js

+let languages
+const getLanguages = async () => {
+  if (languages != null) return languages
+  languages = JSON.parse(await languageFilePromise)
+  return languages
+}


playwright didn't like me importing json and i didn't want to fiddle with the build since this PR is big enough.

SgtPooki · 2023-02-24T00:18:58Z

test/e2e/settings.test.js

+        if (lang === 'en') {
+          // english is the fallback language and we can't guarantee the request wasn't already made, so we resolve for 'en' on any request
+
+          return true
+        }


test hangs without this when looping for en lang

whizzzkid

🚀

## [3.0.0](v2.22.0...v3.0.0) (2023-04-24) CID `bafybeic4gops3d3lyrisqku37uio33nvt6fqxvkxihrwlqsuvf76yln4fm` --- ### ⚠ BREAKING CHANGES * migrate to ESM (#2092) ### Features * ipfs-http-client -> kubo-rpc-client ([#2098](#2098)) ([5e53c79](5e53c79)), closes [#issuecomment-1426219633](https://github.com/ipfs/ipfs-webui/issues/issuecomment-1426219633) [/github.com//issues/2079#issuecomment-1426337490](https://github.com/ipfs//github.com/ipfs/ipfs-webui/issues/2079/issues/issuecomment-1426337490) * migrate to ESM ([#2092](#2092)) ([58a737c](58a737c)) ### Bug Fixes * e2e/explore.test.js succeeds in offline mode ([#2109](#2109)) ([a5e9ac6](a5e9ac6)) * ko language falls back to ko-KR ([#2102](#2102)) ([3369800](3369800)) * semantic release custom notes import ([#2113](#2113)) ([2f9f306](2f9f306)) ### Trivial Changes * add NetworkTraffic.stories.js ([#2094](#2094)) ([7a3bf46](7a3bf46)) * pull new translations ([#2101](#2101)) ([cbabac3](cbabac3)) * pull new translations ([#2104](#2104)) ([4a691a2](4a691a2)) * Pull transifex translations ([#2088](#2088)) ([a5b8a1c](a5b8a1c)) * Pull transifex translations ([#2091](#2091)) ([d209863](d209863)) * Pull transifex translations ([#2099](#2099)) ([1cf2fe7](1cf2fe7)) * Pull transifex translations ([#2111](#2111)) ([57d9b63](57d9b63))

ipfs-gui-bot · 2023-04-24T20:07:28Z

🎉 This PR is included in version 3.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

test: test i18n languages and fallbacks

e97c5c9

SgtPooki linked an issue Feb 23, 2023 that may be closed by this pull request

Reopen #1999: Can't resolve the locale #2097

Closed

SgtPooki temporarily deployed to Deploy February 23, 2023 01:44 — with GitHub Actions Inactive

test(i18n): use available port

87b68e6

SgtPooki temporarily deployed to Deploy February 23, 2023 02:38 — with GitHub Actions Inactive

SgtPooki added 3 commits February 22, 2023 18:48

chore(i18n): ensure app:actions.add has ko translation

db17cd8

fix: only send i18n requests for current language

fc24e90

Sends only a single request for lang via i18n-http-backend see i18next/i18next-http-backend#61

SgtPooki temporarily deployed to Deploy February 23, 2023 02:58 — with GitHub Actions Inactive

SgtPooki requested a review from whizzzkid February 23, 2023 03:07

whizzzkid reviewed Feb 23, 2023

View reviewed changes

fix: current language displays correctly for fallbacks

b3db8ac

SgtPooki temporarily deployed to Deploy February 23, 2023 19:57 — with GitHub Actions Inactive

SgtPooki added 8 commits February 23, 2023 12:44

test(lib/i18n): test getLanguage function

cea0eee

test(lib/i18n): add getCurrentLanguage test

ad2cb3e

test(i18n): add test for naming languages in languages.json

cc3c9e9

fix(i18n): add parser for getting valid locale codes

b7657da

fix(lib/i18n): use i18n-localeParser

54749f4

fix(i18n): prevent the lookup of invalid locales

7eb9327

fixes #2097

test(e2e:settings): test language selector

fb59953

test(e2e/settings): validate that language files are requested

c81c2a2

SgtPooki changed the title ~~[WIP] fix: ko language falls back to ko-KR~~ fix: ko language falls back to ko-KR Feb 23, 2023

SgtPooki self-assigned this Feb 23, 2023

SgtPooki marked this pull request as ready for review February 23, 2023 23:26

SgtPooki requested a review from a team as a code owner February 23, 2023 23:26

SgtPooki temporarily deployed to Deploy February 23, 2023 23:30 — with GitHub Actions Inactive

SgtPooki requested a review from whizzzkid February 23, 2023 23:37

SgtPooki mentioned this pull request Feb 23, 2023

Reopen #1999: Can't resolve the locale #2097

Closed

chore: remove untranslated ko-KR files

594e0ba

SgtPooki commented Feb 24, 2023

View reviewed changes

SgtPooki temporarily deployed to Deploy February 24, 2023 00:03 — with GitHub Actions Inactive

SgtPooki commented Feb 24, 2023

View reviewed changes

whizzzkid approved these changes Feb 24, 2023

View reviewed changes

SgtPooki merged commit 3369800 into main Feb 25, 2023

SgtPooki deleted the 2097-reopen-1999-cant-resolve-the-locale branch February 25, 2023 00:37

ipfs-gui-bot added the released label Apr 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: ko language falls back to ko-KR #2102

fix: ko language falls back to ko-KR #2102

SgtPooki commented Feb 23, 2023 •

edited

whizzzkid left a comment

SgtPooki commented Feb 23, 2023

SgtPooki commented Feb 23, 2023

SgtPooki left a comment

SgtPooki Feb 23, 2023

SgtPooki Feb 23, 2023

SgtPooki Feb 23, 2023

SgtPooki Feb 23, 2023

SgtPooki left a comment

SgtPooki Feb 24, 2023

SgtPooki Feb 24, 2023

SgtPooki Feb 24, 2023

SgtPooki Feb 24, 2023

SgtPooki Feb 24, 2023

SgtPooki Feb 24, 2023

SgtPooki Feb 24, 2023

SgtPooki Feb 24, 2023

SgtPooki Feb 24, 2023

SgtPooki Feb 24, 2023

whizzzkid left a comment

ipfs-gui-bot commented Apr 24, 2023

		const langResult = await i18n.t('app:actions.add', { lng: lang })
		expect(langResult).not.toBe('actions.add')

fix: ko language falls back to ko-KR #2102

fix: ko language falls back to ko-KR #2102

Conversation

SgtPooki commented Feb 23, 2023 • edited

whizzzkid left a comment

Choose a reason for hiding this comment

SgtPooki commented Feb 23, 2023

SgtPooki commented Feb 23, 2023

SgtPooki 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

SgtPooki 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

whizzzkid left a comment

Choose a reason for hiding this comment

ipfs-gui-bot commented Apr 24, 2023

SgtPooki commented Feb 23, 2023 •

edited