Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(client): Correctly report error location in batch transaction (#1…
…6240) Engine PR: prisma/prisma-engines#3384 Uses newly added `batch_request_idx` property of an errors to identify and correctly report error location within a batch. Fix #15433 Fix #14373
- Loading branch information
Showing
20 changed files
with
359 additions
and
82 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| import { PrismaClientKnownRequestError } from '@prisma/engine-core' | ||
|
|
||
| import { waitForBatch } from './waitForBatch' | ||
|
|
||
| test('resolves when all promises succesfully resolve', async () => { | ||
| const result = await waitForBatch([Promise.resolve(1), Promise.resolve(2), Promise.resolve(3)]) | ||
|
|
||
| expect(result).toEqual([1, 2, 3]) | ||
| }) | ||
|
|
||
| test('works with empty array', async () => { | ||
| const result = await waitForBatch([]) | ||
|
|
||
| expect(result).toEqual([]) | ||
| }) | ||
|
|
||
| test('returns results in order even if they resolve out of order', async () => { | ||
| const result = await waitForBatch([ | ||
| Promise.resolve(1), | ||
| new Promise((resolve) => setTimeout(() => resolve(2), 200)), | ||
| Promise.resolve(3), | ||
| ]) | ||
|
|
||
| expect(result).toEqual([1, 2, 3]) | ||
| }) | ||
|
|
||
| test('rejects with error, which batchRequestIdx matches its position in batch', async () => { | ||
| const err1 = new PrismaClientKnownRequestError('one', { code: 'P1', clientVersion: '0.0.0', batchRequestIdx: 2 }) | ||
| const err2 = new PrismaClientKnownRequestError('two', { code: 'P1', clientVersion: '0.0.0', batchRequestIdx: 1 }) | ||
| const err3 = new PrismaClientKnownRequestError('three', { code: 'P1', clientVersion: '0.0.0', batchRequestIdx: 0 }) | ||
| const result = waitForBatch([Promise.reject(err1), Promise.reject(err2), Promise.reject(err3)]) | ||
|
|
||
| await expect(result).rejects.toBe(err2) | ||
| }) | ||
|
|
||
| test('rejects with error, which batchRequestIdx matches its position in batch, even if it rejects later', async () => { | ||
| const err1 = new PrismaClientKnownRequestError('one', { code: 'P1', clientVersion: '0.0.0', batchRequestIdx: 2 }) | ||
| const err2 = new PrismaClientKnownRequestError('two', { code: 'P1', clientVersion: '0.0.0', batchRequestIdx: 1 }) | ||
| const err3 = new PrismaClientKnownRequestError('three', { code: 'P1', clientVersion: '0.0.0', batchRequestIdx: 0 }) | ||
| const result = waitForBatch([ | ||
| Promise.reject(err1), | ||
| new Promise((_, reject) => setTimeout(() => reject(err2), 200)), | ||
| Promise.reject(err3), | ||
| ]) | ||
|
|
||
| await expect(result).rejects.toBe(err2) | ||
| }) | ||
|
|
||
| test('rejects with the first error if no batchRequestIdxes match position', async () => { | ||
| const err1 = new PrismaClientKnownRequestError('one', { code: 'P1', clientVersion: '0.0.0', batchRequestIdx: 1 }) | ||
| const err2 = new PrismaClientKnownRequestError('two', { code: 'P1', clientVersion: '0.0.0', batchRequestIdx: 2 }) | ||
| const err3 = new PrismaClientKnownRequestError('three', { code: 'P1', clientVersion: '0.0.0', batchRequestIdx: 0 }) | ||
| const result = waitForBatch([ | ||
| Promise.reject(err1), | ||
| new Promise((_, reject) => setTimeout(() => reject(err2), 200)), | ||
| Promise.reject(err3), | ||
| ]) | ||
|
|
||
| await expect(result).rejects.toBe(err1) | ||
| }) | ||
|
|
||
| test('rejects with error if one of the promises rejects with non-batch error', async () => { | ||
| const error = new Error('nope') | ||
| const result = waitForBatch([Promise.resolve(1), Promise.reject(error), Promise.resolve(3)]) | ||
|
|
||
| await expect(result).rejects.toBe(error) | ||
| }) | ||
|
|
||
| test('rejects with error if one of the promises rejects with non-batch error, even if other promsies never resolve', async () => { | ||
| const error = new Error('nope') | ||
| const result = waitForBatch([new Promise(() => {}), Promise.reject(error)]) | ||
|
|
||
| await expect(result).rejects.toBe(error) | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| import { hasBatchIndex } from '@prisma/engine-core' | ||
|
|
||
| /** | ||
| * Waits for result of batch $transaction and picks the best possible error to report if any | ||
| * of the request fails. Best error is determined as follows: | ||
| * | ||
| * - if engine have reported an error without batch request index, then the batch is immediately rejected | ||
| * with this error without waiting for other promises | ||
| * - if engine have reported and index of failed request in the batch and that index matches the position of the | ||
| * particular request in the batch, batch is rejected with that error | ||
| * - if batch request index is reported and it does not match current request position, wait for other requests. If no indices | ||
| * match request positions, reject with the earliest error in the batch | ||
| * | ||
| * @param promises | ||
| * @returns | ||
| */ | ||
| export function waitForBatch<T extends PromiseLike<unknown>[]>( | ||
| promises: T, | ||
| ): Promise<{ [K in keyof T]: Awaited<T[K]> }> { | ||
| if (promises.length === 0) { | ||
| return Promise.resolve([] as { [K in keyof T]: Awaited<T[K]> }) | ||
| } | ||
| return new Promise((resolve, reject) => { | ||
| const successfulResults = new Array(promises.length) as { [K in keyof T]: Awaited<T[K]> } | ||
| let bestError: unknown = null | ||
| let done = false | ||
| let settledPromisesCount = 0 | ||
|
|
||
| const settleOnePromise = () => { | ||
| if (done) { | ||
| return | ||
| } | ||
| settledPromisesCount++ | ||
| if (settledPromisesCount === promises.length) { | ||
| done = true | ||
| if (bestError) { | ||
| reject(bestError) | ||
| } else { | ||
| resolve(successfulResults) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const immediatelyReject = (error: unknown) => { | ||
| if (!done) { | ||
| done = true | ||
| reject(error) | ||
| } | ||
| } | ||
|
|
||
| for (let i = 0; i < promises.length; i++) { | ||
| promises[i].then( | ||
| (result) => { | ||
| successfulResults[i] = result | ||
| settleOnePromise() | ||
| }, | ||
| (error) => { | ||
| if (!hasBatchIndex(error)) { | ||
| immediatelyReject(error) | ||
| return | ||
| } | ||
|
|
||
| if (error.batchRequestIdx === i) { | ||
| immediatelyReject(error) | ||
| } else { | ||
| if (!bestError) { | ||
| bestError = error | ||
| } | ||
| settleOnePromise() | ||
| } | ||
| }, | ||
| ) | ||
| } | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.