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

Display submitted message in report action #41040

Merged
merged 17 commits into from
Jul 4, 2024

Conversation

marcochavezf
Copy link
Contributor

Details

We display the message submitted %amount% using the existing submittedAmount copy. In this way, we show the same message even if the expense report is submitted by the admin (where originally we were showing the message You (on behalf of marco@expensify.com via admin-submit) submitted this report to you).

Fixed Issues

$ #35263

Tests

  1. Create a workspace and invite a member
  2. Enable Delay submissions and set the frequency to Daily
  3. Enable Add approvals.
  4. [Member] Create a few expenses but don't submit them
  5. [Admin] Submit the expense report
  6. Verify the message submitted %amount% is displayed in both accounts
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same steps from test section

  • 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari Screenshot 2024-04-25 at 3 54 53 p m Screenshot 2024-04-25 at 4 05 57 p m
MacOS: Desktop

@marcochavezf marcochavezf self-assigned this Apr 25, 2024
@marcochavezf marcochavezf requested a review from a team as a code owner April 25, 2024 22:06
@melvin-bot melvin-bot bot removed the request for review from a team April 25, 2024 22:06
Copy link

melvin-bot bot commented Apr 25, 2024

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

@@ -580,6 +581,9 @@ function ReportActionItem({
} else if (ReportActionsUtils.isOldDotReportAction(action)) {
// This handles all historical actions from OldDot that we just want to display the message text
children = <ReportActionItemBasicMessage message={ReportActionsUtils.getMessageOfOldDotReportAction(action)} />;
} else if (action.actionName === CONST.REPORT.ACTIONS.TYPE.SUBMITTED) {
const formattedAmount = CurrencyUtils.convertToDisplayString(Math.abs(report?.total ?? 0), report.currency);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added report?.total ?? 0 to pass the ts check, but total will be always present if the report action is submitted, since that action only exists in expense reports.

@parasharrajat
Copy link
Member

parasharrajat commented Apr 28, 2024

I don't know what is correct here. But I believe you when you say that it should be submitted x.x as it is when we submit the report. But then it raises a question why backend is sending that A (on behalf of you via admin-submit) submitted this report to A.

@parasharrajat
Copy link
Member

parasharrajat commented Apr 28, 2024

BUG: Web: Copy to clipboard does not copy submitted x.x. Instead whole string messages is copied.

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

Bugs above.

@parasharrajat
Copy link
Member

Bump @marcochavezf

@marcochavezf
Copy link
Contributor Author

why backend is sending that A (on behalf of you via admin-submit) submitted this report to A.

Ah, this is an old hardcoded message that we use for OldDot, and now we want to change it to submitted x.x. Also if we change the hardcoded message, we wouldn't be able to translate it in NewDot.

@marcochavezf
Copy link
Contributor Author

BUG: Web: Copy to clipboard does not copy submitted x.x. Instead whole string messages is copied.

Thanks for catching that, fixed and ready for another review

@marcochavezf marcochavezf requested a review from parasharrajat May 1, 2024 21:33
@marcochavezf
Copy link
Contributor Author

Friendly bump @parasharrajat

@parasharrajat
Copy link
Member

Requested to extend trial for testing.

@parasharrajat
Copy link
Member

BUG: LHN: Shows long message instead of submitted
Screenshot 2024-05-07 at 3 30 03 PM

@parasharrajat
Copy link
Member

parasharrajat commented May 7, 2024

I think this is the last issue. Sorry for not finding this earlier. On Search page, the report shows No activity which is same for other reports as well so no issue there.

@parasharrajat
Copy link
Member

BUG: thread title is not correct for the message.

BUG: Unrelated: I see another submitted message at the bottom of thread which seems wrong. But this is also present on staging.

Screenshot 2024-05-07 at 3 48 26 PM

@parasharrajat
Copy link
Member

Possible Bug: I think we should update the email being sent to the users as well. That might still be showing the whole string to the user.

@marcochavezf
Copy link
Contributor Author

Oh cool, thanks for finding those issues. We're working on other high-priority items this week, and then I will look at them. Seems most of them are backend bugs

@marcochavezf
Copy link
Contributor Author

Backend PRs are in review, I will post again here when those are deployed

@marcochavezf
Copy link
Contributor Author

Thanks for catching that @parasharrajat! Fixed:

Screen.Recording.2024-07-01.at.2.09.29.p.m.mov

@parasharrajat
Copy link
Member

@marcochavezf I have a question about the avatar for the submitted message on the report header. Should this be the actor of the message or the user who created the report?

02.07.2024_16.09.42_REC.mp4

@parasharrajat
Copy link
Member

Similarly, shouldn't LHN subtitle message be from Admin?

image

@parasharrajat
Copy link
Member

@marcochavezf Thoughts?

@marcochavezf
Copy link
Contributor Author

@marcochavezf I have a question about the avatar for the submitted message on the report header. Should this be the actor of the message or the user who created the report?

02.07.2024_16.09.42_REC.mp4

Yeah, in this case we should display the avatar of the user that submitted the report. I will check it out in a moment

@marcochavezf
Copy link
Contributor Author

Similarly, shouldn't LHN subtitle message be from Admin?

image

Ah good point, @trjExpensify what are your thoughts about this one? I see we have the same pattern for approved messages

Screenshot 2024-07-02 at 1 43 25 p m

@marcochavezf
Copy link
Contributor Author

The avatar issue is fixed now

Screen.Recording.2024-07-02.at.2.21.32.p.m.mov

@parasharrajat
Copy link
Member

Thanks for the changes. I think we can look into the LHN-related discussion on a separate issue #41040 (comment). Better to have a separate PR for this. I can help review this too if needed. We have already extended the scope of this PR so let's target our testing on the main issue.

@marcochavezf What do you think?

@parasharrajat
Copy link
Member

parasharrajat commented Jul 3, 2024

Screenshots

🔲 iOS / native

04.07.2024_19.51.06_REC.mp4

🔲 iOS / Safari

04.07.2024_19.33.42_REC.mp4

🔲 MacOS / Desktop

04.07.2024_15.30.18_REC.mp4

🔲 MacOS / Chrome

04.07.2024_15.18.18_REC.mp4

🔲 Android / Chrome

04.07.2024_19.35.40_REC.mp4

🔲 Android / native

04.07.2024_15.23.50_REC.mp4

@marcochavezf
Copy link
Contributor Author

Yeah, I agree that we can consider the LHN-related issue out of scope. Thanks!

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot bot requested a review from blimpich July 4, 2024 14:23
Copy link

melvin-bot bot commented Jul 4, 2024

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

Copy link
Contributor

@blimpich blimpich left a comment

Choose a reason for hiding this comment

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

LGTM

@blimpich blimpich merged commit 21f74e9 into main Jul 4, 2024
15 checks passed
@blimpich blimpich deleted the marco-updateSubmittedAdminMessage branch July 4, 2024 18:53
@OSBotify
Copy link
Contributor

OSBotify commented Jul 4, 2024

✋ 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

OSBotify commented Jul 8, 2024

🚀 Deployed to staging by https://github.com/blimpich in version: 9.0.5-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jul 8, 2024

🚀 Deployed to staging by https://github.com/blimpich in version: 9.0.5-2 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.6-8 🚀

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.

4 participants