fix: allow batching of more than one query inside interactive transactions by LucianBuzzo · Pull Request #25571 · prisma/prisma

LucianBuzzo · 2024-11-04T11:06:34Z

This change fixes an issue where running different queries inside an interactive transaction in the same tick would not be batched together automatically by the engine.
By accounting for the protocolQuery when batching interactive transactions, the engine can optimize the queries correctly, as the queries will be batched by both the transaction ID and the query.

Summary by CodeRabbit

Improvements
- Batching for interactive transactions now groups requests by transaction and protocol batch identifier when available for more precise execution.
Database
- Added a Comment model and a comments relation on User for test scenarios.
Tests
- Expanded interactive-transaction batching tests with detailed engine/batch metrics and PostgreSQL-only scenarios.

jkomyno · 2024-11-04T15:17:18Z

Fixes: #25570

This change fixes an issue where running different queries inside an interactive transaction in the same tick would not be batched together automatically by the engine. By accounting for the protocolQuery when batching interactive transactions, the engine can optimize the queries correctly, as the queries will be batched by both the transaction ID and the query.

Hi @LucianBuzzo, thanks for this PR! Do you think you can maybe add a few tests for this improvement in https://github.com/prisma/prisma/tree/main/packages/client/tests/functional/batching? You can run tests locally by cd'ing to ./packages/client and running:

pnpm run test:functional --provider=${DB_PROVIDER} --client-runtime node --engine-type library --runInBand extensions

You can set DB_PROVIDER to e.g. sqlite, to make things easier.

LucianBuzzo · 2024-11-04T16:33:02Z

@jkomyno No problem, I've added tests to check the base case of batching, and batching with multiple models queried.

packages/client/tests/functional/batching/tests.ts

SAGV · 2025-06-16T22:26:18Z

@LucianBuzzo could you suggest the easiest way to monkeypatch prisma while this fix is on the way? We're facing a very similar issue with our own graphql+rls server unfortunately…

LucianBuzzo · 2025-06-17T08:03:32Z

@SAGV You can see the patching operation here https://github.com/cerebruminc/yates/blob/v3.6.3/src/index.ts#L245
Getting this to function "natively" also required copying in some utility functions from the prisma client source: getBatchId() and buildKeysString().

SAGV · 2025-06-17T15:19:31Z

@LucianBuzzo wow, huge thanks! 👍🏻 👍🏻 👍🏻

I've tried so many things yesterday trying to figure out why the batching is broken inside transactions… The patch has just made our graphql requests 10x faster!

@aqrln even if there are 2 queries, it's still insanely faster…

CLAassistant · 2025-09-24T14:30:32Z

All committers have signed the CLA.

…tions Fixes: prisma#25570 This change fixes an issue where running different queries inside an interactive transaction in the same tick would not be batched together automatically by the engine. By accounting for the protocolQuery when batching interactive transactions, the engine can optimize the queries correctly, as the queries will be batched by both the transaction ID and the query.

coderabbitai · 2026-02-09T16:50:43Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

Walkthrough

RequestHandler.batchBy now groups interactive-transaction (itx) requests using a batch identifier derived from protocolQuery; test schema adds a Comment model and tests are extended to instrument and assert engine batching behavior for interactive transactions (PostgreSQL-only).

Changes

Cohort / File(s)	Summary
RequestHandler batching `packages/client/src/runtime/RequestHandler.ts`	Internal change to `batchBy`: when `request.transaction.kind === 'itx'`, compute `batchId` from `protocolQuery` and return `itx-${transaction.id}-${batchId}` if present, otherwise `itx-${transaction.id}`. Non-itx behavior unchanged. No public signature changes.
Test schema `packages/client/tests/functional/batching/prisma/_schema.ts`	Added new `Comment` model and a `comments Comment[]` relation field on `User` for test coverage.
Functional batching tests `packages/client/tests/functional/batching/tests.ts`	Changed `setupTestSuite` callback to `({ provider }) => { ... }`. Added engine- and query-level counters, reset helpers, instrumentation of `engine.request`/`engine.requestBatch`, refined query-event classification, and PostgreSQL-gated interactive-transaction tests asserting batching and batch sizes.

