@@ -446,3 +446,169 @@ describe('watcher add/unlink error handling', () => {
446446 expect ( logError ) . toHaveBeenCalledWith ( error )
447447 } )
448448} )
449+
450+ describe ( 'closeServer hook' , ( ) => {
451+ test ( 'is called with reason "close" on server.close()' , async ( ) => {
452+ const closeServer = vi . fn ( )
453+ const server = await createServerWithPlugin ( {
454+ name : 'test' ,
455+ closeServer,
456+ } )
457+
458+ await server . close ( )
459+
460+ expect ( closeServer ) . toHaveBeenCalledTimes ( 1 )
461+ expect ( closeServer ) . toHaveBeenCalledWith ( { reason : 'close' } )
462+ } )
463+
464+ test ( 'receives a minimal plugin context as `this`' , async ( ) => {
465+ expect . assertions ( 2 )
466+
467+ const server = await createServerWithPlugin ( {
468+ name : 'test' ,
469+ closeServer ( ) {
470+ expect ( this ) . toMatchObject ( {
471+ debug : expect . any ( Function ) ,
472+ info : expect . any ( Function ) ,
473+ warn : expect . any ( Function ) ,
474+ error : expect . any ( Function ) ,
475+ meta : expect . any ( Object ) ,
476+ } )
477+ // Global hooks don't have an environment.
478+ expect ( this ) . not . toHaveProperty ( 'environment' )
479+ } ,
480+ } )
481+
482+ await server . close ( )
483+ } )
484+
485+ test ( 'is awaited before server.close() resolves' , async ( ) => {
486+ let hookDone = false
487+ const server = await createServerWithPlugin ( {
488+ name : 'test' ,
489+ async closeServer ( ) {
490+ await new Promise ( ( r ) => setTimeout ( r , 10 ) )
491+ hookDone = true
492+ } ,
493+ } )
494+
495+ await server . close ( )
496+
497+ // `server.close()` does not resolve until the async hook has completed.
498+ expect ( hookDone ) . toBe ( true )
499+ } )
500+
501+ test ( 'runs after the server is torn down (after closeBundle)' , async ( ) => {
502+ const order : string [ ] = [ ]
503+ const server = await createServerWithPlugin ( {
504+ name : 'test' ,
505+ closeBundle ( ) {
506+ order . push ( 'closeBundle' )
507+ } ,
508+ closeServer ( ) {
509+ order . push ( 'closeServer' )
510+ } ,
511+ } )
512+
513+ await server . close ( )
514+
515+ // `closeBundle` runs as part of teardown (once per environment); the
516+ // `closeServer` hook runs afterwards, so it is the last event.
517+ expect ( order . at ( - 1 ) ) . toBe ( 'closeServer' )
518+ expect ( order . indexOf ( 'closeBundle' ) ) . toBeLessThan (
519+ order . indexOf ( 'closeServer' ) ,
520+ )
521+ } )
522+
523+ test ( 'runs hooks in parallel' , async ( ) => {
524+ const events : string [ ] = [ ]
525+ const server = await createServer ( {
526+ configFile : false ,
527+ root : import . meta. dirname ,
528+ plugins : [
529+ {
530+ name : 'a' ,
531+ async closeServer ( ) {
532+ events . push ( 'a:start' )
533+ await new Promise ( ( r ) => setTimeout ( r , 20 ) )
534+ events . push ( 'a:end' )
535+ } ,
536+ } ,
537+ {
538+ name : 'b' ,
539+ async closeServer ( ) {
540+ events . push ( 'b:start' )
541+ await new Promise ( ( r ) => setTimeout ( r , 20 ) )
542+ events . push ( 'b:end' )
543+ } ,
544+ } ,
545+ resolveEntryPlugin ,
546+ ] ,
547+ logLevel : 'error' ,
548+ server : { middlewareMode : true , ws : false } ,
549+ } )
550+
551+ await server . close ( )
552+
553+ // Both hooks start before either finishes.
554+ expect ( events . slice ( 0 , 2 ) ) . toStrictEqual ( [ 'a:start' , 'b:start' ] )
555+ } )
556+
557+ test ( 'is called only once even if close() is called multiple times' , async ( ) => {
558+ const closeServer = vi . fn ( )
559+ const server = await createServerWithPlugin ( {
560+ name : 'test' ,
561+ closeServer,
562+ } )
563+
564+ await Promise . all ( [ server . close ( ) , server . close ( ) ] )
565+ await server . close ( )
566+
567+ expect ( closeServer ) . toHaveBeenCalledTimes ( 1 )
568+ } )
569+
570+ test ( 'is called with reason "restart" on server.restart()' , async ( ) => {
571+ const closeServer = vi . fn ( )
572+ const server = await createServerWithPlugin ( {
573+ name : 'test' ,
574+ closeServer,
575+ } )
576+
577+ await server . restart ( )
578+
579+ expect ( closeServer ) . toHaveBeenCalledTimes ( 1 )
580+ expect ( closeServer ) . toHaveBeenCalledWith ( { reason : 'restart' } )
581+
582+ await server . close ( )
583+ } )
584+ } )
585+
586+ describe ( 'closePreviewServer hook' , ( ) => {
587+ test ( 'is called on preview server.close()' , async ( ) => {
588+ const closePreviewServer = vi . fn ( )
589+ const server = await createPreviewServerWithPlugin ( {
590+ name : 'test' ,
591+ closePreviewServer,
592+ } )
593+
594+ await server . close ( )
595+
596+ expect ( closePreviewServer ) . toHaveBeenCalledTimes ( 1 )
597+ } )
598+
599+ test ( 'is awaited before server.close() resolves' , async ( ) => {
600+ let hookDone = false
601+ const server = await createPreviewServerWithPlugin ( {
602+ name : 'test' ,
603+ async closePreviewServer ( ) {
604+ await new Promise ( ( r ) => setTimeout ( r , 10 ) )
605+ hookDone = true
606+ } ,
607+ } )
608+
609+ await server . close ( )
610+
611+ // `server.close()` does not resolve until the async hook has completed.
612+ expect ( hookDone ) . toBe ( true )
613+ } )
614+ } )
0 commit comments