Skip to content
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.

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

WIP: an Electron Axe runner for Ace (side-by-side with the Puppeteer one) #236

Closed
wants to merge 112 commits into from

Conversation

danielweck
Copy link
Member

Note that this has its own CLI, due to the way an Electron app is bootstrapped. However, there is no code redundancy due to the introduction of the "shared" CLI package.

@danielweck
Copy link
Member Author

To compare performance:

yarn run ace-electron -f -V -o PATH_TO_OUTPUT_FOLDER PATH_TO_EPUB
vs.
yarn run ace -f -V -o PATH_TO_OUTPUT_FOLDER PATH_TO_EPUB

...right now the Electron runner is slower that the Puppeteer one due to launching multiple browser windows in sequence (no concurrency).

@danielweck danielweck changed the title WIP: an Electron Axe runner for Ace (side-by-side with the Pupetteer one) WIP: an Electron Axe runner for Ace (side-by-side with the Puppeteer one) Jun 21, 2019
@danielweck
Copy link
Member Author

The Electron-based Axe runner now has the same performance as the Puppeteer one. To check, use this shell script (which is committed at the root of this repository):
./compareAxeRunners.sh PATH_TO_EPUB
This will invoke both Axe runners in sequence (in silent mode but with a final benchmark / time console log), followed by a JSON diff so that the report.json files can be compared.
Note that this shell script creates the following folder structure at the root of the repository (the files are currently not git-ignored):

  • CompareAxeRunners/
    • ElectronAxeRunner/
      • data/
      • report.html
      • report.json
    • PuppeteerAxeRunner/
      • data/
      • report.html
      • report.json

… with arbitrary garbage collection (this is needed for Ace App/GUI metadata editor)
…with mkdirp, well ... "Drop support for outdated Node.js versions. (Technically still works on Node.js v8, but only 10 and above are officially supported.)" see https://github.com/isaacs/node-mkdirp/blob/master/CHANGELOG.md )
…e + EPUB2 metadata name/content pairs were not parsed + added certifierReport in addition to conformsTo (special metadata/link case) + added missing description fields to HTML report (otherwise violations are reported with insufficient information to remediate) + added missing a11y:certifierCredential reporting
…fied / cross-checked with the DAISY Knowledge Base 's recommended values)
…cation notice) in both unit tests CLI and regular
@danielweck
Copy link
Member Author

PR now superseded with #314

@danielweck danielweck closed this Mar 31, 2020
@danielweck danielweck deleted the feature/axe-runner-electron branch April 8, 2021 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant