Skip to content

Fix: Surface processing failures to the user instead of spinning #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nishit24113 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix: Surface processing failures to the user instead of spinning #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46b41d2
Surface backend processing failures to the user
Nishit24113 Jun 9, 2026
3f84fd4
fix: show timeout error to user instead of silently stopping polling
Nishit24113 Jun 18, 2026
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
60 changes: 60 additions & 0 deletions pdf_ui/src/components/ProcessingContainer.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,3 +459,63 @@
width: 100%;
}
}

/* Failure state shown when the backend writes result/FAILED_<name>.json */
.failure-section {
display: flex;
flex-direction: column;
align-items: center;
text-align: center;
padding: 32px 24px;
background: #fdf2f2;
border: 1px solid #f5c6cb;
border-radius: 12px;
margin-top: 8px;
}

.failure-icon {
font-size: 40px;
line-height: 1;
margin-bottom: 12px;
}

.failure-title {
margin: 0 0 8px;
color: #842029;
font-size: 20px;
}

.failure-summary {
margin: 0 0 8px;
color: #5c1a1f;
font-size: 15px;
max-width: 520px;
}

.failure-pages {
margin: 0 0 4px;
color: #842029;
font-weight: 600;
font-size: 14px;
}

.failure-reason {
margin: 0 0 16px;
color: #9a6b6f;
font-size: 12px;
font-family: monospace;
}

.failure-retry-btn {
background: #c0392b;
color: #fff;
border: none;
border-radius: 8px;
padding: 10px 20px;
font-size: 14px;
cursor: pointer;
}

