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 total and money request in offline #36657

Merged
merged 24 commits into from
Mar 28, 2024
Merged

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Feb 16, 2024

Details

Display total and money request in offline

Fixed Issues

$ #26424
PROPOSAL: #26424 (comment)

Tests

  1. Create some money requests in a chat
  2. Open the IOU report and send some messages
  3. Open another report and send a message
  4. Logout and login again with the same account
  5. Without opening any other report, go offline
  6. Open IOU report that we created above
  7. Verify that the total is displayed and at least one money request appears
  • Verify that no errors appear in the JS console

Offline tests

Precondition: Steps 1-3 in online
Steps 4-6

QA Steps

  1. Create some money requests in a chat
  2. Open the IOU report and send some messages
  3. Open another report and send a message
  4. Logout and login again with the same account
  5. Without opening any other report, go offline
  6. Open IOU report that we created above
  7. Verify that the total is displayed and at least one money request appears
  • 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(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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-02-21.at.17.50.44.mov
Android: mWeb Chrome
Screen.Recording.2024-02-16.at.11.38.45.mov
iOS: Native
Screen.Recording.2024-02-21.at.17.23.47.mp4
iOS: mWeb Safari
Screen.Recording.2024-02-16.at.11.33.02.mov
MacOS: Chrome / Safari
Screen.Recording.2024-02-16.at.11.31.33.mov
MacOS: Desktop
Screen.Recording.2024-02-16.at.11.47.30.mov

@dukenv0307 dukenv0307 marked this pull request as ready for review February 16, 2024 04:53
@dukenv0307 dukenv0307 requested a review from a team as a code owner February 16, 2024 04:53
@melvin-bot melvin-bot bot removed the request for review from a team February 16, 2024 04:53
Copy link

melvin-bot bot commented Feb 16, 2024

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

@mountiny
Copy link
Contributor

@abdulrahuman5196 Hello! What is your ETA for the checklist? thank you!

@abdulrahuman5196
Copy link
Contributor

Hi @mountiny , Working on it. Would be completing a day.

@abdulrahuman5196
Copy link
Contributor

Reviewing now

@@ -245,6 +248,50 @@ function ReportActionsView(props) {
}
}, [hasCachedActions]);

