/
PluginChunkReadHandler.ts
138 lines (131 loc) · 4.42 KB
/
PluginChunkReadHandler.ts
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
import { WebpackChunkHandler } from './WebpackChunkHandler';
import { WebpackChunk } from './WebpackChunk';
import { WebpackChunkModule } from './WebpackChunkModule';
import { WebpackChunkModuleIterator } from './WebpackChunkModuleIterator';
import { WebpackInnerModuleIterator } from './WebpackInnerModuleIterator';
import { FileHandler } from './FileHandler';
import { LicenseTypeIdentifier } from './LicenseTypeIdentifier';
import { FileSystem } from './FileSystem';
import { PackageJson } from './PackageJson';
import { LicenseTextReader } from './LicenseTextReader';
import { ModuleCache } from './ModuleCache';
import { LicensePolicy } from './LicensePolicy';
import { LicenseIdentifiedModule } from './LicenseIdentifiedModule';
import { WebpackCompilation } from './WebpackCompilation';
import { Logger } from './Logger';
import { WebpackStats } from './WebpackStats';
class PluginChunkReadHandler implements WebpackChunkHandler {
private moduleIterator = new WebpackChunkModuleIterator();
private innerModuleIterator = new WebpackInnerModuleIterator(require.resolve);
constructor(
private logger: Logger,
private fileHandler: FileHandler,
private licenseTypeIdentifier: LicenseTypeIdentifier,
private licenseTextReader: LicenseTextReader,
private licensePolicy: LicensePolicy,
private fileSystem: FileSystem
) {}
processChunk(
compilation: WebpackCompilation,
chunk: WebpackChunk,
moduleCache: ModuleCache,
stats: WebpackStats | undefined
) {
this.moduleIterator.iterateModules(
compilation,
chunk,
stats,
chunkModule => {
this.innerModuleIterator.iterateModules(
chunkModule,
(module: WebpackChunkModule) => {
const identifiedModule =
this.extractIdentifiedModule(module) ||
this.fileHandler.getModule(module.resource);
if (identifiedModule) {
this.processModule(
compilation,
chunk,
moduleCache,
identifiedModule
);
}
}
);
}
);
}
private extractIdentifiedModule(
module: WebpackChunkModule
): LicenseIdentifiedModule | undefined {
const resolved = module.resourceResolveData;
if (!resolved) return undefined;
const {
descriptionFileRoot: directory,
descriptionFileData: packageJson
} = resolved;
if (
this.fileHandler.isInModuleDirectory(directory) &&
!this.fileHandler.isBuildRoot(directory)
) {
return {
directory,
packageJson,
name: packageJson.name
};
}
return undefined;
}
private getPackageJson(directory: string): PackageJson {
const filename: string = `${directory}${this.fileSystem.pathSeparator}package.json`;
return JSON.parse(this.fileSystem.readFileAsUtf8(filename));
}
processModule(
compilation: WebpackCompilation,
chunk: WebpackChunk,
moduleCache: ModuleCache,
module: LicenseIdentifiedModule
) {
if (!moduleCache.alreadySeenForChunk(chunk.name, module.name)) {
const alreadyIncludedModule = moduleCache.getModule(module.name);
if (alreadyIncludedModule !== null) {
moduleCache.registerModule(chunk.name, alreadyIncludedModule);
} else {
// module not yet in cache
const packageJson =
module.packageJson ?? this.getPackageJson(module.directory);
const licenseType = this.licenseTypeIdentifier.findLicenseIdentifier(
compilation,
module.name,
packageJson
);
if (this.licensePolicy.isLicenseUnacceptableFor(licenseType)) {
this.logger.error(
compilation,
`unacceptable license found for ${module.name}: ${licenseType}`
);
this.licensePolicy.handleUnacceptableLicense(
module.name,
licenseType
);
}
if (this.licensePolicy.isLicenseWrittenFor(licenseType)) {
const licenseText = this.licenseTextReader.readLicense(
compilation,
module,
licenseType
);
moduleCache.registerModule(chunk.name, {
licenseText,
packageJson,
name: module.name,
directory: module.directory,
licenseId: licenseType
});
}
}
moduleCache.markSeenForChunk(chunk.name, module.name);
}
}
}
export { PluginChunkReadHandler };