Fix: Translation for system message #21780

tienifr · 2023-06-28T09:49:18Z

Details

System messages are currently hard-coded strings. This PR added translationKey for them.

Fixed Issues

$ #19449
PROPOSAL: #19449 (comment)

Tests

Login with any account
Go to Settings > Preferences > Language
Select Spanish language and go back
Go to any chat
Send an Attachment
Verify that [Archivo adjunto] shows on LHN

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Login with any account
Go to Settings > Preferences > Language
Select Spanish language and go back
Go to any chat
Send an Attachment
Verify that [Archivo adjunto] shows on LHN

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 / Chrome
- iOS / native
- iOS / 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 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 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screencast.from.28-06-2023.16.53.59.webm

Mobile Web - Chrome

video_2023-07-07_23-58-03.mp4

Mobile Web - Safari

original-0E4EA68E-32B7-45EC-AAE8-8FB8B355AF1A.mp4

Desktop

Screen.Recording.2023-07-09.at.15.27.43.mov

iOS

Screen.Recording.2023-07-09.at.15.36.58.mov

Android

Screencast.from.07-07-2023.23.46.56.webm

melvin-bot · 2023-06-28T09:54:52Z

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

tienifr · 2023-06-28T09:57:14Z

@eVoloshchak I added new logic for translationKey but since old messages haven't had translationKey yet, I also kept the old logic, for example in isReportMessageAttachment function.

tienifr · 2023-06-28T10:01:32Z

@yuwenmemon As mentioned above, since all the old report actions haven't had translationKey yet, thus if we proceed my solution, I suggest the back-end changes as follow:

Add translationKey field under message to all old report actions. Defaults to empty string, if attachment then common.attachment.
Add lastMessageTranslationKey key to all reports. Also defaults to empty string, if attachment then common.attachment.

yuwenmemon · 2023-06-28T23:36:20Z

@tienifr I think we can proceed without worrying about the old messages if that makes things simpler. This only effects the most recent message shown in the LHN anyway, so I don't see a need to fix the old messages for that reason either.

tienifr · 2023-06-29T01:34:16Z

Okay so we'll keep both the old and new logic, right?

yuwenmemon · 2023-06-29T04:57:50Z

Ah, okay then I guess so, but then why would you need this?

Add translationKey field under message to all old report actions. Defaults to empty string, if attachment then common.attachment.

tienifr · 2023-06-29T07:23:22Z

Take isReportMessageAttachment function for example:

Currently we check if the message.text equals [Attachment] and message.html is either an attachment URI or Uploading attachment.
But after adding translationKey, we only need to compare whether the key equals common.attachment.

Thus I think if we want to completely migrate to the translationKey approach, we SHOULD add the translationKey to all old messages. Otherwise, I'll keep both (1) and (2) logic.

This only effects the most recent message shown in the LHN

This is not true since isReportMessageAttachment is used in a lot of places.

abdulrahuman5196 · 2023-06-29T08:07:36Z

Just providing some information on the subtitle translation issues discussion we had previously for LHN since I saw this PR which was mentioned in another issue. @yuwenmemon @eVoloshchak
We are having different translation issues and previously discussed here - https://expensify.slack.com/archives/C01GTK53T8Q/p1687190693298329

The last callout was to avoid complicated solutions incase of LHN translations and leave out small bugs if only way forward is a complex solution. Even attachments was mentioned there and the current path seems to have backend changes and complex solutions.
And one more concern is that, it not just we have either translated or non-translated subtitles, we also have complex subtitles where the message has part translated and part non-translated content, which would not have solved by the new translation key and we can't use the translation key in this case. For Eg.

App/src/libs/SidebarUtils.js

Lines 342 to 358 in 5997357

    
               lastMessageText = 
        
                   Localize.translate(preferredLocale, 'reportActionsView.beginningOfChatHistory') + 
        
                   _.map(displayNamesWithTooltips, ({displayName, pronouns}, index) => { 
        
                       const formattedText = _.isEmpty(pronouns) ? displayName : `${displayName} (${pronouns})`; 
        
                       if (index === displayNamesWithTooltips.length - 1) { 
        
                           return `${formattedText}.`; 
        
                       } 
        
                       if (index === displayNamesWithTooltips.length - 2) { 
        
                           return `${formattedText} ${Localize.translate(preferredLocale, 'common.and')}`; 
        
                       } 
        
                       if (index < displayNamesWithTooltips.length - 2) { 
        
                           return `${formattedText},`; 
        
                       } 
        
                   }).join(' '); 
        
           }

But anyways just providing my 2 cents from the last discussion I had and leaving it up for you guys to decide.

bernhardoj · 2023-06-29T17:26:28Z

The proposal
here #19449 (comment) is actually a straight and easy solution.

eVoloshchak · 2023-06-30T14:30:00Z

