-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathDatasetReportRenderer.test.tsx
More file actions
277 lines (261 loc) · 12.7 KB
/
Copy pathDatasetReportRenderer.test.tsx
File metadata and controls
277 lines (261 loc) · 12.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
/**
* DatasetReportRenderer tests (ADR-0021 single-form).
*
* Covers:
* - isDatasetReport guard (dataset-bound report / joined-with-dataset-blocks)
* - summary report → grouped table via dataSource.queryDataset
* - joined report → one dataset-bound table per block
* - report-level runtimeFilter merged into the dataset query
* - missing queryDataset → a clear error instead of a blank
* - matrix → true rows × columns cross-tab (ADR-0021 D2)
* - matrix totals: requests `totals.groupings` [rows, columns, []] and
* renders the SERVER-supplied subtotals/grand total; no totals in the
* response (older server) → no totals UI (never re-aggregated client-side)
* - drill-down: clickable rows/cells emit {dataset, groupKey, runtimeFilter}
*/
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { render, screen, fireEvent, waitFor } from '@testing-library/react';
import '@testing-library/jest-dom';
import { DatasetReportRenderer, isDatasetReport } from '../DatasetReportRenderer';
type MockRows = Array<Record<string, unknown>>;
type MockResult = { rows: MockRows; totals?: Array<{ dimensions: string[]; rows: MockRows }> };
function makeSource(byDataset: Record<string, MockRows | MockResult>) {
const calls: Array<{ dataset: string; selection: any }> = [];
return {
calls,
queryDataset: vi.fn(async (dataset: string, selection: unknown) => {
calls.push({ dataset, selection: selection as any });
const entry = byDataset[dataset];
if (Array.isArray(entry)) return { rows: entry };
return { rows: entry?.rows ?? [], ...(entry?.totals ? { totals: entry.totals } : {}) };
}),
};
}
describe('isDatasetReport', () => {
it('matches a report bound to a dataset', () => {
expect(isDatasetReport({ name: 'r', dataset: 'task_metrics', values: ['c'] })).toBe(true);
});
it('matches a joined report whose blocks are dataset-bound', () => {
expect(isDatasetReport({ type: 'joined', blocks: [{ dataset: 'task_metrics', values: ['c'] }] })).toBe(true);
});
it('does not match a legacy object-bound report', () => {
expect(isDatasetReport({ name: 'r', objectName: 'task', columns: [{ field: 'x' }] })).toBe(false);
expect(isDatasetReport(null)).toBe(false);
});
});
describe('DatasetReportRenderer', () => {
beforeEach(() => vi.clearAllMocks());
it('renders a summary report as a grouped table', async () => {
const src = makeSource({ task_metrics: [{ status: 'Backlog', est_hours: 30 }, { status: 'Done', est_hours: 24 }] });
render(
<DatasetReportRenderer
report={{ name: 'hours', type: 'summary', dataset: 'task_metrics', rows: ['status'], values: ['est_hours'] }}
dataSource={src}
/>,
);
await waitFor(() => expect(screen.getByText('Backlog')).toBeInTheDocument());
expect(screen.getByText('Done')).toBeInTheDocument();
expect(screen.getByText('30')).toBeInTheDocument();
// headers are the row + value names
expect(screen.getByText('status')).toBeInTheDocument();
expect(screen.getByText('est_hours')).toBeInTheDocument();
expect(src.queryDataset).toHaveBeenCalledWith('task_metrics', expect.objectContaining({
dimensions: ['status'], measures: ['est_hours'],
}));
});
it('renders a joined report as one table per block', async () => {
const src = makeSource({ task_metrics: [{ status: 'To Do', task_count: 4 }] });
render(
<DatasetReportRenderer
report={{
name: 'overview', type: 'joined',
blocks: [
{ name: 'open_block', label: 'Open Tasks', dataset: 'task_metrics', rows: ['status'], values: ['task_count'], runtimeFilter: { done: false } },
{ name: 'done_block', label: 'Completed Tasks', dataset: 'task_metrics', rows: ['status'], values: ['task_count'], runtimeFilter: { done: true } },
],
}}
dataSource={src}
/>,
);
await waitFor(() => expect(screen.getByText('Open Tasks')).toBeInTheDocument());
expect(screen.getByText('Completed Tasks')).toBeInTheDocument();
expect(screen.getAllByTestId('dataset-report-block')).toHaveLength(2);
// each block forwards its own runtimeFilter
expect(src.queryDataset).toHaveBeenCalledWith('task_metrics', expect.objectContaining({ runtimeFilter: { done: false } }));
expect(src.queryDataset).toHaveBeenCalledWith('task_metrics', expect.objectContaining({ runtimeFilter: { done: true } }));
});
it('merges the report-level runtimeFilter into the dataset query', async () => {
const src = makeSource({ task_metrics: [{ status: 'Backlog', task_count: 1 }] });
render(
<DatasetReportRenderer
report={{ name: 'r', type: 'summary', dataset: 'task_metrics', rows: ['status'], values: ['task_count'] }}
dataSource={src}
runtimeFilter={{ owner: 'me' }}
/>,
);
await waitFor(() => expect(src.queryDataset).toHaveBeenCalled());
expect(src.calls[0].selection.runtimeFilter).toMatchObject({ owner: 'me' });
});
it('pivots a matrix report into a rows × columns cross-tab (ADR-0021 D2)', async () => {
const src = makeSource({
task_metrics: [
{ status: 'Backlog', priority: 'High', est_hours: 10 },
{ status: 'Backlog', priority: 'Low', est_hours: 20 },
{ status: 'Done', priority: 'High', est_hours: 14 },
],
});
render(
<DatasetReportRenderer
report={{ name: 'm', type: 'matrix', dataset: 'task_metrics', rows: ['status'], columns: ['priority'], values: ['est_hours'] }}
dataSource={src}
/>,
);
await waitFor(() => expect(screen.getByTestId('dataset-matrix')).toBeInTheDocument());
// One query over ALL dimensions (down + across).
expect(src.queryDataset).toHaveBeenCalledWith('task_metrics', expect.objectContaining({
dimensions: ['status', 'priority'], measures: ['est_hours'],
}));
// Across buckets become column headers (single measure → bucket label only).
expect(screen.getByRole('columnheader', { name: 'High' })).toBeInTheDocument();
expect(screen.getByRole('columnheader', { name: 'Low' })).toBeInTheDocument();
// Cells land at row × column intersections; missing pairs render '—'.
expect(screen.getByText('10')).toBeInTheDocument();
expect(screen.getByText('20')).toBeInTheDocument();
expect(screen.getByText('14')).toBeInTheDocument();
expect(screen.getByText('—')).toBeInTheDocument(); // Done × Low has no bucket
});
it('matrix requests server-side totals groupings: [rows, columns, []]', async () => {
const src = makeSource({ task_metrics: [{ status: 'Backlog', priority: 'High', est_hours: 10 }] });
render(
<DatasetReportRenderer
report={{ name: 'm', type: 'matrix', dataset: 'task_metrics', rows: ['status'], columns: ['priority'], values: ['est_hours'] }}
dataSource={src}
/>,
);
await waitFor(() => expect(src.queryDataset).toHaveBeenCalled());
expect(src.calls[0].selection.totals).toEqual({ groupings: [['status'], ['priority'], []] });
});
it('matrix renders server-supplied totals: row subtotal column, totals row, grand total', async () => {
const src = makeSource({
task_metrics: {
rows: [
{ status: 'Backlog', priority: 'High', est_hours: 10 },
{ status: 'Backlog', priority: 'Low', est_hours: 20 },
{ status: 'Done', priority: 'High', est_hours: 14 },
],
totals: [
{ dimensions: ['status'], rows: [{ status: 'Backlog', est_hours: 30 }, { status: 'Done', est_hours: 14 }] },
{ dimensions: ['priority'], rows: [{ priority: 'High', est_hours: 24 }, { priority: 'Low', est_hours: 20 }] },
{ dimensions: [], rows: [{ est_hours: 44 }] },
],
},
});
render(
<DatasetReportRenderer
report={{ name: 'm', type: 'matrix', dataset: 'task_metrics', rows: ['status'], columns: ['priority'], values: ['est_hours'] }}
dataSource={src}
/>,
);
await waitFor(() => expect(screen.getByTestId('dataset-matrix')).toBeInTheDocument());
// Trailing "Total" column header (single measure → plain label).
expect(screen.getByTestId('matrix-total-col-header')).toHaveTextContent('Total');
// Per-row subtotals, matched to row headers by bucketId.
expect(screen.getAllByTestId('matrix-row-total').map((el) => el.textContent)).toEqual(['30', '14']);
// Totals row: per-column subtotals in cellCols order (High, Low).
const totalRow = screen.getByTestId('matrix-total-row');
expect(totalRow).toHaveTextContent('Total');
expect(totalRow).toHaveTextContent('24');
expect(totalRow).toHaveTextContent('20');
// Grand total ([] grouping) sits at the totals row × Total column corner.
expect(screen.getByTestId('matrix-grand-total')).toHaveTextContent('44');
});
it('matrix degrades gracefully when the server returns no totals (older server)', async () => {
const src = makeSource({
task_metrics: [
{ status: 'Backlog', priority: 'High', est_hours: 10 },
{ status: 'Done', priority: 'High', est_hours: 14 },
],
});
render(
<DatasetReportRenderer
report={{ name: 'm', type: 'matrix', dataset: 'task_metrics', rows: ['status'], columns: ['priority'], values: ['est_hours'] }}
dataSource={src}
/>,
);
await waitFor(() => expect(screen.getByTestId('dataset-matrix')).toBeInTheDocument());
expect(screen.queryByTestId('matrix-total-col-header')).not.toBeInTheDocument();
expect(screen.queryByTestId('matrix-row-total')).not.toBeInTheDocument();
expect(screen.queryByTestId('matrix-total-row')).not.toBeInTheDocument();
expect(screen.queryByTestId('matrix-grand-total')).not.toBeInTheDocument();
});
it('matrix without `columns` degrades to the flat grouped table', async () => {
const src = makeSource({ task_metrics: [{ status: 'Backlog', priority: 'High', est_hours: 10 }] });
render(
<DatasetReportRenderer
report={{ name: 'm', type: 'matrix', dataset: 'task_metrics', rows: ['status', 'priority'], values: ['est_hours'] }}
dataSource={src}
/>,
);
await waitFor(() => expect(screen.getByText('Backlog')).toBeInTheDocument());
expect(screen.queryByTestId('dataset-matrix')).not.toBeInTheDocument();
});
it('drill: clicking a grouped row emits dataset + dimension groupKey + scope filter', async () => {
const src = makeSource({ task_metrics: [{ status: 'Backlog', est_hours: 30 }] });
const onDrill = vi.fn();
render(
<DatasetReportRenderer
report={{ name: 'r', type: 'summary', dataset: 'task_metrics', rows: ['status'], values: ['est_hours'] }}
dataSource={src}
runtimeFilter={{ owner: 'me' }}
onDrill={onDrill}
/>,
);
await waitFor(() => expect(screen.getByTestId('dataset-drill-row')).toBeInTheDocument());
fireEvent.click(screen.getByTestId('dataset-drill-row'));
expect(onDrill).toHaveBeenCalledWith({
dataset: 'task_metrics',
groupKey: { status: 'Backlog' },
runtimeFilter: { owner: 'me' },
});
});
it('drill: clicking a matrix cell emits row + across dimension values', async () => {
const src = makeSource({ task_metrics: [{ status: 'Backlog', priority: 'High', est_hours: 10 }] });
const onDrill = vi.fn();
render(
<DatasetReportRenderer
report={{ name: 'm', type: 'matrix', dataset: 'task_metrics', rows: ['status'], columns: ['priority'], values: ['est_hours'] }}
dataSource={src}
onDrill={onDrill}
/>,
);
await waitFor(() => expect(screen.getByTestId('dataset-matrix')).toBeInTheDocument());
fireEvent.click(screen.getAllByTestId('dataset-drill-cell')[0]);
expect(onDrill).toHaveBeenCalledWith(expect.objectContaining({
dataset: 'task_metrics',
groupKey: { status: 'Backlog', priority: 'High' },
}));
});
it('drilldown: false disables row clicks even with an onDrill sink', async () => {
const src = makeSource({ task_metrics: [{ status: 'Backlog', est_hours: 30 }] });
const onDrill = vi.fn();
render(
<DatasetReportRenderer
report={{ name: 'r', type: 'summary', dataset: 'task_metrics', rows: ['status'], values: ['est_hours'], drilldown: false }}
dataSource={src}
onDrill={onDrill}
/>,
);
await waitFor(() => expect(screen.getByText('Backlog')).toBeInTheDocument());
expect(screen.queryByTestId('dataset-drill-row')).not.toBeInTheDocument();
});
it('shows an error when the data source cannot run dataset queries', async () => {
render(
<DatasetReportRenderer
report={{ name: 'r', type: 'summary', dataset: 'task_metrics', rows: ['status'], values: ['task_count'] }}
dataSource={{}}
/>,
);
await waitFor(() => expect(screen.getByRole('alert')).toBeInTheDocument());
expect(screen.getByText(/does not support dataset queries/i)).toBeInTheDocument();
});
});