Scanning Services
Edit on GitHubScanning Services
Equalify's accessibility scanning is performed by a collection of microservices that work together to scan HTML pages and PDF documents at scale.
How Equalify Scans: URL-Based vs Crawling
Many accessibility tools (such as SiteImprove, Pope Tech, or Monsido) use a crawling approach: you provide a root domain, and the tool automatically discovers pages by following links, parsing sitemaps, and spidering the site. While convenient, crawling has notable drawbacks:
- Unpredictable scope: Crawlers may miss pages behind JavaScript navigation or follow links to external sites, leading to incomplete or noisy results.
- Slow discovery: A full crawl of a large site can take hours before scanning even begins.
- No PDF coverage: Most crawlers focus on HTML pages and ignore linked PDF documents.
- Redundant scans: Crawlers often re-scan unchanged pages, wasting resources.
| Crawling Tools | Equalify (URL-Based) | |
|---|---|---|
| Scope | Automatic discovery; may miss or over-include pages | Explicit — you choose exactly what's scanned |
| PDF support | Typically limited or absent | First-class PDF scanning via veraPDF |
| Speed | Crawl + scan (slow for large sites) | Scan only (no discovery overhead) |
| Repeatability | Results vary based on crawl path | Deterministic — same URLs every time |
| Gated content | Requires authenticated crawling setup | Scan any publicly accessible URL directly |
sitemap.xml and lets you review and select which discovered URLs to add — a single, explicit lookup rather than link-following/spidering. The trade-off is still full control over what gets scanned and consistent, reproducible results across scan runs.
Tip: For large sites, use the CSV upload feature to bulk-add URLs. You can export a URL list from your CMS, sitemap.xml, or analytics tool and import it directly into an Equalify audit. Equalify also supports syncing an audit's URLs from a hosted remote CSV — for WordPress sites, the official Equalify WordPress Integration plugin generates this CSV feed automatically, keeping an audit's pages, posts, and PDF library in sync with the site as content changes.
Overview
The scanning architecture uses AWS SQS FIFO queues to distribute work across scanner Lambdas, ensuring reliable delivery and ordered processing per audit.
┌─────────────┐ ┌──────────────┐ ┌─────────────┐ ┌───────────┐
│ Backend │────▶│ SQS Router │────▶│ SQS Queue │────▶│ Scanner │
│ API │ │ Lambda │ │ (FIFO) │ │ Lambda │
└─────────────┘ └──────────────┘ └─────────────┘ └───────────┘
│
▼
┌───────────┐
│ Webhook │
│ (Backend) │
└───────────┘
Service Components
SQS Router (aws-lambda-scan-sqs-router)
Purpose: Receives scan requests and routes URLs to appropriate SQS queues based on content type.
Input Schema (Zod validated):
const scansSchema = z.object({
urls: z.array(
z.object({
auditId: z.string(),
scanId: z.string(),
urlId: z.string(),
url: z.string(),
type: z.string(), // "html" or "pdf"
isStaging: z.boolean().optional(),
})
),
});
Behavior:
- Parse and validate incoming URL list
- Separate URLs by type (HTML vs PDF)
- Batch URLs into groups of 10 (SQS limit)
- Send batches to appropriate FIFO queues
Event) Lambda invokes reject payloads over 1 MB, which is roughly 3,500 URLs, and before this was handled a large audit's scan silently never reached the queue (#660). apps/backend/utils/queueScanJobs.ts splits a scan's URL list into invokes of at most 512 KB each (a 6,000-URL audit arrives as 3-4 invocations). The router executions may run concurrently, so pages from different chunks can interleave on the queue; nothing depends on URL order. If an invoke fails, the error is raised to the caller and the scan is left for the stuck-scan sweep (below), which closes out the pages that never reported.
Queue Configuration:
- HTML Queue:
scanHtml.fifo(Terraform-provisioned deployments use a project/environment-prefixed name) - PDF Queue:
scanPdf.fifo(same prefixing applies) - Message Group ID:
auditId(ensures ordered processing per audit) - Deduplication ID:
${scanId}-${urlId}(prevents duplicate scans) - Both queues have a dead-letter queue with a 14-day retention
Crawler (aws-lambda-crawler)
Purpose: Optional URL discovery helper, invoked directly from the backend API (crawlUrl endpoint) — not part of the SQS scan pipeline.
Behavior:
- Receives a single URL
- Attempts to fetch
<url>/sitemap.xmland parse it for page URLs - Falls back to returning just the input URL if no sitemap is found
- Returns the discovered URL list to the frontend, where the user reviews and selects which URLs to add to the audit
HTML Scanner (aws-lambda-scan-html)
Purpose: Scans web pages for accessibility issues using a headless Chromium browser and axe-core.
Key Features:
- Uses AWS Lambda Powertools for metrics and logging
- Processes SQS records with partial batch failure handling
- 2-minute timeout per scan to prevent Lambda hangs
- Runs axe-core with two custom rules in addition to the default ruleset: an empty-alt-tag check and a PDF-link check (flags links to PDF documents for review)
- Reports axe violations and incomplete (needs review) results as blockers, except incomplete results from the contrast rules (
color-contrast,color-contrast-enhanced,link-in-text-block). axe reports an inconclusive contrast check most often when it can't determine the background (text over an image, gradient or overlapping element), and treating those as failures inflated contrast counts by thousands on image-heavy sites. Other incomplete results are kept because the two custom rules are declaredreviewOnFailand only ever report through that channel - Converts axe-core results to EqualifyV2 format
- Receive SQS message with URL details
- Launch headless Chromium browser
- Navigate to URL and wait for page load
- Inject and run axe-core accessibility tests
- Convert results to EqualifyV2 format
- POST results to webhook endpoint
- Timeout errors: Logged and reported as failures
- Network errors: Caught and reported with error type
- Partial failures: Uses AWS Powertools batch processor
PDF Scanner (aws-lambda-scan-pdf)
Purpose: Orchestrates PDF accessibility scanning using veraPDF.
Architecture:
- TypeScript Lambda receives SQS message
- Invokes Java-based veraPDF Lambda
- Converts veraPDF results to EqualifyV2 format
- Reports results via webhook
veraPDF Interface (aws-lambda-verapdf-interface)
Purpose: Java Lambda that performs actual PDF scanning using veraPDF library.
Features:
- Native Java Lambda for performance
- Downloads PDF from URL
- Executes veraPDF accessibility checks
- Returns raw JSON results
Result Format (EqualifyV2)
All scanners convert their results to a unified format:
interface StreamResults {
status: string; // "complete" or "failed"
auditId: string;
scanId: string;
urlId: string;
url?: string;
blockers: Blocker[];
date: string;
message: string;
}
interface Blocker {
source: string; // "axe-core" | "pdf-scan" (editoria11y is present in the type but currently unused/disabled)
test: string; // Rule ID (e.g., "color-contrast")
tags?: string[] | null; // WCAG tags (e.g., ["wcag2aa", "wcag143"])
description: string; // Human-readable rule description
summary: string; // Specific failure details
node: string | null; // HTML snippet or null for PDFs
}
Axe-Core Conversion
shared/convertors/AxeToEqualify2.ts exports convertToEqualifyV2, which transforms axe-core results:
function convertToEqualifyV2(axeResult: AxeResults, job: any): StreamResults {
const blockers: Blocker[] = [];
// Process violations and incomplete results
[axeResult.incomplete, axeResult.violations].forEach(results => {
results?.forEach(rule => {
rule.nodes?.forEach(node => {
blockers.push({
source: "axe-core",
test: rule.id,
tags: rule.tags,
description: `${rule.description}. ${rule.help}`,
summary: node.failureSummary ?? "",
node: node.html
});
});
});
});
return {
auditId: job.auditId,
scanId: job.scanId,
urlId: job.urlId,
url: job.url,
blockers,
date: axeResult.timestamp,
status: "complete",
message: "",
};
}
Webhook Integration
Results are sent to the backend API webhook:
| Environment | Endpoint |
|---|---|
| Production | https://api.equalifyapp.com/public/scanWebhook |
| Staging | https://api-staging.equalifyapp.com/public/scanWebhook |
{
"auditId": "uuid",
"scanId": "uuid",
"urlId": "uuid",
"url": "https://example.com",
"status": "complete",
"date": "2026-08-17T00:00:00.000Z",
"message": "",
"blockers": [...]
}
Stuck Scans and Timeouts
A scan only finishes when scanWebhook has heard back about every URL. Two layers make sure a scan can't hang forever, and that the user can see which pages are missing when it doesn't finish cleanly:
| Layer | Where | What it does |
|---|---|---|
| Per-page timeout | aws-lambda-scan-html (SCAN_TIMEOUT, 2 min) and BROWSER_LOAD_TIMEOUT (30 s) | A slow page is reported to the webhook as a page_timeout failure and the scan moves on. |
| Stuck-scan sweep | runEveryMinute (backend, EventBridge) | Closes out scans with no webhook activity for STUCK_SCAN_INACTIVITY_MINUTES (default 60). |
scans row, so updated_at is the time of the last page result, and the threshold measures inactivity, not total runtime. Pages are scanned one at a time per audit (the FIFO message group is the audit id), so a 1,250-page audit takes around 90 minutes and a 6,000-page audit several hours. Because scans of the same audit share that message group, a scan started while an older one is still running waits in the queue with no activity of its own and only starts receiving results once the older one finishes; the sweep therefore skips a scan while an older sibling scan of the same audit has had activity within the threshold, whatever that sibling's status. This is what produced false "Scan Timed Out" notices on large audits before the rule was added.
What the sweep does to a stuck scan.
- Appends a
scan_timeouterror whosedetailscarrytotalPages,scannedPages,unscannedPages,listedPages,cappedandinactivityMinutes, and flipsstatustocomplete(guarded so a webhook landing at the same moment isn't clobbered). - Works out which pages never reported (the scan's
pagessnapshot, which now records each url's id, minusprocessed_pages; scans older than that fall back to matching the audit'surlsrows by URL) and appends aurl_timeouterror per page ("Not Scanned (Timeout)"in the UI), capped at 500 entries so thescansrow stays small enough for the audit page's polling; the summary entry always carries the full count. - Counts those pages as processed (so
percentagereads 100 and the scan is genuinely closed), freezesblocker_count/equalified_countfrom theblockerstable, and sets the audit tocompleteorfaileddepending on whether anything was found - but only if this is still the audit's newest scan.
processing for the next sweep to retry.
If a result for a closed-out page still arrives later (the scan was draining slowly rather than dead), scanWebhook removes that page's url_timeout entry, so the error list corrects itself; the scan itself stays complete.
Metrics & Monitoring
Using AWS Lambda Powertools:
scansStarted: Count of scans initiated (HTML/PDF scanner Lambdas)ScanDuration: Time to complete each scan (milliseconds)scanRequest: Count of scan requests received by the SQS Router- Cold start metrics captured automatically
Adding New Scanners
To add a new scanner type:
- Create a new service in
services/ - Implement SQS message consumption
- Create a converter in
shared/convertors/ - Add queue routing in
aws-lambda-scan-sqs-router - Register the new type in the scan schema
For database schema details, see the Database Schema guide.