feat: add cursor pagination support on sync messages

[ricardogarim]

As per CORE-686 and CORE-682, this PR introduces cursor pagination to the messages/get Meteor method route, which supports the chat.syncMessages route. This improvement allows users to retrieve updates from a given date more efficiently, without compromising response times.

While cursor pagination is now available, it does not affect any existing behaviors. To use cursor pagination, instead of passing lastUpdate as query parameter, users will need to pass next or previous, along with count and type.

• next or previous: These represent the cursor pointers indicating whether the query should retrieve items from a later or earlier point in time. The cursor value must be the number of milliseconds, as it follows Date getTime().
• count: Specifies the number of records to return.
• type: With the introduction of cursors, both updated and deleted messages cannot be retrieved in the same response. Users must specify whether they want to retrieve DELETED (for deleted messages) or UPDATED (for updated messages, which is the default use case).

Notes:

• In the future, it might be worth considering isolating this functionality into a separate route. However, for now, the current implementation ensures no conflicts or breaking changes, and the route’s signature remains unchanged.
• This implementation has been tested to ensure that existing users relying on lastUpdate will continue to have the same experience, with no changes required on their end.
• Keep in mind that while performance is acceptable for now, there may be opportunities to optimize database indexes further. Pagination has been a missing feature, so addressing it was a high priority.
• This change is especially beneficial for users who frequently work with large volumes of messages, such as when a username with a high message count in a room is changed, as cursor pagination offers a more efficient way to paginate through results.

---

Edit: As per OPI-53, it adds cursor null conditions when there's no more records to fetch.

[changeset-bot]

🦋 Changeset detected

Latest commit: 3921018

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 35 packages

Name	Type
@rocket.chat/rest-typings	Minor
@rocket.chat/meteor	Minor
@rocket.chat/api-client	Patch
@rocket.chat/core-services	Patch
@rocket.chat/ddp-client	Patch
@rocket.chat/ui-contexts	Major
@rocket.chat/account-service	Patch
@rocket.chat/authorization-service	Patch
@rocket.chat/ddp-streamer	Patch
@rocket.chat/stream-hub-service	Patch
@rocket.chat/omnichannel-services	Patch
@rocket.chat/presence	Patch
rocketchat-services	Patch
@rocket.chat/omnichannel-transcript	Patch
@rocket.chat/presence-service	Patch
@rocket.chat/queue-worker	Patch
@rocket.chat/network-broker	Patch
@rocket.chat/livechat	Patch
@rocket.chat/uikit-playground	Patch
@rocket.chat/fuselage-ui-kit	Major
@rocket.chat/gazzodown	Major
@rocket.chat/ui-avatar	Major
@rocket.chat/ui-client	Major
@rocket.chat/ui-video-conf	Major
@rocket.chat/ui-voip	Major
@rocket.chat/web-ui-registration	Major
@rocket.chat/core-typings	Minor
@rocket.chat/apps	Patch
@rocket.chat/cron	Patch
@rocket.chat/freeswitch	Patch
@rocket.chat/model-typings	Patch
@rocket.chat/license	Patch
@rocket.chat/pdf-worker	Patch
@rocket.chat/models	Patch
@rocket.chat/instance-status	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[dionisio-bot]

Looks like this PR is ready to merge! 🎉
If you have any trouble, please check the PR guidelines

[github-actions]

PR Preview Action v1.4.8
🚀 Deployed preview to https://RocketChat.github.io/Rocket.Chat/pr-preview/pr-33810/
on branch gh-pages at 2024-11-19 17:55 UTC

[codecov]

Codecov Report

Attention: Patch coverage is 69.86301% with 22 lines in your changes missing coverage. Please review.

Project coverage is 75.16%. Comparing base (6ba7372) to head (30d44c8).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #33810      +/-   ##
===========================================
- Coverage    75.18%   75.16%   -0.03%     
===========================================
  Files          495      497       +2     
  Lines        21600    21688      +88     
  Branches      5362     5392      +30     
===========================================
+ Hits         16241    16301      +60     
- Misses        4717     4743      +26     
- Partials       642      644       +2     

Flag	Coverage Δ
unit	75.16% <69.86%> (-0.03%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

---- 🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests
• JS Bundle Analysis - Avoid shipping oversized bundles

[MarcosSpessatto]

Can we add a changeset?