forked from node-opcua/node-opcua
-
Notifications
You must be signed in to change notification settings - Fork 0
/
extractModules.js
405 lines (371 loc) · 14.3 KB
/
extractModules.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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
/* eslint-disable complexity */
const fs = require("fs");
const path = require("path");
const ts = require("typescript");
const chalk = require("chalk");
const Hjson = require('hjson');
function isNodeJSModule(m) {
return (
[
"assert",
"child_process",
"crypto",
"dns",
"events",
"fs",
"http",
"net",
"os",
"path",
"stream",
"timers",
"url",
"util"
].indexOf(m) !== -1
);
}
function isRelativeModule(m) {
return m[0] === ".";
}
function isExternalModule(m) {
return !isNodeJSModule(m) && !isRelativeModule(m);
}
function getModuleName(str) {
if (str[0] === "@") {
return str.split("/").slice(0, 2).join("/");
}
return str.split("/")[0];
}
function test(input, expected) {
const actual = getModuleName(input);
if (actual !== expected) {
throw new Error(`expecting getModuleName("${input}") == "${expected}" but got "${actual}"`);
}
}
test("@types/node", "@types/node");
test("@types/node/other", "@types/node");
test("a/b", "a");
test("@sterfive/abcdef", "@sterfive/abcdef");
async function exploreSourceFile(filename) {
const filename1 = path.basename(filename);
const source = fs.readFileSync(filename, "utf8"); // sourceText
return exploreSourceFileInner(source, filename1);
}
async function exploreSourceFileInner(source, filename1) {
const node = ts.createSourceFile(
filename1, // fileName
source,
ts.ScriptTarget.Latest // langugeVersion
);
// console.log("filename", filename);
const modules = [];
node.forEachChild((child) => {
// console.log(ts.SyntaxKind[child.kind]);
if (child.kind === ts.SyntaxKind.ExportDeclaration) {
if (!child.moduleSpecifier || !child.moduleSpecifier.text) {
console.log("filename1 = ", filename1);
console.log(child);
process.exit(0);
}
const moduleName = getModuleName(child.moduleSpecifier.text);
if (isExternalModule(moduleName)) {
modules.push(moduleName);
}
} else if (child.kind === ts.SyntaxKind.ImportDeclaration) {
if (!child.moduleSpecifier || !child.moduleSpecifier.text) {
console.log("filename1 = ", filename1);
console.log(child);
}
// console.log("found (ts) ", child.moduleSpecifier.text);
const moduleName = getModuleName(child.moduleSpecifier?.text);
if (isExternalModule(moduleName)) {
modules.push(moduleName);
}
} else if (child.kind === ts.SyntaxKind.FirstStatement) {
// console.log(" ", child.declarationList.declarations);
const s = child.declarationList.declarations[0];
if (s.initializer?.kind === ts.SyntaxKind.PropertyAccessExpression) {
// detecting const a = require("B").c;
const e = s.initializer.expression;
if (e.kind === ts.SyntaxKind.CallExpression) {
if (e.expression.escapedText === "require") {
const moduleName = getModuleName(e.arguments[0]?.text);
// console.log("found (js) ", s.initializer.arguments[0]?.text, moduleName);
if (isExternalModule(moduleName)) {
modules.push(moduleName);
}
}
}
} else if (s.initializer?.kind === ts.SyntaxKind.CallExpression) {
// detecting const a = require("B");
if (s.initializer?.expression?.escapedText === "require") {
const moduleName = getModuleName(s.initializer.arguments[0]?.text);
// console.log("found (js) ", s.initializer.arguments[0]?.text, moduleName);
if (isExternalModule(moduleName)) {
modules.push(moduleName);
}
}
}
} else if (child.kind === ts.SyntaxKind.ExpressionStatement) {
if (child.expression.kind === ts.SyntaxKind.CallExpression) {
if (child.expression.expression.escapedText === "require") {
const m = child.expression.arguments[0].text;
const moduleName = getModuleName(m);
// console.log("found (js) ", s.initializer.arguments[0]?.text, moduleName);
if (isExternalModule(moduleName)) {
modules.push(moduleName);
}
}
}
} else if (child.kind === ts.SyntaxKind.ImportEqualsDeclaration) {
// import envpath = require("env-path");
const moduleName = getModuleName(child.name.escapedText);
if (isExternalModule(moduleName)) {
modules.push(moduleName);
}
}
});
return [...new Set(modules).values()].sort();
}
async function onAllSource(folder, bucket, options) {
const recursive = !options || options.recursive;
const filesAndFolder = await fs.promises.readdir(folder, { withFileTypes: true });
for (const d of filesAndFolder) {
const fullPathName = path.join(folder, d.name);
if (d.isSymbolicLink()) {
//xx console.log("ignoring symbolic link", fullPathName);
} else if (d.isDirectory()) {
recursive && (await onAllSource(fullPathName, bucket));
} else {
const e = path.extname(d.name);
if (e === ".js" || e === ".ts") {
const modules = await exploreSourceFile(fullPathName);
//xx console.log("modules ", modules.join(" "));
bucket.modules = [...new Set(bucket.modules.concat(modules)).values()].sort();
}
}
}
}
const monoRepoPackages = new Map();
async function onModule(folder, bucketDependencies, bucketDevDependencies) {
monoRepoPackages.set(path.basename(folder), folder);
const { sourceFolders, devFolders, ignoreFolders, unknownFolders } = await extractSourceAndDevFolders(folder);
// console.log({ sourceFolders, devFolders, ignoreFolders, unknownFolders });
for (const f of sourceFolders) {
await onAllSource(path.join(folder, f), bucketDependencies);
}
await onAllSource(folder, bucketDependencies, { recursive: false });
for (const f of devFolders) {
await onAllSource(path.join(folder, f), bucketDevDependencies);
}
// make sure that bucketDevDependencies do not have modules already required by bucketDependencies
const m = new Set(bucketDependencies.modules);
bucketDevDependencies.modules = bucketDevDependencies.modules.filter((a) => !m.has(a));
unknownFolders.length && console.log("unknownFolder : ", unknownFolders.join(" "));
}
/**
* @type {[key:string]: string[]}
*/
const _graph = {};
/**
*
* @param {string} parent
* @param {string[]} children
*/
function addDependencies(parent, children) {
if (_graph[parent]) {
throw new Error("parent already inserted");
}
_graph[parent] = children;
}
/**
*
* @param {string} parent
*/
function verifyCycle(parent) {
let cycleCount = 0;
const m = new Set();
/**
* @type string[]
*/
const p = _graph[parent];
const cur = p;
function visit(cur, m, path) {
for (const child of cur) {
const c = _graph[child];
// not visited yet
if (!c) {
continue;
}
if (m.has(child)) continue;
const ind = c.indexOf(parent);
if (ind >= 0) {
cycleCount++;
console.log("Found cycle ", path, " => ", child);
// console.log("child ", child,c);
// console.log()
return;
}
if (!m.has(child)) {
m.add(child);
visit(c, m, path + " => " + child);
}
}
}
visit(cur, m, parent);
return cycleCount;
}
async function extractSourceAndDevFolders(folder) {
const sourceFolders = [];
const devFolders = [];
const ignoreFolders = [];
const unknownFolders = [];
const filesAndFolder = await fs.promises.readdir(folder, { withFileTypes: true });
for (const d of filesAndFolder) {
if (!d.isDirectory()) continue;
if (d.name === "dist" || d.name === "node_modules" || d.name.match(/^dist/)) {
ignoreFolders.push(d.name);
continue;
}
if (d.name === "src" || d.name.match(/^source/) || d.name === "bin") {
sourceFolders.push(d.name);
continue;
}
if (d.name.match(/test/) || d.name.match(/fixture/)) {
devFolders.push(d.name);
continue;
}
unknownFolders.push(d.name);
}
return { sourceFolders, devFolders, ignoreFolders, unknownFolders };
}
function caculateDifference(expected, actual) {
const expectedSet = new Set(expected);
const actualSet = new Set(actual);
const missing = [...expectedSet].filter((d) => !actualSet.has(d));
const extra = [...actualSet].filter((d) => !expectedSet.has(d));
return { missing, extra };
}
async function analyzePackageFolder(folder, packageName) {
const packageJsonFile = path.join(folder, "package.json");
if (!fs.existsSync(packageJsonFile)) {
return;
// not a module
}
const packageJson = JSON.parse(await fs.promises.readFile(packageJsonFile, "utf-8"));
console.log(" -------------> ", folder);
const bucketDependencies = { modules: [] };
const bucketDevDependencies = { modules: [] };
await onModule(folder, bucketDependencies, bucketDevDependencies);
if (false) {
console.log(bucketDependencies);
console.log(bucketDevDependencies);
}
// now compare with what is in package .json
function fixArrobasTypeDefinition(bucket, dependencies) {
const dep = Object.keys(dependencies || {});
const arrobasType = dep.filter((m) => !!m.match(/@types/)).map((x) => x.replace("@types/", ""));
if (arrobasType.length) {
console.log(chalk.yellow("arrobasType"), arrobasType);
}
const m = new Set(Object.keys(dependencies || {}));
const extraArrobas = arrobasType.filter((d) => !m.has(d));
if (extraArrobas.length) {
console.log(chalk.green("unnecessary types="), extraArrobas.join(" "));
}
for (const k of dep.filter((m) => m.match(/@types/))) {
delete dependencies[k];
}
}
function extractMissingAndExtra(title, bucket, dependencies) {
const { missing, extra } = caculateDifference(bucket.modules, Object.keys(dependencies || {}));
if (missing.length || extra.length) {
const msg =
title.padEnd(15, " ") +
" missing :" +
chalk.cyan(missing.join(" ")) +
"\n" +
title.padEnd(15, " ") +
" extra :" +
chalk.yellow(extra.join(" "));
console.log(msg);
console.log("------");
}
return { missing, extra };
}
{
fixArrobasTypeDefinition(bucketDependencies, packageJson.dependencies);
const { missing, extra } = extractMissingAndExtra("dependencies", bucketDependencies, packageJson.dependencies);
}
{
fixArrobasTypeDefinition(bucketDevDependencies, packageJson.devDependencies);
const { missing, extra } = extractMissingAndExtra("devDependencies", bucketDevDependencies, packageJson.devDependencies);
}
addDependencies(packageName, [...bucketDependencies.modules, ...bucketDevDependencies.modules]);
}
async function main() {
const folder = path.join(__dirname, "packages");
const filesAndFolder = await fs.promises.readdir(folder, { withFileTypes: true });
for (const d of filesAndFolder) {
if (d.isDirectory()) {
await analyzePackageFolder(path.join(folder, d.name), d.name);
}
}
let cycleCount = 0;
for (const m of Object.keys(_graph)) {
cycleCount += verifyCycle(m);
}
console.log(cycleCount ? chalk.red(`${cycleCount} cycles have been found !`) : chalk.green("OK"));
// console.log(_graph);
// - verify tsconfig.json files
console.log(monoRepoPackages);
function getMonoRepoPackage(m) {
console.log(m, monoRepoPackages.has(m));
return monoRepoPackages.has(m) ? monoRepoPackages.get(m) : null;
}
for (const m of Object.keys(_graph)) {
const p = getMonoRepoPackage(m);
if (!p) continue;
const tsConfigFilename = path.join(p, "tsconfig.json");
try {
// var obj = Hjson.parse(hjsonText);
const tsConfig = Hjson.parse(fs.readFileSync(tsConfigFilename, "utf-8"));
const references = tsConfig.references || [];
const actual = references.map((r) => path.basename(r.path)).sort();
const expected = _graph[m].filter((m) => monoRepoPackages.has(m)).sort();
const { missing, extra } = caculateDifference(expected, actual);
if (missing.length || extra.length) {
console.log("m =", m);
// console.log("expected = ", expected.join(" "));
// console.log("actual = ", actual.join(" "));
console.log("missing = ", chalk.cyan(missing.join(" ")));
console.log("extra = ", chalk.yellow(extra.join(" ")));
}
} catch (err) {
console.log("tsConfigFilename = ", tsConfigFilename);
console.log(err);
throw err;
}
}
}
async function test2() {
const source = `
import sinon = require("sinon");
import * as foo from "foo1";
import * as path from "path";
const a = require("foo2");
const b = require("foo3/folder");
const c = require("@foo4/foo4");
export { a } from "foo5";
export * from "foo6";
import { a, b } from "..";
import { v } from "../foo7";
`;
const actual = (await exploreSourceFileInner(source, "foo")).join(" - ");
const expected = "@foo4/foo4 - foo1 - foo2 - foo3 - foo5 - foo6 - sinon";
if (actual !== expected) {
throw new Error(`expecting "${expected}" but got "${actual}"`);
}
}
test2();
main();