.failure-retry-btn:hover {
background: #a93226;
}
110 changes: 91 additions & 19 deletions pdf_ui/src/components/ProcessingContainer.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ const ProcessingContainer = ({
const [currentStep, setCurrentStep] = useState(0);
const [elapsedTime, setElapsedTime] = useState(0);
const [pollingAttempts, setPollingAttempts] = useState(0);
// Set when the backend reports a processing failure via result/FAILED_<name>.json.
// When present, polling stops and a failure message (with reason) is shown instead
// of leaving the user waiting until the polling timeout.
const [failureInfo, setFailureInfo] = useState(null);

const processingSteps = [
{ title: "Analyzing Document Structure", description: "Scanning PDF for accessibility issues" },
Expand Down Expand Up @@ -74,27 +78,30 @@ const ProcessingContainer = ({
let intervalId;
let timeIntervalId;
let stepIntervalId;
let attemptCount = 0;

const checkFileAvailability = async () => {
// Maximum polling time: 30 minutes (120 attempts * 15 seconds = 30 minutes)
const MAX_POLLING_ATTEMPTS = 120;

try {
// Increment polling attempts
setPollingAttempts(prev => {
const newAttempts = prev + 1;
attemptCount += 1;
setPollingAttempts(attemptCount);

// Stop polling after maximum attempts
if (newAttempts >= MAX_POLLING_ATTEMPTS) {
console.warn('⚠️ Maximum polling attempts reached. Stopping file check.');
clearInterval(intervalId);
clearInterval(timeIntervalId);
clearInterval(stepIntervalId);
return newAttempts;
}

return newAttempts;
});
// Stop polling after maximum attempts and show a timeout message to the user.
if (attemptCount >= MAX_POLLING_ATTEMPTS) {
console.warn('⚠️ Maximum polling attempts reached. Stopping file check.');
clearInterval(intervalId);
clearInterval(timeIntervalId);
clearInterval(stepIntervalId);
setFailureInfo({
summary: 'Processing timed out after 30 minutes. Please try uploading again or contact support if the issue persists.',
reasonCategory: 'TIMEOUT',
pages: '',
});
return;
}

// Select the correct bucket based on format (same logic as UploadSection)
const selectedBucket = selectedFormat === 'html' ? HTMLBucket : PDFBucket;
Expand Down Expand Up @@ -156,6 +163,53 @@ const ProcessingContainer = ({

console.log(`🔍 Polling attempt ${pollingAttempts + 1}/${MAX_POLLING_ATTEMPTS} for object key:`, objectKey);

// Before checking for success, check whether the backend reported a failure.
// The PDF pipeline writes result/FAILED_<name>.json (name without extension)
// on any failure. If present, stop polling and surface the reason to the user
// instead of spinning until the polling timeout. (PDF format only; the HTML
// pipeline does not emit this marker.)
if (selectedFormat !== 'html') {
const failedKey = `result/FAILED_${updatedFilename.replace(/\.pdf$/i, '')}.json`;
try {
const failedObject = await s3.send(
new GetObjectCommand({
Bucket: selectedBucket,
Key: failedKey,
})
);
const failedBody = await failedObject.Body.transformToString();
let parsed = {};
try {
parsed = JSON.parse(failedBody);
} catch (parseErr) {
console.warn('Could not parse failure marker JSON:', parseErr);
}

console.error('❌ Backend reported a processing failure:', parsed);

// Build a user-facing list of failed pages, if available.
const pages = (parsed.failed_chunks || [])
.filter(c => c.page_start && c.page_end)
.map(c => `pages ${c.page_start}-${c.page_end}`)
.join(', ');

setFailureInfo({
summary: parsed.summary || 'Processing failed. Please try again or contact support.',
reasonCategory: parsed.reason_category || 'UNKNOWN',
pages,
});

// Stop all polling/animation; a failure is terminal.
clearInterval(intervalId);
clearInterval(timeIntervalId);
clearInterval(stepIntervalId);
return;
} catch (failedCheckErr) {
// No failure marker yet (404) — this is the normal case; continue to
// the success check below.
}
}

// Check if the processed file exists
await s3.send(
new HeadObjectCommand({
Expand Down Expand Up @@ -191,7 +245,8 @@ const ProcessingContainer = ({
}
};

if (updatedFilename && !isFileReady) {
// Do not (re)start polling once the file is ready or a failure was reported.
if (updatedFilename && !isFileReady && !failureInfo) {
// Reset polling attempts for new file
setPollingAttempts(0);

Expand All @@ -214,7 +269,7 @@ const ProcessingContainer = ({
clearInterval(timeIntervalId);
clearInterval(stepIntervalId);
};
}, [updatedFilename, isFileReady, onFileReady, awsCredentials, originalFileName, selectedFormat, generatePresignedUrl, processingSteps.length, pollingAttempts]);
}, [updatedFilename, isFileReady, onFileReady, awsCredentials, originalFileName, selectedFormat, generatePresignedUrl, processingSteps.length, pollingAttempts, failureInfo]);


return (
Expand All @@ -234,14 +289,31 @@ const ProcessingContainer = ({
<span>⏱️ Time elapsed: {formatElapsedTime(elapsedTime)}</span>
</div>
<p className="processing-description">
{isFileReady
? 'Remediation complete! Your file is ready for download.'
: 'Remediation process typically takes a few minutes to complete depending on the document complexity'
{failureInfo
? 'We were unable to remediate this document.'
: isFileReady
? 'Remediation complete! Your file is ready for download.'
: 'Remediation process typically takes a few minutes to complete depending on the document complexity'
}
</p>
</div>

{!isFileReady ? (
{failureInfo ? (
<div className="failure-section" role="alert">
<div className="failure-icon">⚠️</div>
<h3 className="failure-title">Remediation Failed</h3>
<p className="failure-summary">{failureInfo.summary}</p>
{failureInfo.pages && (
<p className="failure-pages">Affected: {failureInfo.pages}</p>
)}
<p className="failure-reason">Reason code: {failureInfo.reasonCategory}</p>
{onNewUpload && (
<button className="failure-retry-btn" onClick={onNewUpload}>
Try another document
</button>
)}
</div>
) : !isFileReady ? (
<div className="progress-section">
<div className="steps-list">
{processingSteps.map((step, index) => (
Expand Down