test: Add regression tests for BTreeIndex infinite loop with undefined keys

packages/db/tests/btree-index-undefined-key-infinite-loop.test.ts

@@ -0,0 +1,228 @@
+/**
+ * Test for GitHub issue #1186: Infinite Loop in BTreeIndex.takeInternal
+ *
+ * This test reproduces the bug where using orderBy() and limit() on a collection
+ * containing items with undefined indexed values causes an infinite loop.
+ *
+ * Root cause: When `nextHigherPair(undefined)` is called, it returns the minimum
+ * pair from the B-tree. If that minimum key is itself `undefined`, the method
+ * returns `[undefined, undefined]`. After processing, the code sets `key = pair[0]`
+ * which is `undefined`, and calls `nextHigherPair(undefined)` again, returning
+ * the same pair - creating an infinite loop.
+ */
+import { beforeEach, describe, expect, it } from 'vitest'
+import { createCollection } from '../src/collection/index.js'
+import { createLiveQueryCollection } from '../src/query/live-query-collection.js'
+import { eq } from '../src/query/builder/functions.js'
+import type { Collection } from '../src/collection/index.js'
+
+interface TaskItem {
+  id: string
+  taskDate?: Date
+  assignedTo?: { id: number } | undefined
+}
+
+describe(`BTreeIndex - Issue #1186: Infinite loop with undefined indexed values`, () => {
+  let collection: Collection<TaskItem, string>
+  let beginFn: () => void
+  let writeFn: (mutation: { type: string; value: TaskItem }) => void
+  let commitFn: () => void
+
+  beforeEach(async () => {
+    collection = createCollection<TaskItem, string>({
+      id: `test-collection`,
+      getKey: (item) => item.id,
+      startSync: true,
+      sync: {
+        sync: ({ begin, write, commit, markReady }) => {
+          beginFn = begin
+          writeFn = write as (mutation: {
+            type: string
+            value: TaskItem
+          }) => void
+          commitFn = commit
+
+          // Initialize with empty state
+          begin()
+          commit()
+          markReady()
+        },
+      },
+    })
+
+    await collection.stateWhenReady()
+  })
+
+  // Helper function to insert items via sync
+  function insertItem(item: TaskItem) {
+    beginFn()
+    writeFn({ type: `insert`, value: item })
+    commitFn()
+  }
+
+  it(
+    `should not infinite loop when take() is called on index with undefined values`,
+    { timeout: 5000 },
+    async () => {
+      // Create index on taskDate field
+      const index = collection.createIndex((row) => row.taskDate)
+
+      // Insert an item with undefined indexed value
+      insertItem({ id: `item1`, taskDate: undefined })
+
+      // This should NOT cause an infinite loop
+      // The bug causes this call to hang forever
+      const result = index.take(1)
+
+      expect(result).toBeDefined()
+      expect(Array.isArray(result)).toBe(true)
+      expect(result.length).toBe(1)
+      expect(result[0]).toBe(`item1`)
+    },
+  )
+
+  it(
+    `should not infinite loop when takeReversed() is called on index with undefined values`,
+    { timeout: 5000 },
+    async () => {
+      const index = collection.createIndex((row) => row.taskDate)
+
+      // Insert an item with undefined indexed value
+      insertItem({ id: `item1`, taskDate: undefined })
+
+      // This should NOT cause an infinite loop
+      const result = index.takeReversed(1)
+
+      expect(result).toBeDefined()
+      expect(Array.isArray(result)).toBe(true)
+      expect(result.length).toBe(1)
+    },
+  )
+
+  it(
+    `should correctly return items when mixing undefined and defined indexed values`,
+    { timeout: 5000 },
+    async () => {
+      const index = collection.createIndex((row) => row.taskDate)
+
+      // Add items - some with undefined, some with defined values
+      insertItem({ id: `item1`, taskDate: undefined })
+      insertItem({ id: `item2`, taskDate: new Date(`2024-01-01`) })
+      insertItem({ id: `item3`, taskDate: new Date(`2024-01-02`) })
+
+      // take() should work without infinite loop
+      const result = index.take(3)
+
+      expect(result).toBeDefined()
+      expect(result.length).toBe(3)
+    },
+  )
+
+  it(
+    `should handle take() with limit when only undefined values exist`,
+    { timeout: 5000 },
+    async () => {
+      const index = collection.createIndex((row) => row.assignedTo)
+
+      // Add multiple items all with undefined indexed values
+      insertItem({ id: `item1`, assignedTo: undefined })
+      insertItem({ id: `item2`, assignedTo: undefined })
+
+      // This should NOT cause an infinite loop
+      const result = index.take(1)
+
+      expect(result).toBeDefined()
+      expect(Array.isArray(result)).toBe(true)
+      // Should return at least one item (both items have the same undefined key)
+      expect(result.length).toBeGreaterThanOrEqual(1)
+    },
+  )
+
+  it(
+    `should handle the exact scenario from issue #1186 - live query with orderBy and limit`,
+    { timeout: 5000 },
+    async () => {
+      // Create index on taskDate field (used by orderBy)
+      collection.createIndex((row) => row.taskDate)
+
+      // First insert: item with undefined indexed value
+      insertItem({ id: `1`, assignedTo: undefined, taskDate: undefined })
+
+      // Create a live query with orderBy and limit (as described in the issue)
+      const liveQuery = createLiveQueryCollection({
+        query: (q: any) =>
+          q
+            .from({ item: collection })
+            .orderBy(({ item }: any) => item.taskDate, `desc`)
+            .limit(1)
+            .select(({ item }: any) => ({
+              id: item.id,
+              taskDate: item.taskDate,
+            })),
+        startSync: true,
+      })
+
+      await liveQuery.stateWhenReady()
+
+      // Should have 1 result
+      expect(liveQuery.size).toBe(1)
+
+      // Second insert: item with defined indexed value
+      // This triggers the query to re-run, which causes the infinite loop
+      insertItem({
+        id: `2`,
+        assignedTo: { id: 35 },
+        taskDate: new Date(`2024-01-15`),
+      })
+
+      // After insert, the live query should still work without infinite loop
+      // and should return the most recent item (by date descending)
+      expect(liveQuery.size).toBe(1)
+      expect(liveQuery.toArray[0]?.id).toBe(`2`)
+    },
+  )
+
+  it(
+    `should handle live query with where, orderBy and limit with undefined values`,
+    { timeout: 5000 },
+    async () => {
+      // Create index on taskDate field
+      collection.createIndex((row) => row.taskDate)
+      collection.createIndex((row) => row.assignedTo)
+
+      // Insert item with undefined assignedTo
+      insertItem({ id: `1`, assignedTo: undefined, taskDate: undefined })
+
+      // Create a live query similar to the issue report
+      const liveQuery = createLiveQueryCollection({
+        query: (q: any) =>
+          q
+            .from({ item: collection })
+            .where(({ item }: any) => eq(item.assignedTo, { id: 35 }))
+            .orderBy(({ item }: any) => item.taskDate, `desc`)
+            .limit(1)
+            .select(({ item }: any) => ({
+              id: item.id,
+              taskDate: item.taskDate,
+            })),
+        startSync: true,
+      })
+
+      await liveQuery.stateWhenReady()
+
+      // Should have 0 results (no matching assignedTo)
+      expect(liveQuery.size).toBe(0)
+
+      // Insert matching item - this should trigger the query without infinite loop
+      insertItem({
+        id: `2`,
+        assignedTo: { id: 35 },
+        taskDate: new Date(`2024-01-15`),
+      })
+
+      // Should now have 1 result
+      expect(liveQuery.size).toBe(1)
+      expect(liveQuery.toArray[0]?.id).toBe(`2`)
+    },
+  )
+})