@terreno/admin-frontend 57.2.0 → 57.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.ai/guidelines/core.md +10 -7
- package/README.md +2 -0
- package/dist/AdminScreenPage.d.ts +18 -0
- package/dist/AdminScreenPage.js +35 -0
- package/dist/AdminScreenPage.js.map +1 -0
- package/dist/AdminScreenRouter.js +4 -3
- package/dist/AdminScreenRouter.js.map +1 -1
- package/dist/DocumentStorageBrowser.js +4 -3
- package/dist/DocumentStorageBrowser.js.map +1 -1
- package/dist/comms/CommsDashboardScreen.d.ts +10 -0
- package/dist/comms/CommsDashboardScreen.js +183 -0
- package/dist/comms/CommsDashboardScreen.js.map +1 -0
- package/dist/comms/CommsDashboardScreenWidget.d.ts +4 -0
- package/dist/comms/CommsDashboardScreenWidget.js +11 -0
- package/dist/comms/CommsDashboardScreenWidget.js.map +1 -0
- package/dist/comms/CommsMessageDetail.d.ts +8 -0
- package/dist/comms/CommsMessageDetail.js +50 -0
- package/dist/comms/CommsMessageDetail.js.map +1 -0
- package/dist/comms/CommsStatCard.d.ts +17 -0
- package/dist/comms/CommsStatCard.js +14 -0
- package/dist/comms/CommsStatCard.js.map +1 -0
- package/dist/comms/CommsStatusBadge.d.ts +5 -0
- package/dist/comms/CommsStatusBadge.js +14 -0
- package/dist/comms/CommsStatusBadge.js.map +1 -0
- package/dist/comms/commsDashboardParams.d.ts +17 -0
- package/dist/comms/commsDashboardParams.js +71 -0
- package/dist/comms/commsDashboardParams.js.map +1 -0
- package/dist/comms/commsMessagePayload.d.ts +49 -0
- package/dist/comms/commsMessagePayload.js +43 -0
- package/dist/comms/commsMessagePayload.js.map +1 -0
- package/dist/comms/commsRetrySummary.d.ts +4 -0
- package/dist/comms/commsRetrySummary.js +12 -0
- package/dist/comms/commsRetrySummary.js.map +1 -0
- package/dist/comms/useCommsDashboardApi.d.ts +78 -0
- package/dist/comms/useCommsDashboardApi.js +60 -0
- package/dist/comms/useCommsDashboardApi.js.map +1 -0
- package/dist/comms/useCommsDashboardUrlFilters.d.ts +5 -0
- package/dist/comms/useCommsDashboardUrlFilters.js +16 -0
- package/dist/comms/useCommsDashboardUrlFilters.js.map +1 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +7 -0
- package/dist/index.js.map +1 -1
- package/dist/types.d.ts +2 -0
- package/dist/useAdminBackgroundTask.d.ts +10 -2
- package/dist/useAdminBackgroundTask.js.map +1 -1
- package/dist/useConfigurationApi.d.ts +13 -15
- package/dist/useConfigurationApi.js.map +1 -1
- package/dist/widgets/AIRequestsScreenWidget.js +4 -3
- package/dist/widgets/AIRequestsScreenWidget.js.map +1 -1
- package/dist/widgets/DocumentsScreenWidget.js +2 -2
- package/dist/widgets/DocumentsScreenWidget.js.map +1 -1
- package/dist/widgets/builtInWidgets.js +2 -1
- package/dist/widgets/builtInWidgets.js.map +1 -1
- package/package.json +17 -3
- package/src/AdminActionMenu.test.tsx +1 -1
- package/src/AdminBreadcrumbs.test.tsx +1 -1
- package/src/AdminFieldRenderer.test.tsx +6 -1
- package/src/AdminHome.test.tsx +1 -1
- package/src/AdminModelForm.test.tsx +1 -1
- package/src/AdminModelList.test.tsx +1 -1
- package/src/AdminModelTable.test.tsx +1 -1
- package/src/AdminPrimitiveArrayField.test.tsx +1 -1
- package/src/AdminRolesList.test.tsx +1 -1
- package/src/AdminScreenPage.test.tsx +81 -0
- package/src/AdminScreenPage.tsx +37 -0
- package/src/AdminScreenRouter.test.tsx +2 -1
- package/src/AdminScreenRouter.tsx +18 -5
- package/src/AdminScriptList.test.tsx +1 -1
- package/src/AdminShell.test.tsx +1 -1
- package/src/AdminVersionConfig.test.tsx +1 -1
- package/src/CheckboxListEditor.test.tsx +1 -1
- package/src/ConfigurationScreen.test.tsx +1 -1
- package/src/ConsentFormEditor.test.tsx +1 -1
- package/src/ConsentFormList.test.tsx +1 -1
- package/src/ConsentHistory.test.tsx +1 -1
- package/src/ConsentResponseViewer.test.tsx +1 -1
- package/src/DocumentStorageBrowser.test.tsx +1 -1
- package/src/DocumentStorageBrowser.tsx +10 -3
- package/src/LocaleContentEditor.test.tsx +1 -1
- package/src/adminModelListQueryParams.test.ts +59 -0
- package/src/comms/CommsDashboardScreen.test.tsx +397 -0
- package/src/comms/CommsDashboardScreen.tsx +500 -0
- package/src/comms/CommsDashboardScreenWidget.test.tsx +62 -0
- package/src/comms/CommsDashboardScreenWidget.tsx +20 -0
- package/src/comms/CommsMessageDetail.test.tsx +245 -0
- package/src/comms/CommsMessageDetail.tsx +239 -0
- package/src/comms/CommsStatCard.test.tsx +69 -0
- package/src/comms/CommsStatCard.tsx +60 -0
- package/src/comms/CommsStatusBadge.tsx +14 -0
- package/src/comms/commsDashboardParams.test.ts +75 -0
- package/src/comms/commsDashboardParams.ts +91 -0
- package/src/comms/commsMessagePayload.test.ts +22 -0
- package/src/comms/commsMessagePayload.ts +83 -0
- package/src/comms/commsRetrySummary.ts +10 -0
- package/src/comms/useCommsDashboardApi.test.tsx +144 -0
- package/src/comms/useCommsDashboardApi.tsx +128 -0
- package/src/comms/useCommsDashboardUrlFilters.test.tsx +58 -0
- package/src/comms/useCommsDashboardUrlFilters.tsx +31 -0
- package/src/dynamicHookApi.ts +1 -1
- package/src/index.tsx +14 -0
- package/src/isolated/AdminFieldRenderer.isolated.tsx +1 -1
- package/src/{AdminFilterDrawer.test.tsx → isolated/AdminFilterDrawer.isolated.tsx} +8 -2
- package/src/isolated/AdminNestedArrayField.isolated.tsx +1 -1
- package/src/isolated/AdminObjectPicker.isolated.tsx +1 -1
- package/src/isolated/AdminRefField.isolated.tsx +1 -1
- package/src/isolated/AdminScriptRunModal.isolated.tsx +1 -1
- package/src/isolated/DocumentStorageBrowser.isolated.tsx +1 -1
- package/src/isolated/hooks.isolated.tsx +1 -1
- package/src/types.ts +2 -0
- package/src/useAdminBackgroundTask.ts +7 -5
- package/src/useConfigurationApi.ts +13 -16
- package/src/widgets/AIRequestsScreenWidget.tsx +5 -4
- package/src/widgets/DocumentsScreenWidget.tsx +9 -2
- package/src/widgets/builtInWidgets.ts +2 -0
- package/src/widgets/pluginWidgets.test.tsx +3 -1
|
@@ -0,0 +1,500 @@
|
|
|
1
|
+
import {
|
|
2
|
+
Box,
|
|
3
|
+
Button,
|
|
4
|
+
Card,
|
|
5
|
+
DataTable,
|
|
6
|
+
type DataTableCellData,
|
|
7
|
+
type DataTableColumn,
|
|
8
|
+
DateTimeField,
|
|
9
|
+
Heading,
|
|
10
|
+
IconButton,
|
|
11
|
+
Modal,
|
|
12
|
+
SelectField,
|
|
13
|
+
Spinner,
|
|
14
|
+
Text,
|
|
15
|
+
TextField,
|
|
16
|
+
useToast,
|
|
17
|
+
} from "@terreno/ui";
|
|
18
|
+
import type {Href} from "expo-router";
|
|
19
|
+
import {router} from "expo-router";
|
|
20
|
+
import React, {useCallback, useMemo, useState} from "react";
|
|
21
|
+
import {AdminScreenPage} from "../AdminScreenPage";
|
|
22
|
+
import type {AdminApi} from "../types";
|
|
23
|
+
import {CommsStatCard} from "./CommsStatCard";
|
|
24
|
+
import {CommsStatusBadge} from "./CommsStatusBadge";
|
|
25
|
+
import {type CommsDashboardFilters, withDefaultCommsDashboardDates} from "./commsDashboardParams";
|
|
26
|
+
import {
|
|
27
|
+
type CommsMessageRow,
|
|
28
|
+
commsMessageId,
|
|
29
|
+
formatCommsTimestamp,
|
|
30
|
+
unwrapCommsMessage,
|
|
31
|
+
} from "./commsMessagePayload";
|
|
32
|
+
import {summarizeSkippedReasons} from "./commsRetrySummary";
|
|
33
|
+
import {type CommsStatsResponse, useCommsDashboardApi} from "./useCommsDashboardApi";
|
|
34
|
+
|
|
35
|
+
const LIST_LIMIT = 20;
|
|
36
|
+
const RETRY_MANY_CAP = 100;
|
|
37
|
+
const FAILURE_RATE_ALERT = 0.05;
|
|
38
|
+
const ALL_OPTION = {label: "All", value: ""};
|
|
39
|
+
|
|
40
|
+
const CHANNEL_OPTIONS = [
|
|
41
|
+
ALL_OPTION,
|
|
42
|
+
{label: "Mail", value: "mail"},
|
|
43
|
+
{label: "SMS", value: "sms"},
|
|
44
|
+
{label: "Push", value: "push"},
|
|
45
|
+
{label: "Verification", value: "verification"},
|
|
46
|
+
];
|
|
47
|
+
|
|
48
|
+
const STATUS_OPTIONS = [
|
|
49
|
+
ALL_OPTION,
|
|
50
|
+
{label: "Sent", value: "sent"},
|
|
51
|
+
{label: "Delivered", value: "delivered"},
|
|
52
|
+
{label: "Failed", value: "failed"},
|
|
53
|
+
{label: "Bounced", value: "bounced"},
|
|
54
|
+
{label: "Cancelled", value: "cancelled"},
|
|
55
|
+
];
|
|
56
|
+
|
|
57
|
+
const ERROR_CLASS_OPTIONS = [
|
|
58
|
+
ALL_OPTION,
|
|
59
|
+
{label: "Transient", value: "transient"},
|
|
60
|
+
{label: "Permanent", value: "permanent"},
|
|
61
|
+
{label: "Config", value: "config"},
|
|
62
|
+
];
|
|
63
|
+
|
|
64
|
+
const COLUMNS: DataTableColumn[] = [
|
|
65
|
+
{columnType: "date", title: "Created", width: 160},
|
|
66
|
+
{columnType: "text", title: "Channel", width: 100},
|
|
67
|
+
{columnType: "text", title: "Provider", width: 120},
|
|
68
|
+
{columnType: "text", title: "To", width: 120},
|
|
69
|
+
{columnType: "text", title: "Subject", width: 180},
|
|
70
|
+
{columnType: "commsStatus", title: "Status", width: 110},
|
|
71
|
+
{columnType: "text", title: "Error", width: 100},
|
|
72
|
+
{columnType: "number", title: "Attempts", width: 90},
|
|
73
|
+
{columnType: "commsActions", title: "", width: 88},
|
|
74
|
+
];
|
|
75
|
+
|
|
76
|
+
export interface CommsDashboardScreenProps {
|
|
77
|
+
api: AdminApi;
|
|
78
|
+
filters: CommsDashboardFilters;
|
|
79
|
+
onFiltersChange: (next: CommsDashboardFilters) => void;
|
|
80
|
+
routeBase?: string;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
const percent = (rate: number): string => `${Math.round(rate * 1000) / 10}%`;
|
|
84
|
+
|
|
85
|
+
const StatsCards: React.FC<{stats?: CommsStatsResponse; usingDefaultDateRange: boolean}> = ({
|
|
86
|
+
stats,
|
|
87
|
+
usingDefaultDateRange,
|
|
88
|
+
}) => {
|
|
89
|
+
const totals = stats?.totals;
|
|
90
|
+
const providers = stats?.byProvider ?? [];
|
|
91
|
+
const failed = totals?.failed ?? 0;
|
|
92
|
+
const bounced = totals?.bounced ?? 0;
|
|
93
|
+
const failureRate = totals?.failureRate ?? 0;
|
|
94
|
+
const highFailure = failureRate > FAILURE_RATE_ALERT;
|
|
95
|
+
return (
|
|
96
|
+
<Box gap={3} testID="comms-dashboard-stats">
|
|
97
|
+
{usingDefaultDateRange ? (
|
|
98
|
+
<Text color="secondaryDark" size="sm" testID="comms-stats-range-label">
|
|
99
|
+
Last 7 days
|
|
100
|
+
</Text>
|
|
101
|
+
) : null}
|
|
102
|
+
<Box alignItems="stretch" direction="row" gap={3} wrap>
|
|
103
|
+
<CommsStatCard label="Sent" testID="comms-stat-sent" value={String(totals?.sent ?? 0)} />
|
|
104
|
+
<CommsStatCard
|
|
105
|
+
label="Delivered"
|
|
106
|
+
testID="comms-stat-delivered"
|
|
107
|
+
value={String(totals?.delivered ?? 0)}
|
|
108
|
+
/>
|
|
109
|
+
<CommsStatCard
|
|
110
|
+
label="Failed"
|
|
111
|
+
testID="comms-stat-failed"
|
|
112
|
+
tone={failed > 0 ? "alert" : "neutral"}
|
|
113
|
+
value={String(failed)}
|
|
114
|
+
/>
|
|
115
|
+
<CommsStatCard
|
|
116
|
+
label="Bounced"
|
|
117
|
+
testID="comms-stat-bounced"
|
|
118
|
+
tone={bounced > 0 ? "alert" : "neutral"}
|
|
119
|
+
value={String(bounced)}
|
|
120
|
+
/>
|
|
121
|
+
<CommsStatCard
|
|
122
|
+
caption={`${failed + bounced} of ${totals?.total ?? 0} messages`}
|
|
123
|
+
label="Failure rate"
|
|
124
|
+
testID="comms-stat-failure-rate"
|
|
125
|
+
tone={highFailure ? "alert" : "neutral"}
|
|
126
|
+
value={percent(failureRate)}
|
|
127
|
+
/>
|
|
128
|
+
</Box>
|
|
129
|
+
{providers.length > 0 ? (
|
|
130
|
+
<Box gap={2}>
|
|
131
|
+
<Text color="secondaryDark" size="sm">
|
|
132
|
+
Failure rate by provider
|
|
133
|
+
</Text>
|
|
134
|
+
<Box alignItems="stretch" direction="row" gap={3} wrap>
|
|
135
|
+
{providers.map((row) => (
|
|
136
|
+
<CommsStatCard
|
|
137
|
+
caption={`${row.failed + row.bounced} of ${row.total} messages`}
|
|
138
|
+
key={row.provider}
|
|
139
|
+
label={row.provider}
|
|
140
|
+
testID={`comms-stat-provider-${row.provider}`}
|
|
141
|
+
tone={row.failureRate > FAILURE_RATE_ALERT ? "alert" : "neutral"}
|
|
142
|
+
value={percent(row.failureRate)}
|
|
143
|
+
/>
|
|
144
|
+
))}
|
|
145
|
+
</Box>
|
|
146
|
+
</Box>
|
|
147
|
+
) : null}
|
|
148
|
+
</Box>
|
|
149
|
+
);
|
|
150
|
+
};
|
|
151
|
+
|
|
152
|
+
export const CommsDashboardScreen: React.FC<CommsDashboardScreenProps> = ({
|
|
153
|
+
api,
|
|
154
|
+
filters,
|
|
155
|
+
onFiltersChange,
|
|
156
|
+
routeBase = "/admin",
|
|
157
|
+
}) => {
|
|
158
|
+
const toast = useToast();
|
|
159
|
+
const [confirmRetryMany, setConfirmRetryMany] = useState(false);
|
|
160
|
+
const {useListQuery, useRetryManyMutation, useRetryMutation, useStatsQuery} =
|
|
161
|
+
useCommsDashboardApi(api);
|
|
162
|
+
const page = filters.page ?? 1;
|
|
163
|
+
const queryFilters = useMemo(() => withDefaultCommsDashboardDates(filters), [filters]);
|
|
164
|
+
const usingDefaultDateRange = !filters.startDate && !filters.endDate;
|
|
165
|
+
const listParams = useMemo(
|
|
166
|
+
() => ({
|
|
167
|
+
channel: queryFilters.channel,
|
|
168
|
+
endDate: queryFilters.endDate,
|
|
169
|
+
errorClass: queryFilters.errorClass,
|
|
170
|
+
limit: LIST_LIMIT,
|
|
171
|
+
page,
|
|
172
|
+
provider: queryFilters.provider,
|
|
173
|
+
q: queryFilters.q,
|
|
174
|
+
startDate: queryFilters.startDate,
|
|
175
|
+
status: queryFilters.status,
|
|
176
|
+
}),
|
|
177
|
+
[page, queryFilters]
|
|
178
|
+
);
|
|
179
|
+
const {data, error, isLoading} = useListQuery(listParams);
|
|
180
|
+
const {data: stats} = useStatsQuery({
|
|
181
|
+
channel: queryFilters.channel,
|
|
182
|
+
endDate: queryFilters.endDate,
|
|
183
|
+
errorClass: queryFilters.errorClass,
|
|
184
|
+
provider: queryFilters.provider,
|
|
185
|
+
q: queryFilters.q,
|
|
186
|
+
startDate: queryFilters.startDate,
|
|
187
|
+
status: queryFilters.status,
|
|
188
|
+
});
|
|
189
|
+
const [retryMessage] = useRetryMutation();
|
|
190
|
+
const [retryMany, retryManyState] = useRetryManyMutation();
|
|
191
|
+
const rows = data?.data ?? [];
|
|
192
|
+
const total = data?.total ?? 0;
|
|
193
|
+
const retryableCount = Math.min(
|
|
194
|
+
RETRY_MANY_CAP,
|
|
195
|
+
rows.filter((row) => row.retryable).length + (data?.more ? RETRY_MANY_CAP : 0)
|
|
196
|
+
);
|
|
197
|
+
const confirmationCount = Math.min(RETRY_MANY_CAP, total);
|
|
198
|
+
const hasActiveFilters = Boolean(
|
|
199
|
+
filters.channel ||
|
|
200
|
+
filters.endDate ||
|
|
201
|
+
filters.errorClass ||
|
|
202
|
+
filters.provider ||
|
|
203
|
+
filters.q ||
|
|
204
|
+
filters.startDate ||
|
|
205
|
+
filters.status
|
|
206
|
+
);
|
|
207
|
+
|
|
208
|
+
/** One handler shape for every filter control; changing a filter resets to page 1.
|
|
209
|
+
* Spread applied query filters so implicit 7-day bounds stay when one field changes. */
|
|
210
|
+
const filterSetter = useCallback(
|
|
211
|
+
(key: keyof CommsDashboardFilters) =>
|
|
212
|
+
(value: string): void => {
|
|
213
|
+
onFiltersChange({
|
|
214
|
+
...queryFilters,
|
|
215
|
+
page: 1,
|
|
216
|
+
[key]: value || undefined,
|
|
217
|
+
});
|
|
218
|
+
},
|
|
219
|
+
[onFiltersChange, queryFilters]
|
|
220
|
+
);
|
|
221
|
+
|
|
222
|
+
const openMessage = useCallback(
|
|
223
|
+
(id: string): void => {
|
|
224
|
+
router.push(`${routeBase}/comms/${id}` as Href);
|
|
225
|
+
},
|
|
226
|
+
[routeBase]
|
|
227
|
+
);
|
|
228
|
+
|
|
229
|
+
const clearFilters = useCallback((): void => {
|
|
230
|
+
onFiltersChange({page: 1});
|
|
231
|
+
}, [onFiltersChange]);
|
|
232
|
+
|
|
233
|
+
const handleRetry = useCallback(
|
|
234
|
+
async (id: string): Promise<void> => {
|
|
235
|
+
try {
|
|
236
|
+
const result = await retryMessage(id).unwrap();
|
|
237
|
+
const created = unwrapCommsMessage(result);
|
|
238
|
+
if (!created) {
|
|
239
|
+
throw new Error("Retry did not return a message");
|
|
240
|
+
}
|
|
241
|
+
openMessage(commsMessageId(created));
|
|
242
|
+
} catch (retryError: unknown) {
|
|
243
|
+
toast.catch(retryError, "Retry failed");
|
|
244
|
+
}
|
|
245
|
+
},
|
|
246
|
+
[openMessage, retryMessage, toast]
|
|
247
|
+
);
|
|
248
|
+
|
|
249
|
+
const handleRetryMany = useCallback(async (): Promise<void> => {
|
|
250
|
+
try {
|
|
251
|
+
const result = await retryMany({
|
|
252
|
+
channel: queryFilters.channel,
|
|
253
|
+
endDate: queryFilters.endDate,
|
|
254
|
+
errorClass: queryFilters.errorClass,
|
|
255
|
+
limit: RETRY_MANY_CAP,
|
|
256
|
+
provider: queryFilters.provider,
|
|
257
|
+
q: queryFilters.q,
|
|
258
|
+
startDate: queryFilters.startDate,
|
|
259
|
+
status: queryFilters.status,
|
|
260
|
+
}).unwrap();
|
|
261
|
+
setConfirmRetryMany(false);
|
|
262
|
+
toast.success(
|
|
263
|
+
`Retried ${result.retried.length}. Skipped ${result.skipped.length}: ${summarizeSkippedReasons(result.skipped)}.`
|
|
264
|
+
);
|
|
265
|
+
} catch (retryError: unknown) {
|
|
266
|
+
toast.catch(retryError, "Bulk retry failed");
|
|
267
|
+
}
|
|
268
|
+
}, [queryFilters, retryMany, toast]);
|
|
269
|
+
|
|
270
|
+
const tableData = useMemo((): DataTableCellData[][] => {
|
|
271
|
+
return rows.map((row: CommsMessageRow) => [
|
|
272
|
+
{value: formatCommsTimestamp({value: row.created})},
|
|
273
|
+
{value: row.channel},
|
|
274
|
+
{value: row.provider},
|
|
275
|
+
{value: row.to},
|
|
276
|
+
{value: row.subject ?? ""},
|
|
277
|
+
{value: row.status},
|
|
278
|
+
{value: row.errorCode ?? ""},
|
|
279
|
+
{value: row.attemptCount ?? 0},
|
|
280
|
+
{
|
|
281
|
+
value: {
|
|
282
|
+
onOpen: () => openMessage(commsMessageId(row)),
|
|
283
|
+
// Always supplied; `disabled` is what stops a non-retryable row from firing it.
|
|
284
|
+
onRetry: () => handleRetry(commsMessageId(row)),
|
|
285
|
+
retryable: row.retryable === true,
|
|
286
|
+
retryDisabledReason: row.retryDisabledReason,
|
|
287
|
+
},
|
|
288
|
+
},
|
|
289
|
+
]);
|
|
290
|
+
}, [handleRetry, openMessage, rows]);
|
|
291
|
+
|
|
292
|
+
const customColumnComponentMap = useMemo(
|
|
293
|
+
() => ({
|
|
294
|
+
commsActions: ({cellData}: {cellData: DataTableCellData}) => {
|
|
295
|
+
const value = cellData.value as {
|
|
296
|
+
onOpen: () => void;
|
|
297
|
+
onRetry: () => void;
|
|
298
|
+
retryDisabledReason?: string;
|
|
299
|
+
retryable: boolean;
|
|
300
|
+
};
|
|
301
|
+
return (
|
|
302
|
+
<Box direction="row" gap={1}>
|
|
303
|
+
<IconButton
|
|
304
|
+
accessibilityLabel="Open message"
|
|
305
|
+
iconName="eye"
|
|
306
|
+
onClick={value.onOpen}
|
|
307
|
+
testID="comms-row-open"
|
|
308
|
+
variant="muted"
|
|
309
|
+
/>
|
|
310
|
+
<IconButton
|
|
311
|
+
accessibilityLabel={
|
|
312
|
+
value.retryable ? "Retry message" : (value.retryDisabledReason ?? "Retry")
|
|
313
|
+
}
|
|
314
|
+
disabled={!value.retryable}
|
|
315
|
+
iconName="rotate"
|
|
316
|
+
onClick={value.onRetry}
|
|
317
|
+
testID="comms-row-retry"
|
|
318
|
+
tooltipText={value.retryable ? "Retry" : value.retryDisabledReason}
|
|
319
|
+
variant="muted"
|
|
320
|
+
withConfirmation={value.retryable}
|
|
321
|
+
/>
|
|
322
|
+
</Box>
|
|
323
|
+
);
|
|
324
|
+
},
|
|
325
|
+
commsStatus: ({cellData}: {cellData: DataTableCellData}) => (
|
|
326
|
+
<CommsStatusBadge status={String(cellData.value ?? "")} />
|
|
327
|
+
),
|
|
328
|
+
}),
|
|
329
|
+
[]
|
|
330
|
+
);
|
|
331
|
+
|
|
332
|
+
return (
|
|
333
|
+
<AdminScreenPage
|
|
334
|
+
backHref={routeBase}
|
|
335
|
+
color="transparent"
|
|
336
|
+
maxWidth="100%"
|
|
337
|
+
padding={0}
|
|
338
|
+
scroll
|
|
339
|
+
title="Comms"
|
|
340
|
+
>
|
|
341
|
+
<Box gap={4} padding={4} testID="comms-dashboard">
|
|
342
|
+
<StatsCards stats={stats} usingDefaultDateRange={usingDefaultDateRange} />
|
|
343
|
+
<Card padding={4}>
|
|
344
|
+
<Box gap={4}>
|
|
345
|
+
<Box alignItems="center" direction="row" gap={3} justifyContent="between" wrap>
|
|
346
|
+
<Box gap={1}>
|
|
347
|
+
<Heading size="sm">Filter delivery logs</Heading>
|
|
348
|
+
<Text color="secondaryDark" size="sm">
|
|
349
|
+
Narrow results by delivery state, provider, recipient, or date.
|
|
350
|
+
</Text>
|
|
351
|
+
</Box>
|
|
352
|
+
{hasActiveFilters ? (
|
|
353
|
+
<Button
|
|
354
|
+
onClick={clearFilters}
|
|
355
|
+
testID="comms-clear-filters"
|
|
356
|
+
text="Clear filters"
|
|
357
|
+
variant="muted"
|
|
358
|
+
/>
|
|
359
|
+
) : null}
|
|
360
|
+
</Box>
|
|
361
|
+
<Box alignItems="stretch" direction="row" gap={3} wrap>
|
|
362
|
+
<Box flex="grow" minWidth={150}>
|
|
363
|
+
<SelectField
|
|
364
|
+
onChange={filterSetter("channel")}
|
|
365
|
+
options={CHANNEL_OPTIONS}
|
|
366
|
+
testID="comms-filter-channel"
|
|
367
|
+
title="Channel"
|
|
368
|
+
value={filters.channel ?? ""}
|
|
369
|
+
/>
|
|
370
|
+
</Box>
|
|
371
|
+
<Box flex="grow" minWidth={150}>
|
|
372
|
+
<TextField
|
|
373
|
+
onChange={filterSetter("provider")}
|
|
374
|
+
testID="comms-filter-provider"
|
|
375
|
+
title="Provider"
|
|
376
|
+
value={filters.provider ?? ""}
|
|
377
|
+
/>
|
|
378
|
+
</Box>
|
|
379
|
+
<Box flex="grow" minWidth={150}>
|
|
380
|
+
<SelectField
|
|
381
|
+
onChange={filterSetter("status")}
|
|
382
|
+
options={STATUS_OPTIONS}
|
|
383
|
+
testID="comms-filter-status"
|
|
384
|
+
title="Status"
|
|
385
|
+
value={filters.status ?? ""}
|
|
386
|
+
/>
|
|
387
|
+
</Box>
|
|
388
|
+
<Box flex="grow" minWidth={150}>
|
|
389
|
+
<SelectField
|
|
390
|
+
onChange={filterSetter("errorClass")}
|
|
391
|
+
options={ERROR_CLASS_OPTIONS}
|
|
392
|
+
testID="comms-filter-error-class"
|
|
393
|
+
title="Error class"
|
|
394
|
+
value={filters.errorClass ?? ""}
|
|
395
|
+
/>
|
|
396
|
+
</Box>
|
|
397
|
+
<Box flex="grow" minWidth={220}>
|
|
398
|
+
<TextField
|
|
399
|
+
iconName="magnifying-glass"
|
|
400
|
+
onChange={filterSetter("q")}
|
|
401
|
+
testID="comms-filter-q"
|
|
402
|
+
title="Search"
|
|
403
|
+
value={filters.q ?? ""}
|
|
404
|
+
/>
|
|
405
|
+
</Box>
|
|
406
|
+
</Box>
|
|
407
|
+
<Box alignItems="stretch" direction="row" gap={3} wrap>
|
|
408
|
+
<Box flex="grow" minWidth={280}>
|
|
409
|
+
<DateTimeField
|
|
410
|
+
onChange={filterSetter("startDate")}
|
|
411
|
+
testID="comms-filter-start"
|
|
412
|
+
title="Start"
|
|
413
|
+
type="datetime"
|
|
414
|
+
value={queryFilters.startDate ?? ""}
|
|
415
|
+
/>
|
|
416
|
+
</Box>
|
|
417
|
+
<Box flex="grow" minWidth={280}>
|
|
418
|
+
<DateTimeField
|
|
419
|
+
onChange={filterSetter("endDate")}
|
|
420
|
+
testID="comms-filter-end"
|
|
421
|
+
title="End"
|
|
422
|
+
type="datetime"
|
|
423
|
+
value={queryFilters.endDate ?? ""}
|
|
424
|
+
/>
|
|
425
|
+
</Box>
|
|
426
|
+
</Box>
|
|
427
|
+
</Box>
|
|
428
|
+
</Card>
|
|
429
|
+
<Box alignItems="center" direction="row" gap={3} justifyContent="between" wrap>
|
|
430
|
+
<Box gap={1}>
|
|
431
|
+
<Heading size="sm">Delivery log</Heading>
|
|
432
|
+
<Text color="secondaryDark" size="sm" testID="comms-result-count">
|
|
433
|
+
{`${total} matching message${total === 1 ? "" : "s"}`}
|
|
434
|
+
</Text>
|
|
435
|
+
</Box>
|
|
436
|
+
<Button
|
|
437
|
+
disabled={total === 0}
|
|
438
|
+
onClick={() => setConfirmRetryMany(true)}
|
|
439
|
+
testID="comms-retry-many"
|
|
440
|
+
text="Retry matching"
|
|
441
|
+
variant="secondary"
|
|
442
|
+
/>
|
|
443
|
+
</Box>
|
|
444
|
+
{isLoading ? (
|
|
445
|
+
<Box alignItems="center" padding={6} testID="comms-dashboard-loading">
|
|
446
|
+
<Spinner />
|
|
447
|
+
</Box>
|
|
448
|
+
) : null}
|
|
449
|
+
{error ? (
|
|
450
|
+
<Text color="error" testID="comms-dashboard-error">
|
|
451
|
+
Failed to load delivery logs.
|
|
452
|
+
</Text>
|
|
453
|
+
) : null}
|
|
454
|
+
{!isLoading && !error && rows.length === 0 ? (
|
|
455
|
+
<Card padding={6} testID="comms-dashboard-empty">
|
|
456
|
+
<Box alignItems="center" gap={2}>
|
|
457
|
+
<Heading size="sm">No delivery logs found</Heading>
|
|
458
|
+
<Text color="secondaryDark">
|
|
459
|
+
{hasActiveFilters
|
|
460
|
+
? "Clear or adjust the filters to see more messages."
|
|
461
|
+
: "Delivery activity will appear here as messages are sent."}
|
|
462
|
+
</Text>
|
|
463
|
+
</Box>
|
|
464
|
+
</Card>
|
|
465
|
+
) : null}
|
|
466
|
+
{!isLoading && !error && rows.length > 0 ? (
|
|
467
|
+
<DataTable
|
|
468
|
+
columns={COLUMNS}
|
|
469
|
+
customColumnComponentMap={customColumnComponentMap}
|
|
470
|
+
data={tableData}
|
|
471
|
+
page={page}
|
|
472
|
+
setPage={(nextPage) => onFiltersChange({...filters, page: nextPage})}
|
|
473
|
+
testID="comms-dashboard-table"
|
|
474
|
+
totalPages={Math.max(1, Math.ceil(total / LIST_LIMIT))}
|
|
475
|
+
/>
|
|
476
|
+
) : null}
|
|
477
|
+
</Box>
|
|
478
|
+
<Modal
|
|
479
|
+
onDismiss={() => setConfirmRetryMany(false)}
|
|
480
|
+
primaryButtonOnClick={handleRetryMany}
|
|
481
|
+
primaryButtonText="Retry"
|
|
482
|
+
secondaryButtonOnClick={() => setConfirmRetryMany(false)}
|
|
483
|
+
secondaryButtonText="Cancel"
|
|
484
|
+
testID="comms-retry-many-modal"
|
|
485
|
+
title="Retry matching messages"
|
|
486
|
+
visible={confirmRetryMany}
|
|
487
|
+
>
|
|
488
|
+
<Box gap={2}>
|
|
489
|
+
<Text testID="comms-retry-many-count">
|
|
490
|
+
{`Retry ${confirmationCount} matching message${confirmationCount === 1 ? "" : "s"} (cap ${RETRY_MANY_CAP})?`}
|
|
491
|
+
</Text>
|
|
492
|
+
{retryManyState.isLoading ? <Spinner /> : null}
|
|
493
|
+
<Text color="secondaryDark" size="sm">
|
|
494
|
+
{`Current page has ${retryableCount} retryable row${retryableCount === 1 ? "" : "s"}.`}
|
|
495
|
+
</Text>
|
|
496
|
+
</Box>
|
|
497
|
+
</Modal>
|
|
498
|
+
</AdminScreenPage>
|
|
499
|
+
);
|
|
500
|
+
};
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import {describe, expect, it, mock} from "bun:test";
|
|
2
|
+
import React from "react";
|
|
3
|
+
import {renderWithTheme} from "../../../ui/src/test-utils";
|
|
4
|
+
import type {AdminApi, AdminConfigResponse} from "../types";
|
|
5
|
+
|
|
6
|
+
const replaceMock = mock(() => {});
|
|
7
|
+
const searchParams: Record<string, string> = {channel: "mail"};
|
|
8
|
+
|
|
9
|
+
mock.module("expo-router", () => ({
|
|
10
|
+
router: {push: mock(() => {}), replace: replaceMock},
|
|
11
|
+
useLocalSearchParams: () => searchParams,
|
|
12
|
+
}));
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Stands in for the host RTK Query API so the real `useCommsDashboardApi` runs.
|
|
16
|
+
* Mocking that module instead would leak process-wide and make the suite order-dependent.
|
|
17
|
+
*/
|
|
18
|
+
const createCommsApi = (): AdminApi => {
|
|
19
|
+
const api = {
|
|
20
|
+
enhanceEndpoints: () => api,
|
|
21
|
+
injectEndpoints: () => ({
|
|
22
|
+
useCommsDashboardDetailQuery: () => ({isLoading: false}),
|
|
23
|
+
useCommsDashboardListQuery: () => ({
|
|
24
|
+
data: {data: [], more: false, page: 1, total: 0},
|
|
25
|
+
isLoading: false,
|
|
26
|
+
}),
|
|
27
|
+
useCommsDashboardRetryManyMutation: () => [
|
|
28
|
+
() => ({unwrap: async () => ({retried: [], skipped: []})}),
|
|
29
|
+
{isLoading: false},
|
|
30
|
+
],
|
|
31
|
+
useCommsDashboardRetryMutation: () => [
|
|
32
|
+
() => ({unwrap: async () => ({data: {_id: "x"}})}),
|
|
33
|
+
{isLoading: false},
|
|
34
|
+
],
|
|
35
|
+
useCommsDashboardStatsQuery: () => ({isLoading: false}),
|
|
36
|
+
}),
|
|
37
|
+
};
|
|
38
|
+
return api as unknown as AdminApi;
|
|
39
|
+
};
|
|
40
|
+
|
|
41
|
+
import {COMMS_ADMIN_WIDGETS, CommsDashboardScreenWidget} from "./CommsDashboardScreenWidget";
|
|
42
|
+
|
|
43
|
+
const emptyConfig: AdminConfigResponse = {customScreens: [], models: [], scripts: []};
|
|
44
|
+
|
|
45
|
+
describe("CommsDashboardScreenWidget", () => {
|
|
46
|
+
it("registers as the comms custom screen widget", () => {
|
|
47
|
+
expect(COMMS_ADMIN_WIDGETS.comms).toBe(CommsDashboardScreenWidget);
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
it("reads URL filters into the dashboard", () => {
|
|
51
|
+
const {getByTestId} = renderWithTheme(
|
|
52
|
+
<CommsDashboardScreenWidget
|
|
53
|
+
api={createCommsApi()}
|
|
54
|
+
config={emptyConfig}
|
|
55
|
+
routeBase="/admin"
|
|
56
|
+
screenName="comms"
|
|
57
|
+
/>
|
|
58
|
+
);
|
|
59
|
+
expect(getByTestId("comms-dashboard")).toBeTruthy();
|
|
60
|
+
expect(getByTestId("comms-filter-channel.label")).toBeTruthy();
|
|
61
|
+
});
|
|
62
|
+
});
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import type {AdminScreenWidgetProps, ScreenWidgetComponent} from "../types";
|
|
3
|
+
import {CommsDashboardScreen} from "./CommsDashboardScreen";
|
|
4
|
+
import {useCommsDashboardUrlFilters} from "./useCommsDashboardUrlFilters";
|
|
5
|
+
|
|
6
|
+
export const CommsDashboardScreenWidget: React.FC<AdminScreenWidgetProps> = ({api, routeBase}) => {
|
|
7
|
+
const {filters, onFiltersChange} = useCommsDashboardUrlFilters(routeBase);
|
|
8
|
+
return (
|
|
9
|
+
<CommsDashboardScreen
|
|
10
|
+
api={api}
|
|
11
|
+
filters={filters}
|
|
12
|
+
onFiltersChange={onFiltersChange}
|
|
13
|
+
routeBase={routeBase}
|
|
14
|
+
/>
|
|
15
|
+
);
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
export const COMMS_ADMIN_WIDGETS: Record<string, ScreenWidgetComponent> = {
|
|
19
|
+
comms: CommsDashboardScreenWidget,
|
|
20
|
+
};
|