Fix Cosmos DB pagination for backwards compatibility (3.x) by MarcAstr0 · Pull Request #1595 · boostercloud/booster

MarcAstr0 · 2026-03-02T20:26:09Z

Description

Same fix as #1594, targeting the release/3.x branch (Node 20-compatible versions).

Checks

Project Builds
Project passes tests and checks
Updated documentation accordingly

what-the-diff · 2026-03-02T20:26:34Z

PR Summary

Introduces Trackable Fixes to Database Pagination Issues
A new file for tracking adjustments related to improving pagination issues with a database named "Cosmos DB". This has been added in the "boostercloud framework-core" package.
Updates Multiple Dependencies
Several dependencies in a core file have been updated, which could result in better performance and increased security of the applications. Consequently, a number of packages across various sections stand updated.
Refined Pagination Logic in Database Queries
Within the 'query-helper.ts' file, there's now a constant value set for the default page size in the database queries. The refined logic ensures that the maximum item count for these queries is always set when using continuation tokens, or a limit is provided. This further results in a consistent pagination process as the calculations are now aligned with the effective limit. Also, both legacy cursor support and implementing cursor advancements based on the page size are now handled better.

MarcAstr0 · 2026-03-02T20:26:40Z

/integration sha=7ba540a

github-actions · 2026-03-02T20:27:00Z

⌛ Integration tests are running...

Check their status here 👈

Copilot

Pull request overview

Backports the Cosmos DB pagination compatibility fix to the release/3.x line, aiming to restore a numeric cursor id for frontends while keeping continuation-token pagination for Azure Cosmos DB.

Changes:

Update Azure provider Cosmos query pagination logic (continuation token vs legacy OFFSET/LIMIT) and introduce a default page size.
Update Rush/pnpm lockfile with workspace specifier bumps and an updated resolved TypeScript nightly used by tooling.
Add a Rush changefile for a patch release.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 5 comments.

File	Description
packages/framework-provider-azure/src/helpers/query-helper.ts	Adjusts Cosmos DB paginated search behavior, including continuation-token feed options and cursor shaping.
common/config/rush/pnpm-lock.yaml	Updates workspace dependency specifiers and refreshes some resolved toolchain dependencies in the lockfile.
common/changes/@boostercloud/framework-core/fix-cosmos-pagination_3.x_2026-02-27-21-16.json	Declares a patch change entry for publishing/versioning.

Files not reviewed (1)

common/config/rush/pnpm-lock.yaml: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-02T20:32:54Z

common/config/rush/pnpm-lock.yaml


-  typescript@6.0.0-dev.20250822:
-    resolution: {integrity: sha512-omHezTVn6vg+B/eFHkIzUGFvlbbkJdsdmdBohcsw8NMLyKOhKRMinE9aLu8f0EALT4R2YS41xak2KinK74/6Xg==}
+  typescript@6.0.0-dev.20260302:


This lockfile update bumps the resolved typescript@6.0.0-dev.* nightly used by downlevel-dts (from 20250822 to 20260302) without any corresponding direct dependency change. If this wasn’t intentional, consider reverting the Typescript nightly resolution to avoid unrelated toolchain drift in a pagination-focused backport PR.

Suggested change

typescript@6.0.0-dev.20260302:

typescript@6.0.0-dev.20250822:

Copilot · 2026-03-02T20:32:54Z

common/changes/@boostercloud/framework-core/fix-cosmos-pagination_3.x_2026-02-27-21-16.json

+    {
+      "packageName": "@boostercloud/framework-core",
+      "comment": "Fix pagination issues with Cosmos DB",
+      "type": "patch"
+    }


This changeset is recorded under @boostercloud/framework-core, but the functional change in this PR is in @boostercloud/framework-provider-azure (Cosmos DB query helper). If the goal is to publish the Azure provider pagination fix, the changeset should target the provider package (so changelogs/version bumps line up with the shipped fix).

Copilot · 2026-03-02T20:32:54Z

packages/framework-provider-azure/src/helpers/query-helper.ts

+    // Always set maxItemCount when limit is provided or when using continuation token
+    if (limit || afterCursor?.continuationToken) {
+      feedOptions.maxItemCount = limit ?? DEFAULT_PAGE_SIZE
+    }


In the continuation-token path, maxItemCount is only set when limit is provided or when afterCursor.continuationToken is present. For the first page when limit is omitted (but continuation-token pagination is still used), this can yield an implementation-defined page size from the SDK/service, which makes cursor.id calculations non-deterministic and may break clients relying on stable offsets. Consider always setting feedOptions.maxItemCount when using the continuation-token pagination branch (e.g., to limit ?? DEFAULT_PAGE_SIZE), not only when a token is already present.

Suggested change