🚥 Pre-merge checks | ✅ 4 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Merge Conflict Detection	⚠️ Warning	❌ Merge conflicts detected (41 files): ⚔️ `AGENTS.md` (content) ⚔️ `packages/adapter-mssql/src/connection-string.test.ts` (content) ⚔️ `packages/adapter-mssql/src/connection-string.ts` (content) ⚔️ `packages/adapter-mssql/src/mssql.ts` (content) ⚔️ `packages/cli/src/Init.ts` (content) ⚔️ `packages/cli/src/bin.ts` (content) ⚔️ `packages/cli/src/mcp/MCP.ts` (content) ⚔️ `packages/client-common/package.json` (content) ⚔️ `packages/client-common/src/client-config.ts` (content) ⚔️ `packages/client-engine-runtime/src/batch.ts` (content) ⚔️ `packages/client-engine-runtime/src/interpreter/query-interpreter.ts` (content) ⚔️ `packages/client-engine-runtime/src/query-plan.ts` (content) ⚔️ `packages/client-generator-js/package.json` (content) ⚔️ `packages/client-generator-js/src/TSClient/TSClient.ts` (content) ⚔️ `packages/client-generator-ts/package.json` (content) ⚔️ `packages/client-generator-ts/src/TSClient/file-generators/ClassFile.ts` (content) ⚔️ `packages/client/package.json` (content) ⚔️ `packages/client/src/__tests__/benchmarks/query-performance/compilation.bench.ts` (content) ⚔️ `packages/client/src/runtime/RequestHandler.ts` (content) ⚔️ `packages/client/src/runtime/core/engines/client/ClientEngine.ts` (content) ⚔️ `packages/client/src/runtime/core/engines/common/Engine.ts` (content) ⚔️ `packages/client/src/runtime/core/jsonProtocol/serializeJsonQuery.test.ts` (content) ⚔️ `packages/client/src/runtime/core/jsonProtocol/serializeJsonQuery.ts` (content) ⚔️ `packages/client/src/runtime/getPrismaClient.ts` (content) ⚔️ `packages/client/src/utils/getTestClient.ts` (content) ⚔️ `packages/client/tests/functional/_utils/types.ts` (content) ⚔️ `packages/client/tests/functional/batching/prisma/_schema.ts` (content) ⚔️ `packages/client/tests/functional/batching/tests.ts` (content) ⚔️ `packages/client/tests/functional/chunking-query/tests.ts` (content) ⚔️ `packages/client/tests/functional/tracing/tests.ts` (content) ⚔️ `packages/engines/package.json` (content) ⚔️ `packages/fetch-engine/package.json` (content) ⚔️ `packages/internals/package.json` (content) ⚔️ `packages/json-protocol/src/index.ts` (content) ⚔️ `packages/migrate/package.json` (content) ⚔️ `packages/schema-files-loader/package.json` (content) ⚔️ `packages/sqlcommenter-query-insights/src/parameterize/parameterize.ts` (content) ⚔️ `packages/sqlcommenter-query-insights/src/parameterize/tests/tagged-values.test.ts` (content) ⚔️ `packages/type-benchmark-tests/test.ts` (content) ⚔️ `pnpm-lock.yaml` (content) ⚔️ `tsconfig.build.bundle.json` (content) These conflicts must be resolved before merging into `main`.	Resolve conflicts locally and push changes to this branch.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: enabling batching of multiple queries inside interactive transactions, which is the core fix in the PR.
Linked Issues check	✅ Passed	The PR implementation addresses issue `#25570` by modifying RequestHandler.batchBy to account for protocolQuery when batching interactive transactions, enabling proper batching of multiple distinct queries within the same transaction tick.
Out of Scope Changes check	✅ Passed	All changes are scoped to the interactive transaction batching fix: RequestHandler.ts for batching logic, schema.ts for test setup with User-Comment relation, and tests.ts for comprehensive batching verification tests.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 2

packages/client/tests/functional/batching/tests.ts

coderabbitai

Actionable comments posted: 2

packages/client/tests/functional/batching/tests.ts

codspeed-hq · 2026-02-12T17:13:47Z

Merging this PR will not alter performance

✅ 47 untouched benchmarks

_{Comparing LucianBuzzo:lucianbuzzo/25570-auto-batch-itx (6644c78) with main (9865dcb)}

coderabbitai

Actionable comments posted: 1

packages/client/tests/functional/batching/tests.ts

Co-authored-by: jacek-prisma <malec@prisma.io>

coderabbitai

Actionable comments posted: 1

packages/client/tests/functional/batching/tests.ts

