merge dev to main (v2.15.1) #2138
Conversation
Co-authored-by: Yiming <yiming@whimslab.io>
📝 WalkthroughWalkthroughThe 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 Changes
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
Possibly related PRs
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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
runUserPluginshelper function effectively reduces code duplication, but defining it inside therunmethod impacts readability and reusability. Consider extracting it as a private method of thePluginRunnerclass.+ 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
⛔ Files ignored due to path filters (13)
package.jsonis excluded by!**/*.jsonpackages/ide/jetbrains/package.jsonis excluded by!**/*.jsonpackages/language/package.jsonis excluded by!**/*.jsonpackages/misc/redwood/package.jsonis excluded by!**/*.jsonpackages/plugins/openapi/package.jsonis excluded by!**/*.jsonpackages/plugins/swr/package.jsonis excluded by!**/*.jsonpackages/plugins/tanstack-query/package.jsonis excluded by!**/*.jsonpackages/plugins/trpc/package.jsonis excluded by!**/*.jsonpackages/runtime/package.jsonis excluded by!**/*.jsonpackages/schema/package.jsonis excluded by!**/*.jsonpackages/sdk/package.jsonis excluded by!**/*.jsonpackages/server/package.jsonis excluded by!**/*.jsonpackages/testtools/package.jsonis 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
calculateAllPluginscould 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
dependenciesdeclarations were found in any preprocessor plugins. Please manually confirm that excluding preprocessor plugins from thecalculateAllPluginscall won’t break plugin dependency resolution:
- Review each preprocessor plugin’s metadata or class definition for any
dependenciesfields.- Ensure
calculateAllPluginsinpackages/schema/src/cli/plugin-runner.tsstill resolves all needed core–user plugin relationships when passed onlyotherPlugins.- 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 ExtArgsandinfer _TypeMapCbimprove type parameter inference controlThese modifications likely resolve edge cases in TypeScript's type inference and make the enhanced client type resolution more predictable.
No description provided.