test(cwl): Fix TailLogGroup test not disposing its event listeners #6267
Conversation
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
Hweinstock
reviewed
Dec 17, 2024
packages/core/src/test/awsService/cloudWatchLogs/commands/tailLogGroup.test.ts
Outdated
Show resolved
Hide resolved
Hweinstock
reviewed
Dec 17, 2024
packages/core/src/test/awsService/cloudWatchLogs/commands/tailLogGroup.test.ts
Outdated
Show resolved
Hide resolved
justinmk3
approved these changes
Dec 17, 2024
Contributor
justinmk3
left a comment
justinmk3
left a comment
There was a problem hiding this comment.
Confirmed that No LiveTail session found for URI noise is no longer in the logs. Nice!
karanA-aws
pushed a commit
to karanA-aws/aws-toolkit-vscode
that referenced
this pull request
Jan 17, 2025
…s#6267 ## Problem Currently, the TailLogGroup tests are passing, but emitting noisy errors in the CI logs: ``` <...> No LiveTail session found for URI: test-region:test-log-group:all: Error: No LiveTail session found for URI: test-region:test-log-group:all at D:\a\aws-toolkit-vscode\aws-toolkit-vscode\packages\core\src\awsService\cloudWatchLogs\commands\tailLogGroup.ts:94:19 at AsyncLocalStorage.run (node:async_hooks:346:14) <...> ``` The cause for this, is that the event listener for closing the tailing session when Editor tabs close in TailLogGroup is not being disposed of. Disposal happens [here](https://github.com/aws/aws-toolkit-vscode/blob/master/packages/core/src/awsService/cloudWatchLogs/commands/tailLogGroup.ts#L80). However, currently the "mock response stream" in the test blocks indefinitely on an [un-resolvable promise](https://github.com/aws/aws-toolkit-vscode/blob/master/packages/core/src/test/awsService/cloudWatchLogs/commands/tailLogGroup.test.ts#L67). So the test ends, and this finally block never triggers. ## Solution Instead of using an un-resolving promise to keep the mock responseStream open, use an AbortController. When the tests no longer need the functionality of the disposables, the test can fire the AbortController. This causes the stream to exit exceptionally, which triggers the `finally` block in TailLogGroup and runs disposal. This stops the event listeners from running after the test is completed, and has eliminated the noisy logs. I have tested this by running `npm run test` from the CLI.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Problem
Currently, the TailLogGroup tests are passing, but emitting noisy errors in the CI logs:
The cause for this, is that the event listener for closing the tailing session when Editor tabs close in TailLogGroup is not being disposed of. Disposal happens here. However, currently the "mock response stream" in the test blocks indefinitely on an un-resolvable promise. So the test ends, and this finally block never triggers.
Solution
Instead of using an un-resolving promise to keep the mock responseStream open, use an AbortController. When the tests no longer need the functionality of the disposables, the test can fire the AbortController. This causes the stream to exit exceptionally, which triggers the
finallyblock in TailLogGroup and runs disposal.This stops the event listeners from running after the test is completed, and has eliminated the noisy logs. I have tested this by running
npm run testfrom the CLI.feature/xbranches will not be squash-merged at release time.License: I confirm that my contribution is made under the terms of the Apache 2.0 license.