Skip to content

Conversation

tinglei8
Copy link
Collaborator

@tinglei8 tinglei8 commented Jan 3, 2025

This fix solves an issue of properly flattening zod schemas referenced in chained function calls.

An example:

import { z } from 'zod';

const TypeEnum = z
  .enum(['Normal', 'Unknown'])
  .describe('Type of the item');

const FindManyInput = z.object({
  options: z
    .object({
      userId: z.string().describe('ID of the current user'),
      type1: TypeEnum.optional().describe('Type 1 of the item')
    })
    .merge({
      z.object({
        type2: TypeEnum.optional().describe('Type 2 of the item')
      })
    })
    .describe('Options to find many items'),
});

Before the fix, references to TypeEnum are not flattened in FindManyInput because it's referenced as parameters of the object() and merge() calls instead of the last describe() call.

After the fix, The TypeEnum schema is properly flattened in all places that reference it.

Summary by CodeRabbit

  • Tests

    • Enhanced test coverage for ProcedureGenerator by adding a new test suite for the flattenZodSchema method
    • Improved testing of TypeScript AST manipulation for Zod schema flattening
  • Refactor

    • Updated flattenZodSchema method to handle nested call expressions more effectively
    • Improved schema generation process with recursive call expression handling

Copy link

coderabbitai bot commented Jan 3, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request introduces enhancements to the ProcedureGenerator class in the NestJS tRPC package, specifically focusing on improving the flattenZodSchema method. The changes involve adding more robust handling of nested call expressions during schema generation, with corresponding test cases added to validate the new functionality. The modifications aim to improve the method's ability to process complex Zod schema structures by recursively flattening nested call expressions.

Changes

File Change Summary
packages/nestjs-trpc/lib/generators/procedure.generator.ts Added recursive logic in flattenZodSchema to handle nested call expressions by replacing their text with flattened schemas
packages/nestjs-trpc/lib/generators/__tests__/procedure.generator.spec.ts Added new test suite for flattenZodSchema method, importing additional TypeScript AST manipulation utilities from ts-morph

Sequence Diagram

sequenceDiagram
    participant PG as ProcedureGenerator
    participant Node as AST Node
    participant Schema as Zod Schema

    PG->>Node: flattenZodSchema(node)
    alt Is CallExpression
        Node-->>PG: Recursive call
        PG->>Node: Process child nodes
        Node-->>PG: Flattened child schemas
    else Is Identifier/Literal
        PG-->>Schema: Generate simplified schema
    end
    PG-->>Schema: Return flattened schema
Loading

Poem

🐰 In the realm of Zod and NestJS code,
A rabbit hops through schemas untold,
Flattening calls with recursive might,
Transforming complexity into light,
Where nested expressions once did unfold! 🔍


📜 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 8e921eb and f1e4a4d.

⛔ Files ignored due to path filters (1)
  • packages/nestjs-trpc/lib/generators/__tests__/__snapshots__/procedure.generator.spec.ts.snap is excluded by !**/*.snap
📒 Files selected for processing (2)
  • packages/nestjs-trpc/lib/generators/__tests__/procedure.generator.spec.ts (3 hunks)
  • packages/nestjs-trpc/lib/generators/procedure.generator.ts (1 hunks)

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
🪧 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. (Beta)
  • @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.

@tinglei8 tinglei8 merged commit 317a4a6 into main Jan 3, 2025
1 check was pending
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant