Skip to content

Classify recovered SQLite queue producer contention in tracing tests #883

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rmcdaniel merged 2 commits into from
Oct 21, 2026
Merged

Classify recovered SQLite queue producer contention in tracing tests #883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0635ad
Classify recovered SQLite queue dispatch contention in tracing tests
rmcdaniel Oct 21, 2026
d65f025
Apply ECS formatting to queue diagnostic controls
rmcdaniel Oct 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions tests/Support/TracingQueueErrorDiagnostics.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,34 @@ public static function isFailedJobLogContention(array $error): bool
&& ($frame['file'] ?? null) === 'WorkCommand.php'
&& ($frame['function'] ?? null) === 'logFailedJob') !== [];
}

public static function isQueueDispatchContention(array $error): bool
{
$code = $error['native_code'] ?? null;
if (
($error['error_class'] ?? null) !== QueryException::class
|| ! is_int($code) || $code < 0 || ! in_array($code & 255, [5, 6], true)
|| ($error['operation'] ?? null) !== 'insert'
|| ($error['transaction_level'] ?? null) !== 0
|| ($error['pdo_in_transaction'] ?? null) !== false
|| ! array_key_exists('ack_fence', $error) || $error['ack_fence'] !== null
|| ($error['statement_truncated'] ?? null) !== false
|| ($error['statement'] ?? null) !== 'insert into "jobs" '
. '("queue", "attempts", "reserved_at", "available_at", "created_at", "payload") values (?, ?, ?, ?, ?, ?)'
) {
return false;
}

$frames = $error['stage_frames'] ?? [];
if (! is_array($frames)) {
return false;
}

return array_filter($frames, static fn (mixed $frame): bool => is_array($frame)
&& ($frame['file'] ?? null) === 'DatabaseQueue.php'
&& ($frame['function'] ?? null) === 'insertGetId') !== []
&& array_filter($frames, static fn (mixed $frame): bool => is_array($frame)
&& ($frame['file'] ?? null) === 'DatabaseQueue.php'
&& ($frame['function'] ?? null) === 'pushToDatabase') !== [];
}
}
3 changes: 2 additions & 1 deletion tests/Unit/V2/LargeFanOutExecutionTracingTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,8 @@ private static function assertQueuePressureError(array $error, bool $reported, s
self::assertIsInt($error['native_code'], $diagnostic);
self::assertContains($error['native_code'] & 255, [5, 6], $diagnostic);
self::assertTrue(in_array($error['operation'], ['update', 'delete'], true)
|| ($reported && TracingQueueErrorDiagnostics::isFailedJobLogContention($error)), $diagnostic);
|| ($reported && (TracingQueueErrorDiagnostics::isFailedJobLogContention($error)
|| TracingQueueErrorDiagnostics::isQueueDispatchContention($error))), $diagnostic);
self::assertSame(0, $error['transaction_level'], $diagnostic);
self::assertFalse($error['pdo_in_transaction'], $diagnostic);
}
Expand Down
74 changes: 74 additions & 0 deletions tests/Unit/V2/TracingQueueErrorDiagnosticsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,80 @@ public static function unsafeRefusals(): array
];
}

public function testOnlyKnownQueueDispatchContentionIsClassified(): void
{
$error = self::queueDispatchRefusal();
foreach ([5, 6, 517] as $code) {
$error['native_code'] = $code;
self::assertTrue(TracingQueueErrorDiagnostics::isQueueDispatchContention($error));
}
unset($error['ack_fence']);
self::assertFalse(TracingQueueErrorDiagnostics::isQueueDispatchContention($error));
}

#[DataProvider('unsafeQueueDispatchReports')]
public function testOtherQueueDispatchErrorsRemainRefusals(array $changes): void
{
self::assertFalse(TracingQueueErrorDiagnostics::isQueueDispatchContention(
array_replace(self::queueDispatchRefusal(), $changes),
));
}

public static function unsafeQueueDispatchReports(): array
{
return self::unsafeRefusals() + [
'other exception' => [[
'error_class' => RuntimeException::class,
]],
'untyped sqlite code' => [[
'native_code' => '5',
]],
'invalid negative sqlite code' => [[
'native_code' => -251,
]],
'acknowledgment instead of dispatch' => [[
'operation' => 'delete',
]],
'unexpected acknowledgment fence' => [[
'ack_fence' => [1, 'default', 10, 1],
]],
'missing producer frame' => [[
'stage_frames' => [[
'file' => 'DatabaseQueue.php',
'function' => 'insertGetId',
]],
]],
'missing insert frame' => [[
'stage_frames' => [[
'file' => 'DatabaseQueue.php',
'function' => 'pushToDatabase',
]],
]],
];
}

private static function queueDispatchRefusal(): array
{
return [
'error_class' => QueryException::class,
'native_code' => 5,
'operation' => 'insert',
'transaction_level' => 0,
'pdo_in_transaction' => false,
'ack_fence' => null,
'statement_truncated' => false,
'statement' => 'insert into "jobs" '
. '("queue", "attempts", "reserved_at", "available_at", "created_at", "payload") values (?, ?, ?, ?, ?, ?)',
'stage_frames' => [[
'file' => 'DatabaseQueue.php',
'function' => 'insertGetId',
], [
'file' => 'DatabaseQueue.php',
'function' => 'pushToDatabase',
]],
];
}

private static function failedJobLogRefusal(): array
{
return [
Expand Down
Loading