Skip to content

merge dev to main (v2.15.1) #2138

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 3 commits into from
Jun 3, 2025
Merged

merge dev to main (v2.15.1) #2138

merged 3 commits into from
Jun 3, 2025

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Jun 3, 2025

No description provided.

Copy link
Contributor

coderabbitai bot commented Jun 3, 2025

📝 Walkthrough

Walkthrough

The changes refactor the plugin execution order in the plugin runner by separating preprocessor plugins and running them before core and other user plugins. Additionally, the Enhanced<Client> type alias is updated to simplify its conditional logic, using broader type checks and more explicit type parameters.

Changes

File(s) Change Summary
packages/schema/src/cli/plugin-runner.ts Refactored plugin execution to separate and run preprocessor plugins first, introduced runUserPlugins helper.
packages/schema/src/plugins/enhancer/enhance/index.ts Updated the Enhanced<Client> type alias to use simplified and more explicit conditional type checks.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PluginRunner
    participant PreprocessorPlugins
    participant CorePlugins
    participant UserPlugins

    User->>PluginRunner: run()
    PluginRunner->>PreprocessorPlugins: runUserPlugins(preprocessors)
    PreprocessorPlugins-->>PluginRunner: warnings
    PluginRunner->>CorePlugins: run core plugins
    CorePlugins-->>PluginRunner: results
    PluginRunner->>UserPlugins: runUserPlugins(non-preprocessor plugins)
    UserPlugins-->>PluginRunner: warnings
    PluginRunner-->>User: final result
Loading

Possibly related PRs

  • zenstackhq/zenstack#2010: Refactors and exports the Enhanced type alias in the same enhancer plugin module, directly related to the type changes in this PR.
  • zenstackhq/zenstack#1676: Modifies plugin enabling and inclusion/exclusion logic in plugin-runner.ts, related to plugin management and execution flow.
  • zenstackhq/zenstack#2022: Introduces the "preprocessor" option and initial plugin categorization logic in plugin-runner.ts, directly related to the refactoring in this PR.
✨ 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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

🧹 Nitpick comments (1)
packages/schema/src/cli/plugin-runner.ts (1)

149-165: Consider extracting helper function as a private method.

The runUserPlugins helper function effectively reduces code duplication, but defining it inside the run method impacts readability and reusability. Consider extracting it as a private method of the PluginRunner class.

+    private async runUserPlugins(
+        plugins: PluginInfo[], 
+        runnerOptions: PluginRunnerOptions,
+        dmmf: DMMF.Document | undefined,
+        shortNameMap: Map<string, string> | undefined,
+        project: Project,
+        prismaClientPath: string,
+        prismaClientDtsPath: string | undefined,
+        warnings: string[]
+    ) {
+        for (const { name, description, run, options: pluginOptions } of plugins) {
+            const options = { ...pluginOptions, prismaClientPath, prismaClientDtsPath };
+            const r = await this.runPlugin(
+                name,
+                description,
+                run,
+                runnerOptions,
+                options as PluginOptions,
+                dmmf,
+                shortNameMap,
+                project,
+                false
+            );
+            warnings.push(...(r?.warnings ?? []));
+        }
+    }

Then update the usage:

-        const runUserPlugins = async (plugins: PluginInfo[]) => {
-            // ... implementation
-        };
-
-        await runUserPlugins(preprocessorPlugins);
+        await this.runUserPlugins(preprocessorPlugins, runnerOptions, dmmf, shortNameMap, project, prismaClientPath, prismaClientDtsPath, warnings);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8bc32d and 62e60bd.

⛔ Files ignored due to path filters (13)
  • package.json is excluded by !**/*.json
  • packages/ide/jetbrains/package.json is excluded by !**/*.json
  • packages/language/package.json is excluded by !**/*.json
  • packages/misc/redwood/package.json is excluded by !**/*.json
  • packages/plugins/openapi/package.json is excluded by !**/*.json
  • packages/plugins/swr/package.json is excluded by !**/*.json
  • packages/plugins/tanstack-query/package.json is excluded by !**/*.json
  • packages/plugins/trpc/package.json is excluded by !**/*.json
  • packages/runtime/package.json is excluded by !**/*.json
  • packages/schema/package.json is excluded by !**/*.json
  • packages/sdk/package.json is excluded by !**/*.json
  • packages/server/package.json is excluded by !**/*.json
  • packages/testtools/package.json is excluded by !**/*.json
📒 Files selected for processing (2)
  • packages/schema/src/cli/plugin-runner.ts (3 hunks)
  • packages/schema/src/plugins/enhancer/enhance/index.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: build-test (20.x)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: OSSAR-Scan
  • GitHub Check: build-test (20.x)
  • GitHub Check: dependency-review
  • GitHub Check: build-test (20.x)
🔇 Additional comments (4)
packages/schema/src/cli/plugin-runner.ts (3)

111-113: Good separation of plugin types.

The filtering logic correctly separates preprocessor plugins from other plugins, setting up for the new execution order. This improves the plugin execution flow organization.


206-206: Excellent code deduplication.

Replacing the duplicated plugin execution logic with the helper function improves maintainability while preserving the same functionality.


115-118:

❓ Verification inconclusive

Verify dependency resolution with excluded preprocessor plugins.

Excluding preprocessor plugins from calculateAllPlugins could affect dependency resolution. Ensure that preprocessor plugins don't have dependencies on core plugins or other user plugins that need to be resolved.


🏁 Script executed:

#!/bin/bash
# Description: Search for dependency declarations in preprocessor plugins to verify if they depend on other plugins.

# Find plugin files and search for dependency declarations
fd -e ts -e js | xargs rg -A 3 -B 3 "preprocessor.*true" | rg -A 5 -B 5 "dependencies"

# Search for any references to dependency checking with preprocessor plugins
rg -A 5 -B 5 "dependencies.*preprocessor|preprocessor.*dependencies"

Length of output: 157


Verify plugin dependency resolution when excluding preprocessor plugins

No dependencies declarations were found in any preprocessor plugins. Please manually confirm that excluding preprocessor plugins from the calculateAllPlugins call won’t break plugin dependency resolution:

  • Review each preprocessor plugin’s metadata or class definition for any dependencies fields.
  • Ensure calculateAllPlugins in packages/schema/src/cli/plugin-runner.ts still resolves all needed core–user plugin relationships when passed only otherPlugins.
  • Double-check that no preprocessor plugin has implicit or dynamic dependencies on core or user plugins.
packages/schema/src/plugins/enhancer/enhance/index.ts (1)

288-294: Improved type inference reliability.

The changes to the Enhanced<Client> type alias make the conditional type checks more explicit and robust:

  • Using _PrismaClient<any, any, any> provides clearer type boundaries
  • Explicit infer ExtArgs and infer _TypeMapCb improve type parameter inference control

These modifications likely resolve edge cases in TypeScript's type inference and make the enhanced client type resolution more predictable.

@ymc9 ymc9 merged commit 19f4870 into main Jun 3, 2025
16 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