Bug: Casting happens in insert but not in insertBatch

[patel-vansh]

PHP Version

8.4

CodeIgniter4 Version

4.6.3

CodeIgniter4 Installation Method

Composer (using codeigniter4/appstarter)

Which operating systems have you tested for this bug?

macOS

Which server did you use?

apache

Database

MariaDB 10.4.28

What happened?

When using Model->insert() command, casting (eg. converting of array type to json encoded array) happens. But when using Model->insertBatch() command, casting of each row doesn't happen.

Steps to Reproduce

Create a table with atleast one column that stores json encoded values (i.e, of type TEXT, MEDIUMTEXT, LONGTEXT, etc.). Inside model, set the $cast of that column to type array. Then, fire up Model->insertBatch() command and for each row, pass an array (not string) for that model. The insert command will not insert values to DB.

Expected Output

The insertBatch should perform the casting on each row similar to that done in insert command.

Anything else?

I think I can contribute this but I don't know where to start. I mean, are there any specific things I need to setup before/after making changes or other things like that or just sending PR containing signed commits would suffice?

[patel-vansh]

In the insert function, the transformDataToArray() method is called. Which handles casting and then calls $this->objectToArray().

CodeIgniter4/system/BaseModel.php

Lines 796 to 804 in 63e9ebd

	public function insert($row = null, bool $returnID = true)
	{
	$this->insertID = 0;
	// Set $cleanValidationRules to false temporary.
	$cleanValidationRules = $this->cleanValidationRules;
	$this->cleanValidationRules = false;
	$row = $this->transformDataToArray($row, 'insert');

But, in the insertBatch function, the objectToArray() method is directly called and hence the casting is not happening. Here's the code for reference.

CodeIgniter4/system/BaseModel.php

Lines 904 to 917 in 63e9ebd

	public function insertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false)
	{
	// Set $cleanValidationRules to false temporary.
	$cleanValidationRules = $this->cleanValidationRules;
	$this->cleanValidationRules = false;
	if (is_array($set)) {
	foreach ($set as &$row) {
	// If $row is using a custom class with public or protected
	// properties representing the collection elements, we need to grab
	// them as an array.
	if (is_object($row) && ! $row instanceof stdClass) {
	$row = $this->objectToArray($row, false, true);
	}

I think, instead of calling objectToArray() directly, calling transformDataToArray() on each row would be more proper as consequently, it will call objectToArray() by default.

[michalsn]

Yes, this seems like a bug. However, simply changing the call from objectToArray to transformDataToArray could introduce a breaking change in some cases, since transformDataToArray is stricter about settings like allowEmptyInserts and updateOnlyChanged. Such a change would be acceptable for the 4.7 branch, but not for a patch release.

Instead, I would add an explicit check for casting, like this:

if ($this->useCasts()) {
    if (is_array($row)) {
        $row = $this->converter->toDataSource($row);
    } elseif ($row instanceof stdClass) {
        $row = (array) $row;
        $row = $this->converter->toDataSource($row);
    } elseif ($row instanceof Entity) {
        $row = $this->converter->extract($row, $onlyChanged);
    } elseif (is_object($row)) {
        $row = $this->converter->extract($row, $onlyChanged);
    }
}
// If $row is using a custom class with public or protected
// properties representing the collection elements, we need to grab
// them as an array.
elseif (is_object($row) && ! $row instanceof stdClass) {
    $row = $this->objectToArray($row, false, true);
}

As for requirements for a PR:

• PRs must be sent to the appropriate branch
• All git commits must be GPG-signed
• Must follow our style guide
• Be commented in the PHP source file
• Be documented in the user guide
• Be unit tested

Please let us know if you will be able to send a PR - thanks!

[patel-vansh]

I would be able to send a PR with required changes in both insertBatch and updateBatch methods as both have same problem.
I just want to ask one thing.
The last point Be unit tested. So, after examining the tests folder, I saw InsertModelTest.php file. So, I should add a test function there right? And same for UpdateModelTest.php

[michalsn]

Yes, that's correct. Please check if there is already a model in Tests\Support\Models that uses casting functionality and add tests with it. If not, create a new model specifically for testing.

[patel-vansh]

I think the UserWithCasts.php has email field set to json. So, it should do the work.

[michalsn]

This is an Entity. You need something like this: https://github.com/codeigniter4/CodeIgniter4/blob/develop/tests/_support/Models/UserCastsTimestampModel.php

[patel-vansh]

Ok. Thank you for your help. I'll send the PR as soon as possible.

[patel-vansh]

Hello @michalsn, I've added the code in both insertBatch and updateBatch functions and also created test functions. But, I'm not sure how would I actually test those. I mean, I would have to setup the DB and then run those tests?

Sorry, this is my first time actually contributing to any project.

[michalsn]

Run: composer test tests/system/Models/InsertModelTest.php - if you added a test in this file and accordingly UpdateModelTest.php. By default, we use SQLite3, so everything should be working out of the box.

If you want to use a different DB engine, you can set it via .env file (by setting credentials to the database.tests group).

[patel-vansh]

Ok. Thank you!!

[patel-vansh]

Hello @michalsn, I've created the PR. Please review.