Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/plain-language-errors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@datum-cloud/datum-ui": minor
---

Adds `@datum-cloud/datum-ui/error-content`: `ErrorContent`, `describeApiError` and `ErrorDescriptionProvider` for plain-language errors that keep the raw text under Error details. A failed `DataTable.Server` load now shows an error with Retry instead of "No results."; the store has `refetch()` and `DataTable.Content` takes `errorContent`. TaskQueue formats thrown errors (override with `formatError`) and shows the raw text in its summary. Dropzone explains each rejected file and adds `onReject`.
18 changes: 14 additions & 4 deletions apps/storybook/stories/features/dropzone.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,25 @@ type Story = StoryObj<DropzoneStoryArgs>

function DefaultStory(args: DropzoneStoryArgs) {
const [files, setFiles] = useState<File[] | undefined>(undefined)
const [error, setError] = useState<string>()
return (
<div className="max-w-md">
<Dropzone
disabled={args.disabled}
src={files}
onDrop={accepted => setFiles(accepted)}
onError={err => alert(err.message)}
onDrop={(accepted) => {
setFiles(accepted)
setError(undefined)
}}
onError={err => setError(err.message)}
>
<DropzoneEmptyState
label="Drop files here or click to upload"
description="Drag and drop your files here"
/>
<DropzoneContent />
</Dropzone>
{error && <p role="alert" className="text-destructive mt-2 text-xs whitespace-pre-line">{error}</p>}
</div>
)
}
Expand All @@ -68,12 +73,16 @@ export const Default: Story = {

function WithConstraintsStory() {
const [files, setFiles] = useState<File[] | undefined>(undefined)
const [error, setError] = useState<string>()
return (
<div className="max-w-md">
<Dropzone
src={files}
onDrop={accepted => setFiles(accepted)}
onError={err => alert(err.message)}
onDrop={(accepted) => {
setFiles(accepted)
setError(undefined)
}}
onError={err => setError(err.message)}
accept={{ 'image/*': ['.png', '.jpg', '.jpeg', '.gif'] }}
maxSize={5 * 1024 * 1024}
maxFiles={3}
Expand All @@ -85,6 +94,7 @@ function WithConstraintsStory() {
/>
<DropzoneContent description="Drag and drop or click to replace" />
</Dropzone>
{error && <p role="alert" className="text-destructive mt-2 text-xs whitespace-pre-line">{error}</p>}
</div>
)
}
Expand Down
60 changes: 60 additions & 0 deletions apps/storybook/stories/features/error-content.stories.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
import type { Meta, StoryObj } from 'storybook-react-rsbuild'
import { ErrorContent, ErrorDescriptionProvider } from '@datum-cloud/datum-ui/error-content'

const RBAC_DENIAL = 'forbidden: User \'jane@example.com\' cannot patch resource "dnsrecordsets" in API group "dns.networking.miloapis.com" in the namespace "default"'

const meta: Meta<typeof ErrorContent> = {
title: 'Features/ErrorContent',
component: ErrorContent,
parameters: {
layout: 'centered',
docs: {
description: {
component:
'Shows an error in plain language: a headline, the next step and actions, with the raw '
+ 'technical text in a collapsed **Error details** section. `describeApiError` writes the '
+ 'headline; wrap the app in `ErrorDescriptionProvider` to change the wording.',
},
},
},
argTypes: {
variant: { control: 'select', options: ['default', 'minimal'] },
},
args: {
variant: 'default',
},
}

export default meta
type Story = StoryObj<typeof ErrorContent>

export const PermissionDenied: Story = {
args: {
error: { kind: 'Status', reason: 'Forbidden', code: 403, message: RBAC_DENIAL, requestId: 'req-7f3a' },
actions: [{ label: 'Retry', onClick: () => {} }],
},
}

export const WithProductAreaLabels: Story = {
render: args => (
<ErrorDescriptionProvider apiGroupLabels={{ 'dns.networking.miloapis.com': 'Networking/DNS' }}>
<ErrorContent {...args} />
</ErrorDescriptionProvider>
),
args: {
error: { kind: 'Status', reason: 'Forbidden', code: 403, message: RBAC_DENIAL },
},
}

export const ReadableMessage: Story = {
args: {
error: new Error('Project is not ready: the quota for load balancers is used up.'),
},
}

export const SessionExpired: Story = {
args: {
error: { kind: 'Status', reason: 'Unauthorized', code: 401, message: 'Unauthorized' },
actions: [{ label: 'Sign in', as: 'link', to: '/login' }],
},
}
5 changes: 5 additions & 0 deletions packages/datum-ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,11 @@
"types": "./dist/components/features/empty-content/index.d.ts",
"default": "./dist/empty-content/index.mjs"
},
"./error-content": {
"source": "./src/components/features/error-content/index.ts",
"types": "./dist/components/features/error-content/index.d.ts",
"default": "./dist/error-content/index.mjs"
},
"./form": {
"source": "./src/components/features/form/index.ts",
"types": "./dist/components/features/form/index.d.ts",
Expand Down
1 change: 1 addition & 0 deletions packages/datum-ui/scripts/exports-manifest.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ export const manifest = [
{ subpath: './dropdown', source: './src/components/features/dropdown/index.ts' },
{ subpath: './dropzone', source: './src/components/features/dropzone/index.ts' },
{ subpath: './empty-content', source: './src/components/features/empty-content/index.ts' },
{ subpath: './error-content', source: './src/components/features/error-content/index.ts' },
{ subpath: './form', source: './src/components/features/form/index.ts' },
{ subpath: './form/adapters/conform', source: './src/components/features/form/adapters/conform/index.ts' },
{ subpath: './form/adapters/rhf', source: './src/components/features/form/adapters/rhf/index.ts' },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@
import type { ColumnDef } from '@tanstack/react-table'
import type { ReactNode } from 'react'
import type { DataTableFeatures } from '../core/features'
import { render, screen } from '@testing-library/react'
import { render, screen, waitFor } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { useEffect } from 'react'
import { describe, expect, it, vi } from 'vitest'
import { DataTableContent } from '../components/content'
import { ClientProvider } from '../core/client-provider'
import { DataTableRenderKeyContext, DataTableStoreContext, TableInstanceContext } from '../core/data-table-context'
import { DataTableRenderKeyContext, DataTableStoreContext, TableInstanceContext, useDataTableStore } from '../core/data-table-context'
import { ServerProvider } from '../core/server-provider'
import { createDataTableStore } from '../core/store'

interface TestRow {
Expand Down Expand Up @@ -305,3 +307,59 @@ describe('dataTableContent loading state', () => {
expect(screen.getByText('No pods found')).toBeInTheDocument()
})
})

describe('dataTableContent load errors', () => {
interface Row { readonly id: string, readonly name: string }
const columns = [{ accessorKey: 'name' as const, header: 'Name' }]
const transform = (response: { items: Row[] }) => ({ data: response.items, hasNextPage: false })
const denied = { kind: 'Status', reason: 'NotFound', code: 404, message: 'gone' }

function renderServer(fetchFn: any, content: ReactNode = <DataTableContent />) {
return render(<ServerProvider columns={columns} fetchFn={fetchFn} transform={transform}>{content}</ServerProvider>)
}

it('shows the error with Retry instead of No results', async () => {
const { container } = renderServer((vi.fn() as any).mockRejectedValue(denied))
expect(await screen.findByText('This item no longer exists.')).toBeInTheDocument()
expect(container.querySelector('[data-slot="dt-error"]')).not.toBeNull()
expect(screen.getByRole('button', { name: 'Retry' })).toBeInTheDocument()
expect(screen.queryByText('No results.')).toBeNull()
})

it('clears the error and shows rows after a successful retry', async () => {
const fetchFn = (vi.fn() as any).mockRejectedValueOnce(denied).mockResolvedValue({ items: [{ id: '1', name: 'Pod A' }] })
const { container } = renderServer(fetchFn)
await userEvent.click(await screen.findByRole('button', { name: 'Retry' }))
expect(await screen.findByText('Pod A')).toBeInTheDocument()
await waitFor(() => expect(container.querySelector('[data-slot="dt-error"]')).toBeNull())
})

it('renders errorContent as a node or a function', async () => {
renderServer((vi.fn() as any).mockRejectedValue(denied), <DataTableContent errorContent="Custom" />)
expect(await screen.findByText('Custom')).toBeInTheDocument()
})

it('passes the error and retry to an errorContent function', async () => {
const fetchFn = (vi.fn() as any).mockRejectedValue(new Error('boom'))
renderServer(fetchFn, <DataTableContent errorContent={(error, retry) => <button type="button" onClick={retry}>{error.message}</button>} />)
await userEvent.click(await screen.findByRole('button', { name: 'boom' }))
await waitFor(() => expect(fetchFn).toHaveBeenCalledTimes(2))
})

it('shows the error without Retry in client mode', async () => {
function FailLocally() {
const store = useDataTableStore()
useEffect(() => store.setError(new Error('local failure')), [store])
return null
}
const { container } = render(
<ClientProvider data={[]} columns={columns}>
<FailLocally />
<DataTableContent />
</ClientProvider>,
)
expect(await screen.findByRole('heading', { name: 'local failure' })).toBeInTheDocument()
expect(container.querySelector('[data-slot="dt-error"]')).not.toBeNull()
expect(screen.queryByRole('button', { name: 'Retry' })).toBeNull()
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -347,4 +347,24 @@ describe('server mode', () => {
store.setData(newData)
expect(store.getSnapshot().filteredData).toBe(newData)
})

it('refetch keeps the current query and notifies', () => {
const store = createDataTableStore({ data: sampleData, mode: 'server' })
store.setSorting([{ id: 'name', desc: true }])
store.setFilter('status', 'active')
store.setSearch('ali')
store.setPageIndex(2)
const listener = vi.fn()
store.subscribe(listener)
const before = store.getSnapshot()
store.refetch()
const after = store.getSnapshot()
expect(listener).toHaveBeenCalled()
expect(after._version).toBeGreaterThan(before._version)
expect(after.refetchToken).toBe(before.refetchToken + 1)
expect(after.pageIndex).toBe(before.pageIndex)
expect(after.sorting).toEqual(before.sorting)
expect(after.filters).toEqual(before.filters)
expect(after.search).toBe(before.search)
})
})
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { act, renderHook } from '@testing-library/react'
import { act, renderHook, waitFor } from '@testing-library/react'
import { describe, expect, it, vi } from 'vitest'
import { useDataTableServer } from '../hooks/use-data-table-server'

Expand Down Expand Up @@ -155,4 +155,23 @@ describe('useDataTableServer', () => {

expect(result.current.store.getSnapshot().filters).toEqual({})
})

it('fetches again with the same arguments on refetch', async () => {
const fetchFn = (vi.fn() as any).mockResolvedValue({ items: [{ id: '1', name: 'Pod A' }] })
const { result } = renderHook(() => useDataTableServer<TestResponse, TestRow>({ columns: testColumns, fetchFn, transform: mockTransform }))
await waitFor(() => expect(fetchFn).toHaveBeenCalledTimes(1))
act(() => result.current.store.refetch())
await waitFor(() => expect(fetchFn).toHaveBeenCalledTimes(2))
expect(fetchFn.mock.calls[1][0]).toEqual(fetchFn.mock.calls[0][0])
})

it('keeps a thrown non-Error value readable and as the cause', async () => {
const thrown = { kind: 'Status', message: 'denied' }
const fetchFn = (vi.fn() as any).mockRejectedValue(thrown)
const { result } = renderHook(() => useDataTableServer<TestResponse, TestRow>({ columns: testColumns, fetchFn, transform: mockTransform }))
await waitFor(() => expect(result.current.store.getSnapshot().error).not.toBeNull())
const error = result.current.store.getSnapshot().error!
expect(error.message).toBe('denied')
expect(error.cause).toBe(thrown)
})
})
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
'use client'

import type { Cell, Row, RowData } from '@tanstack/react-table'
import type { ReactNode } from 'react'
import type { DataTableFeatures } from '../core/features'
import type { ContentProps, InlineContentEntry } from '../types'
import { flexRender } from '@tanstack/react-table'
Expand All @@ -15,7 +16,9 @@ import {
TableHeader,
TableRow,
} from '../../../base/table'
import { ErrorContent } from '../../error-content/error-content'
import { DEFAULT_LOADING_ROWS } from '../constants'
import { useDataTableStore } from '../core/data-table-context'
import { useDataTableInlineContents, useDataTableLoading, useDataTablePagination, useDataTableRows } from '../hooks/use-selectors'

/**
Expand Down Expand Up @@ -92,8 +95,28 @@ function renderInlineContentRow<TData extends RowData>(
)
}

/** The body of a table whose load failed: the app's `errorContent`, or ErrorContent with Retry. */
function renderLoadError(
error: Error,
errorContent: ContentProps['errorContent'],
retry: (() => void) | undefined,
): ReactNode {
if (typeof errorContent === 'function')
return errorContent(error, retry ?? (() => {}))
if (errorContent !== undefined)
return errorContent
return (
<ErrorContent
error={error}
variant="minimal"
actions={retry ? [{ label: 'Retry', onClick: retry }] : undefined}
/>
)
}

export function DataTableContent<TData extends RowData = Record<string, any>>({
emptyMessage,
errorContent,
className,
tableClassName,
headerClassName,
Expand All @@ -106,7 +129,8 @@ export function DataTableContent<TData extends RowData = Record<string, any>>({
onRowClick,
}: ContentProps<TData>) {
const { rows, headerGroups, totalColumns } = useDataTableRows<TData>()
const { isLoading, columnCount } = useDataTableLoading()
const { isLoading, columnCount, error, refetch } = useDataTableLoading()
const isServer = useDataTableStore<TData>().getSnapshot().mode === 'server'
const { pageSize } = useDataTablePagination()
const { inlineContents } = useDataTableInlineContents<TData>()
const openInlineContents = useMemo(() => inlineContents.filter(e => e.open), [inlineContents])
Expand Down Expand Up @@ -186,17 +210,25 @@ export function DataTableContent<TData extends RowData = Record<string, any>>({
</TableRow>
))
)
: (
<TableRow data-slot="dt-row">
<TableCell
colSpan={colSpan}
className="h-24 text-center"
data-slot="dt-empty"
>
{emptyMessage ?? 'No results.'}
</TableCell>
</TableRow>
)}
: error
? (
<TableRow data-slot="dt-row">
<TableCell colSpan={colSpan} className="text-center" data-slot="dt-error">
{renderLoadError(error, errorContent, isServer ? refetch : undefined)}
</TableCell>
</TableRow>
)
: (
<TableRow data-slot="dt-row">
<TableCell
colSpan={colSpan}
className="h-24 text-center"
data-slot="dt-empty"
>
{emptyMessage ?? 'No results.'}
</TableCell>
</TableRow>
)}
</TableBody>
</Table>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ export function createDataTableStore<TData extends RowData>(
mode: options.mode,
isLoading: options.isLoading ?? false,
error: null,
refetchToken: 0,
inlineContents: [],
_version: 0,
}
Expand Down Expand Up @@ -176,6 +177,13 @@ export function createDataTableStore<TData extends RowData>(
setState({ ...state, error })
},

refetch: () => {
// Client tables hold their data already; there is nothing to fetch.
if (state.mode === 'client')
return
setState({ ...state, refetchToken: state.refetchToken + 1 })
},

registerFilter: (column, strategy) => {
const next = new Map(registeredFilters)
next.set(column, strategy)
Expand Down
Loading
Loading