Use pagination metadata for report actions #49958

janicduplessis · 2024-09-30T21:37:41Z

Details

Use the new hasNewerActions and hasOlderActions fields from the report pagination api calls to determine if new actions need to be loaded instead of relying on heuristics like the type of action. This simplifies the code and makes it less "hacky". This will also help reduce calls to GetNewerActions in certain cases.

Fixed Issues

$ #41153
PROPOSAL:

Tests

Verify that no errors appear in the JS console
Test common comment linking flows (see QA steps)
Make sure no calls to GetNewerActions is made when linking to latest message in a chat

Offline tests

QA Steps

Test common comment linking flows (testing steps taken from Client side pagination gap detection #41962)

Test 1: Basic Navigation

Create a chat between Account A and Account B.
Send 200 messages from Account A to Account B.
Copy the link to the 70th message and send it to Account B (first link).
Copy the link to the 150th message and send it to Account B (second link).
From Account A, click on the first link. Verify redirection to the exact message.
From Account A, click on the second link. Verify redirection to the exact message.
From Account B, click on the first link. Verify redirection to the exact message.
From Account B, click on the second link. Verify redirection to the exact message.

Note: Links can be copied to any message and used in any order.

Test 2: Popup Navigation

Continue using the chat from Test 1.
From Account A, click on the first link. Verify redirection to the exact message.
After redirection, a popup should appear at the top of the screen (similar to new message popup).
Click on this popup.
Verify navigation to the end of the list (newest messages).

Test 3: Cache and Logout

Logout from the accounts and clear the cache.
Log back in.
From Account A, click on the first link. Verify redirection to the exact message.
From Account A, click on the second link. Verify redirection to the exact message.
From Account B, click on the first link. Verify redirection to the exact message.
From Account B, click on the second link. Verify redirection to the exact message.

Test 4:

Create a workspace as User A.
Invite User B.
Navigate to the created Workspace Chat as User B.
Observe User B has a whisper message.
Send a few messagse as User B inside the workspace chat.
Navigate to Chat as User A.
Observe User A does not see any whisper messages nor have them in their Onyx data.
User A should see the previous actions

Notes:
Ensure the chat contains at least 150 messages. Initially, up to 50 messages are rendered. Navigating to the 70th message should allow further navigation up to the 150th message, even with gaps.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

ishpaul777 · 2024-10-01T18:27:25Z

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

Screen.Recording.2024-10-05.at.12.38.21.AM-1.mov

Android: mWeb Chrome

Screen.Recording.2024-10-05.at.1.45.20.AM-1.mov

iOS: Native

Screen.Recording.2024-10-05.at.12.20.46.AM-1.mov

iOS: mWeb Safari

Screen.Recording.2024-10-05.at.12.17.01.AM-1.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-05.at.12.05.26.AM-1.mov

MacOS: Desktop

Screen.Recording.2024-10-05.at.1.08.16.AM-1.mov

ishpaul777 · 2024-10-02T18:19:10Z

@janicduplessis we have conflicts.

code wise changes as is looks good to me, can you open this PR once you are done with your testing

janicduplessis · 2024-10-03T17:47:52Z

@ishpaul777 Awesome! Gonna work on conflicts and finalizing testing + author checklist now.

melvin-bot · 2024-10-04T04:35:58Z

@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 · 2024-10-04T04:36:06Z

PR is ready!

ishpaul777

All yours @roryabraham

roryabraham · 2024-10-04T20:34:00Z

looks like conflicts

roryabraham · 2024-10-04T20:39:55Z

src/libs/Middleware/Pagination.ts

-        // Detect if we are at the start of the list. This will always be the case for the initial request with no cursor.
-        // For previous requests we check that no new data is returned. Ideally the server would return that info.
-        if ((type === 'initial' && !cursorID) || (type === 'next' && newPage.length === 1 && newPage.at(0) === cursorID)) {
+        if (response.hasNewerActions === false || (type === 'initial' && !cursorID)) {


hmmm I'm wondering if it actually should be more simply like this:

Suggested change

if (response.hasNewerActions === false || (type === 'initial' && !cursorID)) {

if (response.hasNewerActions === false) {

because the back-end should always return hasNewerActions, even if OpenReport is called without a cursorID.

When I tested this it did not, that is why I added this condition back.

I can't find a reference to cursorID in the backend, is that the reportActionID we are linking to?

If so, that seems right, we only send back both hasOlderActions and hasNewerActions when there is a reportActionID

Yes, it is only use in the frontend, it is set here

App/src/libs/actions/Report.ts

Line 973 in 0c4b2d1

cursorID: reportActionID,

.

Would it be possible to make the backend return both hasNext and hasPrevious even if no reportActionID is sent, it would simply the code here?

Just to make sure, OpenReport without a cursorID means the user is opening the report at the last action right?

Hmm this is odd, because of this other comment #41153 (comment) 😄

Anyway, I am not sure what it means calling OpenReport without a reportActionID, how can I say whether a report has newer actions if I don't know related to what?

I mean, the code we are talking about implies that if type is initial and no cursorID then hasNewerActions should be false, right?

From what I understand in #35011 we want to open report at the last unread message, so we want to remove the assumption that calling OpenReport without a reportActionID means that there are no newer actions and instead rely on hasNewerActions returned from the backend. However at the moment it seems like that information is not returned.

I think our 2 options for now is:

Update the backend to always return hasNewerActions even when called with no reportActionID (I do not have access to the backend so it would need to be done by an Expensify engineer).

Just leave the code as is for now and remove the check for type is initial and no cursorID whenever we support opening report at the last unread message.

Aaah I finally understand, thanks for explaining, let me check what would need to change in order for 1 work.

Ok, I figured what needs to be done, but then the App behaves in a few weird ways.

First, if you open a direct link to the report it will load only the unread page and won't load the newer ones, despite having the hasNewerActions: true and the code suggestion above applied

Second, if you have the app open and receive the messages then open the report we call ReadNewestAction before we call OpenReport, then we can't calculate whatever you have unread

I think we should merge this PR and figure out this problems in the other issue, what do you think @janicduplessis ?

Ok sounds good

roryabraham · 2024-10-04T20:41:52Z

Also tagging in @rlinoz to take over internal reviewer role in my absence

janicduplessis · 2024-10-05T19:25:14Z

Conflicts fixed!

OSBotify · 2024-10-08T21:51:28Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-10-09T20:47:20Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 9.0.47-1 🚀

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

github-actions · 2024-10-10T23:02:31Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.47-4 🚀

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

janicduplessis mentioned this pull request Sep 30, 2024

[$250] [HOLD for payment 2024-10-17] Report actions pagination improvements #41153

Closed

janicduplessis force-pushed the @janic/pagination-meta branch from de00d0b to eda8d00 Compare September 30, 2024 21:40

Use pagination metadata for report actions

7463dd4

janicduplessis force-pushed the @janic/pagination-meta branch from eda8d00 to 7463dd4 Compare October 3, 2024 17:53

Add start marker when initial request with no cursor

8134090

janicduplessis marked this pull request as ready for review October 4, 2024 04:35

janicduplessis requested a review from a team as a code owner October 4, 2024 04:35

melvin-bot bot requested a review from ishpaul777 October 4, 2024 04:35

melvin-bot bot removed the request for review from a team October 4, 2024 04:35

ishpaul777 approved these changes Oct 4, 2024

View reviewed changes

melvin-bot bot requested a review from roryabraham October 4, 2024 20:20

roryabraham reviewed Oct 4, 2024

View reviewed changes

roryabraham requested a review from rlinoz October 4, 2024 20:41

Merge branch 'main' into @janic/pagination-meta

39d1f8a

rlinoz approved these changes Oct 8, 2024

View reviewed changes

rlinoz merged commit 2090fa8 into Expensify:main Oct 8, 2024

janicduplessis deleted the @janic/pagination-meta branch October 9, 2024 00:00

github-actions bot mentioned this pull request Oct 9, 2024

Deploy Checklist: New Expensify 2024-10-09 #50518

Closed

58 tasks

	if (response.hasNewerActions === false \|\| (type === 'initial' && !cursorID)) {
	if (response.hasNewerActions === false) {

Use pagination metadata for report actions #49958

Use pagination metadata for report actions #49958

Uh oh!

Conversation

janicduplessis commented Sep 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

ishpaul777 commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ishpaul777 commented Oct 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

janicduplessis commented Oct 3, 2024

Uh oh!

melvin-bot bot commented Oct 4, 2024

Uh oh!

janicduplessis commented Oct 4, 2024

Uh oh!

ishpaul777 left a comment

Choose a reason for hiding this comment

Uh oh!

roryabraham commented Oct 4, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rlinoz Oct 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

janicduplessis Oct 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roryabraham commented Oct 4, 2024

Uh oh!

janicduplessis commented Oct 5, 2024

Uh oh!

OSBotify commented Oct 8, 2024

Uh oh!

github-actions bot commented Oct 9, 2024

Uh oh!

github-actions bot commented Oct 10, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

janicduplessis commented Sep 30, 2024 •

edited

Loading

ishpaul777 commented Oct 1, 2024 •

edited

Loading

ishpaul777 commented Oct 2, 2024 •

edited

Loading

rlinoz Oct 7, 2024 •

edited

Loading

janicduplessis Oct 7, 2024 •

edited

Loading