Skip to content

fix(delegate): remove createManyAndReturn API from delegate model client #1769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 9, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Oct 9, 2024

Fixes #1738

Copy link
Contributor

coderabbitai bot commented Oct 9, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the EnhancerGenerator class and the RequestHandler class across two files. In EnhancerGenerator, methods related to filtering delegate model methods and properties are enhanced, specifically excluding the createManyAndReturn method. The RequestHandler class sees changes in how relationship data is fetched and serialized, with improvements in error handling for validation issues. Additionally, method signatures are updated to reflect these changes.

Changes

File Path Change Summary
packages/schema/src/plugins/enhancer/enhance/index.ts - Enhanced transformInterface and transformTypeAlias methods to exclude createManyAndReturn from delegate models.
- Updated removeCreateFromDelegateInput and removeDiscriminatorFromConcreteInput methods for better type safety.
packages/server/src/api/rest/index.ts - Commented out line for including relationship IDs in selection arguments.
- Improved error handling in handlePrismaError for more specific validation error messages.
- Updated method export signature.

Possibly related PRs


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:

‼️ 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
packages/schema/src/plugins/enhancer/enhance/index.ts (2)

Line range hint 603-610: Consider using AST manipulation instead of string replacements in transformTypeAlias.

In the transformTypeAlias method, the code modifies the source string using replace() operations to remove auxiliary fields and adjust type aliases. Manipulating code as strings can be fragile and may lead to unintended consequences if similar patterns exist elsewhere in the code.

Consider directly manipulating the AST nodes using the ts-morph library to perform these transformations. This approach is more robust and maintainable, reducing the risk of errors from incorrect string replacements.


Line range hint 645-658: Use AST node manipulation in removeCreateFromDelegateInput for safer transformations.

In the removeCreateFromDelegateInput method, the code removes certain fields by replacing text in the source string. This string manipulation can be error-prone, especially if the codebase evolves or if similar text appears elsewhere.

It's advisable to use the AST manipulation capabilities of ts-morph to remove the specific PropertySignature nodes corresponding to the fields. This ensures precise modifications and enhances code reliability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a800fe6 and 048f8d2.

📒 Files selected for processing (2)
  • packages/schema/src/plugins/enhancer/enhance/index.ts (1 hunks)
  • packages/server/src/api/rest/index.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • packages/server/src/api/rest/index.ts
🧰 Additional context used
🔇 Additional comments (1)
packages/schema/src/plugins/enhancer/enhance/index.ts (1)

469-471: LGTM!

The code correctly filters out the specified methods, including createManyAndReturn, from structure.methods. This ensures that delegate models cannot use these methods, aligning with the intended design constraints.

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