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

Change errors key #54370

Merged
merged 9 commits into from
Jan 2, 2025
Merged

Change errors key #54370

merged 9 commits into from
Jan 2, 2025

Conversation

luacmartins
Copy link
Contributor

@luacmartins luacmartins commented Dec 19, 2024

Explanation of Change

Updates App to use the errors key instead of hasErrors so it can benefit from Onyx live updates

Fixed Issues

$ #54161

Tests

  1. [User A] Throttle your connection to 3G
  2. [User B] Submit two expenses to User A.
  3. [User A] Go to Reports > Expenses > Outstanding.
  4. [User B] Delete one of the expenses.
  5. [User A] Quickly pay the two expenses right after User B deletes one of them (to trigger RBR).
  6. [User A] Click Review button.
  7. [User A] Pay the expense from expense RHP.
  8. [User A] Close the RHP.
  9. [User A] Verify that the expense is updated to Paid
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

  • 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.ts 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.
  • 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

Screen.Recording.2024-12-19.at.9.44.09.AM.mov
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@luacmartins luacmartins self-assigned this Dec 19, 2024
@luacmartins luacmartins marked this pull request as ready for review December 19, 2024 16:52
@luacmartins luacmartins requested a review from a team as a code owner December 19, 2024 16:52
@melvin-bot melvin-bot bot requested review from parasharrajat and removed request for a team December 19, 2024 16:52
Copy link

melvin-bot bot commented Dec 19, 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]

@luacmartins
Copy link
Contributor Author

@parasharrajat the backend PR was already merged, but not yet deployed. I'll let you know once this is ready for review

@parasharrajat
Copy link
Member

Sure @luacmartins

@@ -132,7 +131,6 @@ function ReportListItem<TItem extends ListItem>({
canSelectMultiple={canSelectMultiple}
onCheckboxPress={() => onCheckboxPress?.(transactionItem as unknown as TItem)}
onSelectRow={onSelectRow}
onDismissError={onDismissError}
Copy link
Member

@parasharrajat parasharrajat Dec 19, 2024

Choose a reason for hiding this comment

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

Why are we removing this callback ? It seems that it is not used on search page selection list.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We don't actually need to display the error for any of these search list items, so the callback is also unnecessary

@luacmartins
Copy link
Contributor Author

@parasharrajat BE PR is deployed. You can resume review

@parasharrajat
Copy link
Member

Looking now...

@parasharrajat
Copy link
Member

@luacmartins Could you please merge main? I am facing login issues with every email. It was fixed in latest main.

@parasharrajat
Copy link
Member

This does not work for me. I still see review button.

21.12.2024_05.03.02_REC.mp4

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.

Bug

@parasharrajat
Copy link
Member

@luacmartins Any thoughts?

@luacmartins
Copy link
Contributor Author

Just came back from ooo today. I'm looking into this PR now.

@luacmartins
Copy link
Contributor Author

@parasharrajat are you getting another error in the API response on the 2nd attempt to pay?

@luacmartins
Copy link
Contributor Author

I tried to follow the steps in your video, but the Search result updates and shows only the remaining transaction and it updates correctly to paid after we attempt to pay again. Maybe the behavior was updated on main. Could you please test again?

Screen.Recording.2024-12-30.at.1.55.23.PM.mov

@parasharrajat
Copy link
Member

Checking it now...

@parasharrajat
Copy link
Member

@luacmartins I still see the same issue. After step 7, the status does not change to paid from review, when we pay the expense from RHP.

@luacmartins
Copy link
Contributor Author

hmm weird. I cannot reproduce that. Do you see any errors in the API responses?

@parasharrajat
Copy link
Member

My steps are a little different from what you are doing in this #54370 (comment) vid. I am not removing the internet cap until I have completed all the steps from your test section.

Also, you didn't pay the expense from RHP page in the vid, you clicked the pay button on Search page.

Can you please exactly try these steps?

  1. After you get the review button.
  2. Pay the expense from the RHP page.
  3. Then way for the expense to update on the Search page.
  4. Remove the internet cap.
  5. Check the status whether it changes to paid or not.

I don't get any errors as transaction is paid but the the status does not update to paid on search page until I refresh the page or navigate back to Outstanding tab.

@luacmartins
Copy link
Contributor Author

I was able to reproduce the issue. I pushed a fix for it. One thing that I find weird is that the label is updated to Paid and it still includes the deleted transaction, even though the RHP just shows a single transaction when opened. It seems like the Search page is not properly updating to remove the transactions, but I think that's unrelated to this PR 🤔

Screen.Recording.2024-12-31.at.8.54.13.AM.mov

@luacmartins
Copy link
Contributor Author

Looking into the TS error now

@luacmartins
Copy link
Contributor Author

Interesting. So report objects don't have errors, they only have errorFields. These types of action errors are actually stored in the reportActions. That being said, it's impractical for search to scan through the report actions to find errors to show and also return that data to App so it's updated in real time. I put up a solution to fix the current issue, but I'm not sure that's the best long term solution since we'll have the same issue with existing and any future actions introduced to reports. I'll have to go back to the drawing board on this one.

I think for now we can go with the current solution though.

@parasharrajat
Copy link
Member

parasharrajat commented Jan 1, 2025

Screenshots

🔲 iOS / native

02.01.2025_02.34.56_REC.mp4

🔲 iOS / Safari

🔲 MacOS / Desktop

02.01.2025_02.23.30_REC.mp4

🔲 MacOS / Chrome

02.01.2025_02.13.34_REC.mp4

🔲 Android / Chrome

02.01.2025_02.49.09_REC.mp4

🔲 Android / native

02.01.2025_02.43.55_REC.mp4

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 madmax330 January 1, 2025 21:21
Copy link

melvin-bot bot commented Jan 1, 2025

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

@madmax330 madmax330 merged commit 683a450 into main Jan 2, 2025
17 checks passed
@madmax330 madmax330 deleted the cmartins-fixReview branch January 2, 2025 11:09
@OSBotify
Copy link
Contributor

OSBotify commented Jan 2, 2025

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Copy link
Contributor

github-actions bot commented Jan 6, 2025

🚀 Deployed to staging by https://github.com/madmax330 in version: 9.0.81-0 🚀

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

@izarutskaya
Copy link

Copy link
Contributor

github-actions bot commented Jan 8, 2025

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.81-6 🚀

platform result
🤖 android 🤖 true ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 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.

5 participants