buildEnd not trigger with vite 5.0.10

[MaxRenglet]

Describe the bug

Hi,

It seems that buildEnd hook is not trigger anymore in vite 5.0.10 with a custom plugin. I run npm run dev then ctl-c to exit the process and buildEnd isn't trigger.

I tried with vite 4.5.1 and it works.

For the reproduction, I created a small plugin to test it on stackblitz ! It should console.log buildStart then buildEnd when the process is exited.

Thanks for the great work btw !

Reproduction

https://stackblitz.com/edit/vitejs-vite-8cekfx?file=vite.config.js

Steps to reproduce

npm install && npm run dev

System Info

System:
    OS: macOS 14.2.1
    CPU: (11) arm64 Apple M3 Pro
    Memory: 120.44 MB / 18.00 GB
    Shell: 5.9 - /bin/zsh
  Binaries:
    Node: 20.10.0 - ~/.volta/tools/image/node/20.10.0/bin/node
    npm: 10.2.3 - ~/.volta/tools/image/node/20.10.0/bin/npm
  Browsers:
    Safari: 17.2.1
  npmPackages:
    vite: ^5.0.10 => 5.0.10

Used Package Manager

npm

Logs

No response

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• Make sure this is a Vite issue and not a framework-specific issue. For example, if it's a Vue SFC related bug, it should likely be reported to vuejs/core instead.
• Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
• The provided reproduction is a minimal reproducible example of the bug.

[stackblitz]

Start a new pull request in StackBlitz Codeflow.

• vitejs-vite-8cekfx (Open reproduction)

[userquin]

why apply: 'serve'? It shouldn't be called, if Vite 4 calling buildEnd it should be a bug (no makes sense having buildEnd in a dev plugin).

[MaxRenglet]

Hi @userquin, yeah that what i thought, buildEnd is trigger in build mode but shouldn't be trigger in dev mode.. but it does in Vite 4.5.1.

Do you know if there is a similar hook working in dev ?

[userquin]

No, but you can try adding build hooks (https://rollupjs.org/plugin-development/ and https://vitejs.dev/guide/api-plugin#transformindexhtml)... (apply can be also a function)

[MaxRenglet]

Thanks @userquin, I will figure this out.

Should I rename the issue about the buildEnd triggered in dev in Vite 4.5.1 ?

[bluwy]

buildEnd should be called in dev too, it's documented in https://vitejs.dev/guide/api-plugin.html#universal-hooks. Seems like a bug it's not being called now.

[bluwy]

I took a look, and it seemed to work in Vite 4 because we took control of Ctrl+C via setRawMode, which was part of the breaking change related to the CLI shortcuts. Any versions other than v4 didn't work, as if you're relying on this behaviour, it's similar to listening to the Node.js process-exit-hook, and it's known to not always be reliable.

We're currently using SIGTERM to listen for process exit, but that only works in controlled environments such as child processes. I tested, and only SIGINT seems to reliably get triggered, but it was removed in a04db16.

SIGINT is generally very tricky to work with unfortunately. You need to call process.exit() manually if you add a handler. But if you have multiple handlers (maybe some framework adds theirs too), then calling process.exit() will halt the subsequent added handlers.

This SO answer has some more details. If we do something similar, it might also help lessen the impact of #9470

[userquin]

@bluwy the plugin shouldn't be called in build, it has apply: 'serve', check Conditional Application

EDIT: I think I have misunderstood the issue

[bluwy]

I don't see the plugin running when running npm run build in the repro 🤔

[MaxRenglet]

Hi, @bluwy thanks for the heads up and explaination !

I will wait to see if a fix is push to migrate to Vite 5 !

Thanks ;)

[sapphi-red]

Maybe we can try signal-exit. It's used by rollup and might work well.

[TimKraemer]

the custom plugin to end the build correctly from this stackoverflow thread helped me to finally use vite 5 in my deployment workflow...

// file vite-plugin-close.ts

export default function ClosePlugin() {
    return {
        name: 'ClosePlugin', // required, will show up in warnings and errors

        // use this to catch errors when building
        buildEnd(error) {
            if(error) {
                console.error('Error bundling')
                console.error(error)
                process.exit(1)
            } else {
                console.log('Build ended')
            }
        },

        // use this to catch the end of a build without errors
        closeBundle(id) {
            console.log('Bundle closed')
            process.exit(0)
        },
    }
}

// file vite.config.ts

import ClosePlugin from './vite-plugin-close.ts'
// ...

// place the plugin in the *vite* plugins section
// NOT the rollupOptions.plugins section
        plugins: [ClosePlugin()],