test: add comprehensive test coverage for utils.ts #32907

ar-saeedi · 2025-10-31T10:43:19Z

What I did

Added comprehensive test coverage for the utility functions in code/core/src/common/utils/utils.ts which was recently added but lacked test coverage.

This PR introduces 13 well-structured test cases covering all functionality and edge cases for the groupBy and invariant utility functions.

Changes Made:

✅ Created code/core/src/common/utils/utils.test.ts with comprehensive test coverage
✅ Added 8 test cases for groupBy function
✅ Added 11 test cases for invariant function
✅ Covered edge cases, performance optimizations, and TypeScript type assertions

Checklist for Contributors

Testing

unit tests - 13 comprehensive test cases added

Documentation

Tests serve as documentation for the utility functions

Summary by CodeRabbit

Release Notes

Tests
- Enhanced test coverage for core utility functions, including comprehensive validation of grouping operations and assertion behavior across various scenarios and edge cases.

Note: This release contains internal quality improvements with no user-facing changes.

- Add 13 test cases for groupBy and invariant functions - Cover edge cases, type narrowing, and lazy evaluation - Achieve 100% coverage for utils.ts utility functions Tests include: - groupBy: various key types, empty arrays, index handling - invariant: lazy messages, type assertions, edge cases

coderabbitai · 2025-11-03T14:33:19Z

📝 Walkthrough

Walkthrough

Adds comprehensive unit tests for groupBy and invariant utility functions, covering multiple scenarios including edge cases, different key types, message evaluation strategies, and type narrowing behavior.

Changes

Cohort / File(s)	Summary
Test Coverage for Utility Functions `code/core/src/common/utils/utils.test.ts`	Adds tests for `groupBy` utility (grouping by key, empty arrays, single items, index-aware selectors, numeric and symbol keys, same-key scenarios) and `invariant` utility (truthy/falsy conditions, default messages, lazy/eager evaluation, expensive computation avoidance, complex conditions, type narrowing)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10-15 minutes

Test additions follow consistent patterns across multiple utility scenarios
No production logic changes or complex control flow to evaluate
Edge cases and assertions are clearly defined and straightforward to verify

✨ Finishing touches

📝 Generate docstrings

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

code/core/src/common/utils/utils.test.ts (1)
45-55: Consider verifying the grouping result.

While this test correctly verifies that indices are passed to the key selector, it doesn't assert the actual grouping result. Consider also verifying that the returned object matches expectations for completeness.

Apply this diff to also verify the grouping result:
     it('should pass index to key selector', () => {
       const items = ['a', 'b', 'c', 'd'];
       const indices: number[] = [];
 
-      groupBy(items, (_item, index) => {
+      const result = groupBy(items, (_item, index) => {
         indices.push(index);
         return index % 2 === 0 ? 'even' : 'odd';
       });
 
       expect(indices).toEqual([0, 1, 2, 3]);
+      expect(result).toEqual({
+        even: ['a', 'c'],
+        odd: ['b', 'd'],
+      });
     });

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d496297 and 8f367da.

📒 Files selected for processing (1)

code/core/src/common/utils/utils.test.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (7)

code/**/*.{test,spec}.{ts,tsx}

📄 CodeRabbit inference engine (.cursorrules)

code/**/*.{test,spec}.{ts,tsx}: Place all test files under the code/ directory
Name test files as *.test.ts, *.test.tsx, *.spec.ts, or *.spec.tsx

Files:

code/core/src/common/utils/utils.test.ts

**/*.test.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.cursor/rules/spy-mocking.mdc)

**/*.test.{ts,tsx,js,jsx}: Use vi.mock() with the spy: true option for all package and file mocks in Vitest tests
Place all mocks at the top of the test file before any test cases
Use vi.mocked() to type and access mocked functions
Implement mock behaviors in beforeEach blocks
Mock all required dependencies that the test subject uses
Mock implementations should be placed in beforeEach blocks
Each mock implementation should return a Promise for async functions
Mock implementations should match the expected return type of the original function
Use vi.mocked() to access and implement mock behaviors
Mock all required properties and methods that the test subject uses
Avoid direct function mocking without vi.mocked()
Avoid mock implementations outside of beforeEach blocks
Avoid mocking without the spy: true option
Avoid inline mock implementations within test cases
Avoid mocking only a subset of required dependencies
Mock at the highest level of abstraction needed
Keep mock implementations simple and focused
Use type-safe mocking with vi.mocked()
Document complex mock behaviors
Group related mocks together

Files:

code/core/src/common/utils/utils.test.ts

**/*.{js,jsx,json,html,ts,tsx,mjs}