test: improve reverse infer tests

[dinwwwh]

Summary by CodeRabbit

• Refactor
  • Updated API input requirements to enforce valid, non-optional string values for improved consistency and robust error handling.
• Tests
  • Enhanced test coverage to ensure clear error reporting for missing or invalid inputs, aligning behavior across client and server interactions.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
orpc	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 31, 2025 8:53am

[coderabbitai]

Walkthrough

The changes update type definitions and test assertions in both the client and server packages. In the client tests, the input parameter for the client function is now required to be a string instead of possibly undefined, with corresponding updates in assertions and reverse inference tests. In the server tests, the ActionableClient's input type is similarly refined to require a string, altering test cases to enforce this change and adjust output expectations. One test case still allows an optional undefined input, maintaining backward compatibility in a specific scenario.

Changes

File(s)	Summary
packages/client/src/types.test-d.ts	Updated the client function type: changed the input from `string
packages/server/src/procedure-action.test-d.ts	Revised ActionableClient definitions: enforced mandatory string input (removing `

Possibly related PRs

• unnoq/orpc#223: Enforces stricter type definitions by removing undefined from certain input parameters, similar to these changes.
• unnoq/orpc#244: Adjusts type constraints for client functions by removing the option for undefined inputs, aligning closely with the modifications made here.

Poem

I'm a rabbit, hopping through fields of code,
Skipping over undefined, where strings now solely bode.
With type checks crisp and tests all in line,
Each change a crunchy carrot, fresh and fine.
Hoppy coding days to all—my whiskers twitch with delight!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 85e5dff and def7128.

📒 Files selected for processing (2)

• packages/client/src/types.test-d.ts (3 hunks)
• packages/server/src/procedure-action.test-d.ts (4 hunks)

🔇 Additional comments (11)

packages/server/src/procedure-action.test-d.ts (5)

28-28: Type definition updated to enforce required input

The type definition now requires a string input and a number output, removing the | undefined option. This improves type safety by ensuring that inputs must be provided.

---

32-35: Good error handling tests added

Adding explicit error tests for undefined input and missing input cases ensures proper type checking and prevents accidental misuse of the API.

---

43-49: Test renamed to better reflect its purpose

Renamed test to "optional undefindable input" which better describes its behavior. The test now properly demonstrates how to use the client with optional input parameters, testing both the undefined case and the empty call.

---

60-60: Updated output type expectation

The output type expectation is now stricter, requiring a defined number output rather than allowing undefined. This matches the updated type definition on line 28.

---

82-82: Updated reverse inference test

The reverse inference test has been updated to match the new type definitions, correctly reflecting that the input must be a string and the output must be a number.

packages/client/src/types.test-d.ts (6)

5-5: Client type updated to require string input

The client type definition has been updated to require string input (removing | undefined), making the API more predictable and type-safe.

---

8-8: Updated input type expectation

The input type expectation is correctly updated to match the new client definition, ensuring type consistency.

---

14-14: Updated function signature expectation

The function signature expectation now correctly reflects that the input must be a string, matching the updated client type.

---

19-22: Added error handling tests

Good addition of error cases to test invalid inputs, ensuring that TypeScript correctly catches undefined inputs and missing inputs.

---

30-35: Added explicit test for optional input

Created a dedicated test case for optional undefinable input, allowing both undefined input and empty calls. This provides clearer test coverage for different input scenarios.

---

84-84: Updated reverse inference test

The reverse inference test has been updated to match the new type definitions, correctly reflecting that the input must be a string.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

[pkg-pr-new]

Open in Stackblitz

More templates

• @orpc/contract-first-playground
• @orpc/nextjs-playground
• @orpc/nuxt-playground
• @orpc/solid-start-playground
• @orpc/svelte-kit-playground

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@314

@orpc/client

npm i https://pkg.pr.new/@orpc/client@314

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@314

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@314

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@314

@orpc/react

npm i https://pkg.pr.new/@orpc/react@314

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@314

@orpc/server

npm i https://pkg.pr.new/@orpc/server@314

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@314

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@314

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@314

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@314

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@314

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@314

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@314

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@314

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@314

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@314

commit: def7128