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 Reddot pinned chat appears for approver after failed scanned #39970

Merged
merged 20 commits into from
Jun 3, 2024

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Apr 9, 2024

Details

Fixed Issues

$ #37044
PROPOSAL: #37044 (comment)

Tests

Test case 1 (to make sure RBR on the LHN is only shown for the user that made the request):

  1. Create a collect policy in OD as account A
  2. Invite user B as employee
  3. Log in as user B in NewDot
  4. Create a expense report with a invalid receipt to fail the scanning
  5. Log in to user A in NewDot
  6. No RBR pinned chat appear in the LHN for the error message
  7. Log in to user B in NewDot
  8. Verify there is RBR pinned chat appearing in the LHN for the error message

Test case 2 (to make sure the RBRs on the report preview, money request preview, and the ones in the money request view are shown to every user that has access to them):

  1. Create a collect policy in OD as account A
  2. Invite user B as employee
  3. Log in as user B in NewDot
  4. Create a expense report with a invalid receipt to fail the scanning
  5. Log in to user A in NewDot
  6. Verify the RBRs on the report preview, money request preview, and the ones in the money request view are shown
  7. Log in to user B in NewDot
  8. Verify the RBRs on the report preview, money request preview, and the ones in the money request view are shown
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Test case 1 (to make sure RBR on the LHN is only shown for the user that made the request):

  1. Create a collect policy in OD as account A
  2. Invite user B as employee
  3. Log in as user B in NewDot
  4. Create a expense report with a invalid receipt to fail the scanning
  5. Log in to user A in NewDot
  6. No RBR pinned chat appear in the LHN for the error message
  7. Log in to user B in NewDot
  8. Verify there is RBR pinned chat appearing in the LHN for the error message

Test case 2 (to make sure the RBRs on the report preview, money request preview, and the ones in the money request view are shown to every user that has access to them):

  1. Create a collect policy in OD as account A
  2. Invite user B as employee
  3. Log in as user B in NewDot
  4. Create a expense report with a invalid receipt to fail the scanning
  5. Log in to user A in NewDot
  6. Verify the RBRs on the report preview, money request preview, and the ones in the money request view are shown
  7. Log in to user B in NewDot
  8. Verify the RBRs on the report preview, money request preview, and the ones in the money request view are shown
  • 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
Screen.Recording.2024-04-10.at.04.24.13.mov
Android: mWeb Chrome
Screen.Recording.2024-04-10.at.04.26.47.mov
iOS: Native
Screen.Recording.2024-04-10.at.04.23.43.mov
iOS: mWeb Safari
Screen.Recording.2024-04-10.at.04.21.01.mov
MacOS: Chrome / Safari
Screen.Recording.2024-04-10.at.04.12.16.mov
MacOS: Desktop
Screen.Recording.2024-04-10.at.04.17.21.mov

@dukenv0307 dukenv0307 marked this pull request as ready for review April 9, 2024 21:27
@dukenv0307 dukenv0307 requested a review from a team as a code owner April 9, 2024 21:27
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team April 9, 2024 21:27
Copy link

melvin-bot bot commented Apr 9, 2024

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

@dukenv0307
Copy link
Contributor Author

@eVoloshchak Please help review PR once you have a chance

@dukenv0307
Copy link
Contributor Author

@eVoloshchak In case you miss it

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
dukenv0307 and others added 5 commits April 17, 2024 02:13
Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>
Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>
@dukenv0307
Copy link
Contributor Author

@eVoloshchak Any updates here?

@dukenv0307
Copy link
Contributor Author

@eVoloshchak I resolved your comment. Pls help review the PR

@dukenv0307
Copy link
Contributor Author

@eVoloshchak Any update here?

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Apr 30, 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 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 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.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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
24-05-06-15-31-55.mp4
Android: mWeb Chrome
Screen.Recording.2024-05-06.at.15.22.25.mov
iOS: Native
Screen.Recording.2024-05-06.at.15.14.34.mov
iOS: mWeb Safari
Screen.Recording.2024-05-06.at.15.17.10.mov
MacOS: Chrome / Safari
Screen.Recording.2024-05-06.at.15.11.55.mov
MacOS: Desktop
Screen.Recording.2024-05-06.at.15.17.50.mov

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
@eVoloshchak
Copy link
Contributor

