Skip to content

Avoid hash mismatch by stringify bindings #2028

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

Open
erikn69 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Avoid hash mismatch by stringify bindings #2028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion resources/queries/widget.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
const body = {
connection: statement.explain.connection,
query: statement.explain.query,
bindings: statement.params,
bindings: JSON.stringify(statement.params),
hash: statement.explain.hash,
mode: mode,
};
Expand Down
7 changes: 4 additions & 3 deletions src/Controllers/QueriesController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class QueriesController
public function explain(QueriesExplainRequest $request, LaravelDebugbar $debugbar, Explain $explain): \Illuminate\Http\JsonResponse
{
$validated = $request->validated();
$validated['bindings'] = json_decode($validated['bindings'] ?? '[]', true) ?: [];

if (($validated['mode'] ?? null) === 'result') {

Expand All @@ -29,7 +30,7 @@ public function explain(QueriesExplainRequest $request, LaravelDebugbar $debugba

return response()->json([
'success' => true,
'data' => $explain->generateSelectResult($validated['connection'], $validated['query'], $validated['bindings'] ?? null, $validated['hash'], $validated['format'] ?? null),
'data' => $explain->generateSelectResult($validated['connection'], $validated['query'], $validated['bindings'], $validated['hash'], $validated['format'] ?? null),
]);
}

Expand All @@ -44,13 +45,13 @@ public function explain(QueriesExplainRequest $request, LaravelDebugbar $debugba
if (($validated['mode'] ?? null) === 'visual') {
return response()->json([
'success' => true,
'data' => $explain->generateVisualExplain($validated['connection'], $validated['query'], $validated['bindings'] ?? null, $validated['hash']),
'data' => $explain->generateVisualExplain($validated['connection'], $validated['query'], $validated['bindings'], $validated['hash']),
]);
}

return response()->json([
'success' => true,
'data' => $explain->generateRawExplain($validated['connection'], $validated['query'], $validated['bindings'] ?? null, $validated['hash']),
'data' => $explain->generateRawExplain($validated['connection'], $validated['query'], $validated['bindings'], $validated['hash']),
'visual' => $explain->isVisualExplainSupported($validated['connection']) ? [
'confirm' => $explain->confirmVisualExplain($validated['connection']),
] : null,
Expand Down
2 changes: 1 addition & 1 deletion src/Requests/QueriesExplainRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public function rules(): array
return [
'connection' => ['required', 'string'],
'query' => ['required', 'string'],
'bindings' => ['nullable', 'array'],
'bindings' => ['nullable', 'json'],
'hash' => ['required', 'string'],
'mode' => ['nullable', 'string', 'in:explain,visual,result'],
'format' => ['nullable', 'string'],
Expand Down
8 changes: 4 additions & 4 deletions tests/Controllers/QueriesControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public function testExplainReturnsErrorWhenStorageIsNotOpen(): void
$response = $this->postJson('/_debugbar/queries/explain', [
'connection' => 'sqlite',
'query' => 'SELECT 1',
'bindings' => [],
'bindings' => '[]',
'hash' => 'abc123',
]);

Expand All @@ -33,7 +33,7 @@ public function testExplainReturnsErrorWhenExplainIsDisabled(): void
$response = $this->postJson('/_debugbar/queries/explain', [
'connection' => 'sqlite',
'query' => 'SELECT 1',
'bindings' => [],
'bindings' => '[]',
'hash' => 'abc123',
]);

Expand Down Expand Up @@ -63,7 +63,7 @@ public function testExplainValidatesModeValues(): void
$response = $this->postJson('/_debugbar/queries/explain', [
'connection' => 'sqlite',
'query' => 'SELECT 1',
'bindings' => [],
'bindings' => '[]',
'hash' => 'abc123',
'mode' => 'invalid',
]);
Expand All @@ -81,7 +81,7 @@ public function testExplainAcceptsValidModeValues(): void
$response = $this->postJson('/_debugbar/queries/explain', [
'connection' => 'sqlite',
'query' => 'SELECT 1',
'bindings' => [],
'bindings' => '[]',
'hash' => 'abc123',
'mode' => $mode,
]);
Expand Down
Loading