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 - 1:1 Submit expense - The receiving end of the IOU should not be asked to fill out information if the scan failed #53947

Closed

Conversation

FitseTLT
Copy link
Contributor

@FitseTLT FitseTLT commented Dec 11, 2024

Details

Fixed Issues

$ #51574
PROPOSAL: #51574 (comment)

Tests

  1. Start the Submit expense flow in a 1:1 conversation with a user you have access to

  2. Select the scan option

  3. Upload a picture that will fail the scan process

  4. Wait for the scan to fail

  5. Log in as the other account

  6. Navigate to the IOU that failed the scan

  7. Verify the receiver is not asked to fill out the missing information no RBR is shown

  8. On a workspace set tag as required field and allow approval workflow as the admin as the approver

  9. From an employee side of the workspace create an expense without setting tag field

  10. From an employee side verify that RBR is shown and tag required violation text is shown but no RBR shown from the admin side (b/c the admin cannot edit the request)

  11. Now from the admin side approve the expense

  12. Verify that now the employee (now can't edit the expense) will not see the RBR and violation but the admin can see the RBR

  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above

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

Screenshots/Videos

Android: Native image
Android: mWeb Chrome aw
iOS: Native i
iOS: mWeb Safari iw
MacOS: Chrome / Safari w
MacOS: Desktop d

@FitseTLT FitseTLT requested a review from a team as a code owner December 11, 2024 15:07
@melvin-bot melvin-bot bot requested review from getusha and removed request for a team December 11, 2024 15:07
Copy link

melvin-bot bot commented Dec 11, 2024

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

@FitseTLT
Copy link
Contributor Author

Bump for a review @getusha

@getusha
Copy link
Contributor

getusha commented Dec 17, 2024

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

Screenshot 2024-12-18 at 6 45 04 in the evening

Screen.Recording.2024-12-18.at.6.44.12.in.the.evening.mov
Android: mWeb Chrome
Screen.Recording.2024-12-18.at.6.32.53.in.the.evening.mov
iOS: Native

Screenshot 2024-12-18 at 6 49 22 in the evening

iOS: mWeb Safari

Screenshot 2024-12-18 at 6 34 43 in the evening

MacOS: Chrome / Safari

Screenshot 2024-12-18 at 6 29 37 in the evening

MacOS: Desktop

Screenshot 2024-12-18 at 6 54 21 in the evening

@getusha
Copy link
Contributor

getusha commented Dec 17, 2024

@FitseTLT noticed a RBR on the report preview. it disappears when you click on it.

1217.mov

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Dec 17, 2024

Yeah @getusha this because the report data will not be available in onyx to determine whether the current user can edit it or not but when you open it the data will be loaded. mountiny agreed to live with this edge case inconsistency here 👍

@getusha
Copy link
Contributor

getusha commented Dec 18, 2024

@FitseTLT could you please add a unit test? thanks

@FitseTLT
Copy link
Contributor Author

@FitseTLT could you please add a unit test? thanks

Added

@melvin-bot melvin-bot bot requested a review from mountiny December 24, 2024 12:42
@getusha
Copy link
Contributor

getusha commented Dec 24, 2024

@FitseTLT we've got conflicts

@mountiny
Copy link
Contributor

@FitseTLT can you please fix the conflicts? Thanks!

@FitseTLT FitseTLT closed this Dec 31, 2024
@FitseTLT FitseTLT deleted the fix-showing-RBR-if-user-cannot-edit branch December 31, 2024 12:40
@FitseTLT FitseTLT restored the fix-showing-RBR-if-user-cannot-edit branch December 31, 2024 12:40
@FitseTLT
Copy link
Contributor Author

FitseTLT commented Dec 31, 2024

@VickyStash I am confused with the lint errors I am having
Sorry tagged you by mistake 🙏

@FitseTLT FitseTLT reopened this Dec 31, 2024
@FitseTLT
Copy link
Contributor Author

Apart from the lint and ts errors coming from main I have fixed all the current pr errors. @getusha

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Jan 6, 2025

@VickyStash @mountiny @getusha I am having confusing unrelated lint/ts errors on files that I haven't changed. Do you have any idea?
For instance, look at the one linked to this line

const onSuccessFallbackRoute = personalBankAccount?.onSuccessFallbackRoute ?? '';

@VickyStash
Copy link
Contributor

@VickyStash @mountiny @getusha I am having confusing unrelated lint/ts errors on files that I haven't changed. Do you have any idea?

As I see not the Changed files ESLint check failed for you, but the usual ESLint check/TypeScript Checks. These checks are expected to fail even in the files you didn't change in case of broken typing.

In this case it looks dut to updates in ROUTES.ts file the Route type became too complex union and TS can't process it.

cc @fabioh8010

@fabioh8010
Copy link
Contributor

@VickyStash @mountiny @FitseTLT This is a problem we faced in the past with the Route type, and I previously fixed by simplifying the typings we do in ROUTES.ts here. Given that the app increased its routes since last PR, I created another one to apply the optimisations here.

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Jan 7, 2025

@VickyStash @mountiny @FitseTLT This is a problem we faced in the past with the Route type, and I previously fixed by simplifying the typings we do in ROUTES.ts here. Given that the app increased its routes since last PR, I created another one to apply the optimisations here.

Thx so I think the next step would be to wait for the PR to be merged @fabioh8010, right?

@mountiny
Copy link
Contributor

mountiny commented Jan 7, 2025

👍

@mountiny
Copy link
Contributor

@FitseTLT The PR was merged, can you please sync with main?

@FitseTLT
Copy link
Contributor Author

Conflict resolved @mountiny The only doubt I want you to confirm is whether it is correct to apply the pattern we applied here of hiding violations for the non-editable side for all violations like warning and notice type violations.

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

I am really worried about this many changes 😅 also this might have performance impact if we deciding if to show the RBR in LHN using the new canEditTransaction method

tests/unit/TransactionUtilsTest.ts Show resolved Hide resolved
* because there is no point of showing RBR for the user who cannot edit the request.
*/
function shouldShowMissingSmartscanFieldsError(transaction: OnyxInputOrEntry<Transaction>, parentReportAction?: OnyxEntry<ReportAction>): boolean {
if (!canEditTransaction(transaction?.transactionID ?? '-1', parentReportAction)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

should there be default here with the new rules?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you mean ?

* true because we use this function to show RBR only for the user side who can edit the transaction
* but if we can't determine they cannot edit it, we opted to show the RBR instead of hiding it.
*/
function canEditTransaction(transactionID: string | undefined, parentReportAction: OnyxEntry<ReportAction>): boolean {
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems like very heavy function. How often will it be called?

Copy link
Contributor Author

@FitseTLT FitseTLT Jan 14, 2025

Choose a reason for hiding this comment

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

For every transaction on which we are checking the existence of violation

Copy link
Contributor

@adhorodyski adhorodyski Jan 21, 2025

Choose a reason for hiding this comment

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

@mountiny really good catch. From what I can see here this can really become a bottleneck for cases like David's. Here's what I'd do:

  • wait for these changes to get merged (we can't really open up big accounts without this in a diff),
  • checkout to this PR and load David's Onyx state (attached in the Slack thread) locally (before & after), profile regular workflows and submitting expenses to get a Hermes trace,
  • assess the impact then and decide on the next steps

src/libs/actions/ReportActions.ts Show resolved Hide resolved
@mountiny
Copy link
Contributor

@FitseTLT Sorry, this change is really substantial so I am discussing with Tom the exact expecte behaviour now that we know the changes you have implemented so far.

I am still worried about the performance - consider that this additional method is called whenever the LHN is rerendered / computed and that happens often. For accounts that have hundreds if not thousands of transactions locally this could have material impact

@mountiny
Copy link
Contributor

@FitseTLT sorry for the confusion here, but I think we are going to have to move in a bit different direction here.

  1. the IOUs are not a priority now
  2. This solution is super complex and would almost certainly lead to performance degradation, it does not seem like there is an easy way to achieve this without noticeable performance slowdown

Because of that, let's take a step back and simply take the similar solution you originally proposed, let's update the copy of the error for the person who cannot edit it to say something like: The amount was not set yet

@FitseTLT
Copy link
Contributor Author

Ok great @mountiny I had hated the inconsistency in the first place. I will close this PR and open a new one 👍

@FitseTLT FitseTLT closed this Jan 31, 2025
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.

6 participants