forked from GoogleChrome/lighthouse
-
Notifications
You must be signed in to change notification settings - Fork 0
/
build-cdt-lib.js
163 lines (144 loc) · 6.11 KB
/
build-cdt-lib.js
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
/**
* @license Copyright 2020 The Lighthouse Authors. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
*/
'use strict';
/* eslint-disable no-console */
const fs = require('fs');
const ts = require('typescript');
const {LH_ROOT} = require('../root.js');
const outDir = `${LH_ROOT}/lighthouse-core/lib/cdt/generated`;
const files = {
'node_modules/chrome-devtools-frontend/front_end/core/sdk/SourceMap.ts': 'SourceMap.js',
};
console.log('making modifications ...');
for (const [inFilename, outFilename] of Object.entries(files)) {
const code = fs.readFileSync(inFilename, 'utf-8');
const codeTranspiledToCommonJS = ts.transpileModule(code, {
compilerOptions: {module: ts.ModuleKind.CommonJS, target: ts.ScriptTarget.ES2019},
}).outputText;
const sourceFile = ts.createSourceFile('', codeTranspiledToCommonJS,
ts.ScriptTarget.ES2019, true, ts.ScriptKind.JS);
const simplePrinter = ts.createPrinter({newLine: ts.NewLineKind.LineFeed});
/** @type {string[]} */
const classesToRemove = [
// Currently empty.
];
const methodsToRemove = [
// Not needed.
'load',
// Not needed.
'sourceContentProvider',
];
const variablesToRemove = [
'Common',
'CompilerSourceMappingContentProvider_js_1',
'i18n',
'i18nString',
'PageResourceLoader_js_1',
'Platform',
'str_',
'TextUtils',
'UIStrings',
];
const expressionsToRemove = [
/* Original:
let url = Common.ParsedURL.ParsedURL.completeURL(this.baseURL, href) || href;
const source = sourceMap.sourcesContent && sourceMap.sourcesContent[i];
if (url === this.compiledURLInternal && source) {
url += '? [sm]';
}
this.sourceInfos.set(url, new TextSourceMap.SourceInfo(source || null, null));
sourcesList.push(url);
----
If a source file is the same as the compiled url and there is a sourcesContent,
then `entry.sourceURL` (what is returned from .mappings) will have `? [sm]` appended.
This is useful in DevTools - to show that a sources panel tab not a real network resource -
but for us it is not wanted. The sizing function uses `entry.sourceURL` to index the byte
counts, and is further used in the details to specify a file within a source map.
*/
`url += '? [sm]'`,
];
// Complicated expressions are hard detect with the TS lib, so instead work with the raw code.
const rawCodeToReplace = {
'Common.Console.Console.instance().warn': 'console.warn',
// Similar to the reason for removing `url += Common.UIString('? [sm]')`.
// The entries in `.mappings` should not have their url property modified.
'Common.ParsedURL.ParsedURL.completeURL(this.baseURL, href)': `''`,
// Replace i18n function with a very simple templating function.
'i18n.i18n.getLocalizedString.bind(undefined, str_)': (
/** @param {string} template @param {object} vars */
function(template, vars) {
let result = template;
for (const [key, value] of Object.entries(vars)) {
result = result.replace(new RegExp('{' + key + '}'), value);
}
return result;
}).toString(),
// Add some types.
// eslint-disable-next-line max-len
'mappings() {': '/** @return {Array<{lineNumber: number, columnNumber: number, sourceURL?: string, sourceLineNumber, sourceColumnNumber: number, name?: string, lastColumnNumber?: number}>} */\nmappings() {',
};
// Verify that all the above code is present.
const codeFragments = [
...classesToRemove,
...methodsToRemove,
...variablesToRemove,
...expressionsToRemove,
...Object.keys(rawCodeToReplace),
];
for (const codeFragment of codeFragments) {
if (!codeTranspiledToCommonJS.includes(codeFragment)) {
throw new Error(`did not find expected code fragment: ${codeFragment}`);
}
}
const printer = ts.createPrinter({newLine: ts.NewLineKind.LineFeed}, {
substituteNode(hint, node) {
let removeNode = false;
if (ts.isMethodDeclaration(node) &&
// Make typescript happy.
!ts.isComputedPropertyName(node.name) &&
methodsToRemove.includes(node.name.text)) {
removeNode = true;
}
if (ts.isClassDeclaration(node) && node.name && classesToRemove.includes(node.name.text)) {
removeNode = true;
}
if (ts.isExpressionStatement(node)) {
const asString = simplePrinter.printNode(ts.EmitHint.Unspecified, node, sourceFile);
if (classesToRemove.some(className => asString.includes(className))) {
removeNode = true;
}
if (expressionsToRemove.some(className => asString.includes(className))) {
removeNode = true;
}
}
if (ts.isVariableDeclarationList(node) && node.declarations.length === 1) {
// @ts-expect-error: is read-only, but whatever.
node.declarations =
node.declarations.filter(d => !variablesToRemove.includes(d.name.getText()));
if (node.declarations.length === 0) removeNode = true;
}
if (removeNode) {
return ts.createNode(ts.SyntaxKind.Unknown);
}
return node;
},
});
let sourceFilePrinted = '';
sourceFile.forEachChild(node => {
sourceFilePrinted += printer.printNode(ts.EmitHint.Unspecified, node, sourceFile) + '\n';
});
for (const [code, replacement] of Object.entries(rawCodeToReplace)) {
sourceFilePrinted = sourceFilePrinted.replace(code, replacement);
}
const modifiedFile = [
'// @ts-nocheck\n',
'// generated by yarn build-cdt-lib\n',
'const Platform = require(\'../Platform.js\');\n',
sourceFilePrinted,
'module.exports = TextSourceMap;',
].join('');
fs.writeFileSync(`${outDir}/${outFilename}`, modifiedFile);
}