const reportActionsToDisplay = useMemo(() => {
Copy link
Contributor

Choose a reason for hiding this comment

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

@dukenv0307 Can we add clear comments here?
Like What are we doing here? and Why are we doing this? and link the decision GH comments as required.
Since this is not a straightforward approach and would be helpful for people seeing this at future

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated a comment.

@abdulrahuman5196
Copy link
Contributor

Did some initial testing. i was able to test the displaying of total. But unable to complete the skeleton loading part. Will update here once done.

@dukenv0307
Copy link
Contributor Author

@abdulrahuman5196

Did some initial testing. i was able to test the displaying of total. But unable to complete the skeleton loading part. Will update here once done.

Seems like BE always returns the money request action in OpenApp API.

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Feb 21, 2024

@abdulrahuman5196

Did some initial testing. i was able to test the displaying of total. But unable to complete the skeleton loading part. Will update here once done.

Seems like BE always returns the money request action in OpenApp API.

@dukenv0307 Could you provide more info on this?

And lint rule is failing.

@dukenv0307
Copy link
Contributor Author

@dukenv0307 Could you provide more info on this?

@abdulrahuman5196 That is my prediction.

@dukenv0307
Copy link
Contributor Author

Fixed lint.

@abdulrahuman5196
Copy link
Contributor

@dukenv0307
Got it. Yeah I think so the same. Will try to see if I can create 100s of requests and see.

Kindly add videos of iOS and Android native on the author's checklist?
And the skeleton case is not present in your videos as well, do record with that case as well.

@dukenv0307
Copy link
Contributor Author

@abdulrahuman5196

Kindly add videos of iOS and Android native on the author's checklist?

Updated the screenshot

And the skeleton case is not present in your videos as well, do record with that case as well.

I can't face this case because OpenApp API has already returned the money request action.

Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 left a comment

Choose a reason for hiding this comment

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

@dukenv0307 , could you kindly check on these comments?

props.report.total &&
_.filter(
props.reportActions,
(action) => action.actionName === CONST.REPORT.ACTIONS.TYPE.IOU && action.originalMessage && action.originalMessage.type === CONST.IOU.REPORT_ACTION_TYPE.CREATE,
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are we checking if create action is present or not to display the skeleton view?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As I understand in the discussion, we will add a money request action if there is no money request action in the action report. Have I misunderstood? Is it true that we will add 1 more request action if the current number of actions is not equal to the total number of requests?

Copy link
Contributor

Choose a reason for hiding this comment

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

Is it true that we will add 1 more request action if the current number of actions is not equal to the total number of requests?

Yes. Exactly. We are checking if there is report action with CONST.IOU.REPORT_ACTION_TYPE.CREATE type right? Or kindly correct me if I misunderstood the logic of the code.

Copy link
Contributor Author

@dukenv0307 dukenv0307 Feb 22, 2024

Choose a reason for hiding this comment

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

We are checking if there is report action with CONST.IOU.REPORT_ACTION_TYPE.CREATE type right

            (action) => action.actionName === CONST.REPORT.ACTIONS.TYPE.IOU && action.originalMessage && action.originalMessage.type === CONST.IOU.REPORT_ACTION_TYPE.CREATE,

We are checking the report action is an created iou report action

const actions = [...props.reportActions];

if (!ReportActionsUtils.isCreatedAction(_.last(props.reportActions))) {
const optimisticCreatedAction = ReportUtils.buildOptimisticCreatedReportAction(
Copy link
Contributor

Choose a reason for hiding this comment

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

The total is displayed in less opacity even when we don't have any requests added during offline execution. Could you kindly fix it?

Screenshot 2024-02-21 at 4 10 36 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@abdulrahuman5196 I updated to fix this case.

(action) => action.actionName === CONST.REPORT.ACTIONS.TYPE.IOU && action.originalMessage && action.originalMessage.type === CONST.IOU.REPORT_ACTION_TYPE.CREATE,
).length === 0
) {
const optimisticIOUAction = ReportUtils.buildOptimisticIOUReportAction(
Copy link
Contributor

Choose a reason for hiding this comment

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

I tried to test this case locally by removing the if checks, the skeleton comes. But it is not animating like other skeletons do.

Screen.Recording.2024-02-21.at.4.25.47.PM.mov

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@abdulrahuman5196 The reason is MoneyRequestSkeletonView has backgroundColor and foregroundColor are the same, no animation appears.

backgroundColor={theme.borderLighter}
foregroundColor={theme.border}

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 tried to use the same color as we do for another skeleton in the App and here is the result, do we agree with this color cc @mountiny

backgroundColor={theme.skeletonLHNIn}
foregroundColor={theme.skeletonLHNOut}
Screen.Recording.2024-02-22.at.10.37.59.mov

Copy link
Contributor

Choose a reason for hiding this comment

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

@dukenv0307

The reason is MoneyRequestSkeletonView has backgroundColor and foregroundColor are the same, no animation appears.

Is it even previously we didn't have animation where the money request skeleton was display? 🤔
I think I remember seeing animation, not sure though

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Checked and it's also happening on main. Maybe it happens after we migrate theme.

@@ -245,6 +248,55 @@ function ReportActionsView(props) {
}
}, [hasCachedActions]);

// When we offline before opening a money request report,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// When we offline before opening a money request report,
// When we are offline before opening a money request report,

@abdulrahuman5196
Copy link
Contributor

@mountiny , We are trying to test the case where all the report actions of a money report is not loaded and we show a single skeleton report action view as per here #26424 (comment). But I had created 51 money requests but still, all of the report actions are loaded before I go to the view itself.

Do we have a limit on number of report actions of money requests returned from OpenApp API on backend? Or it always returns all the report actions?

Screen.Recording.2024-02-21.at.4.33.51.PM.mov

@mountiny
Copy link
Contributor

@abdulrahuman5196 Can you confirm with the OpenApp response that the reportActions collection is returned?

I think that what you are seeing might be the case because of all the IOU report actions being parent report actions for the transaction threads and we do return all of those on OpenApp. So if that is what you are seeing it might be the case

We do not return them for IOU reports though so you could make IOU p2p requests and test there

@dukenv0307
Copy link
Contributor Author

We do not return them for IOU reports though so you could make IOU p2p requests and test there

@abdulrahuman5196 We can test skeleton case for p2p request, I tried.

@abdulrahuman5196
Copy link
Contributor

I think I have already looked into the code. I will work on platform videos in my morning.

@abdulrahuman5196
Copy link
Contributor

Sorry for the delay working on review videos now.

@abdulrahuman5196
Copy link
Contributor

checking again since we made a merge from live

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Mar 23, 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 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-03-23.at.11.20.07.PM.mp4
Android: mWeb Chrome
Screen.Recording.2024-03-23.at.11.25.43.PM.mp4
iOS: Native
Screen.Recording.2024-03-23.at.11.12.51.PM.mp4
iOS: mWeb Safari
Screen.Recording.2024-03-23.at.11.17.41.PM.mp4
MacOS: Chrome / Safari
1.1.mp4
2.1.mp4
MacOS: Desktop
Screen.Recording.2024-03-23.at.10.19.14.PM.mp4

Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 left a comment

Choose a reason for hiding this comment

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

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @mountiny

🎀 👀 🎀
C+ Reviewed

@dukenv0307
Copy link
Contributor Author

@mountiny Please review the PR when you have a chance, thanks.

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.

@abdulrahuman5196 @dukenv0307 in the videos here
image
shouldnt there be a skeleton? It is on web/desktop

src/pages/home/report/ReportActionsView.tsx Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionsView.tsx Outdated Show resolved Hide resolved
dukenv0307 and others added 3 commits March 28, 2024 16:40
Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>
Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>
@dukenv0307
Copy link
Contributor Author

@mountiny Maybe @abdulrahuman5196 uploaded the old video by mistake when I hadn't added the case optimistic transacion yet.

I tested again and it works well.
https://github.com/Expensify/App/assets/129500732/a53e8b6a-cd48-4294-bdde-33b264b4cd5d

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.

Alright, thanks for the update, lets get this merged now

@mountiny mountiny merged commit 6143bd3 into Expensify:main Mar 28, 2024
15 checks passed
@OSBotify
Copy link
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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.58-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Apr 2, 2024

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.58-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