Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get rid of missing translation #42970

Merged
merged 37 commits into from
Jun 17, 2024
Merged

Get rid of missing translation #42970

merged 37 commits into from
Jun 17, 2024

Conversation

nkdengineer
Copy link
Contributor

@nkdengineer nkdengineer commented Jun 2, 2024

Details

Fixed Issues

$ #42539
PROPOSAL: #42539 (comment)

Tests

  1. Login to Expensify
  2. Try editing the form with errors
  3. Test all features of Expensify
  4. Verify that: There is no missing translation
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Login to app
  2. Try editing the form with errors
  3. Test other features of Expensify
  4. Verify that: There is no missing translation
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
android-resize.mp4
Android: mWeb Chrome
android-mweb-resize.mp4
iOS: Native
ios-resize.mp4
iOS: mWeb Safari
ios-mweb-resize.mp4
MacOS: Chrome / Safari
web-resize.mp4
MacOS: Desktop
desktop-resize.mp4

Copy link

melvin-bot bot commented Jun 2, 2024

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@nkdengineer nkdengineer marked this pull request as ready for review June 3, 2024 17:40
@nkdengineer nkdengineer requested a review from a team as a code owner June 3, 2024 17:40
@melvin-bot melvin-bot bot requested review from fedirjh and removed request for a team June 3, 2024 17:40
Copy link

melvin-bot bot commented Jun 3, 2024

@fedirjh 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]

src/components/MagicCodeInput.tsx Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/pages/workspace/tags/WorkspaceEditTagsPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/WorkspaceNewRoomPage.tsx Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
src/components/PDFView/PDFPasswordForm.tsx Show resolved Hide resolved
@fedirjh
Copy link
Contributor

fedirjh commented Jun 4, 2024

There is conflict

@nkdengineer
Copy link
Contributor Author

@fedirjh thanks your review, i'm working on this issue now.

@nkdengineer
Copy link
Contributor Author

@fedirjh I have finished updating according to your suggestions.
Please check again 🙏

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove function translateIfPhraseKey declaration as it's not used anymore.


These files needs to be updated :

  • src/pages/settings/Profile/Contacts/ValidateCodeForm/BaseValidateCodeForm.tsx
  • src/pages/settings/Wallet/ExpensifyCardPage.tsx

src/components/AddressForm.tsx Outdated Show resolved Hide resolved
src/pages/workspace/WorkspaceNewRoomPage.tsx Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
src/libs/ErrorUtils.ts Show resolved Hide resolved
src/libs/ErrorUtils.ts Show resolved Hide resolved
src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
@fedirjh
Copy link
Contributor

fedirjh commented Jun 5, 2024

@nkdengineer There is a typescript check error and there is a failing unit test.

@nkdengineer
Copy link
Contributor Author

Fixed now.

@melvin-bot melvin-bot bot requested a review from francoisl June 13, 2024 17:18
@fedirjh
Copy link
Contributor

fedirjh commented Jun 13, 2024

@nkdengineer conflicts again

@francoisl
Copy link
Contributor

For the second QA step:

  1. Login to app
  2. Try editing the form with errors

Can we edit it to be a bit more specific? Specifically what form is it referring to (looks like it's the name step of the onboarding flow), and how do you force an error (e.g. use a reserved name like Expensify or Concierge)?

@fedirjh
Copy link
Contributor

fedirjh commented Jun 13, 2024

Can we edit it to be a bit more specific?

@francoisl Actually, we edited all forms in the codebase, not just forms but all components where we have been passing the translation keys instead of translated values. we just need to verify that the errors are displayed correctly.

@@ -1,6 +1,5 @@
import type {AmountFormProps} from '@components/AmountForm';
import type {MenuItemBaseProps} from '@components/MenuItem';
import type {MaybePhraseKey} from '@libs/Localize';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this type is not used anywhere anymore, we might as well remove it?

@francoisl
Copy link
Contributor

Actually, we edited all forms in the codebase, not just forms but all components where we have been passing the translation keys instead of translated values

Yeah makes sense, maybe we can say something like "interact with forms in the app and fill them out incorrectly (e.g. missing values for required fields, values too long, etc.)".

Although now that I think about it, most forms already have regression tests that would catch any issues so maybe we're fine.

@nkdengineer
Copy link
Contributor Author

@francoisl @fedirjh i updated, please check again

francoisl
francoisl previously approved these changes Jun 14, 2024
@francoisl
Copy link
Contributor

Aw there's a conflict in src/pages/settings/Subscription/SubscriptionSize/utils.ts, can you fix please?

@nkdengineer
Copy link
Contributor Author

@francoisl fixed, please check again

@francoisl francoisl merged commit 67ec334 into Expensify:main Jun 17, 2024
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/francoisl in version: 1.4.85-0 🚀

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

2 similar comments
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/francoisl in version: 1.4.85-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/francoisl in version: 1.4.85-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.85-7 🚀

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

@@ -60,7 +59,7 @@ function BaseLoginForm({account, credentials, closeAccount, blurOnSubmit = false
const {translate} = useLocalize();
const input = useRef<BaseTextInputRef | null>(null);
const [login, setLogin] = useState(() => Str.removeSMSDomain(credentials?.login ?? ''));
const [formError, setFormError] = useState<TranslationPaths | undefined>();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We had related issue when form error was shown and user changed language in login page the error would still be in old language. We basically applied old logic to this page reverting its changes. Unfortunately I didn't see this PR before our implementation, I would've discussed this more thoroughly. But so far our changes works as expected

Related issue: #44849

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants