fix: prevent 'Cannot use gte on field undefined' error in splitRange by sethconvex · Pull Request #907 · get-convex/convex-helpers

sethconvex · 2026-01-31T19:11:27Z

When using eq() with undefined on a compound index followed by pagination,
the splitRange function would attempt to access indexFields[i] beyond the
array bounds. This occurred because the commonPrefix loop slices indexFields
while processing equality constraints, but makeCompare and the middleRange
code didn't check array bounds before accessing indexFields[i].

This fix adds bounds checking in:

makeCompare loop and condition (lines 85, 88)
middleRange construction (line 116)

Also adds a regression test for pagination with eq(undefined) on a
compound index to prevent this issue from recurring.

Fixes the error: 'Cannot use gte on field "undefined"'

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Summary by CodeRabbit

Bug Fixes
- Fixed pagination errors that occurred when querying with certain compound index configurations and equality filters.
Tests
- Added regression test for pagination with compound indexes to prevent future regressions.

When using eq() with undefined on a compound index followed by pagination, the splitRange function would attempt to access indexFields[i] beyond the array bounds. This occurred because the commonPrefix loop slices indexFields while processing equality constraints, but makeCompare and the middleRange code didn't check array bounds before accessing indexFields[i]. This fix adds bounds checking in: 1. makeCompare loop and condition (lines 85, 88) 2. middleRange construction (line 116) Also adds a regression test for pagination with eq(undefined) on a compound index to prevent this issue from recurring. Fixes the error: 'Cannot use gte on field "undefined"'

coderabbitai · 2026-01-31T19:11:36Z

📝 Walkthrough

Walkthrough

This change fixes a pagination bug in the stream helper where querying with eq(undefined) on a compound index caused an out-of-bounds error. A regression test validates the fix, and the range-splitting logic now guards against indexing beyond the declared index fields.

Changes

Cohort / File(s)	Summary
Regression Test `packages/convex-helpers/server/stream.test.ts`	Adds a test case "pagination with eq(undefined) on compound index" that verifies pagination works correctly with compound indexes when using `eq("softDeletedAt", undefined)` and descending order, checking first and second page results.
Range-Splitting Logic Fix `packages/convex-helpers/server/stream.ts`	Restricts loop bounds to prevent indexing beyond `indexFields.length`, adds explicit handling for when no index fields remain (all fields in common prefix), and ensures bounds are only constructed for valid index field positions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A cursor once stumbled on undefined's trail,
Compound indexes made the pagination fail,
But bounds were checked, and logic stayed tight,
Now pages turn smoothly, from left into right! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main fix: preventing the 'Cannot use gte on field undefined' error in splitRange, which is the primary issue addressed in the changeset.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix-pagination-undefined-field

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

sethconvex · 2026-01-31T19:11:43Z

fix: prevent 'Cannot use gte on field undefined' error in splitRange #907 👈 (View in Graphite)
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

pkg-pr-new · 2026-01-31T19:12:07Z

Open in StackBlitz

npm i https://pkg.pr.new/get-convex/convex-helpers@907

commit: 484dfb3

