Skip to content

Add pagination to webhook deliveries table #2520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
everettbu wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Add pagination to webhook deliveries table #2520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1681c2c
Add pagination to webhook deliveries table
dnywh Mar 17, 2026
e913f93
Refactor webhook deliveries to TanStack table
dnywh Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
210 changes: 151 additions & 59 deletions apps/studio/components/interfaces/Platform/Webhooks/PlatformWebhooks.mock.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,152 @@
import type { PlatformWebhooksMockSeed, WebhookScope } from './PlatformWebhooks.types'
import type {
PlatformWebhooksMockSeed,
WebhookDelivery,
WebhookScope,
} from './PlatformWebhooks.types'

const createDeliveries = (
endpointId: string,
prefix: string,
deliveries: Array<Pick<WebhookDelivery, 'eventType' | 'status' | 'responseCode' | 'attemptAt'>>
): WebhookDelivery[] =>
deliveries.map((delivery, index) => ({
id: `${prefix}-${index + 1}`,
endpointId,
...delivery,
}))

const organizationPrimaryDeliveries = createDeliveries('org-endpoint-1', 'org-delivery', [
{
eventType: 'project.created',
status: 'success',
responseCode: 200,
attemptAt: '2026-02-27T08:04:00.000Z',
},
{
eventType: 'project.updated',
status: 'failure',
responseCode: 500,
attemptAt: '2026-02-27T07:56:00.000Z',
},
{
eventType: 'project.deleted',
status: 'pending',
attemptAt: '2026-02-27T07:45:00.000Z',
},
{
eventType: 'organization.member_invited',
status: 'success',
responseCode: 202,
attemptAt: '2026-02-27T07:37:00.000Z',
},
{
eventType: 'project.resumed',
status: 'success',
responseCode: 204,
attemptAt: '2026-02-27T07:18:00.000Z',
},
{
eventType: 'organization.member_removed',
status: 'failure',
responseCode: 400,
attemptAt: '2026-02-27T06:59:00.000Z',
},
{
eventType: 'organization.updated',
status: 'skipped',
attemptAt: '2026-02-27T06:40:00.000Z',
},
{
eventType: 'project.paused',
status: 'success',
responseCode: 200,
attemptAt: '2026-02-27T06:21:00.000Z',
},
{
eventType: 'project.created',
status: 'failure',
responseCode: 503,
attemptAt: '2026-02-27T06:03:00.000Z',
},
{
eventType: 'project.updated',
status: 'success',
responseCode: 200,
attemptAt: '2026-02-27T05:44:00.000Z',
},
{
eventType: 'project.deleted',
status: 'skipped',
attemptAt: '2026-02-27T05:25:00.000Z',
},
{
eventType: 'organization.member_invited',
status: 'success',
responseCode: 201,
attemptAt: '2026-02-27T05:07:00.000Z',
},
])

const organizationSecondaryDeliveries = createDeliveries(
'org-endpoint-2',
'org-secondary-delivery',
[
{
eventType: 'organization.updated',
status: 'skipped',
attemptAt: '2026-02-26T14:12:00.000Z',
},
]
)

const projectDeliveries = createDeliveries('project-endpoint-1', 'project-delivery', [
{
eventType: 'project.updated',
status: 'success',
responseCode: 200,
attemptAt: '2026-02-27T09:01:00.000Z',
},
{
eventType: 'project.resource_exhausted',
status: 'failure',
responseCode: 429,
attemptAt: '2026-02-27T08:47:00.000Z',
},
{
eventType: 'project.paused',
status: 'success',
responseCode: 202,
attemptAt: '2026-02-26T21:10:00.000Z',
},
{
eventType: 'project.branch_created',
status: 'success',
responseCode: 200,
attemptAt: '2026-02-26T19:45:00.000Z',
},
{
eventType: 'project.resumed',
status: 'pending',
attemptAt: '2026-02-26T18:30:00.000Z',
},
{
eventType: 'project.branch_deleted',
status: 'success',
responseCode: 204,
attemptAt: '2026-02-26T17:04:00.000Z',
},
{
eventType: 'project.updated',
status: 'failure',
responseCode: 500,
attemptAt: '2026-02-26T15:59:00.000Z',
},
{
eventType: 'project.resource_exhausted',
status: 'skipped',
attemptAt: '2026-02-26T14:12:00.000Z',
},
])

