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.

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

feat: allow entryFileNames, chunkFileNames functions for legacy #4122

Merged
merged 2 commits into from
Jul 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 27 additions & 1 deletion packages/playground/legacy/__tests__/legacy.spec.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { isBuild } from '../../testUtils'
import { isBuild, untilUpdated } from '../../testUtils'

test('should work', async () => {
expect(await page.textContent('#app')).toMatch('Hello')
Expand All @@ -18,3 +18,29 @@ test('wraps with iife', async () => {
'exposed babel helpers: false'
)
})

test('generates assets', async () => {
await untilUpdated(
() => page.textContent('#assets'),
isBuild
? [
'index: 404',
'index-legacy: 404',
'chunk-async: 404',
'chunk-async-legacy: 404',
'immutable-chunk: 200',
'immutable-chunk-legacy: 200',
'polyfills-legacy: 404'
].join('\n')
: [
'index: 404',
'index-legacy: 404',
'chunk-async: 404',
'chunk-async-legacy: 404',
'immutable-chunk: 404',
'immutable-chunk-legacy: 404',
'polyfills-legacy: 404'
].join('\n'),
true
)
})
18 changes: 18 additions & 0 deletions packages/playground/legacy/immutable-chunk.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
const chunks = [
'index',
'index-legacy',
'chunk-async',
'chunk-async-legacy',
'immutable-chunk',
'immutable-chunk-legacy',
'polyfills-legacy'
]

export function fn() {
return Promise.all(
chunks.map(async (name) => {
const response = await fetch(`/assets/${name}.js`)
return `${name}: ${response.status}`
})
)
}
1 change: 1 addition & 0 deletions packages/playground/legacy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ <h1 id="app"></h1>
<div id="env"></div>
<div id="iterators"></div>
<div id="babel-helpers"></div>
<div id="assets"></div>
<script type="module" src="./main.js"></script>
7 changes: 7 additions & 0 deletions packages/playground/legacy/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ text(
String.raw`exposed babel helpers: ${window._templateObject != null}`
)

// dynamic chunk names
import('./immutable-chunk.js')
.then(({ fn }) => fn())
.then((assets) => {
text('#assets', assets.join('\n'))
})

function text(el, text) {
document.querySelector(el).textContent = text
}
14 changes: 13 additions & 1 deletion packages/playground/legacy/vite.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,19 @@ module.exports = {

build: {
// make tests faster
minify: false
minify: false,

rollupOptions: {
output: {
chunkFileNames(chunkInfo) {
if (chunkInfo.name === 'immutable-chunk') {
return `assets/${chunkInfo.name}.js`
}

return `assets/chunk-[name].[hash].js`
}
}
}
},

// special test only hook
Expand Down
59 changes: 36 additions & 23 deletions packages/plugin-legacy/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ function viteLegacyPlugin(options = {}) {
},

async generateBundle(opts, bundle) {
if (!isLegacyOutput(opts)) {
if (!isLegacyBundle(bundle, opts)) {
if (!modernPolyfills.size) {
return
}
Expand Down Expand Up @@ -168,8 +168,9 @@ function viteLegacyPlugin(options = {}) {
}

/**
* @param {string|((chunkInfo: import('rollup').PreRenderedChunk)=>string)} fileNames
* @param {string | ((chunkInfo: import('rollup').PreRenderedChunk) => string)} fileNames
* @param {string?} defaultFileName
* @returns {(chunkInfo: import('rollup').PreRenderedChunk) => string)}
*/
const getLegacyOutputFileName = (
fileNames,
Expand All @@ -179,21 +180,20 @@ function viteLegacyPlugin(options = {}) {
return path.posix.join(config.build.assetsDir, defaultFileName)
}

// does not support custom functions.
if (typeof fileNames === 'function') {
throw new Error(
`@vitejs/plugin-legacy rollupOptions.output.entryFileNames and rollupOptions.output.chunkFileNames` +
` does not support the function format.`
)
}
return (chunkInfo) => {
let fileName =
typeof fileNames === 'function' ? fileNames(chunkInfo) : fileNames

let fileName = defaultFileName
// Custom string file return format.
if (fileNames && typeof fileNames === 'string') {
fileName = fileNames.replace(/\[name\]/, '[name]-legacy')
}
if (fileName.includes('[name]')) {
// [name]-[hash].[format] -> [name]-legacy-[hash].[format]
fileName = fileName.replace('[name]', '[name]-legacy')
} else {
// entry.js -> entry-legacy.js
fileName = fileName.replace(/(.+)\.(.+)/, '$1-legacy.$2')
}

return fileName
return fileName
}
}

/**
Expand All @@ -219,7 +219,7 @@ function viteLegacyPlugin(options = {}) {
},

renderChunk(raw, chunk, opts) {
if (!isLegacyOutput(opts)) {
if (!isLegacyChunk(chunk, opts)) {
if (
options.modernPolyfills &&
!Array.isArray(options.modernPolyfills)
Expand Down Expand Up @@ -399,7 +399,7 @@ function viteLegacyPlugin(options = {}) {
},

generateBundle(opts, bundle) {
if (isLegacyOutput(opts)) {
if (isLegacyBundle(bundle, opts)) {
// avoid emitting duplicate assets
for (const name in bundle) {
if (bundle[name].type === 'asset') {
Expand Down Expand Up @@ -564,14 +564,27 @@ function polyfillsPlugin(imports) {
}

/**
* @param {import('rollup').RenderedChunk} chunk
* @param {import('rollup').NormalizedOutputOptions} options
*/
function isLegacyOutput(options) {
return (
options.format === 'system' &&
typeof options.entryFileNames === 'string' &&
options.entryFileNames.includes('-legacy')
)
function isLegacyChunk(chunk, options) {
return options.format === 'system' && chunk.fileName.includes('-legacy')
}

/**
* @param {import('rollup').OutputBundle} bundle
* @param {import('rollup').NormalizedOutputOptions} options
*/
function isLegacyBundle(bundle, options) {
if (options.format === 'system') {
const entryChunk = Object.values(bundle).find(
(output) => output.type === 'chunk' && output.isEntry
)

return !!entryChunk && entryChunk.fileName.includes('-legacy')
}

return false
}

/**
Expand Down