yomichan/test/test-workers.js

/*
 * Copyright (C) 2020-2022  Yomichan Authors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

const fs = require('fs');
const path = require('path');
const {JSDOM} = require('jsdom');
const {VM} = require('../dev/vm');
const assert = require('assert');


class StubClass {
    prepare() {
        // NOP
    }
}


function loadEslint() {
    return JSON.parse(fs.readFileSync(path.join(__dirname, '..', '.eslintrc.json'), {encoding: 'utf8'}));
}

function filterScriptPaths(scriptPaths) {
    const extDirName = 'ext';
    return scriptPaths.filter((src) => !src.startsWith('/lib/')).map((src) => `${extDirName}${src}`);
}

function getAllHtmlScriptPaths(fileName) {
    const domSource = fs.readFileSync(fileName, {encoding: 'utf8'});
    const dom = new JSDOM(domSource);
    const {window} = dom;
    const {document} = window;
    try {
        const scripts = document.querySelectorAll('script');
        return [...scripts].map(({src}) => src);
    } finally {
        window.close();
    }
}

function convertBackgroundScriptsToServiceWorkerScripts(scripts) {
    // Use parse5-based SimpleDOMParser
    scripts.splice(0, 0, '/lib/parse5.js');
    const index = scripts.indexOf('/js/dom/native-simple-dom-parser.js');
    assert.ok(index >= 0);
    scripts[index] = '/js/dom/simple-dom-parser.js';
}

function getImportedScripts(scriptPath, fields) {
    const importedScripts = [];

    const importScripts = (...scripts) => {
        importedScripts.push(...scripts);
    };

    const vm = new VM(Object.assign({importScripts}, fields));
    vm.context.self = vm.context;
    vm.execute([scriptPath]);

    return importedScripts;
}

function testServiceWorker() {
    // Verify that sw.js scripts match background.html scripts
    const extDir = path.join(__dirname, '..', 'ext');
    const scripts = getAllHtmlScriptPaths(path.join(extDir, 'background.html'));
    convertBackgroundScriptsToServiceWorkerScripts(scripts);
    const importedScripts = getImportedScripts('sw.js', {});
    assert.deepStrictEqual(scripts, importedScripts);

    // Verify that eslint config lists files correctly
    const expectedSwRulesFiles = filterScriptPaths(scripts);
    const eslintConfig = loadEslint();
    const swRules = eslintConfig.overrides.find((item) => (
        typeof item.env === 'object' &&
        item.env !== null &&
        item.env.serviceworker === true
    ));
    assert.ok(typeof swRules !== 'undefined');
    assert.ok(Array.isArray(swRules.files));
    assert.deepStrictEqual(swRules.files, expectedSwRulesFiles);
}

function testWorkers() {
    testWorker(
        'js/language/dictionary-worker-main.js',
        {DictionaryWorkerHandler: StubClass}
    );
}

function testWorker(scriptPath, fields) {
    // Get script paths
    const scripts = getImportedScripts(scriptPath, fields);

    // Verify that eslint config lists files correctly
    const expectedRulesFiles = filterScriptPaths(scripts);
    const expectedRulesFilesSet = new Set(expectedRulesFiles);
    const eslintConfig = loadEslint();
    const rules = eslintConfig.overrides.find((item) => (
        typeof item.env === 'object' &&
        item.env !== null &&
        item.env.worker === true
    ));
    assert.ok(typeof rules !== 'undefined');
    assert.ok(Array.isArray(rules.files));
    assert.deepStrictEqual(rules.files.filter((v) => expectedRulesFilesSet.has(v)), expectedRulesFiles);
}


function main() {
    try {
        testServiceWorker();
        testWorkers();
    } catch (e) {
        console.error(e);
        process.exit(-1);
        return;
    }
    process.exit(0);
}


if (require.main === module) { main(); }