buildEnd not trigger with vite 5.0.10 #15418

Activity

1. MaxRenglet

   added

   pending triage

   on Dec 23, 2023
2. bolt-new-by-stackblitz commented on Dec 23, 2023

   

   bolt-new-by-stackblitzBot

   on Dec 23, 2023 – with Bolt.new (by StackBlitz)

   More actions

   Start a new pull request in StackBlitz Codeflow.

   • vitejs-vite-8cekfx (Open reproduction)
3. userquin commented on Dec 23, 2023

   

   userquin

   on Dec 23, 2023

   Last edited by userquin

   Contributor

   More actions

   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).
4. MaxRenglet commented on Dec 24, 2023

   

   MaxRenglet

   on Dec 24, 2023

   Author

   More actions

   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 ?
5. userquin commented on Dec 24, 2023

   

   userquin

   on Dec 24, 2023

   Contributor

   More actions

   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)
6. MaxRenglet commented on Dec 24, 2023

   

   MaxRenglet

   on Dec 24, 2023

   Author

   More actions

   Thanks @userquin, I will figure this out.

   Should I rename the issue about the buildEnd triggered in dev in Vite 4.5.1 ?
7. bluwy commented on Dec 26, 2023

   

   bluwy

   on Dec 26, 2023

   Member

   More actions

   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.
8. bluwy

   added

   pending triage

   rollup plugin compat

   p3-minor-bugAn edge case that only affects very specific usage (priority)An edge case that only affects very specific usage (priority)

   and removed

   pending triage

   on Dec 26, 2023
9. github-actions

   removed

   pending triage

   on Dec 26, 2023
10. bluwy commented on Dec 26, 2023

    

    bluwy

    on Dec 26, 2023

    Member

    More actions

    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

    👍React with 👍3Reacted by Senao, RMax and btea
11. userquin commented on Dec 26, 2023

    

    userquin

    on Dec 26, 2023

    Last edited by userquin

    Contributor

    More actions

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

    EDIT: I think I have misunderstood the issue
12. bluwy commented on Dec 26, 2023

    

    bluwy

    on Dec 26, 2023

    Member

    More actions

    I don't see the plugin running when running npm run build in the repro 🤔
13. MaxRenglet commented on Dec 27, 2023

    

    MaxRenglet

    on Dec 27, 2023

    Author

    More actions

    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 ;)

    👍React with 👍1Reacted by Tim Krämer
14. sapphi-red commented on Sep 19, 2024

    

    sapphi-red

    on Sep 19, 2024

    Member

    More actions

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

    👍React with 👍1Reacted by Mathieu Laurent
15. TimKraemer commented on Sep 26, 2024

    

    TimKraemer

    on Sep 26, 2024

    Last edited by TimKraemer

    More actions

    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()],

    👍React with 👍1Reacted by Mathieu Laurent