test_runner: add cleanup function support to before() hooks#62166
Open
mattskel wants to merge 1 commit intonodejs:mainfrom
Open
test_runner: add cleanup function support to before() hooks#62166mattskel wants to merge 1 commit intonodejs:mainfrom
mattskel wants to merge 1 commit intonodejs:mainfrom
Conversation
Add tests for cleanup hooks. Cleanup hook is returned from before hook. Await before hooks before executing cleanup hooks. Fixes: nodejs#55853 Refs: nodejs#55853 (comment)
Collaborator
|
Review requested:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements cleanup function support for before() hooks in the Node.js test runner, allowing test setup code to register teardown logic that runs after all after() hooks complete.
Motivation
Currently, the test runner lacks a symmetric teardown mechanism for before() hooks. While after() hooks exist, they don't provide the same locality of setup/teardown that cleanup functions offer. This pattern is common in other testing frameworks (e.g., Vitest, Jest) and improves test maintainability by keeping related setup and teardown code together.
Fixes: #55853
Key Features
LIFO Execution: Multiple cleanup functions execute in reverse order (last registered, first executed)
Async Support: Cleanup functions can be async
Error Handling: Errors in cleanup functions don't prevent other cleanups from running
Late Registration: Supports before() hooks registered inside test bodies
Implementation Details