fix(jest): properly parent beforeAll/afterAll hooks to suite span#7078
Draft
smcroskey wants to merge 1 commit intoDataDog:masterfrom
Draft
fix(jest): properly parent beforeAll/afterAll hooks to suite span#7078smcroskey wants to merge 1 commit intoDataDog:masterfrom
smcroskey wants to merge 1 commit intoDataDog:masterfrom
Conversation
Implements proper span parenting for Jest's beforeAll and afterAll hooks to ensure they are traced as children of the test suite span, similar to the Mocha implementation in PR DataDog#2167. Changes: - Add hook type detection functions (getHookType, isSuiteLevelHook) - Create suite-level channel (suiteFnCh) for suite hook execution - Modify hook wrapping to use appropriate context (suite vs test) - Store suite context in DatadogEnvironment and suiteContexts map - Update plugin to handle suite function channel binding - Add comprehensive tests for hook instrumentation This ensures beforeAll/afterAll hooks create spans parented to the test suite span, while beforeEach/afterEach remain parented to test spans. Fixes DataDog#5677
Collaborator
juan-fernandez
left a comment
juan-fernandez
left a comment
There was a problem hiding this comment.
thanks for the contribution @smcroskey ! This is great stuff.
If I'm seeing this correctly, we should update integration-tests/ci-visibility/jest-hooks/jest-hooks-test.js to include logic in beforeAll and afterAll, for example creating a span in them and checking in integration-tests/jest/jest.spec.js that those spans are children of the test suite span.
Does this make sense?
|
|
||
| // Suite-level hooks - should be parented to suite span | ||
| beforeAll(() => { | ||
| console.log('beforeAll hook executed') |
Collaborator
There was a problem hiding this comment.
should we try to create a span in here and check in the integration test that it is indeed a child of the test suite span?
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
2 participants
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.
Description
This PR implements proper span parenting for Jest's
beforeAllandafterAllhooks to ensure they are traced as children of the test suite span, similar to the Mocha implementation in PR #2167.Problem
Currently, Jest's
beforeAllandafterAllhooks are not properly instrumented with spans that are parented to the test suite span. This means that any work done in these suite-level hooks is not visible in the trace hierarchy, making it difficult to debug setup/teardown performance issues.Solution
This implementation follows the same pattern used in the Mocha integration:
beforeAll/afterAll) and test-level hooks (beforeEach/afterEach)Changes
Core Implementation
getHookType()andisSuiteLevelHook()functions to identify hook typessuiteFnChfor suite hook executionsuiteSpanContextto DatadogEnvironment andsuiteContextsmapci:jest:suite:fnchannel handlingTesting
Related Issues
Fixes #5677
Testing
Notes
This is a draft PR for initial review. The implementation has been tested locally and follows the established patterns from the Mocha integration.