chore: add tests for common-helpers package #540

ymc9 · 2025-12-28T06:03:26Z

Summary by CodeRabbit

Tests
- Added comprehensive test suites for common utility functions, covering edge cases and various input types.
Chores
- Added test script and Vitest configuration to enable automated testing.
- Added testing dependency to development environment.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-28T06:03:37Z

📝 Walkthrough

Walkthrough

This PR establishes comprehensive test coverage for the @zenstackhq/common-helpers package by adding 10 new test suites covering utility functions (clone, case conversion, enumerable, etc.), along with Vitest configuration and package.json updates to enable test execution.

Changes

Cohort / File(s)	Summary
Package Configuration `packages/common-helpers/package.json`, `packages/common-helpers/vitest.config.ts`	Added test script (`test: vitest run`), registered `@zenstackhq/vitest-config` dependency, and configured Vitest with merged base configuration.
Test Suites `packages/common-helpers/test/case-conversion.test.ts`, `test/clone.test.ts`, `test/enumerable.test.ts`, `test/is-plain-object.test.ts`, `test/param-case.test.ts`, `test/safe-json-stringify.test.ts`, `test/sleep.test.ts`, `test/tiny-invariant.test.ts`, `test/zip.test.ts`	Added comprehensive test coverage for 9 utility functions, validating edge cases, type handling, and expected behaviors across primitives, arrays, objects, nested structures, and special types (Date, RegExp, BigInt).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

test: add edge-runtime e2e #458: Adds and updates Vitest configuration files across packages, including the shared @zenstackhq/vitest-config base configuration that this PR depends on.
merge dev to main (v3.0.0-alpha.18) #142: Modifies packages/common-helpers/package.json to add version updates and dependencies, overlapping with this PR's package.json changes.
merge dev to main (v3.0.0-beta.2) #234: Reorganizes root and workspace Vitest configurations while updating the packages/vitest-config package, related to the test infrastructure setup in this PR.

Poem

🐰 Hippity hop, tests take the stage,
Nine helpers tested, page by page,
Clone and case, zip and sleep,
Coverage growing, promises to keep!
With Vitest running, bugs beware,
Quality code beyond compare! 🧪✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main change: adding comprehensive test suites for the common-helpers package, which is the primary focus of all modifications in the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch chore/common-helpers-tests

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f13886b and daa7649.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (11)

packages/common-helpers/package.json
packages/common-helpers/test/case-conversion.test.ts
packages/common-helpers/test/clone.test.ts
packages/common-helpers/test/enumerable.test.ts
packages/common-helpers/test/is-plain-object.test.ts
packages/common-helpers/test/param-case.test.ts
packages/common-helpers/test/safe-json-stringify.test.ts
packages/common-helpers/test/sleep.test.ts
packages/common-helpers/test/tiny-invariant.test.ts
packages/common-helpers/test/zip.test.ts
packages/common-helpers/vitest.config.ts

🧰 Additional context used

🧠 Learnings (6)

📓 Common learnings

Learnt from: CR
Repo: zenstackhq/zenstack-v3 PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-26T01:55:04.540Z
Learning: Applies to packages/zenstackhq/cli/**/*.test.{ts,tsx} : CLI package tests should focus on action-specific tests for each command

Learnt from: CR
Repo: zenstackhq/zenstack-v3 PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-26T01:55:04.540Z
Learning: Applies to packages/zenstackhq/orm/**/*.test.{ts,tsx} : ORM package tests should include comprehensive client API tests and policy tests

Learnt from: CR
Repo: zenstackhq/zenstack-v3 PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-26T01:55:04.540Z
Learning: Applies to tests/**/type*.{ts,tsx} : Ensure TypeScript inference and type coverage are validated through type coverage tests