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

perf(nuxt): only update changed templates #26250

Merged
merged 5 commits into from
Mar 14, 2024
Merged

perf(nuxt): only update changed templates #26250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
62ee986
perf: only update changed templates
antfu Mar 14, 2024
dca4817
[autofix.ci] apply automated fixes
autofix-ci[bot] Mar 14, 2024
801c630
perf: reduce iterations and add `.modified` property
danielroe Mar 14, 2024
ee15ac2
Merge remote-tracking branch 'origin/main' into perf/template-regener…
danielroe Mar 14, 2024
ad770fe
chore: remove return
danielroe Mar 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 16 additions & 8 deletions packages/nuxt/src/core/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,19 +44,23 @@
.map(async (template) => {
const fullPath = template.dst || resolve(nuxt.options.buildDir, template.filename!)
const mark = performance.mark(fullPath)
const oldContents = nuxt.vfs[fullPath]
const contents = await compileTemplate(template, templateContext).catch((e) => {
logger.error(`Could not compile template \`${template.filename}\`.`)
throw e
})

nuxt.vfs[fullPath] = contents
template.modified = oldContents !== contents
if (template.modified) {
nuxt.vfs[fullPath] = contents

const aliasPath = '#build/' + template.filename!.replace(/\.\w+$/, '')
nuxt.vfs[aliasPath] = contents
const aliasPath = '#build/' + template.filename!.replace(/\.\w+$/, '')
nuxt.vfs[aliasPath] = contents

// In case a non-normalized absolute path is called for on Windows
if (process.platform === 'win32') {
nuxt.vfs[fullPath.replace(/\//g, '\\')] = contents
// In case a non-normalized absolute path is called for on Windows
if (process.platform === 'win32') {
nuxt.vfs[fullPath.replace(/\//g, '\\')] = contents
}
}

const perf = performance.measure(fullPath, mark?.name) // TODO: remove when Node 14 reaches EOL
Expand All @@ -66,7 +70,7 @@
logger.info(`Compiled \`${template.filename}\` in ${setupTime}ms`)
}

if (template.write) {
if (template.modified && template.write) {
writes.push(() => {
mkdirSync(dirname(fullPath), { recursive: true })
writeFileSync(fullPath, contents, 'utf8')
Expand All @@ -78,7 +82,11 @@
// runtime overhead of cascading HMRs from vite/webpack
for (const write of writes) { write() }

await nuxt.callHook('app:templatesGenerated', app, filteredTemplates, options)
const changedTemplates = filteredTemplates.filter(t => t.modified)

if (changedTemplates.length) {
await nuxt.callHook('app:templatesGenerated', app, changedTemplates, options)
}
}

/** @internal */
Expand Down Expand Up @@ -225,7 +233,7 @@
for (const plugin of _plugins) {
// Make sure dependency plugins are registered
if (plugin.dependsOn && plugin.dependsOn.some(name => !pluginNames.includes(name))) {
console.error(`Plugin \`${plugin.name}\` depends on \`${plugin.dependsOn.filter(name => !pluginNames.includes(name)).join(', ')}\` but they are not registered.`)

Check warning on line 236 in packages/nuxt/src/core/app.ts

View workflow job for this annotation

GitHub Actions / code 

Unexpected console statement
}
// Make graph to detect circular dependencies
if (plugin.name) {
Expand All @@ -234,7 +242,7 @@
}
const checkDeps = (name: string, visited: string[] = []): string[] => {
if (visited.includes(name)) {
console.error(`Circular dependency detected in plugins: ${visited.join(' -> ')} -> ${name}`)

Check warning on line 245 in packages/nuxt/src/core/app.ts

View workflow job for this annotation

GitHub Actions / code 

Unexpected console statement
return []
}
visited.push(name)
Expand Down
1 change: 1 addition & 0 deletions packages/schema/src/types/nuxt.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ export interface NuxtTemplate<Options = TemplateDefaultOptions> {
export interface ResolvedNuxtTemplate<Options = TemplateDefaultOptions> extends NuxtTemplate<Options> {
filename: string
dst: string
modified?: boolean
}

export interface NuxtTypeTemplate<Options = TemplateDefaultOptions> extends Omit<NuxtTemplate<Options>, 'write' | 'filename'> {
Expand Down