@dukenv0307, looking good!
Could you also expand the testing steps a bit, please?
Overexplain so the QA team could test this properly, also there should be 2 test cases included (i.e. make sure RBR on the LHN is only shown for the user that made the request, while the RBRs on the report preview, money request preview, and the ones in the money request view are shown to every user that has access to them.

@dukenv0307
Copy link
Contributor Author

@eVoloshchak I updated the test steps

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

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 cead22 May 6, 2024 13:35
@cead22
Copy link
Contributor

cead22 commented May 6, 2024

@dukenv0307 do we need to do anything with the warning in your native android video?

Copy link
Contributor

@cead22 cead22 left a comment

Choose a reason for hiding this comment

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

This is probably a long shot, but are there automated tests we could add for this?

* NOTE: On LHN preview we show RBR only to the user that made the request.
* https://github.com/Expensify/App/issues/37044#issuecomment-1984922236
*/
function hasMissingSmartscanFields(iouReportID: string, isLHNPreview?: boolean): 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 isn't where we landed

I agree with this, we shouldn't change hasMissingSmartscanFields, instead we could create shouldShowRBRForMissingSmartscanFields method, which would in turn call hasMissingSmartscanFields conditionally

Let's change this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I created shouldShowRBRForMissingSmartscanFields method

@eVoloshchak
Copy link
Contributor

@dukenv0307, friendly bump on comments above

@dukenv0307
Copy link
Contributor Author

@eVoloshchak @cead22 Do you have any feedback about my comment here?

const isReportPreviewError = ReportActionsUtils.isReportPreviewAction(action) && hasMissingSmartscanFields(IOUReportID) && !isSettled(IOUReportID);
const isReportPreviewError =
ReportActionsUtils.isReportPreviewAction(action) &&
(isLHNPreview ? shouldShowRBRForMissingSmartscanFields(IOUReportID) : hasMissingSmartscanFields(IOUReportID)) &&
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a bit hard to read, let's move this into a separate variable, something like

const hasMissingFields = isLHNPreview ? shouldShowRBRForMissingSmartscanFields(IOUReportID) : hasMissingSmartscanFields(IOUReportID);
const isReportPreviewError = ReportActionsUtils.isReportPreviewAction(action) && hasMissingFields && !isSettled(IOUReportID);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@eVoloshchak I updated and merged main as well.

@melvin-bot melvin-bot bot requested a review from cead22 May 21, 2024 13:44
Copy link
Contributor

@cead22 cead22 left a comment

Choose a reason for hiding this comment

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

  • How come we didn't implement isRequestor like in the proposal?
  • Can you update both test cases to sign in as User B and confirm things look right for that user?

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
reportActionErrors.smartscan = ErrorUtils.getMicroSecondOnyxError('report.genericSmartscanFailureMessage');
}
} else if (ReportUtils.hasSmartscanError(Object.values(reportActions ?? {}))) {
} else if (ReportUtils.hasSmartscanError(Object.values(reportActions ?? {}), true)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we calling ReportUtils.hasSmartscanError from anywhere else? Do we need the second param?

Even if we need it, I don't think it should be a separate param, and instead we should have that check outside of the ReportUtils.hasSmartscanError function, since that function name sounds like it shouldn't care about isLHNPreview

Copy link
Contributor Author

@dukenv0307 dukenv0307 May 27, 2024

Choose a reason for hiding this comment

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

Are we calling ReportUtils.hasSmartscanError from anywhere else?

No

Do we need the second param?

I think we still need to create a isLHNPreview param then handle both case (isLHNPreview is true or false) in hasSmartscanError to reduce the duplicate logics.

As you can see, if we do like this, we just need to create a new variable, hasMissingField and apply a minor change to isReportPreviewError, the rest logic does not change.
image

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we still need to create a isLHNPreview param then handle both case (isLHNPreview is true or false) in hasSmartscanError to reduce the duplicate logics.

I think I'm not following or I'm missing something, because if we always pass this as true, this doesn't make sense

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That makes sense. I removed isLHNPreview in commit

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
@dukenv0307
Copy link
Contributor Author

I am working on it

/**
* Check if the current user is the requestor of the action
*/
function isRequestor(reportAction: 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.

Sorry I kinda missed this in the proposal and original review, but I was thinking about reports when thinking about isRequestor, but for report actions, this name isn't great.

How about we call this something like ReportActionUtils.actionWasTakenByCurrentUser(reportAction)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I renamed it in commit

Copy link
Contributor

Choose a reason for hiding this comment

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

Cool, let me know when this is ready for re-review. Thanks

@cead22 cead22 merged commit 908d29c into Expensify:main Jun 3, 2024
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jun 3, 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 Jun 6, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.79-11 🚀

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