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

lastvisibleactioncreated fix for task, iou, expense reports #30903

Merged
merged 8 commits into from
Dec 4, 2023

Conversation

rojiphil
Copy link
Contributor

@rojiphil rojiphil commented Nov 6, 2023

@parasharrajat @johnmlee101

Details

This PR makes the following changes:

  1. Set optimistic value for lastVisibleActionCreated in Task Report i.e. buildOptimisticTaskReport
  2. Set optimistic value for lastVisibleActionCreated in IOU Report i.e. buildOptimisticIOUReport
  3. Set optimistic value for lastVisibleActionCreated in Expense Report i.e. buildOptimisticExpenseReport

Fixed Issues

$ #30472
PROPOSAL: #30472 (comment)

Tests

This is an offline test scenario.

Note: Non-archived reports are always displayed below the Pinned/GBR/Draft reports in LHN. Further, archived reports are shown below the non-archived reports.

Test 1: For Task Report

  1. Go Offline
  2. In any chat report, create a task using FAB -> Assign Task
    Expected Result: Verify that the LHN shows the created task towards the top of non-archived reports in LHN rather than at the bottom.

Test 2: For IOU Report

  1. Go Offline
  2. Click Global FAB ->Request Money
  3. Click on Manual tab, enter amount and click Next
  4. Select a new participant with whom there was no chat history before and generate money request
    Expected Result: Verify that the LHN shows the IOU report with the new participant towards the top of non-archived reports in LHN rather than at the bottom.

Test 3: For Expense Report
Note: This test is ONLY applicable to large screen devices. So, smaller screen devices running native and mweb versions are not applicable.

  1. Go Offline
  2. Go to a workspace report (Precondition: The workspace report should not have any open money request. If it is there, settle it)
  3. Click FAB -> Request Money -> Manual tab -> enter amount -> Next -> Generate Money Request
  4. Click on the Report Preview in Chat Report to launch the Expense Report.
    Expected Result: Verify that the LHN shows the newly created Expense report towards the top of non-archived reports in LHN rather than at the bottom.
  • Verify that no errors appear in the JS console

Offline tests

Same as the Steps for Tests Section.

QA Steps

Same as the Steps for Tests Section.

  • 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 / Chrome
    • iOS / native
    • iOS / 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
      • 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(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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
30472-web-safari-1.mp4
Desktop
30472-desktop-1.mp4
iOS
30472-ios-native-1.mp4
Android
30472-android-native-2.mp4
Mobile Web - Chrome
30472-mweb-chrome-1.mp4
Mobile Web - Safari
30472-mweb-safari-1.mp4

@rojiphil
Copy link
Contributor Author

rojiphil commented Nov 6, 2023

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)

A console error occurs during Test 3: For Expense Report.
The error occurs in native and web versions.
The attached screens display the error details:
Screenshot 2023-11-06 at 3 33 22 PM
Screenshot 2023-11-06 at 1 39 31 PM

@rojiphil rojiphil marked this pull request as ready for review November 6, 2023 10:14
@rojiphil rojiphil requested a review from a team as a code owner November 6, 2023 10:14
@melvin-bot melvin-bot bot requested review from parasharrajat and removed request for a team November 6, 2023 10:14
Copy link

melvin-bot bot commented Nov 6, 2023

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

@rojiphil
Copy link
Contributor Author

rojiphil commented Nov 6, 2023

@parasharrajat
PR Author checklist done. Works well too.
Over to you for review

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.

Please update unit tests for Sidebar.

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.

  1. Please add QA steps.
  2. Verify that the LHN shows the created task towards the top of LHN rather than at the bottom.

This is good but we should also mention in QA steps that other higher order will remain above this new item. Such as pinned items, unread reports, etc.

@rojiphil
Copy link
Contributor Author

rojiphil commented Nov 8, 2023

  1. Please add QA steps.
  2. Verify that the LHN shows the created task towards the top of LHN rather than at the bottom.

This is good but we should also mention in QA steps that other higher order will remain above this new item. Such as pinned items, unread reports, etc.

I have mentioned this as a note in the Tests section. Also, I added a comment for QA steps.

@rojiphil
Copy link
Contributor Author

rojiphil commented Nov 8, 2023

Please update unit tests for Sidebar.

@parasharrajat
Sorry for missing this. The unit tests are updated for Sidebar.
Works well too.
Kindly review

@rojiphil
Copy link
Contributor Author