@abdulrahuman5196, thanks for attaching the discussion!
According to the thread:

would be totally fine if server side messages are not translated ever, since translating the backend is not something we did yet and whenever we want to fully internationalize the app, we will need to add backend translation anyway
I am also fine leaving small bugs related to this, especially when switching languages

It is a rare bug that can be reproduced only when switching languages, I agree this isn't a top priority. I think the implementation in this PR is correct, so in case we decide to implement this later - we should use it.
Asking if we should proceed in slack thread

tienifr · 2023-07-06T09:30:15Z

@eVoloshchak Any update?

eVoloshchak

@tienifr, the translation in LHN works well now.
I think we should translate "Uploading attachment" message too

Screen.Recording.2023-07-06.at.17.39.28.mov

tienifr · 2023-07-06T14:59:56Z

We are going to remove the Uploading attachment message, aren't we? I thought we have already agreed on translating [Attachment] only.

eVoloshchak · 2023-07-07T13:33:56Z

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 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

Screen.Recording.2023-07-10.at.14.02.38.mov

Mobile Web - Chrome

screen-20230710-140726.mp4

Mobile Web - Safari

Screen.Recording.2023-07-10.at.15.10.04.mov

Desktop

Screen.Recording.2023-07-10.at.14.14.37.mov

iOS

Screen.Recording.2023-07-10.at.15.08.13.mov

Android

screen-20230710-140856.mp4

eVoloshchak · 2023-07-07T15:13:02Z

We are going to remove the Uploading attachment message, aren't we? I thought we have already agreed on translating [Attachment] only.

Ah, you're correct, we indeed have an issue for that

Looks good to me, there are only two steps left

Merge with main
Upload videos for the remaining platforms

tienifr · 2023-07-07T16:26:08Z

@eVoloshchak main was pulled. I'll upload the rest videos in the next hour.

tienifr · 2023-07-09T12:18:32Z

@eVoloshchak All were updated. Thanks for your patience.

eVoloshchak

LGTM

eVoloshchak · 2023-07-10T12:16:50Z

@tienifr, could you please take a look at the failing PR Author check?
It might have been updated

tienifr · 2023-07-10T12:25:01Z

@eVoloshchak Thanks, I've updated that.

OSBotify · 2023-07-13T02:00:15Z

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 1.3.40-0 🚀

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

OSBotify · 2023-07-14T14:45:11Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.40-5 🚀

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

eh2077 · 2023-07-15T16:01:43Z

src/libs/actions/Report.js

