Skip to content

Translate empty report next step message#94488

Merged
Julesssss merged 1 commit into
Expensify:mainfrom
shivang-goliyan:shivang-goliyan/85123-translate-empty-report-next-step
Jun 29, 2026
Merged

Translate empty report next step message#94488
Julesssss merged 1 commit into
Expensify:mainfrom
shivang-goliyan:shivang-goliyan/85123-translate-empty-report-next-step

Conversation

@shivang-goliyan

@shivang-goliyan shivang-goliyan commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

On an empty report, the next-step status message ("Waiting for you to add expenses") was always rendered in English, even when the user's locale was Spanish (or any other language).

The root cause is that two next-step systems exist in parallel: a deprecated one that hardcodes English text fragments, and a newer translatable one that uses a messageKey. For the empty-report case, getReportNextStep (src/libs/NextStepUtils.ts) fell through to returning the deprecated (English-only) next step, so the renderer never reached the translatable path.

This PR makes getReportNextStep prefer the translatable next step when the empty-report case applies (messageKey === CONST.NEXT_STEP.MESSAGE_KEY.WAITING_TO_ADD_TRANSACTIONS), so the message is rendered through translate() and respects the user's locale. The deprecated format remains the fallback for every other case, so no other next-step behaviour changes. useOptimisticNextStep (src/hooks/useOptimisticNextStep.ts) now passes moneyRequestReport?.nextStep into getReportNextStep so the translatable value is available.

Unit tests were added in tests/unit/NextStepUtilsTest.ts covering: the translatable step is preferred for the empty-report case, the deprecated step is still used for other message keys, and higher-priority overrides (e.g. prevent-self-approval) still win.

Fixed Issues

$ #85123
PROPOSAL: #85123 (comment)

Tests

  1. Set the app language to Spanish: Settings → Preferences → Language → Español (or set your device/browser language to Spanish).
  2. Make sure you have a workspace (create one if needed).
  3. Go to Reports → Create report to create an empty report.
  4. Look at the status bar at the top of the report.
  5. Verify it reads "Esperando a que tú añadas gastos." (translated) and not "Waiting for you to add expenses." (English).
  6. Switch the language back to English and verify the same message reads "Waiting for you to add expenses." (no regression for English).
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests — the next step for an empty report is computed optimistically on the client, so the translated message appears identically while offline.

QA Steps

  1. Set the account/device language to Spanish.
  2. Create (or open) a workspace.
  3. Go to Reports → Create report to create an empty report.
  4. Verify the status bar reads "Esperando a que tú añadas gastos." and not the English text.
  5. Switch the language to English and verify it reads "Waiting for you to add expenses."
  • 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
  • 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 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 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)
  • 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)
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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-native-85123
Android: mWeb Chrome android mweb
iOS: Native

I don't currently have the Mac disk space to build the iOS native app. Since this is a shared-JS translation change that renders identically across platforms (verified on Web, Android: Native, Android: mWeb Chrome, and iOS: mWeb Safari), the iOS native behavior is the same. Could a reviewer kindly verify iOS: Native? Happy to provide anything needed.

iOS: mWeb Safari ios mweb
MacOS: Chrome / Safari mac chrome

When a report is empty, getReportNextStep returned the deprecated,
English-only next step. Prefer the translatable next step (messageKey
WAITING_TO_ADD_TRANSACTIONS) so the "Waiting for you to add expenses"
message respects the user's locale. Falls back to the deprecated format
for every other case.

Issue: Expensify#85123
@shivang-goliyan

Copy link
Copy Markdown
Contributor Author

Hey @abdulrahuman5196, thanks for taking this on! Quick note on the testing.

I've added screenshots in the description for Web, Android Native, Android mWeb Chrome, and iOS mWeb Safari. The only one I couldn't manage is iOS Native. My Mac is really low on free space right now, so I can't build it (Xcode plus a simulator runtime takes up quite a lot). Since this fix is just a shared JS translation change, it renders the same on every platform, so iOS Native should look exactly like the others.

Would you mind verifying that one when you test? And if you'd rather I capture it some other way, just let me know and I'll figure it out.

cc @Julesssss, thanks a lot for offering to help with the PR earlier, really appreciate it.

@shivang-goliyan shivang-goliyan marked this pull request as ready for review June 24, 2026 19:27
@shivang-goliyan shivang-goliyan requested review from a team as code owners June 24, 2026 19:27
@melvin-bot melvin-bot Bot requested review from abdulrahuman5196 and joekaufmanexpensify and removed request for a team June 24, 2026 19:27
@melvin-bot

melvin-bot Bot commented Jun 24, 2026

Copy link
Copy Markdown

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

@melvin-bot melvin-bot Bot removed the request for review from a team June 24, 2026 19:27
@Julesssss

Copy link
Copy Markdown
Contributor

Would you mind verifying that one when you test?

That should be fine, but could you check the item off the checklist anyway. As long as you left a comment it is okay to check it off.

Else our CI check will fail and prevent merging 🙃

@codecov

codecov Bot commented Jun 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/libs/NextStepUtils.ts 71.33% <100.00%> (+3.28%) ⬆️
src/hooks/useOptimisticNextStep.ts 0.00% <0.00%> (ø)
... and 458 files with indirect coverage changes

@shivang-goliyan

Copy link
Copy Markdown
Contributor Author

Thanks @Julesssss, makes sense! I've checked the iOS Native box off now. Appreciate the quick help 🙌

@Julesssss

Copy link
Copy Markdown
Contributor

Ready for review @abdulrahuman5196

@abdulrahuman5196

Copy link
Copy Markdown
Contributor

nit: In the Author's Checklist, for QA Steps, you can directly mark as Same as Tests

@abdulrahuman5196

Copy link
Copy Markdown
Contributor

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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 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 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)
  • 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)
  • 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(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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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

Android: HybridApp
Screen.Recording.2026-06-28.at.4.08.00.PM.mov
Android: mWeb Chrome
Screen.Recording.2026-06-28.at.4.09.50.PM.mov
iOS: HybridApp
Screen.Recording.2026-06-28.at.3.59.23.PM.mov
iOS: mWeb Safari
Screen.Recording.2026-06-28.at.4.00.58.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2026-06-28.at.3.55.55.PM.mov

@abdulrahuman5196 abdulrahuman5196 left a comment

Copy link
Copy Markdown
Contributor

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. Reviewers checklist is also complete.

All yours. @Julesssss

🎀 👀 🎀
C+ Reviewed

@melvin-bot melvin-bot Bot requested a review from Julesssss June 28, 2026 10:43
@Julesssss Julesssss merged commit a21c548 into Expensify:main Jun 29, 2026
44 of 54 checks passed
@OSBotify

Copy link
Copy Markdown
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.

@github-actions

Copy link
Copy Markdown
Contributor

🚧 Julesssss has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.4.25-0 🚀

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

@OSBotify

OSBotify commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.4.25-2 🚀

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

Bundle Size Analysis (Sentry):

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.

4 participants