[NoQA] Safely catch translation key when it's wrong or missing by dukenv0307 · Pull Request #28377 · Expensify/App

dukenv0307 · 2023-09-28T08:54:13Z

Details

Fixed Issues

$ #27759
PROPOSAL: #27759 (comment)

Tests

Testing in dev env

Comment out this line so that we can test it locally
Navigate to screen A and change the text value of a translate function to something not in the translation.
For example: Update this common.settings in this line to 'wrong'
Login with an email from EXPENSIFY_EMAIL_DOMAIN ( from here )
Verify that "MISSING TRANSLATION" is showing up when you go to the screen A
Login with an email that is not from EXPENSIFY_EMAIL_DOMAIN ( from here )
Verify that the 'wrong' string is showing up when you go to the screen A

Verify that no errors appear in the JS console

Offline tests

QA Steps

Testing in dev env

Comment out this line so that we can test it locally
Navigate to screen A and change the text value of a translate function to something not in the translation.
For example: Update this common.settings in this line to 'wrong'
Login with an email from EXPENSIFY_EMAIL_DOMAIN ( from here )
Verify that "MISSING TRANSLATION" is showing up when you go to the screen A
Login with an email that is not from EXPENSIFY_EMAIL_DOMAIN ( from here )
Verify that the 'wrong' string is showing up when you go to the screen A

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.4.mp4

Mobile Web - Chrome

chrome.mov

Mobile Web - Safari

safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-10-02T03:05:34Z

@lakchote Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

dukenv0307 · 2023-10-02T03:08:18Z

@lakchote Wrong assigned. Please ignore this PR
@mountiny @robertKozik Please help review the PR as well as this comment

mountiny · 2023-10-02T20:48:43Z

I dont think we have to worry about the API fallback now, we do not have the violations in place right now so I think we can just proceed with what we have now. Did I miss anything?

dukenv0307 · 2023-10-03T02:58:14Z

@mountiny When you mentioned:

I dont think we have to worry about the API fallback now, we do not have the violations in place right

Does that mean we can leave out test steps and screenshots for this PR? If it does, I think we could continue reviewing the PR

mountiny · 2023-10-03T10:08:58Z

@dukenv0307 Lets test this by hardcoding different than Expensify domain and then hardcoding wrong translation to see it works fine

dukenv0307 · 2023-10-04T11:12:09Z

@mountiny @robertKozik I just updated the test steps and screenshots. Please help review when you have time.
Feel free to ping me if any concerns.

dukenv0307 · 2023-10-09T03:51:44Z

@robertKozik Friendly bump. Please help review the PR

robertKozik · 2023-10-09T07:56:15Z

src/libs/Localize/index.js

+let userEmail = '';
+Onyx.connect({
+    key: ONYXKEYS.SESSION,
+    waitForCollectionCallback: true,
+    callback: (val) => {
+        if (!val) {
+            return;
+        }
+        userEmail = val.email;
+    },
+});


I think we can create some comment to address why are we need user email here - similar to LocaleListener.connect() comment below

robertKozik · 2023-10-09T08:12:04Z

src/CONST.ts

        RECEIPTS: 'receipts@expensify.com',
        STUDENT_AMBASSADOR: 'studentambassadors@expensify.com',
        SVFG: 'svfg@expensify.com',
+        EXPENSIFY_EMAIL_DOMAIN: '@expensify',


Suggested change

EXPENSIFY_EMAIL_DOMAIN: '@expensify',

EXPENSIFY_EMAIL_DOMAIN: '@expensify.com',

If you have an phone number as your primary contact method the userEmail gets format : <phone_number>@expensify.sms so we need to specify top-level domain as well.

robertKozik

One change in comment, so it will be more descriptive. I'll start doing reviewer checklist now.

robertKozik · 2023-10-09T09:01:50Z

src/libs/Localize/index.js

 import BaseLocaleListener from './LocaleListener/BaseLocaleListener';
+import ONYXKEYS from '../../ONYXKEYS';
+
+// Save the email after user logins


Suggested change

// Save the email after user logins

// Current user mail is needed for handling missing translations

robertKozik · 2023-10-09T09:22:20Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

robertKozik

LGTM

mountiny

Thanks

OSBotify · 2023-10-09T13:25:32Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-10-09T23:01:22Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.80-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

kavimuru · 2023-10-09T23:12:50Z

@mountiny is this internal QA?

mountiny · 2023-10-10T14:14:08Z

Yeah I will check this off

OSBotify · 2023-10-11T04:41:38Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.80-3 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-10-11T05:10:29Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.81-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

marcaaron · 2023-10-12T19:57:09Z

PR caused this weird confusing thing to happen here -> #28312 (comment)

OSBotify · 2023-10-13T21:59:38Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:11:41Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:27:54Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T23:03:18Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-10-16T21:14:59Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-16T21:51:19Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

blazejkustra · 2023-10-18T11:28:26Z