@@ -249,6 +249,7 @@ function addActions(reportID, text = '', file) {

    const optimisticReport = {
        lastVisibleActionCreated: currentTime,
+        lastMessageTranslationKey: lodashGet(lastAction, 'message[0].translationKey', ''),


It looks like that push event should also update this field to update let LHN message after sending an attachment, like this case #22937

rushatgabhane · 2023-08-14T19:17:42Z

src/libs/actions/Report.js

@@ -249,6 +249,7 @@ function addActions(reportID, text = '', file) {

    const optimisticReport = {
        lastVisibleActionCreated: currentTime,
+        lastMessageTranslationKey: lodashGet(lastAction, 'message[0].translationKey', ''),


Hi all, this PR caused a regression Red dot and [Attachment] shows in LHN even after close error message

This is because we didn't set failure data for lastMessageTranslationKey

eVoloshchak · 2023-09-26T11:11:34Z

src/libs/isReportMessageAttachment.js

 * @returns {Boolean}
 */
-export default function isReportMessageAttachment({text, html}) {
+export default function isReportMessageAttachment({text, html, translationKey}) {
+    if (translationKey) {


👋 This was partially responsible for a regression in #24246
It was mainly a back-end problem, the translation key is not set/reset when we change from a message with a translation key to one without, or vice-versa
While this wasn't caused by this PR, leaving a note to myself and others to test more complex test cases (this one included testing with two accounts)

thanks @eVoloshchak

tienifr added 2 commits June 28, 2023 16:44

fix: translation for system message

d7966ec

Merge branch 'main' into fix/19449

dc7c924

tienifr marked this pull request as ready for review June 28, 2023 09:54

tienifr requested a review from a team as a code owner June 28, 2023 09:54

melvin-bot bot removed the request for review from a team June 28, 2023 09:54

melvin-bot bot requested a review from eVoloshchak June 28, 2023 09:54

fix lint

a5ace86

Merge branch 'main' into fix/19449

c1a47c1

eVoloshchak suggested changes Jul 6, 2023

View reviewed changes

Merge branch 'main' into fix/19449

4927f4b

eVoloshchak approved these changes Jul 10, 2023

View reviewed changes

melvin-bot bot requested a review from yuwenmemon July 10, 2023 12:15

yuwenmemon approved these changes Jul 11, 2023

View reviewed changes

yuwenmemon merged commit 12d54e8 into Expensify:main Jul 11, 2023

tienifr mentioned this pull request Jul 12, 2023

[$1000] LHN Attachment taking some time to translate into Spanish #19449

Closed

6 tasks

hoangzinh mentioned this pull request Jul 12, 2023

Dev - Unable to send new message, getting console error #22754

Closed

6 tasks

OSBotify mentioned this pull request Jul 13, 2023

Deploy Checklist: New Expensify 2023-07-13 #22783

Closed

53 tasks

eh2077 mentioned this pull request Jul 15, 2023

Chat - Message received after attachment isn't displayed in LHN until reply is sent and deleted #22937

Closed

6 tasks

eh2077 reviewed Jul 15, 2023

View reviewed changes

rushatgabhane reviewed Aug 14, 2023

View reviewed changes

rushatgabhane mentioned this pull request Aug 14, 2023

[HOLD for payment 2023-08-17] [$1000] Red dot and [Attachment] shows in LHN even after close error message #24136

Closed

6 tasks

eVoloshchak reviewed Sep 26, 2023

View reviewed changes

eVoloshchak mentioned this pull request Sep 26, 2023

[Awaiting payment] [$1000] After deleting an attachment, the LHN shows '[Attachment]' instead of 'No activity yet' until you delete one more message #24246

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Translation for system message #21780

Fix: Translation for system message #21780

tienifr commented Jun 28, 2023 •

edited

Loading

melvin-bot bot commented Jun 28, 2023

tienifr commented Jun 28, 2023 •

edited

Loading

tienifr commented Jun 28, 2023 •

edited

Loading

yuwenmemon commented Jun 28, 2023 •

edited

Loading

tienifr commented Jun 29, 2023

yuwenmemon commented Jun 29, 2023

tienifr commented Jun 29, 2023 •

edited

Loading

abdulrahuman5196 commented Jun 29, 2023

bernhardoj commented Jun 29, 2023

eVoloshchak commented Jun 30, 2023

tienifr commented Jul 6, 2023

eVoloshchak left a comment

tienifr commented Jul 6, 2023 •

edited

Loading

eVoloshchak commented Jul 7, 2023 •

edited

Loading

eVoloshchak commented Jul 7, 2023

tienifr commented Jul 7, 2023 •

edited

Loading

tienifr commented Jul 9, 2023

eVoloshchak left a comment

eVoloshchak commented Jul 10, 2023

tienifr commented Jul 10, 2023

OSBotify commented Jul 13, 2023

OSBotify commented Jul 14, 2023

eh2077 Jul 15, 2023

rushatgabhane Aug 14, 2023

eVoloshchak Sep 26, 2023

rushatgabhane Sep 26, 2023

Fix: Translation for system message #21780

Fix: Translation for system message #21780

Conversation

tienifr commented Jun 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 28, 2023

tienifr commented Jun 28, 2023 • edited Loading

tienifr commented Jun 28, 2023 • edited Loading

yuwenmemon commented Jun 28, 2023 • edited Loading

tienifr commented Jun 29, 2023

yuwenmemon commented Jun 29, 2023

tienifr commented Jun 29, 2023 • edited Loading

abdulrahuman5196 commented Jun 29, 2023

bernhardoj commented Jun 29, 2023

eVoloshchak commented Jun 30, 2023

tienifr commented Jul 6, 2023

eVoloshchak left a comment

Choose a reason for hiding this comment

tienifr commented Jul 6, 2023 • edited Loading

eVoloshchak commented Jul 7, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak commented Jul 7, 2023

tienifr commented Jul 7, 2023 • edited Loading

tienifr commented Jul 9, 2023

eVoloshchak left a comment

Choose a reason for hiding this comment

eVoloshchak commented Jul 10, 2023

tienifr commented Jul 10, 2023

OSBotify commented Jul 13, 2023

OSBotify commented Jul 14, 2023

eh2077 Jul 15, 2023

Choose a reason for hiding this comment

rushatgabhane Aug 14, 2023

Choose a reason for hiding this comment

eVoloshchak Sep 26, 2023

Choose a reason for hiding this comment

rushatgabhane Sep 26, 2023

Choose a reason for hiding this comment

tienifr commented Jun 28, 2023 •

edited

Loading

tienifr commented Jun 28, 2023 •

edited

Loading

tienifr commented Jun 28, 2023 •

edited

Loading

yuwenmemon commented Jun 28, 2023 •

edited

Loading

tienifr commented Jun 29, 2023 •

edited

Loading

tienifr commented Jul 6, 2023 •

edited

Loading

eVoloshchak commented Jul 7, 2023 •

edited

Loading

tienifr commented Jul 7, 2023 •

edited

Loading