Skip to content
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

Use prisma edge client for edge target #2060

Merged
merged 19 commits into from
Apr 3, 2025

Conversation

fredevery
Copy link
Contributor

While attempting to run a zenstack instance in a dockerized cloudflare enviroment, errors were thrown as the prisma client attempted to require node apis that aren't available in the cloudflare enviroment.

I was able to resolve this by forcing the zenstack edge enhancer to use the prisma edge client.

Copy link
Contributor

coderabbitai bot commented Mar 27, 2025

📝 Walkthrough

Walkthrough

The pull request updates the EnhancerGenerator class in the enhancer module. The methods createSimplePrismaImports and createLogicalPrismaImports have been modified to accept an additional target parameter. This change enables the methods to construct different import paths based on whether the runtime environment is set to 'edge' or not. The generate method has been updated accordingly to pass the new parameter.

Changes

File Change Summary
packages/.../enhancer/enhance/index.ts Updated method signatures for createSimplePrismaImports and createLogicalPrismaImports to include a target parameter; updated the generate method to pass target to these methods, enabling conditional Prisma import paths.

Sequence Diagram(s)

sequenceDiagram
    participant G as Generate
    participant S as createSimplePrismaImports
    participant L as createLogicalPrismaImports
    participant C as Conditional Logic

    G->>S: Call with prismaImport and target
    S->>C: Evaluate target parameter
    C-->>S: Return corresponding import path
    S-->>G: Return simple import string

    G->>L: Call with prismaImport, prismaClientImport, and target
    L->>C: Evaluate target parameter
    C-->>L: Return corresponding logical import path
    L-->>G: Return logical import string
Loading

Possibly related issues


📜 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 8a62f63 and a91824e.

📒 Files selected for processing (1)
  • packages/schema/src/plugins/enhancer/enhance/index.ts (3 hunks)
🔇 Additional comments (3)
packages/schema/src/plugins/enhancer/enhance/index.ts (3)

154-155: Logical change to support Prisma edge client

The code now passes the target parameter to both import creation methods, enabling conditional client selection based on the target environment. This change aligns perfectly with the PR objective of supporting Cloudflare environments.


209-213: Great implementation of conditional imports for edge targets

This change adds support for using Prisma's edge client when the target is 'edge'. By appending "/edge" to the import path, the code selectively uses the edge-compatible client which avoids the Node.js API dependencies that cause problems in Cloudflare environments.


240-242: Consistent implementation for logical Prisma client

The same edge client selection logic is correctly applied to the logical Prisma client imports, ensuring consistent behavior between simple and logical client modes. This change provides a complete solution for the Cloudflare compatibility issue.

✨ 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
🪧 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 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.

@ymc9 ymc9 changed the base branch from main to dev April 3, 2025 05:56
Copy link
Member

@ymc9 ymc9 left a comment

Choose a reason for hiding this comment

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

Hi @fredevery , thank you for making the fix. The change looks good to me. I'll merge when CI passes.

@ymc9 ymc9 merged commit 700553f into zenstackhq:dev Apr 3, 2025
11 checks passed
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.

2 participants