fix(tanstack,swr): create/upsert hooks shouldn't be generated for delegate models

[ymc9]

No description provided.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates implement checks for delegate models to exclude specific operations like create and upsert in the SWR and Tanstack Query plugins. These changes ensure that model hooks generation logic respects delegate model constraints. Additionally, integration tests were updated to cover these new functionalities.

Changes

File(s)	Change Summary
packages/plugins/swr/src/generator.ts, packages/plugins/tanstack-query/src/generator.ts	Added checks using isDelegateModel to exclude create and upsert operations for delegate models.
tests/integration/tests/enhancements/with-delegate/plugin-interaction.test.ts	Added swr test case, modified trpc test case to include React-specific helpers and dependencies.

Sequence Diagram(s)

sequenceDiagram
    participant User 
    participant SWRPlugin 
    participant TanstackQueryPlugin
    participant Model 

    User ->> SWRPlugin: Generate SWR hooks
    SWRPlugin ->> SWRPlugin: Check if model is a delegate model
    alt Delegate Model
        SWRPlugin -->> User: Skip create and upsert operations
    else Non-Delegate Model
        SWRPlugin ->> Model: Generate create and upsert hooks
        User -->> Model: Use generated hooks
    end

    User ->> TanstackQueryPlugin: Generate Tanstack Query hooks
    TanstackQueryPlugin ->> TanstackQueryPlugin: Check if model is a delegate model
    alt Delegate Model
        TanstackQueryPlugin -->> User: Skip create and upsert operations
    else Non-Delegate Model
        TanstackQueryPlugin ->> Model: Generate create and upsert hooks
        User -->> Model: Use generated hooks
    end

Loading

---

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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4f56c15 and cb979ab.

Files selected for processing (3)

• packages/plugins/swr/src/generator.ts (3 hunks)
• packages/plugins/tanstack-query/src/generator.ts (3 hunks)
• tests/integration/tests/enhancements/with-delegate/plugin-interaction.test.ts (1 hunks)

Additional comments not posted (8)

tests/integration/tests/enhancements/with-delegate/plugin-interaction.test.ts (2)

26-40: LGTM! Ensure schema and dependencies are correct.

The swr test case is correctly added, defining a schema and loading it with the required dependencies.

Verify that the schema and dependencies (@zenstackhq/swr and swr) are correctly configured and available.

---

49-55: LGTM! Ensure additional dependencies are correct.

The trpc test case has been correctly modified to include generateClientHelpers = 'react' and add @trpc/react-query to extraDependencies.

Verify that the additional dependencies (@trpc/react-query) are correctly configured and available.

packages/plugins/swr/src/generator.ts (3)

81-85: LGTM! Ensure isDelegateModel function is correctly integrated.

The create operation is correctly excluded for delegate models.

Verify that the isDelegateModel function is correctly integrated and functioning as expected.

---

91-91: LGTM! Ensure isDelegateModel function is correctly integrated.

The createMany operation is correctly excluded for delegate models.

Verify that the isDelegateModel function is correctly integrated and functioning as expected.

---

144-144: LGTM! Ensure isDelegateModel function is correctly integrated.

The upsert operation is correctly excluded for delegate models.

Verify that the isDelegateModel function is correctly integrated and functioning as expected.

packages/plugins/tanstack-query/src/generator.ts (3)

345-349: LGTM! Ensure isDelegateModel function is correctly integrated.

The create operation is correctly excluded for delegate models.

Verify that the isDelegateModel function is correctly integrated and functioning as expected.

---

354-354: LGTM! Ensure isDelegateModel function is correctly integrated.

The createMany operation is correctly excluded for delegate models.

Verify that the isDelegateModel function is correctly integrated and functioning as expected.

---

428-428: LGTM! Ensure isDelegateModel function is correctly integrated.

The upsert operation is correctly excluded for delegate models.

Verify that the isDelegateModel function is correctly integrated and functioning as expected.