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

Fix for: Room name rename text is translated in chat but not translated to Spanish in LHN #20479

Merged
merged 10 commits into from Jun 14, 2023

Conversation

Ollyws
Copy link
Contributor

@Ollyws Ollyws commented Jun 8, 2023

Details

Fixed Issues

$ #20124
PROPOSAL: #20124 (comment)

Tests

  1. Open the app
  2. Open any room or create new room
  3. Click on room name in header, change room name using: settings->room name
  4. Change language to Spanish
  5. Verify that room rename text in the LHN has been changed to Spanish
  6. Verify that room rename text in the chat, including "You" ("Tú") has been changed to Spanish
  • Verify that no errors appear in the JS console

Offline tests

  1. Open the app
  2. Open any room or create new room
  3. Click on room name in header, change room name using: settings->room name
  4. Change language to Spanish
  5. Verify that room rename text in the LHN has been changed to Spanish
  6. Verify that room rename text in the chat, including "You" ("Tú") has been changed to Spanish

QA Steps

  1. Open the app
  2. Open any room or create new room
  3. Click on room name in header, change room name using: settings->room name
  4. Change language to Spanish
  5. Verify that room rename text in the LHN has been changed to Spanish
  6. Verify that room rename text in the chat, including "You" ("Tú") has been changed to Spanish
  • 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
    • 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
MacOS_Chrome.mp4
Mobile Web - Chrome
Android_Chrome.mp4
Mobile Web - Safari
iOS_Safari.mp4
Desktop
MacOS_Desktop.mp4
iOS
iOS_Native.mp4
Android
Android_Native.mp4

@Ollyws Ollyws requested a review from a team as a code owner June 8, 2023 19:22
@melvin-bot melvin-bot bot requested review from abdulrahuman5196 and neil-marcellini and removed request for a team June 8, 2023 19:22
@melvin-bot
Copy link

melvin-bot bot commented Jun 8, 2023

@neil-marcellini @abdulrahuman5196 One of you needs to 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]

@Ollyws
Copy link
Contributor Author

Ollyws commented Jun 8, 2023

I have for now just included my original proposal with some minor alterations. Personally I think it looks good with the same text that we have in the chat, is more congruent that way and there seems to be enough space for it, but let me know what you think.

renamelhnexample

Something that I did notice is that when you change the text to Spanish the You is not translated in the chat:

YouExample

Happy to fix this too even if it it may be a little out of scope.

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Jun 9, 2023

@Ollyws

Personally I think it looks good with the same text that we have in the chat, is more congruent that way and there seems to be enough space for it, but let me know what you think.

I am not sure on this. Even for 10+ characters the new room name the text is getting truncated on the default web view. I think its best to go with the current behaviour of Room renamed to and it will also have more space to show new room name and consistent with current behaviour. Actually I don't think we need to show the same text from chat in the LHN anyways.

Screenshot 2023-06-09 at 2 16 19 PM
2)

Something that I did notice is that when you change the text to Spanish the You is not translated in the chat:
Happy to fix this too even if it it may be a little out of scope.

Yeah. that would be great. Kindly confirm on our slack channel on these translations.(LHN rename as well)

  1. Kindly fill in the author's checklist once we have confirmation on these.

@Ollyws
Copy link
Contributor Author

Ollyws commented Jun 9, 2023

@abdulrahuman5196 Ok, so you're suggesting we create a new translation key for Room renamed to and the spanish translation and use those?

@abdulrahuman5196
Copy link
Contributor

Yes. Thats my suggestion. But During the slack request for translation confirmation itself you can also check if any other text is good. I think this is best IMO but we can always double check with others on the string if you think other is better. No issues on that.
@Ollyws

@Ollyws
Copy link
Contributor Author

Ollyws commented Jun 9, 2023

@abdulrahuman5196 Ok, I've asked in Slack.

@Ollyws
Copy link
Contributor Author

Ollyws commented Jun 9, 2023

@abdulrahuman5196 This commit should fix "You" not being translated in the chat as I mentioned here.

@Ollyws
Copy link
Contributor Author

Ollyws commented Jun 9, 2023

@abdulrahuman5196 Updated as per your suggestions.

@abdulrahuman5196
Copy link
Contributor

It seems in fresh login we are not getting lastMessageText and 'No activity Yet' or 'Beginning of ' text is shown in case of different actions like renamed, IOU, tasks. I think we would need a more broader fix to support this similar places/action in the LHN sidebar subtitle to what we had discussed in the slack here - https://expensify.slack.com/archives/C01GTK53T8Q/p1686326271370549?thread_ts=1686301855.618179&cid=C01GTK53T8Q (Could have some backend changes as well)
I will create a separate bug report to start a issue on this, since it out be out of scope of this translation bug.

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Jun 12, 2023

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
Untitled.27.mp4
Mobile Web - Chrome
Untitled.24.mp4
Mobile Web - Safari
Untitled.28.mp4
Desktop
Untitled.26.mp4
iOS
Untitled.25.mp4
Android
Untitled.29.mp4

src/components/ReportActionItem/RenameAction.js Outdated Show resolved Hide resolved
src/libs/SidebarUtils.js Outdated Show resolved Hide resolved
Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 left a comment

Choose a reason for hiding this comment

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

Changes looks good and works well. And reviewers check is also complete.

All yours @neil-marcellini

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Looks great, but I want to understand why we made changes to the RenameAction.

Comment on lines +20 to +23
const currentUserAccountID = lodashGet(props.currentUserPersonalDetails, 'accountID', '');
const userDisplayName = lodashGet(props.action, ['person', 0, 'text']);
const actorAccountID = lodashGet(props.action, 'actorAccountID', '');
const displayName = actorAccountID === currentUserAccountID ? `${props.translate('common.you')}` : `${userDisplayName}`;
Copy link
Contributor

Choose a reason for hiding this comment

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

Why did we need to make this change to set "You" instead of the user's display name? It seems unnecessary.

Copy link
Contributor

Choose a reason for hiding this comment

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

@neil-marcellini
This was not part of the issue which we are fixing in LHN, this was a related translation issue where 'you' text was not translated in the chat page for the rename action. @Ollyws mentioned this issue and lended to fix it as well.

Since it was a similar translation issue during room rename action, I was ok with the extra fix as well. Let me know if you think otherwise.

#20479 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@neil-marcellini I originally mentioned here, I noticed that the 'You' in the chat was not localised to Spanish as you can can see in the linked comment, so I opted to fix that too.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah ok I missed that. Thanks for explaining. Please add tests for that part as well.

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Please fix merge conflicts and then it should be good to go. Please message me on NewDot when it's updated for a quicker review.

Comment on lines +20 to +23
const currentUserAccountID = lodashGet(props.currentUserPersonalDetails, 'accountID', '');
const userDisplayName = lodashGet(props.action, ['person', 0, 'text']);
const actorAccountID = lodashGet(props.action, 'actorAccountID', '');
const displayName = actorAccountID === currentUserAccountID ? `${props.translate('common.you')}` : `${userDisplayName}`;
Copy link
Contributor

Choose a reason for hiding this comment

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

Ah ok I missed that. Thanks for explaining. Please add tests for that part as well.

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Great thanks! Abdul's videos show the new test step too so I think we're good to go.

@neil-marcellini neil-marcellini merged commit 1345605 into Expensify:main Jun 14, 2023
12 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/neil-marcellini in version: 1.3.28-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

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.

None yet

4 participants