Open reports at first unread action #51366

janicduplessis · 2024-10-23T21:40:34Z

Details

Implements opening reports at the last unread message. This builds on top of #52149 to be able to start our list at any item. This removes a few assumptions that open report will always open at the newest action.

Fixed Issues

$ #35011
PROPOSAL:

Tests

Verify that no errors appear in the JS console
Test the scenarios described in the QA steps

Offline tests

QA Steps

Verify that no errors appear in the JS console
Using 2 accounts in the same chat test the following scenarios:

With account A send 30+ messages, with account B open the chat. It should open at the last unread message and load more messages once scrolled at the bottom.
With account A send 20 new messages, with account B open the chat. It should open at the last unread message and all messages should be loaded already.
With account A send 1 new message, with account B open the chat. It should open at the last unread message and all messages should be loaded already.

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2025-01-27.at.23.42.32.mov

Android: mWeb Chrome

Screen.Recording.2025-01-27.at.23.37.31.mov

iOS: Native

Screen.Recording.2025-01-27.at.22.56.37.mov

iOS: mWeb Safari

Screen.Recording.2025-01-27.at.23.02.45.mov

MacOS: Chrome / Safari

Screen.Recording.2025-01-27.at.22.33.19.mov

MacOS: Desktop

Screen.Recording.2025-01-27.at.23.32.32.mov

janicduplessis · 2025-01-28T16:30:07Z

I have a UX question here, where do we want the scroll of the list to open at? Currently it opens the chat where the new message is aligned at the bottom so like this:

But it could also be aligned at the top so we see more new messages instead of old ones, like this:

rlinoz · 2025-01-28T17:36:32Z

Oh I guess I am not sure how to assign someone from the @Expensify/design team to the PR, but I think they can help with your question #51366 (comment)

shawnborton · 2025-01-28T17:48:20Z

But it could also be aligned at the top so we see more new messages instead of old ones, like this:

I personally like this, but I think I would prefer to let an older message slightly peak out from above so there is a little more context that you are starting from a certain point. So basically what you have but maybe push down the starting point by like 56px or 64px or something like that.

dannymcclain · 2025-01-28T17:54:15Z

Yeah I like that too Shawn!

dubielzyk-expensify · 2025-01-28T23:54:55Z

+1 to that. Always like it when we peek content to show that there's more there

ikevin127 · 2025-02-02T10:06:30Z

@janicduplessis First of all, props for picking up this veteran difficulty level issue, doing such great work on it so far and getting it so close to completion 🚀

👋 Please tag me before merging this in case I don't get notified because I'd like to run some tests myself to make sure this works as expected, I have 2 scenarios in mind:

opening a report for the first time on fresh login, with 300-500 unread new messages
opening a report for the first time on fresh login where the last read message was deleted in the meantime

Note: I'm one of the contributors which attempted to fix this from FE only but ultimately figured out it won't work and suggested a BE + FE implementation discussion months ago before Rory went on parental leave.

How did I get here ? Another C+ reviewer asked just yesterday about an issue on Slack, which will basically be fixed by this PR - that's how I remembered this 1 year old issue and decided to join the testing effort as well since I have some context on this.

Note: No compensation needed, just want to help 👍

melvin-bot · 2025-02-22T19:44:53Z

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

janicduplessis · 2025-02-22T19:47:55Z

This is ready for review and further testing. Sadly adjusting the scroll position so the newest message is near the top ended up very difficult with the way we handle opening the list in the middle of a chat. I think we should punt that for later since this is already taking longer than I would have liked.

ishpaul777 · 2025-02-25T19:44:20Z

src/pages/home/report/ReportActionsList.tsx

+                // This scrolls the unread action at the top of the screen.
+                viewPosition: 1,
+                // This makes sure that the unread indicator doesn't get cut off.
+                viewOffset: -64,


Sadly adjusting the scroll position so the newest message is near the top ended up very difficult with the way we handle opening the list in the middle of a chat.

how is this relevant if the last unread message is show at the bottom not the top?

From Flatlist's scrollToIndex() docs:

Scrolls to the item at the specified index such that it is positioned in the viewable area such that viewPosition 0 places it at the top, 1 at the bottom, and 0.5 centered in the middle.

This is actually not needed anymore.

ishpaul777 · 2025-02-25T19:58:32Z

Did the first pass of testing on the web desktop, and it work really well no issues spotted so far, Great Work @janicduplessis 🥇

Screen.Recording.2025-02-26.at.12.54.52.AM-1.mov

I'll test more and update back soon... @janicduplessis we have some conflicts can you please resolve them

ikevin127

♻️ Reporting on my previous comment:

✅ opening a report for the first time on fresh login, with 300-500 unread new messages: works well, tested both with fresh login and Clear cache and reset
✅ opening a report for the first time on fresh login where the last read message was deleted in the meantime: works well, looks like the current behaviour is that when the last read message is deleted, the one underneath (right below) will become the last read 👍

🗒️ Notes:

I only tested on web-based platforms (Web / mWeb / Desktop)
I did not fully test the manual Mark as unread functionality but from the test mentioned above it seems to work as expected 👍

rlinoz · 2025-02-28T12:27:24Z

Friendly bump @janicduplessis to resolve conflicts so @ishpaul777 can continue his review 😄

janicduplessis · 2025-02-28T16:06:15Z

Conflicts fixed!

ishpaul777 · 2025-03-04T17:11:04Z

On my list today!

ishpaul777 · 2025-03-04T20:45:59Z

tested more on web, in most cases it works well but on very large chat while marking the first message as unread and going back to it does not scroll to unread message room link

Screen.Recording.2025-03-05.at.1.59.20.AM.mov

