Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

📚 Fix Prisma Extension Docs for Common Misconfigurations (#2167)#2203

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
saisharan0103 wants to merge4 commits intotriggerdotdev:main
base:main
Choose a base branch
Loading
fromsaisharan0103:2167

Conversation

@saisharan0103
Copy link

📚 Fix Prisma Extension Docs for Common Misconfigurations (#2167)

This PR improves the documentation for theprismaExtension config intrigger.dev, addressing confusion around:

✅ What’s Fixed

  • Clarifiedschema usage

    • Docs now specify thatschema must point to a.prismafile, not a folder
    • Removed incorrect mention ofprismaSchemaFolder which doesn’t exist in the extension API

  • ExplainedclientGenerator clearly

    • Added guidance thatclientGenerator should be thegenerator ID (e.g.'client'), not the provider (e.g.'prisma-client-js')
    • Especially useful for projects withmultiple Prisma generators likeclient +json

  • 🚨 Added FAQ / Troubleshooting section

    • Covers the confusing Prisma error:
      Prisma Client could not locate the Query Engine for runtime "debian-openssl-3.0.x"
    • Explains that this usually means the extension isn’t installed — and users shouldnot manually download the binary (Trigger handles that automatically)

📌 Related Issue

Fixes#2167
Credit to@lucafaggianelli for reporting the gaps and sharing reproducible context.

🤝 Contributor Notes

  • No functional code changes — doc-only update
  • Formatting and tests not run due to Codex environment restrictions, but markdown syntax and structure verified manually

Let me know if you'd like this split into smaller commits or want to adjust anything before merge 🙌

@changeset-bot
Copy link

changeset-botbot commentedJun 27, 2025•
edited
Loading

⚠️ No Changeset found

Latest commit:afab455

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go.If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitaibot commentedJun 27, 2025•
edited
Loading

Walkthrough

The documentation for theprismaExtension build extension was updated to clarify usage details. The instructions now specify that theschema option requires a direct path to a*.prisma file, not just a directory. The description of theclientGenerator option was refined to indicate that it should reference the generator ID from the Prisma schema, such asclient, rather than the provider name. Additionally, a new troubleshooting section was introduced to address a common error regarding the Prisma Client's Query Engine runtime, explaining its cause and resolution. No changes were made to exported or public entities.

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 withCodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • 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 oursupport 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 togenerate 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 theconfiguration 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 ourDocumentation for detailed information on how to use CodeRabbit.
  • Join ourDiscord Community to get help, request features, and share feedback.
  • Follow us onX/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitaicoderabbitaibot 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)
docs/config/extensions/prismaExtension.mdx (1)

68-69:Minor phrasing improvement for clarity

The sentence “which will prevent other generators from being generated” is a bit clunky. Consider:

- ...the `clientGenerator` option to specify the `prisma-client-js` generator, which will prevent other generators from being generated.+ ...the `clientGenerator` option to specify the `prisma-client-js` generator and prevent the other generators from running.

Pure wording tweak—feel free to ignore if style guidelines prefer the current phrasing.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between7a6d9dc andc12b07b.

📒 Files selected for processing (1)
  • docs/config/extensions/prismaExtension.mdx (3 hunks)
🧰 Additional context used
🧠 Learnings (1)
docs/config/extensions/prismaExtension.mdx (8)
Learnt from: CRPR: triggerdotdev/trigger.dev#0File: .cursor/rules/writing-tasks.mdc:0-0Timestamp: 2025-06-24T08:07:10.028ZLearning: Build extensions in 'trigger.config.ts' allow customization of the build process, such as copying files, including packages, installing system dependencies, and enabling TypeScript features.
Learnt from: CRPR: triggerdotdev/trigger.dev#0File: .cursor/rules/webapp.mdc:0-0Timestamp: 2025-06-24T08:06:34.164ZLearning: The Prisma client (from @trigger.dev/database) is set up in db.server.ts and should be used for all PostgreSQL access in the webapp.
Learnt from: CRPR: triggerdotdev/trigger.dev#0File: .cursor/rules/writing-tasks.mdc:0-0Timestamp: 2025-06-24T08:07:10.028ZLearning: Incorrect implementation of Trigger.dev tasks (wrong imports, missing exports, deprecated patterns) will break production, fail deployment, and fail to run locally.
Learnt from: CRPR: triggerdotdev/trigger.dev#0File: .cursor/rules/writing-tasks.mdc:0-0Timestamp: 2025-06-24T08:07:10.028ZLearning: When implementing Trigger.dev tasks in files under '**/trigger/**/*.{ts,tsx,js,jsx}', always import from '@trigger.dev/sdk/v3' and export every task, including subtasks, to ensure correct discovery and execution.
Learnt from: CRPR: triggerdotdev/trigger.dev#0File: .cursor/rules/writing-tasks.mdc:0-0Timestamp: 2025-06-24T08:07:10.028ZLearning: Before generating any Trigger.dev task code, always verify: (1) imports are from '@trigger.dev/sdk/v3', (2) every task is exported, and (3) no deprecated code patterns are present.
Learnt from: CRPR: triggerdotdev/trigger.dev#0File: .cursor/rules/writing-tasks.mdc:0-0Timestamp: 2025-06-24T08:07:10.028ZLearning: The 'trigger.config.ts' file configures the Trigger.dev project, specifying task directories, retry settings, telemetry, runtime, machine settings, log level, max duration, and build extensions.
Learnt from: nicktrnPR: triggerdotdev/trigger.dev#2195File: hosting/k8s/helm/values.yaml:22-51Timestamp: 2025-06-25T13:20:17.174ZLearning: In the Trigger.dev Helm chart values.yaml, the maintainer prefers to use explicit comprehensive warnings for security-sensitive default values rather than implementing secure-by-default behavior that would fail installation. The project uses deterministic default secrets with clear "TESTING ONLY" warnings and instructions for production deployment.
Learnt from: CRPR: triggerdotdev/trigger.dev#0File: .cursor/rules/writing-tasks.mdc:0-0Timestamp: 2025-06-24T08:07:10.028ZLearning: The deprecated 'client.defineJob' pattern must never be used in Trigger.dev tasks; always use the 'task' function from '@trigger.dev/sdk/v3' for defining tasks.

@matt-aitken
Copy link
Member

@saisharan0103 you seem to have reverted all the changes. The first commit looked good to me.

@matt-aitken
Copy link
Member

@saisharan0103 I liked your original commit, what happened?

@the-dream-machine
Copy link

Spent a whole day debugging this issue. Trigger.dev checks if theschema.prisma file is contained in a folder namedschema:

constusingSchemaFolder=dirname(this._resolvedSchemaPath).endsWith("schema");

Probably worth explicitly showing the expected folder structure and configs that work for multiple prisma schema files:

prisma/├── schema/│   ├── (all .prisma files)│   ├── sql/│   │   └── (all .sql files)│   └── migrations/│       ├── (migration folders)│       └── migration_lock.toml└── seed.ts

package.json:

"prisma": {  "schema": "prisma/schema",},

trigger.config

prismaExtension({  schema: 'prisma/schema/schema.prisma',  ...})

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Prisma Extension documentation improvements

3 participants

@saisharan0103@matt-aitken@the-dream-machine
[8]ページ先頭
©2009-2025 Movatter.jp