// Always set maxItemCount when limit is provided or when using continuation token

if (limit || afterCursor?.continuationToken) {

feedOptions.maxItemCount = limit ?? DEFAULT_PAGE_SIZE

}

// Always set maxItemCount when using continuation-token pagination

feedOptions.maxItemCount = limit ?? DEFAULT_PAGE_SIZE

Copilot · 2026-03-02T20:32:55Z

packages/framework-provider-azure/src/helpers/query-helper.ts

        count: processedResources.length,
        cursor: {
-          id: (offset + processedResources.length).toString(),
+          id: (offset + effectiveLimit).toString(),


The legacy OFFSET/LIMIT branch advances cursor.id by effectiveLimit rather than by the number of items actually returned (processedResources.length). If Cosmos returns fewer than effectiveLimit for any reason, an old client that paginates using only cursor.id will skip items on the next request. Advancing by the actual returned count keeps the numeric cursor aligned with the true offset.

Suggested change

id: (offset + effectiveLimit).toString(),

id: (offset + processedResources.length).toString(),

Copilot · 2026-03-02T20:32:55Z

packages/framework-provider-azure/src/helpers/query-helper.ts

+    // cursor.id advances by the page size (limit) to maintain consistent page-based offsets
+    // that frontends rely on (e.g., limit=5 produces cursors 5, 10 ,15, ...)
+    const previousOffset = afterCursor?.id ? parseInt(afterCursor.id) : 0
+    const effectiveLimit = limit ?? DEFAULT_PAGE_SIZE
+
    let cursor: Record<string, string> | undefined
    if (continuationToken) {
-      cursor = { continuationToken }
+      cursor = { continuationToken, id: (previousOffset + effectiveLimit).toString() }
    } else if (finalResources.length > 0) {
-      const currentOffset = afterCursor?.id && !isNaN(parseInt(afterCursor.id)) ? parseInt(afterCursor.id) : 0
-      cursor = { id: (currentOffset + finalResources.length).toString() } // Use the length of the results to calculate the next id
+      cursor = { id: (previousOffset + effectiveLimit).toString() }


previousOffset is computed via parseInt(afterCursor.id) without validating that afterCursor.id is numeric. If a client sends a non-numeric id alongside a continuationToken (or any other non-legacy cursor shape), this becomes NaN and the response cursor will include id: 'NaN'. Also, advancing cursor.id by effectiveLimit (instead of finalResources.length) can desynchronize offsets when fetchNext() returns fewer than maxItemCount, causing legacy clients (that ignore continuationToken) to skip results if they later fall back to OFFSET pagination. Consider (1) defaulting previousOffset to 0 unless afterCursor.id matches a numeric string, and (2) advancing by the actual number of returned items.

github-actions · 2026-03-02T20:42:14Z

❌ Oh no! Integration tests have failed

github-actions · 2026-03-02T22:05:53Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2026-03-02T22:11:45Z

❌ Oh no! Integration tests have failed

github-actions · 2026-03-03T03:49:53Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2026-03-03T03:55:49Z

❌ Oh no! Integration tests have failed

github-actions · 2026-03-03T11:56:59Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2026-03-03T12:53:19Z

❌ Oh no! Integration tests have failed

MarcAstr0 · 2026-03-03T15:19:02Z

/integration sha=832ebbe

github-actions · 2026-03-03T15:19:21Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2026-03-03T16:09:41Z

❌ Oh no! Integration tests have failed

github-actions · 2026-03-03T16:25:34Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2026-03-03T17:20:58Z

✅ Integration tests have finished successfully!

Castro, Mario and others added 3 commits February 27, 2026 18:15

Fix pagination issues with Cosmos DB

0bb0062

Add rush change file

bf7892d

Update lock file

7ba540a

MarcAstr0 requested review from alvaroloes, Copilot and javiertoledo March 2, 2026 20:26

Copilot started reviewing on behalf of MarcAstr0 March 2, 2026 20:26 View session

Copilot AI reviewed Mar 2, 2026

View reviewed changes

Fix integration tests

832ebbe

	typescript@6.0.0-dev.20260302:
	typescript@6.0.0-dev.20250822:

	id: (offset + effectiveLimit).toString(),
	id: (offset + processedResources.length).toString(),

Conversation

MarcAstr0 commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checks

Uh oh!

what-the-diff bot commented Mar 2, 2026

PR Summary

Uh oh!

MarcAstr0 commented Mar 2, 2026

Uh oh!

github-actions bot commented Mar 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 2, 2026

Uh oh!

github-actions bot commented Mar 2, 2026

Uh oh!

github-actions bot commented Mar 2, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

MarcAstr0 commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

github-actions bot commented Mar 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MarcAstr0 commented Mar 2, 2026 •

edited

Loading