Mobile apps testing in progress

Bug?
Opening a unread chat offline shows white screen with no messages (make sure you have no data in onyx for chat)

ishpaul777 · 2025-03-04T22:14:18Z

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
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

Screen.Recording.2025-03-05.at.3.25.20.AM.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2025-03-05.at.3.28.47.AM.mov

iOS: mWeb Safari

Screen.Recording.2025-03-05.at.3.39.09.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2025-03-05.at.2.15.30.AM.mov

MacOS: Desktop

rlinoz · 2025-03-07T12:30:38Z

Hey what is the latest on this one? @janicduplessis @ishpaul777

ishpaul777 · 2025-03-07T17:13:44Z

Hey what is the latest on this one? @janicduplessis @ishpaul777

2 issues spotted while testing #51366 (comment)

rlinoz · 2025-03-11T13:52:38Z

Hey @janicduplessis were you able to take a look at the 2 issues?

janicduplessis · 2025-03-11T16:19:05Z

Hey, sorry I wasn’t available last week, I should be able to have a look soon

janicduplessis mentioned this pull request Jan 17, 2025

Move logic to start report actions list at index to BaseInvertedFlatList #52149

Merged

51 tasks

janicduplessis force-pushed the @janic/open-at-new branch from 20bb3d2 to c811ef7 Compare January 18, 2025 19:01

janicduplessis mentioned this pull request Jan 21, 2025

[$1000] Jump to last unread chat when opening a report #35011

Open

6 tasks

janicduplessis force-pushed the @janic/open-at-new branch 5 times, most recently from fb6a2fb to 3b03cef Compare January 28, 2025 16:23

janicduplessis force-pushed the @janic/open-at-new branch 2 times, most recently from b88cba8 to 13de5ad Compare January 28, 2025 17:26

rlinoz requested review from a team and removed request for a team January 28, 2025 17:34

janicduplessis force-pushed the @janic/open-at-new branch 3 times, most recently from 007ef6c to cb8fd25 Compare February 22, 2025 19:40

Open reports at first unread action

4a9ef9f

janicduplessis force-pushed the @janic/open-at-new branch from cb8fd25 to 4a9ef9f Compare February 22, 2025 19:44

janicduplessis marked this pull request as ready for review February 22, 2025 19:44

janicduplessis requested a review from a team as a code owner February 22, 2025 19:44

melvin-bot bot requested review from ishpaul777 and removed request for a team February 22, 2025 19:44

ishpaul777 reviewed Feb 25, 2025

View reviewed changes

janicduplessis added 2 commits February 25, 2025 20:35

Remove not needed code

d3458ed

Merge remote-tracking branch 'upstream/main' into @janic/open-at-new

c49865c

ikevin127 approved these changes Feb 26, 2025

View reviewed changes

melvin-bot bot requested a review from rlinoz February 26, 2025 05:48

Merge remote-tracking branch 'upstream/main' into @janic/open-at-new

866106c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Open reports at first unread action #51366

Open reports at first unread action #51366

janicduplessis commented Oct 23, 2024 •

edited

Loading

janicduplessis commented Jan 28, 2025

rlinoz commented Jan 28, 2025

shawnborton commented Jan 28, 2025

dannymcclain commented Jan 28, 2025

dubielzyk-expensify commented Jan 28, 2025

ikevin127 commented Feb 2, 2025 •

edited

Loading

melvin-bot bot commented Feb 22, 2025

janicduplessis commented Feb 22, 2025

ishpaul777 Feb 25, 2025

ikevin127 Feb 25, 2025

janicduplessis Feb 26, 2025

ishpaul777 commented Feb 25, 2025

ikevin127 left a comment

rlinoz commented Feb 28, 2025

janicduplessis commented Feb 28, 2025

ishpaul777 commented Mar 4, 2025

ishpaul777 commented Mar 4, 2025 •

edited

Loading

ishpaul777 commented Mar 4, 2025 •

edited

Loading

rlinoz commented Mar 7, 2025

ishpaul777 commented Mar 7, 2025

rlinoz commented Mar 11, 2025

janicduplessis commented Mar 11, 2025

Open reports at first unread action #51366

Are you sure you want to change the base?

Open reports at first unread action #51366

Conversation

janicduplessis commented Oct 23, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

janicduplessis commented Jan 28, 2025

rlinoz commented Jan 28, 2025

shawnborton commented Jan 28, 2025

dannymcclain commented Jan 28, 2025

dubielzyk-expensify commented Jan 28, 2025

ikevin127 commented Feb 2, 2025 • edited Loading

melvin-bot bot commented Feb 22, 2025

janicduplessis commented Feb 22, 2025

ishpaul777 Feb 25, 2025

Choose a reason for hiding this comment

ikevin127 Feb 25, 2025

Choose a reason for hiding this comment

janicduplessis Feb 26, 2025

Choose a reason for hiding this comment

ishpaul777 commented Feb 25, 2025

ikevin127 left a comment

Choose a reason for hiding this comment

rlinoz commented Feb 28, 2025

janicduplessis commented Feb 28, 2025

ishpaul777 commented Mar 4, 2025

ishpaul777 commented Mar 4, 2025 • edited Loading

ishpaul777 commented Mar 4, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

rlinoz commented Mar 7, 2025

ishpaul777 commented Mar 7, 2025

rlinoz commented Mar 11, 2025

janicduplessis commented Mar 11, 2025

janicduplessis commented Oct 23, 2024 •

edited

Loading

ikevin127 commented Feb 2, 2025 •

edited

Loading

ishpaul777 commented Mar 4, 2025 •

edited

Loading

ishpaul777 commented Mar 4, 2025 •

edited

Loading