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
169
170
171
172
|
/*
* 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 assert = require('assert');
const {JSDOM} = require('jsdom');
const {getAllFiles} = require('../util');
function lstatSyncSafe(fileName) {
try {
return fs.lstatSync(fileName);
} catch (e) {
return null;
}
}
function validatePath(src, fileName, extDir) {
assert.ok(typeof src === 'string', `<script> missing src attribute in ${fileName}`);
assert.ok(src.startsWith('/'), `<script> src attribute is not absolute in ${fileName} (src=${JSON.stringify(src)})`);
const relativeSrc = src.substring(1);
assert.ok(!path.isAbsolute(relativeSrc), `<script> src attribute is invalid in ${fileName} (src=${JSON.stringify(src)})`);
const fullSrc = path.join(extDir, relativeSrc);
const stats = lstatSyncSafe(fullSrc);
assert.ok(stats !== null, `<script> src file not found in ${fileName} (src=${JSON.stringify(src)})`);
assert.ok(stats.isFile(), `<script> src file invalid in ${fileName} (src=${JSON.stringify(src)})`);
}
function getSubstringCount(string, pattern) {
let count = 0;
while (true) {
const match = pattern.exec(string);
if (match === null) { break; }
++count;
}
return count;
}
function getSortedScriptPaths(scriptPaths) {
// Sort file names without the extension
const extensionPattern = /\.[^.]*$/;
scriptPaths = scriptPaths.map((value) => {
const match = extensionPattern.exec(value);
let ext = '';
if (match !== null) {
ext = match[0];
value = value.substring(0, value.length - ext.length);
}
return {value, ext};
});
const stringComparer = new Intl.Collator('en-US'); // Invariant locale
scriptPaths.sort((a, b) => stringComparer.compare(a.value, b.value));
scriptPaths = scriptPaths.map(({value, ext}) => `${value}${ext}`);
return scriptPaths;
}
function validateScriptOrder(fileName, window) {
const {document, Node: {ELEMENT_NODE, TEXT_NODE}, NodeFilter} = window;
const scriptElements = document.querySelectorAll('script');
if (scriptElements.length === 0) { return; }
// Assert all scripts are siblings
const scriptContainerElement = scriptElements[0].parentNode;
for (const element of scriptElements) {
if (element.parentNode !== scriptContainerElement) {
assert.fail('All script nodes are not contained within the same element');
}
}
// Get script groupings and order
const scriptGroups = [];
const newlinePattern = /\n/g;
let separatingText = '';
const walker = document.createTreeWalker(scriptContainerElement, NodeFilter.SHOW_ELEMENT | NodeFilter.SHOW_TEXT);
walker.firstChild();
for (let node = walker.currentNode; node !== null; node = walker.nextSibling()) {
switch (node.nodeType) {
case ELEMENT_NODE:
if (node.tagName.toLowerCase() === 'script') {
let scriptGroup;
if (scriptGroups.length === 0 || getSubstringCount(separatingText, newlinePattern) >= 2) {
scriptGroup = [];
scriptGroups.push(scriptGroup);
} else {
scriptGroup = scriptGroups[scriptGroups.length - 1];
}
scriptGroup.push(node.src);
separatingText = '';
}
break;
case TEXT_NODE:
separatingText += node.nodeValue;
break;
}
}
// Ensure core.js is first (if it is present)
const ignorePattern = /^\/lib\//;
const index = scriptGroups.flat()
.filter((value) => !ignorePattern.test(value))
.findIndex((value) => (value === '/js/core.js'));
assert.ok(index <= 0, 'core.js is not the first included script');
// Check script order
for (let i = 0, ii = scriptGroups.length; i < ii; ++i) {
const scriptGroup = scriptGroups[i];
try {
assert.deepStrictEqual(scriptGroup, getSortedScriptPaths(scriptGroup));
} catch (e) {
console.error(`Script order for group ${i + 1} in file ${fileName} is not correct:`);
throw e;
}
}
}
function validateHtmlScripts(fileName, extDir) {
const fullFileName = path.join(extDir, fileName);
const domSource = fs.readFileSync(fullFileName, {encoding: 'utf8'});
const dom = new JSDOM(domSource);
const {window} = dom;
const {document} = window;
try {
for (const {src} of document.querySelectorAll('script')) {
validatePath(src, fullFileName, extDir);
}
for (const {href} of document.querySelectorAll('link')) {
validatePath(href, fullFileName, extDir);
}
validateScriptOrder(fileName, window);
} finally {
window.close();
}
}
function main() {
try {
const extDir = path.resolve(__dirname, '..', '..', 'ext');
const pattern = /\.html$/;
const ignorePattern = /^lib[\\/]/;
const fileNames = getAllFiles(extDir, (f) => pattern.test(f) && !ignorePattern.test(f));
for (const fileName of fileNames) {
validateHtmlScripts(fileName, extDir);
}
} catch (e) {
console.error(e);
process.exit(-1);
return;
}
process.exit(0);
}
if (require.main === module) { main(); }
|