Skip to content
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

[8.x] Add method to dump the SQL query replacing all bindings #36918

Closed
wants to merge 11 commits into from
Closed

[8.x] Add method to dump the SQL query replacing all bindings #36918

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3d0d264
Add method to dump the SQL query replacing all bindings
mateusjunges Apr 8, 2021
a1001f9
Apply fixes from styleci
mateusjunges Apr 8, 2021
8118b62
add tests for each builder
mateusjunges Apr 8, 2021
101f276
Fix toSqlWithBindings to work with objects that doesnt implement __to…
mateusjunges Apr 11, 2021
07a2a42
using PDO quote method to quote query parameters in order to work whe…
mateusjunges Apr 12, 2021
b1ad059
Use getPdo only if method exists
mateusjunges Apr 12, 2021
56a24ac
fixes from styleci
mateusjunges Apr 12, 2021
20bdb8c
fix var name
mateusjunges Apr 12, 2021
8e35202
wip
mateusjunges Apr 12, 2021
aff2f0c
Remove PDOstub class from tests
mateusjunges Apr 12, 2021
e24803a
remove duplicate is_string check
mateusjunges Apr 12, 2021
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 src/Illuminate/Database/Query/Builder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2275,7 +2275,7 @@ public function toSqlWithBindings()
'?',
collect($this->connection->prepareBindings($this->getBindings()))
->map(function ($i) {
return (is_string($i)) ? "'{$i}'" : $i;
return (is_string($i)) ? $this->connection->getPdo()->quote($i) : $i;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$this->connection is type-hinted as a Illuminate\Database\ConnectionInterface, which does not have a getPdo() method.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rodrigopedra Do you think something like this would be better?

$search = ["\\",  "\x00", "\n",  "\r",  "'",  '"', "\x1a"];
$replace = ["\\\\","\\0","\\n", "\\r", "\'", '\"', "\\Z"];

return "'" . str_replace($search, $replace, $value) . "'";

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a combination of both, similar to what debugbar does:

https://github.com/barryvdh/laravel-debugbar/blob/6420113d90bb746423fa70b9940e9e7c26ebc121/src/DataCollector/QueryCollector.php#L121-L126

https://github.com/barryvdh/laravel-debugbar/blob/6420113d90bb746423fa70b9940e9e7c26ebc121/src/DataCollector/QueryCollector.php#L148-L152

https://github.com/barryvdh/laravel-debugbar/blob/6420113d90bb746423fa70b9940e9e7c26ebc121/src/DataCollector/QueryCollector.php#L191-L197

Although I would use method_exists instead of try...catch to check for PDO

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rodrigopedra done.

})->all(),
$this->toSql()
);
Expand Down
56 changes: 56 additions & 0 deletions tests/Database/DatabaseQueryBuilderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use Illuminate\Pagination\LengthAwarePaginator;
use InvalidArgumentException;
use Mockery as m;
use PDO;
use PHPUnit\Framework\TestCase;
use RuntimeException;
use stdClass;
Expand Down Expand Up @@ -3813,6 +3814,10 @@ public function testToSqlWithBindingsMethodUsingMysqlBuilder()
$processor = m::mock(Processor::class);
$connection = m::mock(ConnectionInterface::class);

$pdo = $this->createMock(PDOStub::class);
$pdo->expects($this->once())->method('quote')->with('%Taylor%')->willReturn("'%Taylor%'");

$connection->shouldReceive('getPdo')->andReturn($pdo);
$connection->expects('prepareBindings')
->with(['%Taylor%'])
->andReturn(['%Taylor%']);
Expand All @@ -3829,6 +3834,10 @@ public function testToSqlWithBindingsMethodUsingPostgresBuilder()
$processor = m::mock(Processor::class);
$connection = m::mock(ConnectionInterface::class);

$pdo = $this->createMock(PDOStub::class);
$pdo->expects($this->once())->method('quote')->with('%Taylor%')->willReturn("'%Taylor%'");

$connection->shouldReceive('getPdo')->andReturn($pdo);
$connection->expects('prepareBindings')
->with(['%Taylor%'])
->andReturn(['%Taylor%']);
Expand All @@ -3845,6 +3854,10 @@ public function testToSqlWithBindingsMethodUsingSQLiteBuilder()
$processor = m::mock(Processor::class);
$connection = m::mock(ConnectionInterface::class);

$pdo = $this->createMock(PDOStub::class);
$pdo->expects($this->once())->method('quote')->with('%Taylor%')->willReturn("'%Taylor%'");

$connection->shouldReceive('getPdo')->andReturn($pdo);
$connection->expects('prepareBindings')
->with(['%Taylor%'])
->andReturn(['%Taylor%']);
Expand All @@ -3861,6 +3874,10 @@ public function testToSqlWithBindingsMethodUsingSqlServerBuilder()
$processor = m::mock(Processor::class);
$connection = m::mock(ConnectionInterface::class);

$pdo = $this->createMock(PDOStub::class);
$pdo->expects($this->once())->method('quote')->with('%Taylor%')->willReturn("'%Taylor%'");

$connection->shouldReceive('getPdo')->andReturn($pdo);
$connection->expects('prepareBindings')
->with(['%Taylor%'])
->andReturn(['%Taylor%']);
Expand All @@ -3879,6 +3896,12 @@ public function testToSqlWithBindingsWorksWithObjectsThatDoesntImplementToString

$datetime = new Datetime();

$pdo = $this->createMock(PDOStub::class);
$pdo->expects($this->once())->method('quote')
->with($datetime->format('Y-m-d H:i:s'))
->willReturn("'{$datetime->format('Y-m-d H:i:s')}'");

$connection->shouldReceive('getPdo')->andReturn($pdo);
$connection->expects('prepareBindings')
->with([$datetime])
->andReturn([$datetime->format('Y-m-d H:i:s')]);
Expand All @@ -3893,6 +3916,26 @@ public function testToSqlWithBindingsWorksWithObjectsThatDoesntImplementToString
);
}

public function testToSqlWithBindingsWorksWithQuotedStrings()
{
$grammar = new MySqlGrammar();
$processor = m::mock(Processor::class);
$connection = m::mock(ConnectionInterface::class);

$pdo = $this->createMock(PDOStub::class);
$pdo->expects($this->once())->method('quote')->with("%Taylor's%")->willReturn("'%Taylor\'s%'");

$connection->shouldReceive('getPdo')->andReturn($pdo);
$connection->expects('prepareBindings')
->with(['%Taylor\'s%'])
->andReturn(['%Taylor\'s%']);

$builder = new Builder($connection, $grammar, $processor);

$builder->select('*')->from('users')->where('name', 'like', '%Taylor\'s%');
$this->assertSame("select * from `users` where `name` like '%Taylor\'s%'", $builder->toSqlWithBindings());
}

protected function getConnection()
{
$connection = m::mock(ConnectionInterface::class);
Expand Down Expand Up @@ -3961,3 +4004,16 @@ protected function getMockQueryBuilder()
])->makePartial();
}
}

class PDOStub extends PDO
{
public function __construct()
{
//
}

public function quote($string, $type = PDO::PARAM_STR)
{
//
}
}