coderabbitai

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@packages/convex-helpers/server/stream.test.ts`:
- Around line 817-856: Prettier formatting failed for the new test "pagination
with eq(undefined) on compound index"; run your project's Prettier (or
formatter) on packages/convex-helpers/server/stream.test.ts and reformat the new
test block so indentation and spacing match the repo style (normalize
indentation around the test definition and the block using defineSchema,
defineTable, convexTest, stream, and query.paginate); then re-run lint/CI to
ensure the file passes formatting checks before reopening the PR.

coderabbitai · 2026-01-31T20:40:29Z

packages/convex-helpers/server/stream.test.ts

+  test("pagination with eq(undefined) on compound index", async () => {
+      // Regression test for bug where eq(field, undefined) on a compound index
+      // would cause "Cannot use gte on field 'undefined'" error during pagination
+      const testSchema = defineSchema({
+        items: defineTable({
+          softDeletedAt: v.optional(v.number()),
+          updatedAt: v.number(),
+        }).index("by_active_updated", ["softDeletedAt", "updatedAt"]),
+      });
+      const t = convexTest(testSchema, modules);
+      await t.run(async (ctx) => {
+        // Insert some active (non-deleted) items
+        await ctx.db.insert("items", { updatedAt: 1 });
+        await ctx.db.insert("items", { updatedAt: 2 });
+        await ctx.db.insert("items", { updatedAt: 3 });
+        // Insert some soft-deleted items
+        await ctx.db.insert("items", { softDeletedAt: 100, updatedAt: 4 });
+
+        const query = stream(ctx.db, testSchema)
+          .query("items")
+          .withIndex("by_active_updated", (q) => q.eq("softDeletedAt", undefined))
+          .order("desc");
+
+        // This should not throw "Cannot use gte on field 'undefined'"
+        const result = await query.paginate({ numItems: 2, cursor: null });
+        expect(result.page.length).toBe(2);
+        expect(result.page[0]!.updatedAt).toBe(3);
+        expect(result.page[1]!.updatedAt).toBe(2);
+        expect(result.isDone).toBe(false);
+
+        // Continue pagination
+        const page2 = await query.paginate({
+          numItems: 2,
+          cursor: result.continueCursor,
+        });
+        expect(page2.page.length).toBe(1);
+        expect(page2.page[0]!.updatedAt).toBe(1);
+        expect(page2.isDone).toBe(true);
+      });
+    });


⚠️ Potential issue | 🟡 Minor

Fix Prettier failure in the new regression test.

CI reports a Prettier formatting failure for this file; please run Prettier (or your formatter) to normalize the indentation in this new test block.

🤖 Prompt for AI Agents

In `@packages/convex-helpers/server/stream.test.ts` around lines 817 - 856, Prettier formatting failed for the new test "pagination with eq(undefined) on compound index"; run your project's Prettier (or formatter) on packages/convex-helpers/server/stream.test.ts and reformat the new test block so indentation and spacing match the repo style (normalize indentation around the test definition and the block using defineSchema, defineTable, convexTest, stream, and query.paginate); then re-run lint/CI to ensure the file passes formatting checks before reopening the PR.

ianmacartney · 2026-02-02T22:48:27Z

should I review even though it's a draft?

sethconvex · 2026-02-02T22:49:31Z

yes please! I was hoping to get the prettier pushed but haven't had a second to do that yet

ianmacartney · 2026-02-03T01:18:45Z

packages/convex-helpers/server/stream.ts

    const range = commonPrefix.slice();
    let i = 0;
-    for (; i < key.length - 1; i++) {
+    for (; i < key.length - 1 && i < indexFields.length; i++) {


When would key be longer than indexFields? That seems like a bug - unless they indexFields don't include _creationTime, _id, which would be important to respect here. If we want to add more safety let's assert that it's the case, vs. not constraining the range as much as expected

ianmacartney · 2026-02-03T01:55:27Z

packages/convex-helpers/server/stream.test.ts

    });
  });
+
+  test("pagination with eq(undefined) on compound index", async () => {


This test passes without the proposed changes, so I think we need another test that previously failed

ianmacartney · 2026-02-03T01:59:27Z

packages/convex-helpers/server/stream.ts

  } else if (startBound.length === 0) {
    middleRange = makeCompare(endBoundType, endBound);
-  } else {
+  } else if (indexFields.length > 0) {


Again, not sure how this could happen, so would rather assert - not sure how we would get here

ianmacartney · 2026-02-03T01:59:28Z

packages/convex-helpers/server/stream.ts

    middleRange = commonPrefix.slice();
    middleRange.push([startBoundType, indexFields[0]!, startValue]);
    middleRange.push([endBoundType, indexFields[0]!, endValue]);
+  } else {


Would love to have some unit tests just on splitRange to validate that it's doing what it's supposed to for the four variants we expect here -

sethconvex requested a review from ianmacartney January 31, 2026 19:12

coderabbitai bot reviewed Jan 31, 2026

View reviewed changes

fix: correct indentation in stream.test.ts

484dfb3

sethconvex marked this pull request as ready for review February 3, 2026 00:37

ianmacartney requested changes Feb 3, 2026

View reviewed changes

Conversation

sethconvex commented Jan 31, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

sethconvex commented Jan 31, 2026

Uh oh!

pkg-pr-new bot commented Jan 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Jan 31, 2026

Choose a reason for hiding this comment

Uh oh!

ianmacartney commented Feb 2, 2026

Uh oh!

sethconvex commented Feb 2, 2026

Uh oh!

ianmacartney Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

ianmacartney Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

sethconvex Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

ianmacartney Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

ianmacartney Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sethconvex commented Jan 31, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 31, 2026 •

edited

Loading

pkg-pr-new bot commented Jan 31, 2026 •

edited

Loading