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

fix: [Model] updateBatch() may generate invalid SQL statement #7787

Merged
merged 3 commits into from
Aug 10, 2023
Merged

fix: [Model] updateBatch() may generate invalid SQL statement #7787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9cc163
test: add and update tests
kenjis Aug 7, 2023
2238bf1
fix: check if index exists
kenjis Aug 7, 2023
6b05c90
fix: updateBatch() may generate invalid SQL string
kenjis Aug 7, 2023
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
11 changes: 10 additions & 1 deletion system/BaseModel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -979,7 +979,9 @@ public function updateBatch(?array $set = null, ?string $index = null, int $batc
// properties representing the collection elements, we need to grab
// them as an array.
if (is_object($row) && ! $row instanceof stdClass) {
$row = $this->objectToArray($row, true, true);
// For updates the index field is needed even if it is not changed.
// So set $onlyChanged to false.
$row = $this->objectToArray($row, false, true);
}

// If it's still a stdClass, go ahead and convert to
Expand All @@ -997,6 +999,13 @@ public function updateBatch(?array $set = null, ?string $index = null, int $batc
// Save updateIndex for later
$updateIndex = $row[$index] ?? null;

if ($updateIndex === null) {
throw new InvalidArgumentException(
'The index ("' . $index . '") for updateBatch() is missing in the data: '
. json_encode($row)
);
}

// Must be called first so we don't
// strip out updated_at values.
$row = $this->doProtectFields($row);
Expand Down
26 changes: 26 additions & 0 deletions tests/system/Models/UpdateModelTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,27 @@ public function testUpdateBatchSuccess(): void
]);
}

public function testUpdateBatchInvalidIndex(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage(
'The index ("not_exist") for updateBatch() is missing in the data: {"name":"Derek Jones","country":"Greece"}'
);

$data = [
[
'name' => 'Derek Jones',
'country' => 'Greece',
],
[
'name' => 'Ahmadinejad',
'country' => 'Greece',
],
];

$this->createModel(UserModel::class)->updateBatch($data, 'not_exist');
}

public function testUpdateBatchValidationFail(): void
{
$data = [
Expand Down Expand Up @@ -208,11 +229,16 @@ public function testUpdateBatchWithEntity(): void
$entity1->name = 'Jones Martin';
$entity1->country = 'India';
$entity1->deleted = 0;
$entity1->syncOriginal();
// Update the entity.
$entity1->country = 'China';

// This entity is not updated.
$entity2->id = 4;
$entity2->name = 'Jones Martin';
$entity2->country = 'India';
$entity2->deleted = 0;
$entity2->syncOriginal();

$this->assertSame(2, $this->createModel(UserModel::class)->updateBatch([$entity1, $entity2], 'id'));
}
Expand Down