[10.x] Add toRawSql for query builders

.github/workflows/databases.yml

@@ -1,11 +1,6 @@
 name: databases
 
-on:
-  push:
-    branches:
-      - master
-      - '*.x'
-  pull_request:
+on: [push, pull_request]
 
 jobs:
   mysql_57:

.github/workflows/facades.yml

@@ -1,10 +1,6 @@
 name: facades
 
-on:
-  push:
-    branches:
-      - master
-      - '*.x'
+on: [push, pull_request]
 
 jobs:
   update:

.github/workflows/static-analysis.yml

@@ -1,11 +1,6 @@
 name: static analysis
 
-on:
-  push:
-    branches:
-      - master
-      - '*.x'
-  pull_request:
+on: [push, pull_request]
 
 jobs:
   types:

.github/workflows/tests.yml

@@ -1,13 +1,6 @@
 name: tests
 
-on:
-  push:
-    branches:
-      - master
-      - '*.x'
-  pull_request:
-  schedule:
-    - cron: '0 0 * * *'
+on: [push, pull_request]
 
 jobs:
   linux_tests:

src/Illuminate/Database/Eloquent/Builder.php

@@ -115,6 +115,7 @@ class Builder implements BuilderContract
         'raw',
         'rawValue',
         'sum',
+        'toRawSql',
         'toSql',
     ];
 

src/Illuminate/Database/Query/Builder.php

@@ -2634,6 +2634,19 @@ public function toSql()
         return $this->grammar->compileSelect($this);
     }
 
+    /**
+     * Get the raw SQL representation of the query.
+     *
+     * @return string
+     */
+    public function toRawSql()
+    {
+        $sql = $this->toSql();
+        $bindings = $this->connection->prepareBindings($this->getBindings());
+
+        return $this->grammar->makeRawSql($sql, $bindings);
+    }
+
     /**
      * Execute a query for a single record by ID.
      *

src/Illuminate/Database/Query/Grammars/Grammar.php

@@ -1376,4 +1376,39 @@ public function getBitwiseOperators()
     {
         return $this->bitwiseOperators;
     }
+
+    /**
+     * Make raw SQL query.
+     *
+     * @param string $sql
+     * @param array $bindings
+     * @return string
+     */
+    public function makeRawSql($sql, $bindings)
+    {
+        $bindings = array_map(fn ($value) => $this->escape($value), $bindings);
+        $query = '';
+
+        $isEscape = false;
+        for ($i = 0; $i < strlen($sql); $i++) {
+            $char = $sql[$i];
+            $nextChar = $sql[$i + 1] ?? null;
+
+            // Single quotes can be escaped as '' according to the SQL standard while MySQL uses \'.
+            // PostgreSQL has operators like ?| that have to be encoded in PHP like ??|.
+            if (in_array($char.$nextChar, ["\'", "''", '??'])) {
+                $query .= $char.$nextChar;
+                $i += 1;
+            } else if ($char === "'") {
+                $query .= $char;
+                $isEscape = !$isEscape;
+            } else if ($char === '?' && !$isEscape) {
+                $query .= array_shift($bindings) ?? '?';
+            } else {
+                $query .= $char;
+            }
+        }
+
+        return $query;
+    }
 }

src/Illuminate/Database/Query/Grammars/PostgresGrammar.php

@@ -698,4 +698,18 @@ protected function parseJsonPathArrayKeys($attribute)
 
         return [$attribute];
     }
+
+    /**
+     * Make raw SQL query.
+     *
+     * @param string $sql
+     * @param array $bindings
+     * @return string
+     */
+    public function makeRawSql($sql, $bindings)
+    {
+        $query = parent::makeRawSql($sql, $bindings);
+
+        return str_replace('??', '?', $query);
+    }
 }

tests/Database/DatabaseEloquentBuilderTest.php

@@ -2216,6 +2216,17 @@ public function testClone()
         $this->assertSame('select * from "users" where "email" = ?', $clone->toSql());
     }
 
