fix(client): restore OmitOpts default type to improve type-checking performance - #29592
Conversation
…for type performance
WalkthroughThe ChangesPrismaClient Generic Parameter Update
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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. Comment |
aqrln
left a comment
There was a problem hiding this comment.
Thanks so much, this looks good and works well. CI failures are unrelated, I'll fix them separately.
|
@aqrln Any plans on a 7.8.1/7.9.0 release soon(ish)? I was so used to your bi-weekly release cycles that 2 months since the last release now feel like an eternity… |
|
@clemens yes, we're planning a release this week. |
|
@clemens apologies for the unplanned delay, release is still coming soon |
|
Hey @aqrln, do we have any timeline for when 7.9.0 will be released? We've been using the Thanks |
|
We are also waiting for the release. We are patching prisma locally, and is not the best workflow. This PR is super important for large schema. Can we not have this as a quick patch 7.8.1? |
This PR contains the following updates: | Package | Type | Update | Change | Pending | |---|---|---|---|---| | [@prisma/adapter-pg](https://github.com/prisma/prisma) ([source](https://github.com/prisma/prisma/tree/HEAD/packages/adapter-pg)) | imports | minor | [`7.8.0` -> `7.9.0`](https://renovatebot.com/diffs/npm/@prisma%2fadapter-pg/7.8.0/7.9.0) | `7.9.1` | | [@prisma/client](https://www.prisma.io) ([source](https://github.com/prisma/prisma/tree/HEAD/packages/client)) | imports | minor | [`7.8.0` -> `7.9.0`](https://renovatebot.com/diffs/npm/@prisma%2fclient/7.8.0/7.9.0) | `7.9.1` | | [prisma](https://www.prisma.io) ([source](https://github.com/prisma/prisma/tree/HEAD/packages/cli)) | imports | minor | [`7.8.0` -> `7.9.0`](https://renovatebot.com/diffs/npm/prisma/7.8.0/7.9.0) | `7.9.1` | --- ### Release Notes <details> <summary>prisma/prisma (@​prisma/adapter-pg)</summary> ### [`v7.9.0`](https://github.com/prisma/prisma/releases/tag/7.9.0) [Compare Source](prisma/orm@7.8.0...7.9.0) Today, we are excited to share the `7.9.0` stable release 🎉 **🌟 Star this repo for notifications about new releases, bug fixes & features — or [follow us on X](https://pris.ly/x)!** ##### Highlights ##### ORM ##### Tab completions for the Prisma CLI Typing out CLI commands from memory is now optional. Prisma ships **shell tab completions** for `bash`, `zsh`, `fish`, and PowerShell, covering commands, subcommands, options, flags, and even option values. **Setting it up.** Most projects run Prisma through a package manager, so completions are enabled through `@bomb.sh/tab`'s package-manager integration — install it once, then source the completion for your package manager and shell: ```bash # 1. Install @​bomb.sh/tab globally npm install -g @​bomb.sh/tab # 2. Wire up your package manager + shell (pnpm shown; swap in npm / yarn / bun): echo 'source <(tab pnpm zsh)' >> ~/.zshrc # zsh echo 'source <(tab pnpm bash)' >> ~/.bashrc # bash tab pnpm fish > ~/.config/fish/completions/pnpm.fish # fish tab pnpm powershell > ~/.tab-pnpm.ps1 # PowerShell (then dot-source it from $PROFILE) ``` `@bomb.sh/tab` delegates to any locally-installed CLI that ships completions, so `pnpm prisma <TAB>`, `pnpm exec prisma <TAB>`, `yarn prisma <TAB>`, and `bun x prisma <TAB>` all complete Prisma's commands, options, and values — no per-project setup. (`npx` and `bunx` don't support completion themselves; use `npm exec` and `bun x`.) If instead you have Prisma installed globally on your `PATH`, source its own completion directly: `source <(prisma complete zsh)` (or the `bash` / `fish` / `powershell` variant). This is built on [`@bomb.sh/tab`](https://github.com/bombshell-dev/tab/), the same completion library that powers other CLIs in the ecosystem — including Cloudflare, Nuxt, and Vitest — so the package-manager completions you enable for Prisma work for those tools too. A wonderful community contribution from [@​AmirSa12](https://github.com/AmirSa12) ([#​28351](prisma/orm#28351)) — thank you! <https://github.com/user-attachments/assets/1f916a60-ee4d-40be-bb7d-74035d48ca83> ##### Prisma ORM, ready for AI agents Coding agents are now a first-class audience for Prisma, and 7.9.0 brings the first wave of work to make Prisma projects safe and productive for them to work in. **Agent skills installed with `prisma init`** ([#​29689](prisma/orm#29689)) `prisma init` now installs the [prisma/skills](https://github.com/prisma/skills) catalog into freshly scaffolded projects. Agents such as Claude Code, Cursor, Codex, and Windsurf start out with current, version-relevant Prisma knowledge instead of relying on whatever happened to be in their training data. The install is best-effort and never blocks scaffolding; opt out at any time with `--no-skills`. ```terminal npx prisma@latest init ```  **A safer default around destructive commands** ([#​29684](prisma/orm#29684), [#​29691](prisma/orm#29691), [#​29713](prisma/orm#29713)) Prisma's AI safety checkpoint refuses to run destructive commands when it detects that an AI agent is at the keyboard, unless the user has given explicit consent. In this release we: - **Broadened agent detection** to cover today's landscape — Codex CLI (now on Linux as well as macOS), Qwen Code, GitHub Copilot CLI, OpenCode, Cline, Goose, Amp, Crush, Augment Code, Antigravity, Replit Agent, and Devin — plus generic `AI_AGENT` / `AGENT` conventions so future agents are caught without a code change. - **Extended the guard to `db push --accept-data-loss`**, which previously bypassed the checkpoint even though it can drop data. - **Removed the `migrate-reset` tool from the `prisma mcp` server** entirely — resetting a database drops it, and that is not an operation an agent should be handed as a first-class tool. An agent that needs a reset must run the CLI, where the checkpoint applies. ##### Bug Fixes Many of the fixes below are **community contributions** — thank you to everyone who reported and fixed these! **Prisma Client** - Fixed a severe TypeScript performance regression introduced in Prisma 7: restoring the `OmitOpts` generic default lets `tsc` reuse cached type instantiations again, bringing type-checking on large schemas back from minutes to seconds ([#​29592](prisma/orm#29592), from [@​nfl1ryxditimo12](https://github.com/nfl1ryxditimo12)). - The `XOR` type helper now rejects primitive values such as `data: 5`, which were previously accepted at compile time even though the runtime rejected them ([#​29735](prisma/orm#29735), from [@​kyungseopk1m](https://github.com/kyungseopk1m)). - `$queryRaw` and `$executeRaw` now fail fast with a clear validation error when passed an invalid `Date`, instead of silently serializing it as `null` and corrupting the value sent to the database ([#​29697](prisma/orm#29697), from [@​jibin7jose](https://github.com/jibin7jose)). - The generated client is no longer corrupted by a `///` documentation comment that contains a `*/` sequence; the comment terminator is now escaped when doc comments are emitted, in both the TypeScript and JavaScript generators ([#​29736](prisma/orm#29736), from [@​kyungseopk1m](https://github.com/kyungseopk1m)). - Improved the runtime and TypeScript error messages shown when a driver adapter is missing from the `PrismaClient` constructor; both now include a copy-pasteable example and a link to the [driver adapters docs](https://pris.ly/d/driver-adapters) ([#​29624](prisma/orm#29624)). - Unmapped database errors from driver adapters now surface as a user-facing `P2039` (`PrismaClientKnownRequestError`) carrying the original code and message, instead of an opaque failure, which keeps schema-drift-style problems debuggable ([#​29512](prisma/orm#29512)). - The `prisma-client-js` generator no longer emits a stray `undefined` statement when generating from a schema that declares only enums or types and no models ([#​29738](prisma/orm#29738), from [@​kyungseopk1m](https://github.com/kyungseopk1m)). - Fixed a connection leak when an interactive transaction times out (`maxWait`) while it is still starting: the discarded transaction now sends an explicit `ROLLBACK` before the connection is returned to the pool, instead of releasing it mid-transaction. Previously, on adapters like `@prisma/adapter-pg` and `@prisma/adapter-neon`, the next query to reuse that connection could fail with `there is already a transaction in progress` — or silently commit the leaked transaction's work ([#​29727](prisma/orm#29727), from [@​lazerg](https://github.com/lazerg)). **CLI** - `prisma validate` (and other schema-loading commands) no longer hangs forever on a multi-file schema whose directories contain a symlink cycle, and no longer reports the same file twice when a directory is reachable under two spellings (e.g. `/tmp` → `/private/tmp` on macOS) ([#​29740](prisma/orm#29740), from [@​kyungseopk1m](https://github.com/kyungseopk1m)). - On Windows, engine binaries are now cached in a stable, user-level directory (`%APPDATA%\Prisma`) instead of a `cwd`-relative `node_modules\.cache`, which eliminated duplicate cache directories and the bloated Serverless/Docker bundles they caused ([#​29730](prisma/orm#29730), from [@​santichausis](https://github.com/santichausis); closes [#​22574](prisma/orm#22574), [#​6670](prisma/orm#6670), [#​11577](prisma/orm#11577)). **Driver Adapters** - **[@​prisma/adapter-pg](https://github.com/prisma/adapter-pg)**, **[@​prisma/adapter-neon](https://github.com/prisma/adapter-neon)**, **[@​prisma/adapter-ppg](https://github.com/prisma/adapter-ppg)**: Reading a `Bytes` column no longer emits Node.js' `DEP0005` deprecation warning, thanks to an upstream `postgres-bytea` bump ([#​29538](prisma/orm#29538), from [@​kolia-zamnius](https://github.com/kolia-zamnius)). - **[@​prisma/adapter-ppg](https://github.com/prisma/adapter-ppg)**: `ColumnNotFound` (`P2022`) errors now parse both quoted and unquoted PostgreSQL column names, including identifiers containing spaces, matching the fix previously applied to `adapter-pg` ([#​29737](prisma/orm#29737), from [@​kyungseopk1m](https://github.com/kyungseopk1m)). - **[@​prisma/adapter-mssql](https://github.com/prisma/adapter-mssql)**: Setting a `Bytes?` (`@db.VarBinary`) field to `null` no longer fails with an implicit-conversion error; the adapter now sends the parameter typed as `VarBinary` instead of letting SQL Server default it to `nvarchar` ([#​29630](prisma/orm#29630), from [@​AnupamKumar-1](https://github.com/AnupamKumar-1)). **Schema Engine** - `prisma migrate status` now reports a rolled-back migration that still exists on disk as *unapplied*, instead of incorrectly treating the schema as up to date ([prisma/prisma-engines#5817](prisma/prisma-engines#5817), from [@​goutamadwant](https://github.com/goutamadwant)). - Primary-key constraint renames are now rendered as separate `ALTER TABLE` statements on PostgreSQL, avoiding a database error when a single table has multiple changes in one migration ([prisma/prisma-engines#4906](prisma/prisma-engines#4906), from [@​eruditmorina](https://github.com/eruditmorina)). ##### Security - Resolved the `hono` security advisories at their source: `@prisma/dev` was updated to a version that no longer depends on `hono` at all, so the CLI is no longer exposed to those advisories through that path. We also patched moderate-severity advisories in `ajv` and `uuid` across production dependencies ([#​29514](prisma/orm#29514)). - Hardened the Prisma Platform credentials file (`~/.config/prisma-platform/auth.json`) and its directory to `0o600` / `0o700` so OAuth tokens are no longer world-readable, bringing Prisma in line with the GitHub, AWS, and Google Cloud CLIs ([#​29568](prisma/orm#29568), from Jaeyoung Yun). - Bumped the `openssl` crate in the schema engine binaries from 0.10.74 to 0.10.81 ([prisma/prisma-engines#5815](prisma/prisma-engines#5815)). ##### Prisma Studio The bundled Prisma Studio moves from `0.27.3` to `0.33.0` ([#​29720](prisma/orm#29720)), gathering up everything shipped in the Studio releases in between. ##### Migrations view Studio can now visualise your **migration history**. This view is powered by **[Prisma Next](https://www.prisma.io/docs/orm/next)** — the next major version of Prisma ORM, a full TypeScript rewrite (available now in [Early Access](https://www.prisma.io/docs/next/getting-started)) that keeps the schema-first workflow and model-first queries you know, but treats your schema as a versioned, inspectable **contract** instead of compiling it into a heavy generated client. Prisma Next records every migration and its contract snapshots in the database, and Studio reads them to draw the timeline and diff below. Databases managed with classic Prisma Migrate don't carry this ledger, so the view simply stays hidden there. When the connected database has a Prisma Next migration ledger, a **Migrations** entry appears in the sidebar: a newest-first timeline of every applied migration with its name, apply time, operation count, and compact chips summarizing what changed (`+2 models`, `~2 models +3 fields`, `+1 model`, …). Selecting a migration opens a visual, FigJam-style diff canvas — added, removed, and changed models as colour-coded cards (`NEW` / `UPDATED` / `UNCHANGED`) with per-field before → after details, enum cards, and relation edges — next to a SQL panel of the executed statements and a Prisma-schema line diff. Switching migrations morphs the canvas rather than rebuilding it.  <!-- On publishing: drag wip/demos/prisma-studio-migrations.webp into the GitHub release editor so it becomes a user-attachments URL. --> ##### Prisma Streams browser Studio gains first-class support for Prisma Streams: a dedicated stream browser, live stream aggregations, stream diagnostics, routing-key browsing, and a WAL-history handoff straight from your tables, plus richer stream request observability with concise event-log and OpenTelemetry span summaries. ##### Working with SQL - SQL execution, linting, and navigation are now **schema-aware**: unqualified identifiers resolve against the schema you've selected instead of always falling back to the adapter's default schema. - SQL result visualizations are rendered with Studio-owned chart configuration, and there's an optional **Queries** view backed by query-insights snapshots. - Added copy actions to the Query Details view. ##### Fixes - Fixed editing PostgreSQL text-array cells when queries are compiled with inline values. - Avoided cancelling and repeating introspection requests when Studio first mounts, removing duplicate startup work. ##### Thanks to our contributors A heartfelt thank you to the community members whose contributions shaped this release: [@​AmirSa12](https://github.com/AmirSa12), [@​kyungseopk1m](https://github.com/kyungseopk1m), [@​nfl1ryxditimo12](https://github.com/nfl1ryxditimo12), [@​jibin7jose](https://github.com/jibin7jose), [@​santichausis](https://github.com/santichausis), [@​kolia-zamnius](https://github.com/kolia-zamnius), [@​goutamadwant](https://github.com/goutamadwant), [@​eruditmorina](https://github.com/eruditmorina), [@​lazerg](https://github.com/lazerg), [@​AnupamKumar-1](https://github.com/AnupamKumar-1), [@​Swapanrishi](https://github.com/Swapanrishi), [@​anupamme](https://github.com/anupamme), and [@​oyi77](https://github.com/oyi77). ##### Prisma Compute is now in public beta **"Push code, it runs."** [Prisma Compute](https://www.prisma.io/compute) — managed hosting for TypeScript apps that run right next to your database — is now available in [public beta](https://blog.prisma.io/blog/launching-prisma-compute-public-beta), and free to use while the beta lasts. Compute deploys your app as a long-lived process on Bun, colocated with your Prisma Postgres database, so there are no cold starts, no request timeouts, and no separate hosting vendor to wire up. It's a fit for REST and GraphQL APIs, full-stack apps, streaming and gRPC, and the long-running, stateful AI agents that keep connections open and hold in-process caches — "self-hosting, without the painful parts". - **Push-to-deploy** from the CLI or via GitHub integration. Every deployment is an immutable, versioned release with its own preview URL, and rolling back is simply promoting a previous version. - **Branch-based environments** — each branch gets its own app and database, so you can preview a change before promoting it to production. - **Auto-wires with Prisma Postgres** (or bring any database), with automatic health checks and self-recovery. - **[Custom domains](https://blog.prisma.io/blog/prisma-compute-custom-domains)** — point a single CNAME at Prisma and Compute provisions and renews the TLS certificate for you, with no manual certificate uploads or private-key handling. With Prisma ORM for type-safe data access, Prisma Postgres for the managed database, and now Prisma Compute for hosting, the whole stack lives in one place. Read the full story in the [Prisma Compute blog series](https://blog.prisma.io/blog/series/prisma-compute). ##### Enterprise support Thousands of teams use Prisma and many of them already tap into our Enterprise & Agency Support Program for hands-on help with everything from schema integrations and performance tuning to security and compliance. With this program you also get priority issue triage and bug fixes, expert scalability advice, and custom training so that your Prisma-powered apps stay rock-solid at any scale. Learn more or join: <https://prisma.io/enterprise>. </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - At any time (no schedule defined) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4yNzIuMSIsInVwZGF0ZWRJblZlciI6IjQzLjI3Mi4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Reviewed-on: https://git.oirnoir.dev/OIRNOIR/YouTube-Helper-Server/pulls/30
…erformance (prisma#29592) Fixes prisma#29011 <br/> ## Problem After upgrading from Prisma 6 to 7, type checking on our production codebase (406 models, ~9,300-line schema) became effectively unusable — `tsc --noEmit` ran for over 2 minutes and `tsgo` timed out at 3 minutes, whereas it completed in ~9 seconds on v6. I traced this down to a single line change. <br/> ## Root Cause In prisma#28375, the default value of the `OmitOpts` generic parameter on the `PrismaClient` interface was changed from `Prisma.PrismaClientOptions['omit']` to `undefined`: ```diff export interface PrismaClient< in LogOpts extends Prisma.LogLevel = never, - in out OmitOpts extends Prisma.PrismaClientOptions['omit'] = Prisma.PrismaClientOptions['omit'], + in out OmitOpts extends Prisma.PrismaClientOptions['omit'] = undefined, in out ExtArgs extends runtime.Types.Extensions.InternalArgs = runtime.Types.Extensions.DefaultArgs > { ``` This reverts the optimization from prisma#27777 (ORM-850). The change looks unintentional — prisma#28375 was focused on removing the library engine and doesn't mention any reason for touching the `OmitOpts` default. <br/> ## Why this causes the regression When `OmitOpts` defaults to `undefined`, every model delegate gets instantiated with `{ omit: undefined }`. Since `undefined` is structurally distinct from the constraint type (`GlobalOmitConfig | undefined`), TypeScript can't reuse cached type instantiations — it re-evaluates the full generic chain for every model x every operation. When the default matches the constraint (`= Prisma.PrismaClientOptions['omit']`), TypeScript can short-circuit the structural comparison and reuse a single cached instantiation. This is exactly how prisma#27777 was designed to work. <br/> ## Benchmark 406 models, ~9,300-line schema. Using `tsgo --extendedDiagnostics`: | Metric | `= undefined` (current) | `= PrismaClientOptions['omit']` (this fix) | Improvement | | ------------------- | ----------------------- | ------------------------------------------ | ----------- | | Type Instantiations | 32,823,262 | 2,650,891 | **12.4x** | | Types | 6,385,830 | 1,162,723 | **5.5x** | | Memory | 4,610 MB | 2,193 MB | **2.1x** | | Check time | 16.97s | 2.47s | **6.9x** | Full project type check (`pnpm check:type`): | Tool | Before | After | | ------------ | --------------- | -------- | | `tsgo` | >3min (timeout) | **7.7s** | | `tsc` v5.9.2 | OOM / >2min | **9.0s** | I can't share the production schema (proprietary), but the numbers in prisma#29011 from other reporters are consistent with what I'm seeing — ~30M instantiations on v7 vs ~8M on v6. <br/> ## Changes One-line fix in `packages/client-generator-ts/src/TSClient/PrismaClient.ts` — restores the original default from prisma#27777. Note that `ClientFile.ts` already uses `Prisma.PrismaClientOptions['omit']` as the default for the public-facing export type, so this just aligns the internal interface with it. <br/> ### Type safety `PrismaClientOptions['omit']` resolves to `GlobalOmitConfig | undefined` (since `omit` is optional), which is a superset of `undefined` — so this is not a breaking change. The constructor's `OmitOpts` default is also unaffected. No runtime behavior changes.
Fixes #29011
Problem
After upgrading from Prisma 6 to 7, type checking on our production codebase (406 models, ~9,300-line schema) became effectively unusable —
tsc --noEmitran for over 2 minutes andtsgotimed out at 3 minutes, whereas it completed in ~9 seconds on v6.I traced this down to a single line change.
Root Cause
In #28375, the default value of the
OmitOptsgeneric parameter on thePrismaClientinterface was changed fromPrisma.PrismaClientOptions['omit']toundefined:This reverts the optimization from #27777 (ORM-850). The change looks unintentional — #28375 was focused on removing the library engine and doesn't mention any reason for touching the
OmitOptsdefault.Why this causes the regression
When
OmitOptsdefaults toundefined, every model delegate gets instantiated with{ omit: undefined }. Sinceundefinedis structurally distinct from the constraint type (GlobalOmitConfig | undefined), TypeScript can't reuse cached type instantiations — it re-evaluates the full generic chain for every model x every operation.When the default matches the constraint (
= Prisma.PrismaClientOptions['omit']), TypeScript can short-circuit the structural comparison and reuse a single cached instantiation. This is exactly how #27777 was designed to work.Benchmark
406 models, ~9,300-line schema. Using
tsgo --extendedDiagnostics:= undefined(current)= PrismaClientOptions['omit'](this fix)Full project type check (
pnpm check:type):tsgotscv5.9.2I can't share the production schema (proprietary), but the numbers in #29011 from other reporters are consistent with what I'm seeing — ~30M instantiations on v7 vs ~8M on v6.
Changes
One-line fix in
packages/client-generator-ts/src/TSClient/PrismaClient.ts— restores the original default from #27777.Note that
ClientFile.tsalready usesPrisma.PrismaClientOptions['omit']as the default for the public-facing export type, so this just aligns the internal interface with it.Type safety
PrismaClientOptions['omit']resolves toGlobalOmitConfig | undefined(sinceomitis optional), which is a superset ofundefined— so this is not a breaking change. The constructor'sOmitOptsdefault is also unaffected. No runtime behavior changes.