Skip to content

feat: add --continueOnError flag to skip a hung/crashing document #466

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
sajeeshnaniyil wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add --continueOnError flag to skip a hung/crashing document #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions packages/ace-cli-shared/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ const meowHelpMessage = `

-M, --doNotReportMedia skips reporting media resources

-C, --continueOnError skip a content document that hangs or crashes the axe runner
(default is to abort the whole audit on the first per-doc error)

-E, --exiterror2 exit process with code 2 when fail (return-2-on-validation-error)
Examples
$ ace -o out ~/Documents/book.epub
Expand Down Expand Up @@ -90,6 +93,10 @@ const meowOptions = {
doNotReportMedia: {
alias: 'M',
},
continueOnError: {
alias: 'C',
type: 'boolean'
},
exiterror2: { // process exit code
alias: 'E',
type: 'boolean'
Expand Down Expand Up @@ -168,6 +175,7 @@ ${overrides.map(file => ` - ${file}`).join('\n')}
lang: cli.flags.lang,
timeout: cli.flags.timeout || undefined,
doNotReportMedia: cli.flags.doNotReportMedia || undefined,
continueOnError: cli.flags.continueOnError || undefined,
exiterror2: cli.flags.exiterror2 || undefined,
}, axeRunner)
.then(async (jobData) => {
Expand Down
22 changes: 18 additions & 4 deletions packages/ace-core/src/checker/checker-chromium.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,15 +205,29 @@ async function checkSingle(spineItem, epub, lang, doNotReportMedia, axeRunner) {
}
}

module.exports.check = async (epub, lang, doNotReportMedia, axeRunner) => {
module.exports.check = async (epub, lang, doNotReportMedia, axeRunner, continueOnError) => {
await axeRunner.launch();
winston.info('Checking documents...');
return pMap(epub.contentDocs, (doc) => {
return checkSingle(doc, epub, lang, doNotReportMedia, axeRunner); // not AWAIT'ed! (pMap takes the Promise)
return pMap(epub.contentDocs, async (doc) => {
// When continueOnError is set, a single hung / crashing document
// logs a warning and yields a null result, letting the rest of the
// audit finish. Without the flag we preserve the original behavior:
// pMap's default fail-fast bubbles the first per-doc rejection up
// and aborts the whole run.
if (!continueOnError) {
return checkSingle(doc, epub, lang, doNotReportMedia, axeRunner);
}
try {
return await checkSingle(doc, epub, lang, doNotReportMedia, axeRunner);
} catch (err) {
const which = (doc && (doc.relpath || doc.href)) || '?';
winston.warn(`Skipping document ${which} (continueOnError): ${err && err.message ? err.message : err}`);
return null;
}
}, { concurrency: DISABLE_CONCURRENT_TO_DEBUG_INDIVIDUAL_SPINE_ITEM ? 1 : axeRunner.concurrency })
.then(async (results) => {
await axeRunner.close();
return results;
return continueOnError ? results.filter((r) => r !== null) : results;
}).catch(async (err) => {
winston.error(`Ace HTML check error: ${err.message ? err.message : err}`);
if (err.stack) winston.debug(err.stack);
Expand Down
4 changes: 2 additions & 2 deletions packages/ace-core/src/checker/checker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ function consolidate(results, report) {
return report;
}

module.exports.check = function check(epub, report, lang, doNotReportMedia, axeRunner) {
module.exports.check = function check(epub, report, lang, doNotReportMedia, axeRunner, continueOnError) {
return epubChecker.check(epub, report)
.then(async (obj) => {
return htmlChecker.check(epub, lang, doNotReportMedia, axeRunner).then((results) => {
return htmlChecker.check(epub, lang, doNotReportMedia, axeRunner, continueOnError).then((results) => {
return new Promise((res) => {
res({
assertion: obj.assertion,
Expand Down
9 changes: 8 additions & 1 deletion packages/ace-core/src/core/ace.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ module.exports = function ace(epubPath, options, axeRunner) {
// if (!!options.doNotReportMedia) axeRunner.setDoNotReportMedia();
//if (options.doNotReportMedia && process && process.env) process.env.ACE_DO_NOT_REPORT_MEDIA_RESOURCES = "1";

// When set (via --continue-on-error, options.continueOnError, or
// ACE_CONTINUE_ON_ERROR=1), a single content document that hangs or
// crashes the axe runner is logged as a warning and skipped, and the
// rest of the audit continues. Without the flag the current behavior
// is preserved: pMap's default fail-fast aborts the whole run.
const continueOnError = !!options.continueOnError || process && process.env && process.env.ACE_CONTINUE_ON_ERROR === '1';

return new Promise((resolve, reject) => {

function l10nDoneCallback() {
Expand Down Expand Up @@ -75,7 +82,7 @@ module.exports = function ace(epubPath, options, axeRunner) {
// initialize the report
.then(() => new Report(epub, options.outdir, options.lang).init())
// Check each Content Doc
.then(report => checker.check(epub, report, options.lang, doNotReportMedia, axeRunner))
.then(report => checker.check(epub, report, options.lang, doNotReportMedia, axeRunner, continueOnError))
// Process the Results
.then((report) => {
if (!options.outdir) {
Expand Down