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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488import { useQuery } from "@tanstack/react-query";
import * as API from "aws-amplify/api";
import { useEffect, useId, useRef, useState, ChangeEvent } from "react";
import { Link, useSearchParams } from "react-router-dom";
import * as Tooltip from "@radix-ui/react-tooltip";
import { TbEye, TbEyeX, TbChevronDown, TbChevronUp } from "react-icons/tb";
import { PrismLight as SyntaxHighlighter } from "react-syntax-highlighter";
import jsx from "react-syntax-highlighter/dist/esm/languages/prism/jsx";
import { a11yDark as prism } from "react-syntax-highlighter/dist/esm/styles/prism";
import { StyledButton } from "./StyledButton";
import { StyledLabeledInput } from "./StyledLabeledInput";
import { SkeletonAuditHeader, SkeletonBlockersTable } from "./Skeleton";
import { BlockerUrlsDrawer } from "./BlockerUrlsDrawer";
import { useGlobalStore } from "../utils";
import { useScrollFade } from "#src/utils/useScrollFade.ts";
import { getAccessibilityStandardLabel } from "#src/utils/accessibilityStandardTags.ts";
import { useToggleIgnore } from "../hooks";
import style from "./BlockersRecommendations.module.scss";
SyntaxHighlighter.registerLanguage("jsx", jsx);
const PAGE_SIZE = 10;
const STANDARDS_TO_SHOW = 1;
interface RecommendationTag {
id: string;
content: string;
}
interface Recommendation {
id: string; // representative blocker id
short_id: string;
content_hash_id: string;
occurrences: number;
urlCount: number;
ignored: boolean;
url: string;
type: string;
content: string;
message: string;
category: string;
tags: RecommendationTag[];
}
interface RecommendationsResp {
scan_date: string | null;
stats: {
totalBlockers: number;
uniqueBlockers: number;
activeUniqueBlockers: number;
repeatedBlockers: number;
pagesWithBlockers: number;
filteredUnique: number;
filteredRepeated: number;
filteredSingle: number;
filteredTotalOccurrences: number;
filteredRepeatedOccurrences: number;
};
items: Recommendation[];
pagination: {
page: number;
pageSize: number;
totalCount: number;
totalPages: number;
};
}
interface BlockersRecommendationsProps {
auditId: string;
isShared: boolean;
}
// Renders a blocker's code with a capped height; only shows the fade/toggle
// when the code actually overflows that cap, so short snippets render plainly.
const CodeBlock = ({ content }: { content: string }) => {
const [expanded, setExpanded] = useState(false);
const [overflowing, setOverflowing] = useState(false);
const contentRef = useRef<HTMLDivElement>(null);
const contentId = useId();
useEffect(() => {
const node = contentRef.current;
if (!node) return;
setOverflowing(node.scrollHeight > node.clientHeight + 1);
}, [content]);
return (
<div className={style["code-block"] + (expanded ? " " + style["expanded"] : "")}>
<div className={style["code-content"]} id={contentId} ref={contentRef}>
<SyntaxHighlighter style={prism} language="jsx" className={style["code-highlighter"]}>
{content}
</SyntaxHighlighter>
{!expanded && overflowing && <div className={style["code-fade"]} aria-hidden="true" />}
</div>
{overflowing && (
<StyledButton
onClick={() => setExpanded((e) => !e)}
label={expanded ? "Show less" : "Show more"}
icon={expanded ? <TbChevronUp className="icon-small" /> : <TbChevronDown className="icon-small" />}
variant="naked"
className={style["code-toggle"]}
aria-expanded={expanded}
aria-controls={contentId}
/>
)}
</div>
);
};
export const BlockersRecommendations = ({ auditId, isShared }: BlockersRecommendationsProps) => {
const { setAnnounceMessage, authenticated } = useGlobalStore();
const [searchParams] = useSearchParams();
const [scrollFadeRef, showScrollFade] = useScrollFade();
// Local (not URL) page state so it doesn't collide with the Detailed
// View's ?page= param when a user flips between tabs.
const [page, setPage] = useState(0);
const [status, setStatus] = useState<string>("active");
const [repeat, setRepeat] = useState<"all" | "repeated" | "single">("repeated");
useEffect(() => {
setPage(0);
}, [auditId]);
const toggleIgnoreMutation = useToggleIgnore(auditId);
const { data, isLoading, error } = useQuery({
queryKey: ["auditRecommendations", auditId, page, status, repeat],
queryFn: async () => {
const response = await API.get({
apiName: isShared ? "public" : "auth",
path: "/getAuditRecommendations",
options: {
queryParams: {
id: auditId,
page: page.toString(),
pageSize: PAGE_SIZE.toString(),
status,
repeat,
},
},
}).response;
return (await response.body.json()) as any as RecommendationsResp;
},
placeholderData: (previousData) => previousData,
});
// Announce pagination changes once the requested page has actually loaded.
const announcedPageRef = useRef(page);
useEffect(() => {
if (!data?.pagination) return;
if (announcedPageRef.current !== page) {
setAnnounceMessage(
`Showing ${data.items.length} of ${data.pagination.totalCount} recommendations, page ${page + 1} of ${data.pagination.totalPages}`,
"normal",
true
);
}
announcedPageRef.current = page;
}, [data]);
const handleStatusChange = (value: string) => {
setStatus(value);
setPage(0);
};
const handleRepeatChange = (value: "all" | "repeated" | "single") => {
setRepeat(value);
setPage(0);
};
const getCategoryBlockersLinkSearch = (category: string) => {
const params = new URLSearchParams(searchParams);
params.set("view", "detailed");
params.set("categories", category);
params.delete("page");
return params.toString();
};
const copyToClipboard = async (val: string) => {
try {
await navigator.clipboard.writeText(val);
setAnnounceMessage(`"${val}" copied to clipboard!`, "success");
} catch (err) {
console.error("Failed to copy: ", err);
}
};
if (error) {
return (
<div className={style.BlockersRecommendations}>
<p>Error loading recommendations: {String(error)}</p>
</div>
);
}
if (isLoading || !data) {
return (
<div className={style.BlockersRecommendations}>
<SkeletonAuditHeader />
<SkeletonBlockersTable rows={5} />
</div>
);
}
// Default every stat so a backend that predates a field (e.g. mid-deploy)
// renders zeros instead of throwing inside render and blanking the page.
const stats = {
totalBlockers: data.stats?.totalBlockers ?? 0,
uniqueBlockers: data.stats?.uniqueBlockers ?? 0,
activeUniqueBlockers: data.stats?.activeUniqueBlockers ?? 0,
repeatedBlockers: data.stats?.repeatedBlockers ?? 0,
pagesWithBlockers: data.stats?.pagesWithBlockers ?? 0,
filteredUnique: data.stats?.filteredUnique ?? 0,
filteredRepeated: data.stats?.filteredRepeated ?? 0,
filteredSingle: data.stats?.filteredSingle ?? 0,
filteredTotalOccurrences: data.stats?.filteredTotalOccurrences ?? 0,
filteredRepeatedOccurrences: data.stats?.filteredRepeatedOccurrences ?? 0,
};
// "Fixing these clears 14% of your blockers" for the Repeated block
const repeatedPercent = stats.filteredTotalOccurrences > 0
? Math.round((stats.filteredRepeatedOccurrences / stats.filteredTotalOccurrences) * 100)
: 0;
const repeatedNote = stats.filteredRepeated > 0 && stats.filteredTotalOccurrences > 0
? <>Fixing these clears <strong>{repeatedPercent}%</strong> of your blockers.</>
: null;
const items = data.items ?? [];
const pagination = data.pagination ?? { page: 0, pageSize: PAGE_SIZE, totalCount: 0, totalPages: 0 };
const auditIdNoDash = auditId.replace(/-/g, "");
return (
<div className={style.BlockersRecommendations}>
{/* Stat blocks — these ARE the repeat filter */}
<div className={style["stat-blocks-row"]}>
<div className={style["stat-blocks"]} role="group" aria-label="Filter recommendations by how often they repeat">
{([
// Unique Blockers view disabled — Repeated Blockers is the default/primary view now.
// {
// key: "all",
// count: stats.filteredUnique,
// label: "Unique Blockers",
// description: "Every distinct blocker, counted once, no matter how many pages it appears on.",
// note: null,
// },
{
key: "repeated",
count: stats.filteredRepeated,
label: "Repeated Blockers",
description: "Appear in more than one place. Fix the source once and every copy clears.",
note: repeatedNote,
},
{
key: "single",
count: stats.filteredSingle,
label: "One-off Blockers",
description: "Appear in a single place. Each one is its own fix.",
note: null,
},
] as const).map((block) => (
<button
key={block.key}
type="button"
className={style["stat-block"] + (repeat === block.key ? " " + style["selected"] : "")}
aria-pressed={repeat === block.key}
onClick={() => handleRepeatChange(block.key)}
>
<span className={style["stat-count"]}>{block.count.toLocaleString()}</span>
<span className={style["stat-label"]}>{block.label}</span>
<span className={style["stat-description"]}>{block.description}</span>
{block.note && <span className={style["stat-note"]}>{block.note}</span>}
</button>
))}
</div>
<p className={style["explainer"]}>
{stats.totalBlockers === 0 ? (
<>The latest scan found no blockers, so there is nothing to recommend yet.</>
) : stats.repeatedBlockers === 0 ? (
<>
The latest scan found <strong>{stats.totalBlockers.toLocaleString()}</strong> {stats.totalBlockers === 1 ? "blocker" : "blockers"} across{" "}
<strong>{stats.pagesWithBlockers.toLocaleString()}</strong> {stats.pagesWithBlockers === 1 ? "page" : "pages"}.
None of them repeat, so each one is its own fix.
</>
) : (
<>
The latest scan found <strong>{stats.totalBlockers.toLocaleString()}</strong> blockers across{" "}
<strong>{stats.pagesWithBlockers.toLocaleString()}</strong> {stats.pagesWithBlockers === 1 ? "page" : "pages"}. <br/><br/>
Some of those are the same piece of code showing up in more than one place, so we grouped them as <strong>repeated blockers</strong>.<br/>
That leaves <strong>{stats.uniqueBlockers.toLocaleString()}</strong> unique blockers to fix.
Fix those and all <strong>{stats.totalBlockers.toLocaleString()}</strong> go away.<br/><br/>
The list below puts the fixes that clear the most blockers first.
Ignoring a blocker here ignores every copy of it.
</>
)}
</p>
</div>
{/* Status + result count */}
<div className={style["filters-row"]}>
<div className={style["filters"]}>
<StyledLabeledInput>
<label>Status</label>
<select
id="recommendationsStatus"
aria-label="Filter recommendations by status:"
value={status}
onChange={(e: ChangeEvent<HTMLSelectElement>) => handleStatusChange(e.target.value)}
>
<option value="active">Active</option>
<option value="ignored">Ignored</option>
<option value="all">All</option>
</select>
</StyledLabeledInput>
</div>
<div className={style["result-count"]} aria-live="polite">
{pagination.totalCount.toLocaleString()} {pagination.totalCount === 1 ? "recommendation" : "recommendations"}
</div>
</div>
{/* Table */}
<div className="table-container">
<div
className={"table-scroll-wrapper" + (showScrollFade ? " scroll-fade-active" : "")}
ref={scrollFadeRef}
tabIndex={0}
role="region"
aria-label="Recommendations table, scrollable horizontally"
>
<table aria-label="Recommendations table">
<thead>
<tr>
<th scope="col">Code</th>
<th scope="col">Description</th>
<th scope="col">Appears on...</th>
{/* <th scope="col">ID</th> */}
<th scope="col">Ignore</th>
</tr>
</thead>
<tbody>
{items.length === 0 ? (
<tr>
<td colSpan={4} className={style["empty-table"]}>
{stats.totalBlockers === 0
? "No blockers found in the latest scan."
: "No recommendations match these filters."}
</td>
</tr>
) : (
items.map((item) => {
const standards = item.tags
.map((tag) => {
const label = getAccessibilityStandardLabel(tag.content);
return label ? { id: tag.id, label } : null;
})
.filter((tag): tag is { id: string; label: string } => tag !== null);
return (
<tr key={item.content_hash_id}>
{/* Code */}
<td className={style["code-cell"]}>
<CodeBlock content={item.content} />
</td>
{/* Description */}
<td className={style["description-cell"]}>
<div className={style["description"]}>
<div className={style["description-text"]}>{item.message}</div>
<div className={"tags " + style["tag-row"]}>
<Link
to={{ search: getCategoryBlockersLinkSearch(item.category) }}
className="tag"
aria-label={`View all ${item.category} blockers in Detailed View`}
>
{item.category}
</Link>
{standards.slice(0, STANDARDS_TO_SHOW).map((tag) => (
<span key={tag.id} className="tag">{tag.label}</span>
))}
{standards.length > STANDARDS_TO_SHOW && (
<Tooltip.Provider>
<Tooltip.Root>
<Tooltip.Trigger
className={style["tooltip-rondel"]}
aria-label={`${standards.length - STANDARDS_TO_SHOW} more accessibility standards`}
>
{`+${standards.length - STANDARDS_TO_SHOW}`}
</Tooltip.Trigger>
<Tooltip.Portal>
<Tooltip.Content side="bottom" className="tooltip" collisionPadding={8}>
<div className={"tags " + style["tag-row"]}>
{standards.slice(STANDARDS_TO_SHOW).map((tag) => (
<span key={tag.id} className="tag">{tag.label}</span>
))}
</div>
<Tooltip.Arrow className="tooltip-arrow" />
</Tooltip.Content>
</Tooltip.Portal>
</Tooltip.Root>
</Tooltip.Provider>
)}
</div>
</div>
</td>
{/* Appears on... (occurrence count, with a drawer for the actual URLs) */}
<td className={style["impact-cell"]}>
<div className={style["impact"]}>
<span className={style["impact-text"]}>
{`${item.occurrences} ${item.occurrences === 1 ? "occurrence" : "occurrences"} across ${item.urlCount} ${item.urlCount === 1 ? "URL" : "URLs"}`}
</span>
</div>
<div className={style["where"]}>
{item.occurrences === 1 ? (
<a href={item.url} target="_blank" rel="noopener noreferrer">{item.url}</a>
) : (
<BlockerUrlsDrawer
auditId={auditId}
isShared={isShared}
contentHashId={item.content_hash_id}
occurrences={item.occurrences}
triggerLabel={`View all ${item.occurrences} occurrences`}
/>
)}
</div>
</td>
{/* ID */}
{/* <td className={style["id-td"]}>
<div className={style["id-cell"]}>
<Link to={"/shared/" + auditIdNoDash + "/" + item.short_id}>{item.short_id}</Link>
<StyledButton
onClick={() => copyToClipboard(item.short_id)}
icon={<FaClipboard className="icon-small" />}
label={item.short_id || "N/A"}
variant={"naked"}
showLabel={false}
/>
</div>
</td> */}
{/* Ignore */}
<td className={style["ignore-cell"]}>
<StyledButton
onClick={() => {
if (!authenticated) return;
toggleIgnoreMutation.mutate({
blockerId: item.id,
contentHashId: item.content_hash_id,
isCurrentlyIgnored: item.ignored,
});
setAnnounceMessage(
`Blocker ${item.short_id} and its ${item.occurrences - 1} ${item.occurrences - 1 === 1 ? "copy" : "copies"} set to ${item.ignored ? "Active" : "Ignored"}`,
"success"
);
}}
label={item.ignored ? "Ignored" : "Active"}
icon={item.ignored ? <TbEyeX className="icon-small" /> : <TbEye className="icon-small" />}
variant={item.ignored ? "toggle-ignored" : "toggle"}
/>
</td>
</tr>
);
})
)}
</tbody>
</table>
</div>
{/* Pagination */}
<div className="pagination" role="navigation" aria-label="Recommendations pagination">
<div className="pagination-text">
Showing {items.length} of {pagination.totalCount} recommendations
{pagination.totalPages > 0 && ` (Page ${page + 1} of ${pagination.totalPages})`}
</div>
<div className="pagination-buttons">
<div className="pagination-buttons-prev-next">
<StyledButton onClick={() => setPage(0)} disabled={page === 0} label="First" variant="light" className="pagination-edge" />
<StyledButton onClick={() => setPage((p) => Math.max(0, p - 1))} disabled={page === 0} label="Previous" variant="light" />
<StyledButton onClick={() => setPage((p) => p + 1)} disabled={page >= pagination.totalPages - 1} label="Next" variant="light" />
<StyledButton onClick={() => setPage(Math.max(0, pagination.totalPages - 1))} disabled={page >= pagination.totalPages - 1} label="Last" variant="light" className="pagination-edge" />
</div>
</div>
</div>
</div>
</div>
);
};