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

[saisharan0103]

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

This PR improves the documentation for the prismaExtension config in trigger.dev, addressing confusion around:

---

✅ What’s Fixed

• Clarified schema usage

  • Docs now specify that schema must point to a .prisma file, not a folder
  • Removed incorrect mention of prismaSchemaFolder which doesn’t exist in the extension API

• Explained clientGenerator clearly

  • Added guidance that clientGenerator should be the generator ID (e.g. 'client'), not the provider (e.g. 'prisma-client-js')
  • Especially useful for projects with multiple Prisma generators like client + 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 should not 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[bot]]

⚠️ No Changeset found

Latest commit: afab455851234e26a1f9df112432c431a8973824

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[bot]]

Walkthrough

The documentation for the prismaExtension build extension was updated to clarify usage details. The instructions now specify that the schema option requires a direct path to a *.prisma file, not just a directory. The description of the clientGenerator option was refined to indicate that it should reference the generator ID from the Prisma schema, such as client, 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• 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 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.

[matt-aitken]

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

[matt-aitken]

@saisharan0103 I liked your original commit, what happened?

[the-dream-machine]

Spent a whole day debugging this issue. Trigger.dev checks if the schema.prisma file is contained in a folder named schema:

https://github.com/triggerdotdev/trigger.dev/blob/c0b6c41afcbafff5bd6cde31bec4d6cb30f47fa0/packages/build/src/extensions/prisma.ts#L115

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',
  ...
})