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.

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

[11.x] Fix incorrect bindings in DB::update when using a collection as a value #53254

Merged
merged 3 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
6 changes: 5 additions & 1 deletion src/Illuminate/Database/Query/Builder.php
Original file line number Diff line number Diff line change
Expand Up @@ -3848,7 +3848,11 @@ public function update(array $values)

$values = collect($values)->map(function ($value) {
if (! $value instanceof Builder) {
return ['value' => $value, 'bindings' => $value];
return ['value' => $value, 'bindings' => match (true) {
$value instanceof Collection => $value->toArray(),
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not use $value->all() and skip the implicit array_map call inside to Collection@toArray()?

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, I'd change the check to $value instanceof Enumerable, so $value->all() also covers LazyCollection instances

Copy link
Member Author

Choose a reason for hiding this comment

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

It might not be even worth it to pursue these changes. Using Collection as value is not in the docs (unless someone can share the URL) and Postgres/SQLServer would require different syntax to store JSON

Copy link
Contributor

Choose a reason for hiding this comment

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

You're right. And it is easy enough for someone to just add collect(...)->all() on the call-site

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 it's problematic though that the behaviour is somewhat undefined when passing in a collection (or at least very unexpected), especially as I think many devs don't actively differentiate between arrays and collections in Laravel as much Laravel functionality behaves the same no matter what you pass in.

$value instanceof UnitEnum => enum_value($value),
default => $value,
}];
}

[$query, $bindings] = $this->parseSub($value);
Expand Down
50 changes: 50 additions & 0 deletions tests/Integration/Database/QueryBuilderUpdateTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<?php

namespace Illuminate\Tests\Integration\Database;

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schema;
use Orchestra\Testbench\Attributes\RequiresDatabase;
use PHPUnit\Framework\Attributes\DataProvider;

require_once 'Enums.php';

class QueryBuilderUpdateTest extends DatabaseTestCase
{
protected function afterRefreshingDatabase()
{
Schema::create('example', function (Blueprint $table) {
$table->increments('id');
$table->string('name')->nullable();
$table->string('title')->nullable();
$table->string('status')->nullable();
$table->json('payload')->nullable();
});
}

#[DataProvider('jsonValuesDataProvider')]
#[RequiresDatabase(['sqlite', 'mysql', 'mariadb'])]
public function testBasicUpdateForJson($column, $given, $expected)
{
DB::table('example')->insert([
'name' => 'Taylor Otwell',
'title' => 'Mr.',
]);

DB::table('example')->update([$column => $given]);

$this->assertDatabaseHas('example', [
'name' => 'Taylor Otwell',
'title' => 'Mr.',
$column => $column === 'payload' ? $this->castAsJson($expected) : $expected,
]);
}

public static function jsonValuesDataProvider()
{
yield ['payload', ['Laravel', 'Founder'], ['Laravel', 'Founder']];
yield ['payload', collect(['Laravel', 'Founder']), ['Laravel', 'Founder']];
yield ['status', StringStatus::draft, 'draft'];
}
}