Test coverage for utils #2057
Test coverage for utils #2057
Conversation
WalkthroughA new test file was added to provide unit tests for three utility functions: Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure ✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/core/test/utils.test.ts (1)
77-87: Consider using undefined instead of void for type parameter.The test is correctly verifying that the promise can resolve with undefined. However, there's a minor improvement to make:
- const deferred = promiseWithResolvers<void>(); + const deferred = promiseWithResolvers<undefined>(); - deferred.promise.then((value: void) => { + deferred.promise.then((value: undefined) => {Using
undefinedinstead ofvoidas a type parameter is clearer, asvoidis typically used for return types rather than as a type parameter.🧰 Tools
🪛 Biome (1.9.4)
[error] 80-80: void is confusing outside a return type or a type parameter.
Unsafe fix: Use undefined instead.
(lint/suspicious/noConfusingVoidType)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
packages/core/test/utils.test.ts(1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/core/test/utils.test.ts (1)
packages/core/src/utils.ts (2)
assertExhaustive(1-3)promiseWithResolvers(26-40)
🪛 Biome (1.9.4)
packages/core/test/utils.test.ts
[error] 80-80: void is confusing outside a return type or a type parameter.
Unsafe fix: Use undefined instead.
(lint/suspicious/noConfusingVoidType)
🔇 Additional comments (7)
packages/core/test/utils.test.ts (7)
3-7: Good test for the assertExhaustive utility.The test correctly verifies that the utility throws an error when called with an unexpected value, which is exactly what this type safety utility is designed to do.
9-14: Good test for the happy path of tryCatch.This test correctly verifies that tryCatch returns [null, value] when a promise resolves successfully.
16-22: Good error handling test for tryCatch.This test properly verifies that tryCatch returns the error as the first element and null as the second when a promise rejects with an Error object.
24-29: Comprehensive test for non-Error rejections.This test is valuable as it confirms that tryCatch correctly handles rejections with non-Error values (strings, objects, etc.), maintaining the expected return format.
31-46: Good coverage of edge cases for tryCatch.These tests thoroughly validate tryCatch behavior with various edge cases:
- Resolving to undefined
- Already resolved promises
- Handling undefined inputs
This level of coverage helps ensure the utility is robust in all scenarios.
49-63: Good initial test for promiseWithResolvers.This test verifies the essential functionality of promiseWithResolvers:
- That it returns an object with the expected properties
- That the properties are functions
- That the promise resolves with the correct value when resolve is called
The test effectively confirms both the structure and behavior of this utility.
65-75: Thorough test for promise rejection.This test effectively verifies both that:
- The promise rejects with the correct error when reject is called
- The catch handler is properly executed
Good job confirming both the rejection state and the handler execution.
Closes #
✅ Checklist
Testing
pnpm testChangelog
Added test coverage for the utils.ts and all passed!
Screenshots
💯
Summary by CodeRabbit