summaryrefslogtreecommitdiff
path: root/test/test-workers.js
blob: 3de7ac48061f11898e1169deb3efc3145d47a39c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
 * Copyright (C) 2023  Yomitan Authors
 * 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
    }
}


/**
 * @returns {import('core').SafeAny}
 */
function loadEslint() {
    return JSON.parse(fs.readFileSync(path.join(__dirname, '..', '.eslintrc.json'), {encoding: 'utf8'}));
}

/**
 * @param {string[]} scriptPaths
 * @returns {string[]}
 */
function filterScriptPaths(scriptPaths) {
    const extDirName = 'ext';
    return scriptPaths.filter((src) => !src.startsWith('/lib/')).map((src) => `${extDirName}${src}`);
}

/**
 * @param {string} fileName
 * @returns {string[]}
 */
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();
    }
}

/**
 * @param {string[]} scripts
 */
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';
}

/**
 * @param {string} scriptPath
 * @param {import('core').UnknownObject} fields
 * @returns {string[]}
 */
function getImportedScripts(scriptPath, fields) {
    /** @type {string[]} */
    const importedScripts = [];

    /**
     * @param {...string} scripts
     */
    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 = /** @type {import('core').SafeAny[]} */ (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}
    );
}

/**
 * @param {string} scriptPath
 * @param {import('core').UnknownObject} fields
 */
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 = /** @type {import('core').SafeAny[]} */ (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(/** @type {import('core').SafeAny[]} */ (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(); }