Client side pagination gap detection

[janicduplessis]

Details

Listing out related or potentially related issues, won't move these into Fixed Issues unless we test and confirm:

• CRITICAL: [API Reliability] Workspace room does not load older messages due to infinite GetOlderActions calls #41254
• [$250] Comments after threaded comment are gone after returning to parent #40644
• [HOLD] CRITICAL: reportAction chain is broken in rooms and expense reports #42214
• [HOLD #41254][$250] IOS - After editing split expense amount weird flash and reloads at the top #41174
• https://expensify.slack.com/archives/C05LX9D6E07/p1718059029709639

Fixed Issues

$
PROPOSAL: https://docs.google.com/document/d/19xEEr0mY41cTio1lGgJ2F6vYCA5QH4Sj7hOMRZsj0Dc/edit

Tests

• Verify that no errors appear in the JS console

Offline tests

QA Steps

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.
If bugs are found, confirm they are reproducible on another account, or provide credentials for debugging. Thsnks!

• 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.
• I verified that similar component doesn't exist in the codebase
• I verified that all props are defined accurately and each prop has a /** comment above it */
• I verified that each file is named correctly
• I verified that each component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
• I verified that the only data being stored in component state is data necessary for rendering and nothing else
• In component 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
• 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)
• I verified that component 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)
• I verified that all JSX used for rendering exists in the render method
• I verified that each 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

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[roryabraham]

The main piece of feedback I have is that I'd really love to see the Middleware generalized such that it's not really referencing reportActions directly. I think the way I set that up with API.paginate was looking pretty clean.

I might even say the same for the UI component. Would be great to have some business-logic-agnostic UI component like PaginatedList that leverages this pattern and then just make ReportActionsList a lightweight wrapper around that.

[melvin-bot]

🎯 @ishpaul777, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #44874.

[mountiny]

Seems like this is ready to go, amazing job pushing this ahead, any concerns about merging this as is?

[mountiny]

+1 seems like we are missing the comment here

[mountiny]

Thanks

[OSBotify]

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

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

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

[OSBotify]

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.5-2 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.6-8 🚀

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

[Julesssss]

Hey @janicduplessis and everyone subscribed to this pagination PR. I think this newly discovered bug is related to these changes. Our backend seems to report a value of -1 to be invalid. Is a value of -1 necessary for the clientUpdateID default?

[janicduplessis]

@roryabraham I think you worked on this part, do you know why this happens now?

[roryabraham]

@Julesssss we didn't change the logic with clientUpdateID in this PR. We just DRYed it up and moved it from being added to requests in multiple places in src/libs/API/index.ts to being added to requests in one place in src/libs/Network/enhanceParameters.ts. It was already defaulting to -1

[mountiny]

I believe @iwiznia @danieldoglas were doing something around this default/ logic

[roryabraham]

Let's discuss in #45252. I added some breadcrumbs here

[ishpaul777]

Coming from #51108,

These changes broke storybook for components, Incase when isJestEnv is "false", there seems to be case of circular depency in importing of module @react-navigation/native we are importing the module in its mock itself.