…tions (#25571) Fixes: #25570 This change fixes an issue where running different queries inside an interactive transaction in the same tick would not be batched together automatically by the engine. By accounting for the protocolQuery when batching interactive transactions, the engine can optimize the queries correctly, as the queries will be batched by both the transaction ID and the query.  ## Summary by CodeRabbit * **Improvements** * Batching for interactive transactions now groups requests by transaction and protocol batch identifier when available for more precise execution. * **Database** * Added a Comment model and a comments relation on User for test scenarios. * **Tests** * Expanded interactive-transaction batching tests with detailed engine/batch metrics and PostgreSQL-only scenarios.  --------- Co-authored-by: jacek-prisma <malec@prisma.io>

dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Nov 4, 2024

LucianBuzzo mentioned this pull request Nov 4, 2024

Automatic batching doesn't work inside interactive transaction #25570

Closed

dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels Nov 4, 2024

LucianBuzzo force-pushed the lucianbuzzo/25570-auto-batch-itx branch from 4322bb9 to d963e26 Compare November 4, 2024 16:33

jkomyno assigned aqrln Nov 5, 2024

LucianBuzzo force-pushed the lucianbuzzo/25570-auto-batch-itx branch from 587d609 to 87c83a1 Compare November 26, 2024 16:11

aqrln reviewed Mar 7, 2025

View reviewed changes

packages/client/tests/functional/batching/tests.ts Show resolved Hide resolved

aqrln reviewed Mar 7, 2025

View reviewed changes

packages/client/tests/functional/batching/tests.ts Outdated Show resolved Hide resolved

LucianBuzzo added 2 commits February 9, 2026 16:41

add functional tests for batching in interactive transactions

4e9c491

LucianBuzzo force-pushed the lucianbuzzo/25570-auto-batch-itx branch from c2fd912 to 4e9c491 Compare February 9, 2026 16:48

coderabbitai bot reviewed Feb 9, 2026

View reviewed changes

packages/client/tests/functional/batching/tests.ts Show resolved Hide resolved

packages/client/tests/functional/batching/tests.ts Show resolved Hide resolved

test(client): assert no extra tx boundaries in itx batching

5e10037

coderabbitai bot reviewed Feb 9, 2026

View reviewed changes

packages/client/tests/functional/batching/tests.ts Show resolved Hide resolved

packages/client/tests/functional/batching/tests.ts Outdated Show resolved Hide resolved

LucianBuzzo requested a review from aqrln February 9, 2026 18:27

test(client): assert itx batching uses engine requestBatch

f2d25c3

LucianBuzzo force-pushed the lucianbuzzo/25570-auto-batch-itx branch from 4f9b6d9 to f2d25c3 Compare February 12, 2026 17:35

coderabbitai bot reviewed Feb 12, 2026

View reviewed changes

packages/client/tests/functional/batching/tests.ts Outdated Show resolved Hide resolved

jacek-prisma reviewed Feb 13, 2026

View reviewed changes

packages/client/tests/functional/batching/tests.ts Outdated Show resolved Hide resolved

refactor: use stricter client type in batch test

e88453a

Co-authored-by: jacek-prisma <malec@prisma.io>

coderabbitai bot reviewed Feb 14, 2026

View reviewed changes

packages/client/tests/functional/batching/tests.ts Outdated Show resolved Hide resolved

jacek-prisma reviewed Feb 14, 2026

View reviewed changes

packages/client/tests/functional/batching/tests.ts Outdated Show resolved Hide resolved

jacek-prisma added 2 commits February 17, 2026 16:45

chore: cleanup

24ec6ec

Merge branch 'main' into lucianbuzzo/25570-auto-batch-itx

6644c78

jacek-prisma approved these changes Feb 18, 2026

View reviewed changes

jacek-prisma merged commit 6587f54 into prisma:main Feb 18, 2026
244 of 245 checks passed

Conversation

LucianBuzzo commented Nov 4, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

jkomyno commented Nov 4, 2024

Uh oh!

LucianBuzzo commented Nov 4, 2024

Uh oh!

Uh oh!

Uh oh!

SAGV commented Jun 16, 2025

Uh oh!

LucianBuzzo commented Jun 17, 2025

Uh oh!

SAGV commented Jun 17, 2025

Uh oh!

CLAassistant commented Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codspeed-hq bot commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

LucianBuzzo commented Nov 4, 2024 •

edited by coderabbitai bot

Loading

CLAassistant commented Sep 24, 2025 •

edited

Loading

coderabbitai bot commented Feb 9, 2026 •

edited

Loading

codspeed-hq bot commented Feb 12, 2026 •

edited

Loading