src/libs/Localize/index.js

+let userEmail = '';
+Onyx.connect({
+    key: ONYXKEYS.SESSION,
+    waitForCollectionCallback: true,


@dukenv0307 SESSION onyx key is not a collection key, I'm wondering why waitForCollectionCallback: true was added?

That was probably a bad copy pasta we have missed

Np, we will remove it in a TS migration PR 👍

dukenv0307 added 2 commits September 28, 2023 15:49

Safely catch translation key when it's wrong or missing

d5f884c

update comment

8e27b0c

dukenv0307 mentioned this pull request Sep 28, 2023

[Paid] [$500] Safely catch translation key when it's wrong/missing #27759

Closed

dukenv0307 marked this pull request as ready for review October 2, 2023 03:05

dukenv0307 requested a review from a team as a code owner October 2, 2023 03:05

dukenv0307 marked this pull request as draft October 2, 2023 03:05

melvin-bot bot requested review from lakchote and removed request for a team October 2, 2023 03:05

dukenv0307 marked this pull request as ready for review October 2, 2023 03:06

lakchote requested review from mountiny and robertKozik and removed request for lakchote October 2, 2023 14:10

mountiny assigned dukenv0307 Oct 3, 2023

dukenv0307 added 3 commits October 4, 2023 10:45

Merge branch 'main' into fix/27759-catch-translation-key

141d6fe

fix condition

0bbe159

fix test

6608234

resolve conflict

54320fa

robertKozik reviewed Oct 9, 2023

View reviewed changes

robertKozik suggested changes Oct 9, 2023

View reviewed changes

fix comments

604b078

robertKozik suggested changes Oct 9, 2023

View reviewed changes

change comment

8c7f8a2

robertKozik approved these changes Oct 9, 2023

View reviewed changes

mountiny approved these changes Oct 9, 2023

View reviewed changes

mountiny merged commit a545eaa into Expensify:main Oct 9, 2023

OSBotify mentioned this pull request Oct 9, 2023

Deploy Checklist: New Expensify 2023-10-09 #29131

Closed

64 tasks

mountiny changed the title ~~Safely catch translation key when it's wrong or missing~~ [NoQA] Safely catch translation key when it's wrong or missing Oct 10, 2023

OSBotify mentioned this pull request Oct 11, 2023

Deploy Checklist: New Expensify 2023-10-11 #29252

Closed

dukenv0307 mentioned this pull request Oct 12, 2023

[HOLD for payment 2023-10-23] [HOLD for payment 2023-10-23] [HOLD for payment 2023-10-20] [HOLD for payment 2023-10-20] Task settings - Page header displayed if none selected in notification settings for task #29450

Closed

7 tasks

fedirjh mentioned this pull request Oct 12, 2023

add “Report virtual card fraud” page and route #28312

Merged

64 tasks

blazejkustra reviewed Oct 18, 2023

View reviewed changes

blazejkustra mentioned this pull request Nov 6, 2023

[TS migration] Migrate 'Localize' lib to TypeScript #29742

Merged

59 tasks

blazejkustra mentioned this pull request Feb 5, 2024

Fix: Missing translation for server errors #30073

Merged

56 tasks

	EXPENSIFY_EMAIL_DOMAIN: '@expensify',
	EXPENSIFY_EMAIL_DOMAIN: '@expensify.com',

	// Save the email after user logins
	// Current user mail is needed for handling missing translations

Conversation

dukenv0307 commented Sep 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Testing in dev env

Offline tests

QA Steps

Testing in dev env

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Oct 2, 2023

Uh oh!

dukenv0307 commented Oct 2, 2023

Uh oh!

mountiny commented Oct 2, 2023

Uh oh!

dukenv0307 commented Oct 3, 2023

Uh oh!

mountiny commented Oct 3, 2023

Uh oh!

dukenv0307 commented Oct 4, 2023

Uh oh!

dukenv0307 commented Oct 9, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robertKozik left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robertKozik commented Oct 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

robertKozik left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Oct 9, 2023

Uh oh!

OSBotify commented Oct 9, 2023

Uh oh!

kavimuru commented Oct 9, 2023

Uh oh!

mountiny commented Oct 10, 2023

Uh oh!

OSBotify commented Oct 11, 2023

Uh oh!

OSBotify commented Oct 11, 2023

Uh oh!

marcaaron commented Oct 12, 2023

Uh oh!

OSBotify commented Oct 13, 2023

Uh oh!

OSBotify commented Oct 13, 2023

Uh oh!

OSBotify commented Oct 13, 2023

Uh oh!

OSBotify commented Oct 13, 2023

Uh oh!

OSBotify commented Oct 16, 2023

Uh oh!

OSBotify commented Oct 16, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

dukenv0307 commented Sep 28, 2023 •

edited

Loading

robertKozik commented Oct 9, 2023 •

edited

Loading