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

fix(cli): install proper prisma version during init #1906

Merged
merged 2 commits into from
Dec 5, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Dec 5, 2024

No description provided.

Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • tests/integration/tsconfig.json is excluded by !**/*.json

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request focus on enhancing the init function within the packages/schema/src/cli/actions/init.ts file. A new function, getLatestSupportedPrismaVersion, has been introduced to dynamically determine the latest supported version of Prisma based on the peer dependencies in the package.json file. This function replaces hardcoded version strings in the init function, improving version management for package installations while maintaining existing error handling and installation logic.

Changes

File Path Change Summary
packages/schema/src/cli/actions/init.ts Added getLatestSupportedPrismaVersion function to determine the latest supported Prisma version. Updated init function to use this new function for ensurePackage calls for 'prisma' and '@prisma/client'. Error handling and installation of 'zenstack' and '@zenstackhq/runtime' packages remain unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant PackageManager

    User->>CLI: Initiate init command
    CLI->>CLI: Check project path and Prisma schema
    CLI->>CLI: Call getLatestSupportedPrismaVersion()
    CLI->>PackageManager: EnsurePackage('prisma', version)
    CLI->>PackageManager: EnsurePackage('@prisma/client', version)
    CLI->>PackageManager: Install 'zenstack' and '@zenstackhq/runtime'
    PackageManager-->>CLI: Installation complete
    CLI-->>User: Initialization successful
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
🪧 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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d123047 and 320222c.

⛔ Files ignored due to path filters (1)
  • packages/schema/src/package.json is excluded by !**/*.json
📒 Files selected for processing (1)
  • packages/schema/src/cli/actions/init.ts (3 hunks)
🔇 Additional comments (2)
packages/schema/src/cli/actions/init.ts (2)

4-4: LGTM: Import statement for package.json

The import is correctly added to access peer dependencies information.


54-57: Verify version determination behavior

The change from hardcoded 'latest' to dynamic version determination looks good, but let's verify the peer dependency specification.

✅ Verification successful

Version determination logic is correctly implemented

The implementation looks correct and well-aligned with the peer dependency specification:

  • getLatestSupportedPrismaVersion() correctly parses the version range from package.json's peer dependencies (5.0.0 - 6.0.x)
  • It properly handles both single version and range specifications
  • The version is consistently applied to both prisma and @prisma/client packages
  • The codebase has appropriate version checks against PRISMA_MINIMUM_VERSION in relevant places
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify prisma peer dependency specification in package.json

# Check the peer dependency specification
jq -r '.peerDependencies.prisma' packages/schema/package.json

# List all files containing prisma version references to ensure consistency
rg -l "prisma.*version|version.*prisma" --type ts

Length of output: 413


Script:

#!/bin/bash
# Let's check the implementation of getLatestSupportedPrismaVersion and its usage
ast-grep --pattern 'function getLatestSupportedPrismaVersion() {
  $$$
}'

# Check the content of files that reference prisma version to understand the version handling
rg "prisma.*version|version.*prisma" -A 3 --type ts

Length of output: 3357

packages/schema/src/cli/actions/init.ts Show resolved Hide resolved
@ymc9 ymc9 merged commit 4c8b86f into dev Dec 5, 2024
13 checks passed
@ymc9 ymc9 deleted the fix/init-prisma-version branch December 5, 2024 02:36
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