Skip to content

Hide GBR on pending transactions#53039

Merged
johnmlee101 merged 5 commits into
Expensify:mainfrom
cretadn22:hide-GBR-on-pending-transaction
Jan 7, 2025
Merged

Hide GBR on pending transactions#53039
johnmlee101 merged 5 commits into
Expensify:mainfrom
cretadn22:hide-GBR-on-pending-transaction

Conversation

@cretadn22

@cretadn22 cretadn22 commented Nov 24, 2024

Copy link
Copy Markdown
Contributor

Explanation of Change

Fixed Issues

$ #52315
PROPOSAL: #52315 (comment)

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Prerequisite: Auto approval limit set for $1000 and Receipt required set for $200

  1. Submit a card expense for the amount above $1000 to approver
  2. As the approver view the expense report
  3. Verify that the GBR should not be shown to the approver if all expenses on a report are pending.
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 [Screen102.webm](https://github.com/user-attachments/assets/3c0f573a-936e-4167-bd9b-dff8f9163ba6)
Android: mWeb Chrome [Screen101.webm](https://github.com/user-attachments/assets/ed210946-d21d-4af1-9e81-57c171200d2b)
iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-12-16.at.23.27.07.mp4
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-12-16.at.23.26.47.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-12-12.at.00.50.38.mov
MacOS: Desktop
Screen.Recording.2024-12-12.at.00.49.08.mov

@cretadn22 cretadn22 requested a review from a team as a code owner November 24, 2024 09:48
@melvin-bot melvin-bot Bot requested a review from akinwale November 24, 2024 09:48
@melvin-bot

melvin-bot Bot commented Nov 24, 2024

Copy link
Copy Markdown

@akinwale 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 November 24, 2024 09:48
@cretadn22

Copy link
Copy Markdown
Contributor Author

Hi @akinwale,

I’m currently working on mocking data to test this PR. However, to ensure proper validation, we’ll ultimately need to use the correct data from the backend for testing. Do you know of any way to mock a card expense on the New Dot?

@akinwale

Copy link
Copy Markdown
Contributor

Hi @akinwale,

I’m currently working on mocking data to test this PR. However, to ensure proper validation, we’ll ultimately need to use the correct data from the backend for testing. Do you know of any way to mock a card expense on the New Dot?

@cretadn22 I am not sure. Can you ask in the #expensify-open-source channel on Slack?

@akinwale akinwale 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.

LGTM.

@melvin-bot melvin-bot Bot requested a review from johnmlee101 November 27, 2024 06:31
@akinwale

Copy link
Copy Markdown
Contributor

@johnmlee101 Please hold off on reviewing this. I accidentally approved thinking it was a different PR.

@johnmlee101 johnmlee101 requested a review from akinwale November 27, 2024 16:49
@cretadn22

Copy link
Copy Markdown
Contributor Author

Asking here: https://expensify.slack.com/archives/C01GTK53T8Q/p1732719302806679

But there are no response

@cretadn22

cretadn22 commented Dec 2, 2024

Copy link
Copy Markdown
Contributor Author

@akinwale Should I do on this PR? Or I will use mock data to test

@akinwale

akinwale commented Dec 9, 2024

Copy link
Copy Markdown
Contributor

@cretadn22 Feel free to use mock data to test. You can try making use of a useEffect hook or whatever works to generate the mock data in the app. You will need to include this in your test steps.

@cretadn22

cretadn22 commented Dec 11, 2024

Copy link
Copy Markdown
Contributor Author

Command to mock test:

Onyx.merge('transactions_2516042651968607486', {bank: "Expensify Card", cardId: 4, status: "Pending"})

Testing offline is necessary to prevent data updates from the backend

@cretadn22

Copy link
Copy Markdown
Contributor Author

@akinwale Could you review this PR?

@akinwale

Copy link
Copy Markdown
Contributor

Command to mock test:

Onyx.merge('transactions_2516042651968607486', {bank: "Expensify Card", cardId: 4, status: "Pending"})

Testing offline is necessary to prevent data updates from the backend

@cretadn22 In which file do you add this as a useEffect for testing?

@cretadn22

Copy link
Copy Markdown
Contributor Author

@akinwale You can use any file as long as the mock data is imported before testing. Additionally, ensure offline mode is enabled to prevent the backend from overwriting the mock data.

@trjExpensify

Copy link
Copy Markdown
Contributor

@akinwale what's the next step here, can we get this over the line this week? Thanks!

@akinwale

Copy link
Copy Markdown
Contributor

I'll review this today.

@akinwale

Copy link
Copy Markdown
Contributor

@cretadn22 I have been trying to test this but I have not been able to produce the expected result.

Could you please provide a detailed step by step guide on how to test using the provided Onyx.merge call? I turned on offline mode, added this as a useEffect to the ReportDetailsPage component with the transaction ID of the pending transaction, but the GBR is still displayed.

useEffect(() => {
    Onyx.merge('transactions_7436740186307161489', {bank: "Expensify Card", cardId: 4, status: "Pending"})
}, []);

@cretadn22

Copy link
Copy Markdown
Contributor Author

@akinwale

We need to trigger a re-render of the LHN to accurately reflect the new mock data

Screen.Recording.2024-12-31.at.11.09.46.mp4

@johnmlee101

Copy link
Copy Markdown
Contributor

@akinwale let me know when you manage to test!

@akinwale

akinwale commented Jan 6, 2025

Copy link
Copy Markdown
Contributor

I'll retest today and should hopefully be able to wrap this up.

@akinwale

akinwale commented Jan 7, 2025

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 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 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 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 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.ts 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 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.
  • 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: Native
Android: mWeb Chrome
53039-android-chrome.mp4
iOS: Native
iOS: mWeb Safari
53039-ios-safari.mp4
MacOS: Chrome / Safari
53039-web.mp4
MacOS: Desktop
53039-desktop.mp4

@akinwale akinwale 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.

LGTM.

@akinwale

akinwale commented Jan 7, 2025

Copy link
Copy Markdown
Contributor

@johnmlee101 This is ready for your review.

@johnmlee101 johnmlee101 merged commit cf9a023 into Expensify:main Jan 7, 2025
@OSBotify

OSBotify commented Jan 7, 2025

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

github-actions Bot commented Jan 8, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/johnmlee101 in version: 9.0.82-0 🚀

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

1 similar comment
@github-actions

github-actions Bot commented Jan 8, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/johnmlee101 in version: 9.0.82-0 🚀

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

@kavimuru

kavimuru commented Jan 8, 2025

Copy link
Copy Markdown

@johnmlee101 @akinwale our QA team can't test the card expense. Could this be verified internally?

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.82-12 🚀

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

Comment thread src/libs/ReportUtils.ts

// Has a child report that is awaiting action (e.g. approve, pay, add bank account) from current user
if (optionOrReport.hasOutstandingChildRequest) {
if (optionOrReport.hasOutstandingChildRequest && !hasOnlyPendingTransactions) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This PR caused #59374

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.

7 participants