export const PLATFORM_WEBHOOKS_MOCK_DATA: Record<WebhookScope, PlatformWebhooksMockSeed> = {
organization: {
Expand Down Expand Up @@ -39,38 +187,7 @@ export const PLATFORM_WEBHOOKS_MOCK_DATA: Record<WebhookScope, PlatformWebhooksM
createdAt: '2026-02-12T10:14:00.000Z',
},
],
deliveries: [
{
id: 'org-delivery-1',
endpointId: 'org-endpoint-1',
eventType: 'project.created',
status: 'success',
responseCode: 200,
attemptAt: '2026-02-27T08:04:00.000Z',
},
{
id: 'org-delivery-2',
endpointId: 'org-endpoint-1',
eventType: 'project.updated',
status: 'failure',
responseCode: 500,
attemptAt: '2026-02-27T07:56:00.000Z',
},
{
id: 'org-delivery-3',
endpointId: 'org-endpoint-1',
eventType: 'project.deleted',
status: 'pending',
attemptAt: '2026-02-27T07:45:00.000Z',
},
{
id: 'org-delivery-4',
endpointId: 'org-endpoint-2',
eventType: 'organization.updated',
status: 'skipped',
attemptAt: '2026-02-26T14:12:00.000Z',
},
],
deliveries: [...organizationPrimaryDeliveries, ...organizationSecondaryDeliveries],
},
project: {
eventTypes: [
Expand All @@ -94,31 +211,6 @@ export const PLATFORM_WEBHOOKS_MOCK_DATA: Record<WebhookScope, PlatformWebhooksM
createdAt: '2026-02-18T11:23:00.000Z',
},
],
deliveries: [
{
id: 'project-delivery-1',
endpointId: 'project-endpoint-1',
eventType: 'project.updated',
status: 'success',
responseCode: 200,
attemptAt: '2026-02-27T09:01:00.000Z',
},
{
id: 'project-delivery-2',
endpointId: 'project-endpoint-1',
eventType: 'project.resource_exhausted',
status: 'failure',
responseCode: 429,
attemptAt: '2026-02-27T08:47:00.000Z',
},
{
id: 'project-delivery-3',
endpointId: 'project-endpoint-1',
eventType: 'project.paused',
status: 'success',
responseCode: 202,
attemptAt: '2026-02-26T21:10:00.000Z',
},
],
deliveries: projectDeliveries,
},
}
101 changes: 101 additions & 0 deletions apps/studio/components/interfaces/Platform/Webhooks/PlatformWebhooksEndpointDetails.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
import { render, screen, waitFor } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import type { ComponentProps } from 'react'
import { describe, expect, it, vi } from 'vitest'

import { PLATFORM_WEBHOOKS_MOCK_DATA } from './PlatformWebhooks.mock'
import { PlatformWebhooksEndpointDetails } from './PlatformWebhooksEndpointDetails'

vi.mock('components/ui/DataTable/DataTableColumn/DataTableColumnStatusCode', () => ({
DataTableColumnStatusCode: ({ value }: { value: number }) => <span>{value}</span>,
}))

vi.mock('ui-patterns', async () => {
const actual = await vi.importActual<typeof import('ui-patterns')>('ui-patterns')

return {
...actual,
TimestampInfo: ({ utcTimestamp, className }: { utcTimestamp: string; className?: string }) => (
<span className={className}>{utcTimestamp}</span>
),
}
})

describe('PlatformWebhooksEndpointDetails', () => {
const selectedEndpoint = PLATFORM_WEBHOOKS_MOCK_DATA.organization.endpoints[0]
const allDeliveries = PLATFORM_WEBHOOKS_MOCK_DATA.organization.deliveries.filter(
(delivery) => delivery.endpointId === selectedEndpoint.id
)

const renderComponent = (
props?: Partial<ComponentProps<typeof PlatformWebhooksEndpointDetails>>
) =>
render(
<PlatformWebhooksEndpointDetails
deliverySearch=""
filteredDeliveries={allDeliveries}
selectedEndpoint={selectedEndpoint}
onDeliverySearchChange={vi.fn()}
onOpenDelivery={vi.fn()}
{...props}
/>
)

it('renders paginated deliveries with previous and next controls', async () => {
const user = userEvent.setup()

renderComponent()

expect(screen.getByText('Showing 1 to 5 of 12 deliveries')).toBeInTheDocument()
expect(screen.queryByText('organization.member_removed')).not.toBeInTheDocument()

await user.click(screen.getByLabelText('Next page'))

expect(screen.getByText('Showing 6 to 10 of 12 deliveries')).toBeInTheDocument()
expect(screen.getByText('organization.member_removed')).toBeInTheDocument()

await user.click(screen.getByLabelText('Previous page'))

expect(screen.getByText('Showing 1 to 5 of 12 deliveries')).toBeInTheDocument()
expect(screen.queryByText('organization.member_removed')).not.toBeInTheDocument()
})

it('sorts deliveries by event type from the header', async () => {
const user = userEvent.setup()

renderComponent()

await user.click(screen.getByRole('button', { name: 'Event type' }))

expect(screen.getAllByRole('row')[1]).toHaveTextContent('organization.member_invited')

await user.click(screen.getByRole('button', { name: 'Event type' }))

expect(screen.getAllByRole('row')[1]).toHaveTextContent('project.updated')
})

it('resets to the first page when the delivery search changes', async () => {
const user = userEvent.setup()
const projectDeliveries = allDeliveries.filter((delivery) =>
delivery.eventType.includes('project')
)
const { rerender } = renderComponent()

await user.click(screen.getByLabelText('Next page'))
expect(screen.getByText('Showing 6 to 10 of 12 deliveries')).toBeInTheDocument()

rerender(
<PlatformWebhooksEndpointDetails
deliverySearch="project"
filteredDeliveries={projectDeliveries}
selectedEndpoint={selectedEndpoint}
onDeliverySearchChange={vi.fn()}
onOpenDelivery={vi.fn()}
/>
)

await waitFor(() => {
expect(screen.getByText('Showing 1 to 5 of 8 deliveries')).toBeInTheDocument()
})
})
})
Loading