Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

fix(studio): paginate queue messages on a unique cursor (#47016)

oniani13d101e2415a9
diff --git a/apps/studio/data/database-queues/database-queue-messages-infinite-query.test.ts b/apps/studio/data/database-queues/database-queue-messages-infinite-query.test.ts
new file mode 100644
index 00000000000..eba594c45bb
--- /dev/null
+++ b/apps/studio/data/database-queues/database-queue-messages-infinite-query.test.ts
@@ -0,0 +1,47 @@
+import { beforeEach, expect, test, vi } from 'vitest'
+
+import { getDatabaseQueue } from './database-queue-messages-infinite-query'
+
+const mockExecuteSql = vi.fn()
+
+vi.mock('@/data/sql/execute-sql-mutation', () => ({
+ executeSql: (...args: unknown[]) => mockExecuteSql(...args),
+}))
+
+beforeEach(() => {
+ mockExecuteSql.mockReset()
+ mockExecuteSql.mockResolvedValue({ result: [] })
+})
+
+const capturedSql = () => String(mockExecuteSql.mock.calls[0][0].sql)
+
+test('next pages use a composite (enqueued_at, msg_id) cursor, not enqueued_at alone', async () => {
+ await getDatabaseQueue({
+ projectRef: 'ref',
+ connectionString: null,
+ queueName: 'my_queue',
+ status: ['available'],
+ after: { enqueuedAt: '2024-01-01T00:00:00.000Z', msgId: 42 },
+ })
+
+ const sql = capturedSql()
+ expect(sql).toContain('(enqueued_at, msg_id) > (')
+ expect(sql).toContain('order by enqueued_at, msg_id')
+ // The old single-column cursor (`WHERE enqueued_at > ...`) skipped rows sharing
+ // the last page's timestamp, dropping messages from the list.
+ expect(sql).not.toMatch(/WHERE enqueued_at >\s/)
+})
+
+test('first page omits the cursor predicate but still orders by the unique key', async () => {
+ await getDatabaseQueue({
+ projectRef: 'ref',
+ connectionString: null,
+ queueName: 'my_queue',
+ status: ['available'],
+ after: undefined,
+ })
+
+ const sql = capturedSql()
+ expect(sql).not.toContain('(enqueued_at, msg_id) >')
+ expect(sql).toContain('order by enqueued_at, msg_id')
+})
diff --git a/apps/studio/data/database-queues/database-queue-messages-infinite-query.ts b/apps/studio/data/database-queues/database-queue-messages-infinite-query.ts
index c9b0dfc89fb..ac854fac021 100644
--- a/apps/studio/data/database-queues/database-queue-messages-infinite-query.ts
+++ b/apps/studio/data/database-queues/database-queue-messages-infinite-query.ts
@@ -32,13 +32,15 @@ export type PostgresQueueMessage = {
export const QUEUE_MESSAGES_PAGE_SIZE = 30
+export type QueueMessagesPageParam = { enqueuedAt: string; msgId: number }
+
export async function getDatabaseQueue({
projectRef,
connectionString,
queueName,
- afterTimestamp,
+ after,
status,
-}: DatabaseQueueVariables & { afterTimestamp: string | undefined }) {
+}: DatabaseQueueVariables & { after: QueueMessagesPageParam | undefined }) {
if (!projectRef) throw new Error('Project ref is required')
if (!isQueueNameValid(queueName)) {
throw new Error(
@@ -76,8 +78,13 @@ export async function getDatabaseQueue({
safeSql``
)
- const whereClause = afterTimestamp
- ? safeSql` WHERE enqueued_at > ${literal(afterTimestamp)}`
+ // Keyset pagination on a composite (enqueued_at, msg_id) cursor. enqueued_at is
+ // not unique: pgmq defaults it to now(), so every message from one send_batch
+ // shares a timestamp. A plain `enqueued_at > last` cursor skips the rows that
+ // share the last page's timestamp, dropping them from the list. msg_id is unique
+ // within each queue/archive table and breaks the tie.
+ const whereClause = after
+ ? safeSql` WHERE (enqueued_at, msg_id) > (${literal(after.enqueuedAt)}, ${literal(after.msgId)})`
: safeSql``
const sql = safeSql`SELECT
@@ -85,7 +92,7 @@ export async function getDatabaseQueue({
FROM
(
${unionFragment}
- ) AS combined${whereClause} order by enqueued_at LIMIT ${literal(QUEUE_MESSAGES_PAGE_SIZE)}`
+ ) AS combined${whereClause} order by enqueued_at, msg_id LIMIT ${literal(QUEUE_MESSAGES_PAGE_SIZE)}`
const { result } = await executeSql({
projectRef,
@@ -108,7 +115,7 @@ export const useQueueMessagesInfiniteQuery = <TData = DatabaseQueueData>(
DatabaseQueueError,
InfiniteData<TData>,
readonly unknown[],
- string | undefined
+ QueueMessagesPageParam | undefined
> = {}
) =>
useInfiniteQuery({
@@ -118,17 +125,19 @@ export const useQueueMessagesInfiniteQuery = <TData = DatabaseQueueData>(
projectRef,
connectionString,
queueName,
- afterTimestamp: pageParam,
+ after: pageParam,
status,
})
},
staleTime: 0,
enabled: enabled && typeof projectRef !== 'undefined',
- initialPageParam: undefined,
+ initialPageParam: undefined as QueueMessagesPageParam | undefined,
getNextPageParam(lastPage) {
const hasNextPage = lastPage.length >= QUEUE_MESSAGES_PAGE_SIZE
if (!hasNextPage) return undefined
- return last(lastPage)?.enqueued_at
+ const lastRow = last(lastPage)
+ if (!lastRow) return undefined
+ return { enqueuedAt: lastRow.enqueued_at, msgId: lastRow.msg_id }
},
...options,
})