Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: filter chunk assets #655

Closed
wants to merge 3 commits into from
Closed

feat: filter chunk assets #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5710eab
add filter option
cahnory Nov 2, 2020
8e57eca
rename filter option to filterChunk
cahnory Nov 2, 2020
d1dca8c
fix filterChunk extractor option unit test
cahnory Jan 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 21 additions & 20 deletions packages/server/__fixtures__/stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"errors": [],
"warnings": [],
"version": "4.41.0",
"hash": "3e6566a0799a062ba9c6",
"version": "4.46.0",
"hash": "6bd3f3f9c2fe8a3d1b0f",
"publicPath": "/dist/node/",
"outputPath": "../../examples/server-side-rendering/public/dist/node",
"assetsByChunkName": {
Expand Down Expand Up @@ -201,7 +201,7 @@
},
{
"name": "main.js",
"size": 13586,
"size": 13582,
"chunks": [
"main"
],
Expand Down Expand Up @@ -511,7 +511,7 @@
"files": [
"Y-file.js"
],
"hash": "b4d8d777cba1919ad570",
"hash": "e57a651e1c0b1f68eff1",
"siblings": [],
"parents": [
"main"
Expand All @@ -535,7 +535,7 @@
"letters-A.css",
"letters-A.js"
],
"hash": "0c15a7fd2a22c9b265fa",
"hash": "eb9a32a6db31b2899f58",
"siblings": [],
"parents": [
"main"
Expand All @@ -559,7 +559,7 @@
"letters-A-css.css",
"letters-A-css.js"
],
"hash": "8028b2657cb1626f301d",
"hash": "89c9874f01b1e3949436",
"siblings": [],
"parents": [
"main"
Expand All @@ -582,7 +582,7 @@
"files": [
"letters-B.js"
],
"hash": "84099bce3af835a0d9b3",
"hash": "a3dc7ba1a249083fd1a2",
"siblings": [],
"parents": [
"main"
Expand All @@ -605,7 +605,7 @@
"files": [
"letters-C.js"
],
"hash": "e2e5758bdd6bdbcd8c64",
"hash": "0873e4e07b1949c2212a",
"siblings": [],
"parents": [
"main"
Expand All @@ -628,7 +628,7 @@
"files": [
"letters-D.js"
],
"hash": "698cbca6bfdf9fbf1074",
"hash": "611804f2589a69fd908c",
"siblings": [],
"parents": [
"main"
Expand All @@ -651,7 +651,7 @@
"files": [
"letters-E.js"
],
"hash": "21404278fb1a3c5e67ad",
"hash": "1c23ff7e41756c9ac4c7",
"siblings": [],
"parents": [
"main"
Expand All @@ -674,7 +674,7 @@
"files": [
"letters-E-param.js"
],
"hash": "5253b4e1e5e59e52c4fa",
"hash": "94c459d9fc0e6f9c1ec1",
"siblings": [],
"parents": [
"main"
Expand All @@ -697,7 +697,7 @@
"files": [
"letters-F.js"
],
"hash": "4f9fef34f4df74392d9f",
"hash": "d0a6bbc708c2980012bc",
"siblings": [],
"parents": [
"main"
Expand All @@ -713,14 +713,14 @@
"rendered": true,
"initial": false,
"entry": false,
"size": 153,
"size": 166,
"names": [
"letters-G"
],
"files": [
"letters-G.js"
],
"hash": "0119642059748a42b121",
"hash": "05ba7bf72eab83fb0877",
"siblings": [],
"parents": [
"main"
Expand All @@ -743,7 +743,7 @@
"files": [
"letters-Z-file.js"
],
"hash": "21d8cde8b6e3c5c8b362",
"hash": "9a7d56059319a25320c1",
"siblings": [],
"parents": [
"main"
Expand All @@ -759,15 +759,15 @@
"rendered": true,
"initial": true,
"entry": true,
"size": 14368,
"size": 14654,
"names": [
"main"
],
"files": [
"main.css",
"main.js"
],
"hash": "f2e7d69a2c13975fa3a9",
"hash": "af91cc7eead6c72e727d",
"siblings": [],
"parents": [],
"children": [
Expand Down Expand Up @@ -849,7 +849,7 @@
"files": [
"*"
],
"hash": "ae6a81c348917f377d61",
"hash": "0bd7ee33f38ce0c05d66",
"siblings": [],
"parents": [],
"children": [],
Expand Down Expand Up @@ -1010,7 +1010,7 @@
"files": [
"*"
],
"hash": "3de4c2d6fb7d56e8b981",
"hash": "db3f80a505f46970d1ec",
"siblings": [],
"parents": [],
"children": [],
Expand Down Expand Up @@ -1126,5 +1126,6 @@
"children": [],
"name": "mini-css-extract-plugin node_modules/css-loader/dist/cjs.js!src/client/main.css"
}
]
],
"generator": "loadable-components"
}
17 changes: 15 additions & 2 deletions packages/server/src/ChunkExtractor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ class ChunkExtractor {
namespace = '',
outputPath,
publicPath,
filterChunk,
inputFileSystem = fs,
} = {}) {
this.namespace = namespace
Expand All @@ -210,8 +211,13 @@ class ChunkExtractor {
this.outputPath = outputPath || this.stats.outputPath
this.statsFile = statsFile
this.entrypoints = Array.isArray(entrypoints) ? entrypoints : [entrypoints]
this.filterChunk = filterChunk || Boolean
this.chunks = []
this.inputFileSystem = inputFileSystem
this.assetsByName = this.stats.assets.reduce((acc, asset) => {
acc[asset.name] = asset
return acc
}, {})
}

resolvePublicUrl(filename) {
Expand All @@ -230,10 +236,16 @@ class ChunkExtractor {
return chunkInfo
}

isExctractableChunkAsset(chunk) {
return isValidChunkAsset(chunk) && this.filterChunk(chunk)
}

createChunkAsset({ filename, chunk, type, linkType }) {
const resolvedFilename =
typeof filename === 'object' && filename.name ? filename.name : filename

const asset = this.assetsByName[resolvedFilename]

return {
filename: resolvedFilename,
scriptType: getFileScriptType(resolvedFilename),
Expand All @@ -242,6 +254,7 @@ class ChunkExtractor {
path: path.join(this.outputPath, resolvedFilename),
type,
linkType,
info: asset ? asset.info : {},
}
}

Expand All @@ -257,7 +270,7 @@ class ChunkExtractor {
linkType: 'preload',
}),
)
.filter(isValidChunkAsset)
.filter(this.isExctractableChunkAsset, this)
}

if (Array.isArray(chunks)) {
Expand All @@ -280,7 +293,7 @@ class ChunkExtractor {
linkType: type,
}),
)
.filter(isValidChunkAsset)
.filter(this.isExctractableChunkAsset, this)
}

if (Array.isArray(chunks)) {
Expand Down
43 changes: 43 additions & 0 deletions packages/server/src/ChunkExtractor.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,49 @@ describe('ChunkExtrator', () => {
`)
})

it('should use filterChunk from options', () => {
const filteredExtractor = new ChunkExtractor({
stats,
outputPath: targetPath,
filterChunk: ({ chunk }) => chunk !== 'letters-B',
})
filteredExtractor.addChunk('letters-A')
filteredExtractor.addChunk('letters-B')

expect(filteredExtractor.getScriptElements()).toMatchInlineSnapshot(`
Array [
<script
dangerouslySetInnerHTML={
Object {
"__html": "[\\"letters-A\\",\\"letters-B\\"]",
}
}
id="__LOADABLE_REQUIRED_CHUNKS__"
type="application/json"
/>,
<script
dangerouslySetInnerHTML={
Object {
"__html": "{\\"namedChunks\\":[\\"letters-A\\",\\"letters-B\\"]}",
}
}
id="__LOADABLE_REQUIRED_CHUNKS___ext"
type="application/json"
/>,
<script
async={true}
data-chunk="main"
src="/dist/node/main.js"
/>,
<script
async={true}
data-chunk="letters-A"
src="/dist/node/letters-A.js"
/>,
]
`)
})

it('should add extra props if specified - function argument', () => {
extractor.addChunk('letters-A')
expect(
Expand Down