@parasharrajat
Gentle bump for review here

@rojiphil
Copy link
Contributor Author

@parasharrajat
Can you prioritize the review here, please?

@parasharrajat
Copy link
Member

It will reviewed in 2 hours.

@parasharrajat
Copy link
Member

Started reviewing.

@parasharrajat
Copy link
Member

@rojiphil Can you please merge main?

@rojiphil
Copy link
Contributor Author

@parasharrajat

The branch is, now, merged with the latest main. It works great with an additional observation here.

The observation is that the latest main does not show the Expense Report in LHN by default. We need to click on the Report Preview to invoke it explicitly. I'm not sure if this is intentional or is caused by some regression.
I have added Step 4 to Test 3 Steps for testing the Expense Report to accommodate this change.

Over to you for review.

30472-web-chrome.mp4

@parasharrajat
Copy link
Member

Sorry for the delay. I am stuck with a build error on Android.

@rojiphil
Copy link
Contributor Author

I am stuck with a build error on Android.

@parasharrajat
I just tried it on my development environment for Android build. It worked well.
Looks like something specific in your development environment is causing this.
Is there any way I can help here?

30472-android-native-1.mp4

@rojiphil
Copy link
Contributor Author

Maybe you could share a screenshot of the Android build error and we can take it up from there

@parasharrajat
Copy link
Member

Sure. I face this issue from time to time. Building React-Native from the source throws an error. https://expensify.slack.com/archives/C01GTK53T8Q/p1695826372213339

@rojiphil
Copy link
Contributor Author

Sure. I face this issue from time to time. Building React-Native from the source throws an error. https://expensify.slack.com/archives/C01GTK53T8Q/p1695826372213339

I saw the slack communication but I could not open the full build log from here. So, don’t know what is the latest error there.
Anyway, clearing metro cache didn’t work for you as mentioned in slack?
When I get a build problem, I usually run npm run clean and reboot the system. That solves my problem.

@parasharrajat
Copy link
Member

Screenshots

🔲 iOS / native

Screen.Recording.2023-11-18.at.2.14.01.AM.mov

🔲 iOS / Safari

Screen.Recording.2023-11-18.at.2.01.04.AM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-11-18.at.2.04.04.AM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-11-18.at.1.55.44.AM.mov

🔲 Android / Chrome

Screen.Recording.2023-11-18.at.2.21.10.AM.mov

🔲 Android / native

Screen.Recording.2023-11-21.at.2.10.50.AM.mov

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 / Chrome
    • iOS / native
    • iOS / 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(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 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

@rojiphil
Copy link
Contributor Author

@johnmlee101
Gentle bump on review here

@johnmlee101
Copy link
Contributor

Apologies for the delay, was OOO. Would you mind merging main and pinging me right after? I'll try to get to this ASAP

…iphil/App into 30472-lhn-offline-sort-order

force pushed the branch as reportUtils.js has been migrated to ts
@johnmlee101
Copy link
Contributor

Why was this force pushed?

@johnmlee101 johnmlee101 reopened this Nov 27, 2023
@rojiphil
Copy link
Contributor Author

Why was this force pushed?

I had to force push this because it didn't allow me to merge changes in reportUtils here due to migration to typescript. Sorry if there was any other way to do it as I am unaware of it.

@rojiphil
Copy link
Contributor Author

@johnmlee101
Also, there is typecheck failure. Will fix this and ping you.

@rojiphil
Copy link
Contributor Author

rojiphil commented Nov 27, 2023

@johnmlee101
I have fixed the typecheck failures after merging with the latest main.
Also, this works well across all the platforms. I have also attached the latest test videos in the PR Author checklist.
Over to you for review.

@johnmlee101
Copy link
Contributor

@parasharrajat would you mind re-reviewing since it was force-pushed, just to be sure what you approved is the same. No need to re-test

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.

LGTM

@rojiphil
Copy link
Contributor Author

rojiphil commented Dec 4, 2023

@johnmlee101
Gentle bump for review here

@johnmlee101 johnmlee101 merged commit b94458c into Expensify:main Dec 4, 2023
18 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Dec 4, 2023

✋ 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 Dec 5, 2023

🚀 Cherry-picked to staging by https://github.com/yuwenmemon in version: 1.4.7-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

OSBotify commented Dec 5, 2023

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

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

@OSBotify
Copy link
Contributor

OSBotify commented Dec 6, 2023

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Dec 6, 2023

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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