fix(trpc): make input arg's optionality consistent with Prisma

[ymc9]

Fixes #1707

[coderabbitai]

Walkthrough

Walkthrough

The changes introduce a new boolean variable argsOptional in the getPrismaOperationTypes function to determine if certain database operations (findMany, findFirst, etc.) should accept optional input parameters. This adjustment is reflected in the generateRouterTyping and getInputSchemaByOpName functions, allowing for conditional input parameter handling based on operation type. The modifications ensure that the input types for specified operations are treated as optional.

Changes

Files	Change Summary
packages/plugins/trpc/src/helpers.ts	Updated getPrismaOperationTypes, generateRouterTyping, and getInputSchemaByOpName to incorporate argsOptional for handling optional input parameters in specified operations.

Assessment against linked issues

Objective	Addressed	Explanation
Procedures like findMany, findFirst etc. should have optional input args (#1707)	✅

Possibly related PRs

• fix(delegate): null reference when reading an optional relation #1491: This PR addresses a null reference error when reading optional relations in database operations, which is relevant to handling optional parameters in operations like findMany.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 resolve resolve all the CodeRabbit review comments.
• @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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

packages/plugins/trpc/src/helpers.ts (1)

51-53: Consider defining the operations list as a constant for maintainability

The array of operation names used to determine argsOptional is defined inline. To improve maintainability and readability, consider defining this array as a constant at the top of the file or in a shared configuration. This makes it easier to manage and update the list of operations in the future.

Apply this diff to define the operations list as a constant:

+const optionalArgsOperations = ['findMany', 'findFirst', 'findFirstOrThrow', 'createMany', 'deleteMany', 'count'];

...

-const argsOptional = ['findMany', 'findFirst', 'findFirstOrThrow', 'createMany', 'deleteMany', 'count'].includes(
-    operation
-);
+const argsOptional = optionalArgsOperations.includes(operation);

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b8d8902 and f9c7fd9.

Files ignored due to path filters (4)

• packages/plugins/trpc/tests/projects/t3-trpc-v10/src/server/api/routers/generated/routers/Post.router.ts is excluded by !**/generated/**, !**/generated/**
• packages/plugins/trpc/tests/projects/t3-trpc-v10/src/server/api/routers/generated/routers/User.router.ts is excluded by !**/generated/**, !**/generated/**
• packages/plugins/trpc/tests/projects/t3-trpc-v11/src/server/api/routers/generated/routers/Post.router.ts is excluded by !**/generated/**, !**/generated/**
• packages/plugins/trpc/tests/projects/t3-trpc-v11/src/server/api/routers/generated/routers/User.router.ts is excluded by !**/generated/**, !**/generated/**

Files selected for processing (1)

• packages/plugins/trpc/src/helpers.ts (8 hunks)

Additional comments not posted (2)

packages/plugins/trpc/src/helpers.ts (2)

Line range hint 207-243: Verify that optionality of 'input' parameter is correctly applied across all operations

The use of input${inputOptional} adjusts the optionality of the input parameter based on the operation type. Please ensure that all operations that should accept optional inputs are included in argsOptional, and that this change doesn't impact operations where the input should remain mandatory.

---

305-305: Ensure consistent application of '.optional()' to input schemas

Adding .optional() to input schemas for operations like 'findFirst', 'findMany', 'createMany', 'deleteMany', and 'count' makes their inputs optional. Verify that this aligns with Prisma's specifications and consider if any other operations should also have their input schemas marked as optional for consistency.

Also applies to: 308-308, 317-317, 326-326, 344-344