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

fix(terser): support pure functions for nth_identifier #17589

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
1 change: 1 addition & 0 deletions packages/vite/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@
"source-map-support": "^0.5.21",
"strip-ansi": "^7.1.0",
"strip-literal": "^2.1.0",
"terser": "^5.31.6",
"tsconfck": "^3.1.3",
"tslib": "^2.7.0",
"types": "link:./types",
Expand Down
45 changes: 45 additions & 0 deletions packages/vite/src/node/__tests__/plugins/terser.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { resolve } from 'node:path'
import { fileURLToPath } from 'node:url'
import { describe, expect, test } from 'vitest'
import { build } from 'vite'
import type { RollupOutput } from 'rollup'

const __dirname = resolve(fileURLToPath(import.meta.url), '..')

describe('terser', () => {
test('nth', async () => {
const result = (await build({
root: resolve(__dirname, '../packages/build-project'),
logLevel: 'silent',
build: {
write: false,
minify: 'terser',
terserOptions: {
mangle: {
nth_identifier: {
get: (n) => {
return 'prefix_' + n.toString()
},
},
},
},
},
plugins: [
{
name: 'test',
resolveId(id) {
if (id === 'entry.js') {
return '\0' + id
}
},
load(id) {
if (id === '\0entry.js') {
return `const foo = 1;console.log(foo)`
}
},
},
],
})) as RollupOutput
expect(result.output[0].code).toContain('prefix_')
})
})
40 changes: 40 additions & 0 deletions packages/vite/src/node/plugins/terser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ const loadTerserPath = (root: string) => {
return terserPath
}

const toString = (obj: Record<string, any>, name: string) => {
if (name in obj && typeof obj[name] === 'function') {
obj[name] = obj[name].toString()
}
}

export function terserPlugin(config: ResolvedConfig): Plugin {
const { maxWorkers, ...terserOptions } = config.build.terserOptions

Expand All @@ -47,6 +53,27 @@ export function terserPlugin(config: ResolvedConfig): Plugin {
// test fails when using `import`. maybe related: https://github.com/nodejs/node/issues/43205
// eslint-disable-next-line no-restricted-globals -- this function runs inside cjs
const terser = require(terserPath)
const nth:
| Terser.SimpleIdentifierMangler
| Terser.WeightedIdentifierMangler
| undefined = (options.mangle as any)?.nth_identifier
if (nth && typeof nth === 'object') {
const toFunction = (obj: Record<string, any>, name: string) => {
if (name in obj && typeof obj[name] === 'string') {
const fn = eval(obj[name])
if (typeof fn !== 'function') {
throw new Error(
`Failed to eval nth_identifier.${name}: not a function`,
)
}
obj[name] = fn
}
}
toFunction(nth, 'get')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you tried running this code? The Worker is using https://github.com/sapphi-red/artichokie and it stringifies its content to run in worker threads so it cannot access variables / functions declared outside of its scope.

The toFunction needs to be moved to inside the worker.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's kinda surprising to me that the tests passed with this change - it looks like we don't have a test case covering terser minification. /cc @sapphi-red

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😓 sorry I didn't test it, I was hoping the CI would catch any errors. I'll add a test case for both n_th options

toFunction(nth, 'consider')
toFunction(nth, 'sort')
}

return terser.minify(code, options) as Terser.MinifyOutput
},
{
Expand Down Expand Up @@ -87,12 +114,25 @@ export function terserPlugin(config: ResolvedConfig): Plugin {
worker ||= makeWorker()

const terserPath = loadTerserPath(config.root)
const nth =
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at terser option types, it seems mangle.properties can also contain nth functions: https://github.com/vitejs/vite/blob/main/packages/vite/src/types/terser.d.ts#L118

I was going to propose a more generic function serialize / revive mechanism, but it looks like these are the only two places where functions may appear in all terser options.

@sapphi-red are you aware of other places where we use workers this way and may require handling functions?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For other places that require sync function options, it's falling back to running them on the main thread as the function itself might not be serializable. For example, the importer/plugin might be a 3rd party package and could reference a variable outside the function.

shouldUseFake(_sassPath, _data, options) {
// functions and importer is a function and is not serializable
// in that case, fallback to running in main thread
return !!(
(options.functions && Object.keys(options.functions).length > 0) ||
(options.importer &&
(!Array.isArray(options.importer) || options.importer.length > 0))
)
},

shouldUseFake(_lessPath, _content, options) {
// plugins are a function and is not serializable
// in that case, fallback to running in main thread
return options.plugins?.length > 0
},

{
shouldUseFake(_stylusPath, _content, _root, options) {
// define can include functions and those are not serializable
// in that case, fallback to running in main thread
return !!(
options.define &&
Object.values(options.define).some((d) => typeof d === 'function')
)
},

For async functions, parentFunctions is used. It calls the function on the main thread from the worker by serializing the input/output.

parentFunctions: { internalImporter },

parentFunctions: { viteLessResolve },

I guess we can call sync functions on the main thread from the worker without making it async by using Atomics.wait if we want to. But I'm not sure how the performance will be.

typeof terserOptions.mangle === 'object'
? { ...terserOptions.mangle.nth_identifier }
: undefined
if (nth) {
toString(nth, 'get')
toString(nth, 'consider')
toString(nth, 'sort')
}
const res = await worker.run(terserPath, code, {
safari10: true,
...terserOptions,
sourceMap: !!outputOptions.sourcemap,
module: outputOptions.format.startsWith('es'),
toplevel: outputOptions.format === 'cjs',
mangle:
typeof terserOptions.mangle === 'object'
? { ...terserOptions.mangle, nth_identifier: nth as any }
: terserOptions.mangle,
})
return {
code: res.code!,
Expand Down
3 changes: 3 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading