-
Notifications
You must be signed in to change notification settings - Fork 670
Detect and handle webpack module cycles #4874
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
openshift-merge-robot
merged 2 commits into
openshift:master
from
vojtechszocs:check-cycles
Apr 2, 2020
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| /* eslint-env node */ | ||
| /* eslint-disable no-console */ | ||
|
|
||
| import * as webpack from 'webpack'; | ||
| import * as path from 'path'; | ||
| import * as fs from 'fs'; | ||
| import * as moment from 'moment'; | ||
| import * as CircularDependencyPlugin from 'circular-dependency-plugin'; | ||
|
|
||
| type PresetOptions = { | ||
| exclude: RegExp; | ||
| reportFile: string; | ||
| }; | ||
|
|
||
| type DetectedCycle = { | ||
| // webpack module record that caused the cycle | ||
| causedBy: string; | ||
| // relative module paths that make up the cycle | ||
| modulePaths: string[]; | ||
| }; | ||
|
|
||
| export class CircularDependencyPreset { | ||
| private readonly HandleCyclesPluginName = 'HandleCyclesPlugin'; | ||
|
|
||
| constructor(private readonly options: PresetOptions) {} | ||
|
|
||
| private getCycleReport(cycles: DetectedCycle[], compilation: webpack.compilation.Compilation) { | ||
| const hash = compilation.getStats().hash; | ||
| const builtAt = moment(compilation.getStats().endTime).format('MM/DD/YYYY HH:mm:ss'); | ||
|
|
||
| const countByDir = cycles | ||
| .map((c) => c.modulePaths[0].replace(/\/.*$/, '')) | ||
| .reduce((acc, dir) => { | ||
| acc[dir] = (acc[dir] ?? 0) + 1; | ||
| return acc; | ||
| }, {} as { [key: string]: number }); | ||
|
|
||
| const header = | ||
| `# webpack compilation ${hash} built at ${builtAt}\n` + | ||
| '# this file is auto-generated on every webpack development build\n'; | ||
|
|
||
| const stats = | ||
| `# ${cycles.length} total cycles: ${Object.keys(countByDir) | ||
| .map((d) => `${d} (${countByDir[d]})`) | ||
| .join(', ')}\n` + | ||
| `# ${ | ||
| cycles.filter((c) => c.modulePaths.length === 3).length | ||
| } minimal-length cycles (A -> B -> A)\n`; | ||
|
|
||
| const entries = cycles.map((c) => `${c.causedBy}\n${c.modulePaths.join('\n-> ')}\n`).join('\n'); | ||
|
|
||
| return [header, stats, entries].join('\n'); | ||
| } | ||
|
|
||
| apply(plugins: webpack.Plugin[]) { | ||
| const cycles: DetectedCycle[] = []; | ||
|
|
||
| plugins.push( | ||
| new CircularDependencyPlugin({ | ||
| exclude: this.options.exclude, | ||
| onDetected: ({ module: { resource }, paths: modulePaths }) => { | ||
| cycles.push({ causedBy: resource, modulePaths }); | ||
| }, | ||
| }), | ||
| { | ||
| // Ad-hoc plugin to handle detected module cycle information | ||
| apply: (compiler) => { | ||
| compiler.hooks.emit.tap(this.HandleCyclesPluginName, (compilation) => { | ||
| if (cycles.length === 0) { | ||
| return; | ||
| } | ||
|
|
||
| const reportPath = path.resolve(__dirname, this.options.reportFile); | ||
| fs.writeFileSync(reportPath, this.getCycleReport(cycles, compilation)); | ||
|
|
||
| console.log(`detected ${cycles.length} cycles`); | ||
| console.log(`module cycle report written to ${reportPath}`); | ||
| }); | ||
| }, | ||
| }, | ||
| ); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note, this dependency was introduced in #1456 (unused until now).