WIP - PR merge 40+42 (l10n + Axe runner Electron adapter)

README.md

@@ -62,3 +62,20 @@ Please read our [code of conduct](CODE_OF_CONDUCT.md) and [contributing guidelin
 ## License
 
 This project is licensed under the MIT License - see the [license file](LICENSE.md) for details
+
+## Clean slate build for Electron
+
+* `yarn run clean`
+* `rm -rf dist`
+* `rm -rf node_modules`
+* `yarn cache clean`
+* `git branch`
+* `git status`
+* `git pull`
+* `rm yarn.lock`
+* `yarn install`
+* `open node_modules/@daisy`
+* `yarn build`
+* `yarn start`
+
+

package.json

@@ -44,24 +44,18 @@
   },
   "@daisy/ace-core": "^1.0.2",
   "dependencies": {
-    "@daisy/ace-config": "^1.0.0",
-    "@daisy/ace-logger": "^1.0.1",
-    "@daisy/ace-report": "^1.0.1",
-    "@daisy/ace-report-axe": "^1.0.1",
-    "@daisy/epub-utils": "^1.0.2",
+    "@daisy/ace-core": "file:../ace/packages/ace-core",
+    "@daisy/ace-localize": "file:../ace/packages/ace-localize",
+    "@daisy/ace-logger": "file:../ace/packages/ace-logger",
     "@material-ui/core": "^3.0.0",
     "@material-ui/icons": "^3.0.0",
     "@mrmlnc/readdir-enhanced": "^2.2.1",
     "about-window": "^1.12.1",
     "axe-core": "~2.6.1",
     "electron-debug": "^2.0.0",
     "electron-redux": "^1.3.1",
-    "electron-store": "^2.0.0",
+    "electron-store": "^3.2.0",
     "express": "^4.16.4",
-    "file-url": "^2.0.2",
-    "fs-jetpack": "^2.1.0",
-    "h5o": "^0.11.3",
-    "handlebars": "^4.1.2",
     "jszip": "^3.1.5",
     "p-map": "^1.2.0",
     "portfinder": "^1.0.20",
@@ -95,7 +89,7 @@
     "cross-env": "^5.2.0",
     "css-loader": "^1.0.0",
     "devtron": "^1.4.0",
-    "electron": "2.0.7",
+    "electron": "^5.0.0",
     "electron-builder": "^20.28.3",
     "electron-react-devtools": "^0.5.3",
     "file-loader": "^2.0.0",

src/main/axe-runner.js

@@ -144,15 +144,18 @@ export function axeRunnerInitEvents() {
     ipcMain.on('AXE_RUNNER_RUN', (event, arg) => {
 
         const basedir = arg.basedir;
-        const u = arg.url;
+        const uarel = arg.url;
         const scripts = arg.scripts;
+        const scriptContents = arg.scriptContents;
 
-        if (LOG_DEBUG) console.log(`${AXE_LOG_PREFIX} axeRunner running ... ${basedir} ${u}`);
+        if (LOG_DEBUG) console.log(`${AXE_LOG_PREFIX} axeRunner running ... ${basedir} ${uarel}`);
 
         function doRun() {
 
-            const p = decodeURI(url.parse(u).pathname);
-            const httpUrl = rootUrl + p.replace(basedir, "");
+             // windows! file://C:\aa\bb\chapter.xhtml
+            const uarelObj = url.parse(uarel.replace(/\\/g, "/"));
+            const windowsDrive = uarelObj.hostname ? `${uarelObj.hostname.toUpperCase()}:` : "";
+            const httpUrl = rootUrl + (windowsDrive + decodeURI(uarelObj.pathname)).replace(basedir.replace(/\\/g, "/"), "");
 
             let replySent = false;
 
@@ -173,16 +176,24 @@ new Promise((resolve, reject) => {
                 browserWindow.webContents.executeJavaScript(js, true)
                     .then((ok) => {
                         if (LOG_DEBUG) console.log(`${AXE_LOG_PREFIX} axeRunner done.`);
-                        // console.log(ok);
-                        // console.log(JSON.stringify(ok, null, "  "));
+                        if (replySent) {
+                            if (LOG_DEBUG) console.log(`${AXE_LOG_PREFIX} axeRunner WAS TIMEOUT!`);
+                            return;
+                        }
                         replySent = true;
+
                         event.sender.send("AXE_RUNNER_RUN_", {
                             ok
                         });
                     })
                     .catch((err) => {
                         if (LOG_DEBUG) console.log(`${AXE_LOG_PREFIX} axeRunner fail!`);
+                        if (replySent) {
+                            if (LOG_DEBUG) console.log(`${AXE_LOG_PREFIX} axeRunner WAS TIMEOUT!`);
+                            return;
+                        }
                         replySent = true;
+
                         event.sender.send("AXE_RUNNER_RUN_", {
                             err
                         });
@@ -202,11 +213,11 @@ new Promise((resolve, reject) => {
                 event.sender.send("AXE_RUNNER_RUN_", {
                     err: "Timeout :("
                 });
-            }, 3000);
+            }, 10000);
         }
 
         if (!httpServer) { // lazy init
-            startAxeServer(basedir, scripts).then(() => {
+            startAxeServer(basedir, scripts, scriptContents).then(() => {
                 if (LOG_DEBUG) console.log(`${AXE_LOG_PREFIX} server started`);
 
                 browserWindow = new BrowserWindow({
@@ -252,11 +263,18 @@ new Promise((resolve, reject) => {
     });
 }
 
-export function startAxeServer(epubRootPath, scripts) {
+export function startAxeServer(basedir, scripts, scriptContents) {
 
     return new Promise((resolve, reject) => {
 
         let scriptsMarkup = "";
+        scriptContents.forEach((scriptCode) => {
+            scriptsMarkup += `<script data-ace="" type="text/javascript">
+            // <![CDATA[
+            ${scriptCode}
+            // ]]>
+            </script>`;
+        });
         scripts.forEach((scriptPath) => {
             const filename = path.basename(scriptPath);
             scriptsMarkup += `<script data-ace="" src="/${HTTP_QUERY_PARAM}/${filename}"> </script>`;
@@ -290,7 +308,7 @@ export function startAxeServer(epubRootPath, scripts) {
             if (req.query[HTTP_QUERY_PARAM]) {
                 if (LOG_DEBUG) console.log(`${AXE_LOG_PREFIX} HTTP intercept ${req.url}`);
 
-                let html = fs.readFileSync(path.join(epubRootPath, url.parse(req.url).pathname), { encoding: "utf8" });
+                let html = fs.readFileSync(path.join(basedir, url.parse(req.url).pathname), { encoding: "utf8" });
 
                 if (html.match(/<\/head>/)) {
                     html = html.replace(/<\/head>/, `${scriptsMarkup}</head>`);
@@ -324,8 +342,8 @@ export function startAxeServer(epubRootPath, scripts) {
             //     setResponseCORS(res);
             // },
         };
-        if (LOG_DEBUG) console.log(`${AXE_LOG_PREFIX} HTTP static path ${epubRootPath}`);
-        expressApp.use("/", express.static(epubRootPath, staticOptions));
+        if (LOG_DEBUG) console.log(`${AXE_LOG_PREFIX} HTTP static path ${basedir}`);
+        expressApp.use("/", express.static(basedir, staticOptions));
 
         const startHttp = function () {
             generateSelfSignedData().then((certData) => {

src/main/main.js

@@ -36,7 +36,20 @@ function openTopLevelDevTools() {
 let win;
 function createWindow() {
 
-  win = new BrowserWindow({ show: false });
+  win = new BrowserWindow(
+    {
+      show: false,
+      webPreferences: {
+          allowRunningInsecureContent: false,
+          contextIsolation: false,
+          nodeIntegration: true,
+          nodeIntegrationInWorker: false,
+          sandbox: false,
+          webSecurity: true,
+          webviewTag: false,
+      }
+    }
+  );
   win.maximize();
   let sz = win.getSize();
   const sz0 = sz[0];

src/shared/actions/app.js

@@ -69,7 +69,7 @@ export function runAce(inputPath) {
     if (outdir.success) {
       const language = getCurrentLanguage();
 
-      ace(inputPath, {outdir: outdir.value, lang: language, verbose: true, silent: false, initLogger: true}, axeRunner)
+      ace(inputPath, {outdir: outdir.value, lang: language, verbose: true, silent: false, initLogger: false}, axeRunner)
       .then(() => {
         dispatch(addMessage(localize("message.checkcomplete")));
         let reportPath = outdir.value + '/report.json';

src/shared/axe-runner.js

@@ -35,7 +35,7 @@ export const axeRunner = {
         //     ipcRenderer.send('AXE_RUNNER_CLOSE', {});
         // });
     },
-    run: function (url, scripts, basedir) {
+    run: function (url, scripts, scriptContents, basedir) {
         if (LOG_DEBUG) console.log(`${AXE_LOG_PREFIX} axeRunner will run ...`);
 
         return new Promise((resolve, reject) => {
@@ -54,6 +54,7 @@ export const axeRunner = {
             ipcRenderer.send('AXE_RUNNER_RUN', {
                 url,
                 scripts,
+                scriptContents,
                 basedir,
             });
         });

src/shared/helpers/about.js

@@ -13,6 +13,17 @@ module.exports = {
         copyright: 'Copyright (c) 2018 DAISY Consortium',
         package_json_dir: __dirname,
         open_devtools: isDev,
+        win_options: {
+          webPreferences: {
+            allowRunningInsecureContent: false,
+            contextIsolation: false,
+            nodeIntegration: true,
+            nodeIntegrationInWorker: false,
+            sandbox: false,
+            webSecurity: true,
+            webviewTag: false,
+          }
+        }
     });
   },
 };

src/shared/l10n/localize.js

@@ -1,18 +1,16 @@
 const { newLocalizer } = require('@daisy/ace-localize');
 
-// import * as enJson from "./locales/en.json";
-// import * as frJson from "./locales/fr.json";
 const enJson = require("./locales/en.json");
 const frJson = require("./locales/fr.json");
 
 export const localizer = newLocalizer({
     en: {
         name: "English",
         default: true,
-        translation: enJson, // enJson.default || enJson,
+        translation: enJson,
     },
     fr: {
         name: "Français",
-        translation: frJson, // frJson.default || frJson,
+        translation: frJson,
     },
 });