+    public function testToRawSql()
+    {
+        $query = m::mock(BaseBuilder::class);
+        $query->shouldReceive('toRawSql')
+            ->andReturn('select * from "users" where "email" = \'foo\'');
+
+        $builder = new Builder($query);
+
+        $this->assertSame('select * from "users" where "email" = \'foo\'', $builder->toRawSql());
+    }
+
     protected function mockConnectionForModel($model, $database)
     {
         $grammarClass = 'Illuminate\Database\Query\Grammars\\'.$database.'Grammar';

tests/Database/DatabaseMySqlQueryGrammarTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Illuminate\Tests\Database;
+
+use Illuminate\Database\Connection;
+use Illuminate\Database\Query\Grammars\MySqlGrammar;
+use Mockery as m;
+use PHPUnit\Framework\TestCase;
+
+class DatabaseMySqlQueryGrammarTest extends TestCase
+{
+    protected function tearDown(): void
+    {
+        m::close();
+    }
+
+    public function testToRawSql()
+    {
+        $connection = m::mock(Connection::class);
+        $connection->shouldReceive('escape')->with('foo', false)->andReturn("'foo'");
+        $grammar = new MySqlGrammar;
+        $grammar->setConnection($connection);
+
+        $query = $grammar->makeRawSql(
+            'select * from "users" where \'Hello\\\'World?\' IS NOT NULL AND "email" = ?',
+            ['foo'],
+        );
+
+        $this->assertSame('select * from "users" where \'Hello\\\'World?\' IS NOT NULL AND "email" = \'foo\'', $query);
+    }
+}

tests/Database/DatabasePostgresQueryGrammarTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Illuminate\Tests\Database;
+
+use Illuminate\Database\Connection;
+use Illuminate\Database\Query\Grammars\PostgresGrammar;
+use Mockery as m;
+use PHPUnit\Framework\TestCase;
+
+class DatabasePostgresQueryGrammarTest extends TestCase
+{
+    protected function tearDown(): void
+    {
+        m::close();
+    }
+
+    public function testToRawSql()
+    {
+        $connection = m::mock(Connection::class);
+        $connection->shouldReceive('escape')->with('foo', false)->andReturn("'foo'");
+        $grammar = new PostgresGrammar;
+        $grammar->setConnection($connection);
+
+        $query = $grammar->makeRawSql(
+            'select * from "users" where \'{}\' ?? \'Hello\\\'\\\'World?\' AND "email" = ?',
+            ['foo'],
+        );
+
+        $this->assertSame('select * from "users" where \'{}\' ? \'Hello\\\'\\\'World?\' AND "email" = \'foo\'', $query);
+    }
+}

tests/Database/DatabaseQueryBuilderTest.php

@@ -5663,6 +5663,22 @@ public function testCloneWithoutBindings()
         $this->assertEquals([], $clone->getBindings());
     }
 
+    public function testToRawSql()
+    {
+        $connection = m::mock(ConnectionInterface::class);
+        $connection->shouldReceive('prepareBindings')
+            ->with(['foo'])
+            ->andReturn(['foo']);
+        $grammar = m::mock(Grammar::class)->makePartial();
+        $grammar->shouldReceive('makeRawSql')
+            ->with('select * from "users" where "email" = ?', ['foo'])
+            ->andReturn('select * from "users" where "email" = \'foo\'');
+        $builder = new Builder($connection, $grammar, m::mock(Processor::class));
+        $builder->select('*')->from('users')->where('email', 'foo');
+
+        $this->assertSame('select * from "users" where "email" = \'foo\'', $builder->toRawSql());
+    }
+
     protected function getConnection()
     {
         $connection = m::mock(ConnectionInterface::class);

tests/Database/DatabaseSQLiteQueryGrammarTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Illuminate\Tests\Database;
+
+use Illuminate\Database\Connection;
+use Illuminate\Database\Query\Grammars\SQLiteGrammar;
+use Mockery as m;
+use PHPUnit\Framework\TestCase;
+
+class DatabaseSQLiteQueryGrammarTest extends TestCase
+{
+    protected function tearDown(): void
+    {
+        m::close();
+    }
+
+    public function testToRawSql()
+    {
+        $connection = m::mock(Connection::class);
+        $connection->shouldReceive('escape')->with('foo', false)->andReturn("'foo'");
+        $grammar = new SQLiteGrammar;
+        $grammar->setConnection($connection);
+
+        $query = $grammar->makeRawSql(
+            'select * from "users" where \'Hello\'\'World?\' IS NOT NULL AND "email" = ?',
+            ['foo'],
+        );
+
+        $this->assertSame('select * from "users" where \'Hello\'\'World?\' IS NOT NULL AND "email" = \'foo\'', $query);
+    }
+}

tests/Database/DatabaseSqlServerQueryGrammarTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Illuminate\Tests\Database;
+
+use Illuminate\Database\Connection;
+use Illuminate\Database\Query\Grammars\SqlServerGrammar;
+use Mockery as m;
+use PHPUnit\Framework\TestCase;
+
+class DatabaseSqlServerQueryGrammarTest extends TestCase
+{
+    protected function tearDown(): void
+    {
+        m::close();
+    }
+
+    public function testToRawSql()
+    {
+        $connection = m::mock(Connection::class);
+        $connection->shouldReceive('escape')->with('foo', false)->andReturn("'foo'");
+        $grammar = new SqlServerGrammar;
+        $grammar->setConnection($connection);
+
+        $query = $grammar->makeRawSql(
+            "select * from [users] where 'Hello''World?' IS NOT NULL AND [email] = ?",
+            ['foo'],
+        );
+
+        $this->assertSame("select * from [users] where 'Hello''World?' IS NOT NULL AND [email] = 'foo'", $query);
+    }
+}