fix: checking the state of a database with a binary field. #240

AZabolotnikov · 2026-01-18T08:35:01Z

If a DB table has a binary field, the field displays as null when checking the database state.

Copilot

Pull request overview

This pull request fixes an issue where binary fields were displaying as null when checking database state. The fix adds support for detecting and properly serializing binary data fields by converting them to hexadecimal representation.

Changes:

Added binary field handling logic that detects binary data using UTF-8 encoding validation
Created test infrastructure including a BinaryCast class and test cases to verify binary field state tracking
Updated test expectations to include the new binary_field in the TestModel

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/Testing/TableTestState.php	Core fix that detects binary data and converts it to hex representation before comparison
tests/support/Mock/Casts/BinaryCast.php	New custom cast implementation for testing binary field behavior
tests/support/Mock/Models/TestModel.php	Added binary_field to the test model for testing purposes
tests/ModelTestStateTest.php	Added test case for binary field changes and updated expectations
tests/BaseRequestTest.php	Updated test expectations to include binary_field in orderable fields
tests/fixtures/ModelTestStateTest/db_changes/test_models/assert_changes_binary_string.json	Test fixture defining expected state changes for binary field updates

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/ModelTestStateTest.php

src/Testing/TableTestState.php

tests/ModelTestStateTest.php

src/Testing/TableTestState.php

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/ModelTestStateTest.php

src/Testing/TableTestState.php

Co-authored-by: Copilot <[email protected]>

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/Testing/TableTestState.php

DenTray · 2026-01-26T03:23:31Z

src/Testing/TableTestState.php

@@ -89,14 +89,24 @@ protected function prepareChanges(array $changes): array
        return array_map(function ($item) use ($jsonFields) {
            foreach ($jsonFields as $jsonField) {
                if (Arr::has($item, $jsonField)) {


Suggested change

if (Arr::has($item, $jsonField)) {

if (Arr::has($item, $jsonField) && !is_null($item[$jsonField])) {

DenTray · 2026-01-26T03:23:42Z

src/Testing/TableTestState.php

-                    $item[$jsonField] = json_decode($item[$jsonField], true);
+                    $value = $item[$jsonField];
+
+                    $item[$jsonField] = $this->isBinary($value)


Suggested change

$item[$jsonField] = $this->isBinary($value)

$item[$jsonField] = ($this->isBinary($value))

DenTray · 2026-01-26T03:24:03Z

src/Testing/TableTestState.php

+        return !is_null($data)
+            && !mb_check_encoding($data, 'UTF-8');


Suggested change

return !is_null($data)

&& !mb_check_encoding($data, 'UTF-8');

return !mb_check_encoding($data, 'UTF-8');

DenTray · 2026-01-26T03:38:33Z

tests/support/Mock/Models/TestModel.php

+        'binary_field' => BinaryCast::class,
    ];


let's remove extra class

Suggested change

'binary_field' => BinaryCast::class,

];

];

protected function binaryField(): Attribute

{

return Attribute::make(

get: fn (string $value) => bin2hex($value),

set: fn (string $value) => md5($value, true)

);

}

@DenTray casting by class also has problem. modelState take cast by class as jsonField, please look here. We need test by cast

I don't found how resolve problem in method isJsonCast

DenTray · 2026-01-26T03:43:08Z

tests/ModelTestStateTest.php

+        $this->mockGettingDatasetForChanges($changedDatasetMock, $initialDatasetMock, 'test_models');
+
+        $modelTestState = new ModelTestState(TestModel::class);
+        $modelTestState->assertChangesEqualsFixture('assert_changes_binary_string.json');


Suggested change

$modelTestState->assertChangesEqualsFixture('assert_changes_binary_string.json');

$modelTestState->assertChangesEqualsFixture('null_to_binary_string_changes');

tests/ModelTestStateTest.php

DenTray · 2026-01-26T03:44:00Z

tests/ModelTestStateTest.php

+            'id' => 1,
+            'binary_field' => md5('some_string', true),
+        ]]);
+        $changedDatasetMock = collect([[


Suggested change

$changedDatasetMock = collect([[

$changedDatasetMock = collect([[

DenTray · 2026-01-26T03:44:35Z

tests/ModelTestStateTest.php

+        $this->mockGettingDatasetForChanges($changedDatasetMock, $initialDatasetMock, 'test_models');
+
+        $modelTestState = new ModelTestState(TestModel::class);
+        $modelTestState->assertChangesEqualsFixture('assert_changes_binary_string_to_null.json');


Suggested change

$modelTestState->assertChangesEqualsFixture('assert_changes_binary_string_to_null.json');

$modelTestState->assertChangesEqualsFixture('binary_string_to_null_changes');

…y-field' into azabolotnikov/fix-db-check-binary-field

AZabolotnikov · 2026-01-28T09:40:08Z

@DenTray I did a small research and found the following problem with the binary field:

  $this->exportJson('export_json/response.json', [
            'some_key' => md5('some_string', true),
        ]);

But I think this case is related only to the database test, because we get data from the DB facade , we should use bin2hex to cast the field inside test for model state

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/ModelTestStateTest.php

tests/support/Mock/Casts/BinaryCast.php

src/Testing/TableTestState.php

Co-authored-by: Copilot <[email protected]>

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-28T10:28:31Z

src/Testing/TableTestState.php

                $changes = array_diff_assoc($updatedItem, $originItem);

                if (!empty($changes)) {
+                    $changes = Arr::map($changes, fn ($field) => (!mb_check_encoding($field, 'UTF-8')) ? bin2hex($field) : $field);


The binary field conversion using bin2hex is only applied to changed fields in updated records. However, created and deleted records (lines 78-79) may contain full records with binary fields that have not been converted yet. This could cause issues when comparing created/deleted records against fixtures if they contain binary data.

Consider extracting the binary conversion logic into a separate method and applying it consistently to all record types (created, updated, deleted) in the prepareChanges method or before passing records to prepareChanges.

src/Testing/TableTestState.php

Copilot · 2026-01-28T10:28:31Z

tests/ModelTestStateTest.php

        $state = $this->getProtectedProperty($reflectionClass, 'state', $modelTestState);

-        $this->assertEquals(['json_field', 'castable_field'], $jsonFields);
+        $this->assertEquals(['json_field', 'castable_field', 'binary_field'], $jsonFields);


The current implementation treats ALL fields with custom CastsAttributes implementations as JSON fields (including BinaryCast). This is problematic because not all custom casts represent JSON data. The fix in line 93 of TableTestState.php works around this by adding json_validate() checks, but this is a band-aid solution.

A more robust approach would be to:

Introduce a marker interface (e.g., JsonCast) that JSON-based custom casts can implement

Update isJsonCast() to only return true for casts that implement this interface or are the 'array' type

This would prevent binary fields from being incorrectly treated as JSON fields in the first place

The current workaround works but may cause confusion and could lead to similar issues with other non-JSON custom casts in the future.

Suggested change

$this->assertEquals(['json_field', 'castable_field', 'binary_field'], $jsonFields);

$this->assertEquals(['json_field', 'castable_field'], $jsonFields);

Copilot · 2026-01-28T10:28:32Z

tests/ModelTestStateTest.php

+    public function testAssertChangesBinaryString()
+    {
+        $initialDatasetMock = collect([[
+            'id' => 1,
+            'binary_field' => null,
+        ]]);
+
+        $changedDatasetMock = collect([[
+            'id' => 1,
+            'binary_field' => md5('some_string', true),
+        ]]);
+
+        $this->mockGettingDatasetForChanges($changedDatasetMock, $initialDatasetMock, 'test_models');
+
+        $modelTestState = new ModelTestState(TestModel::class);
+        $modelTestState->assertChangesEqualsFixture('null_to_binary_string_changes');
+    }
+
+    public function testAssertChangesBinaryToNull()
+    {
+        $initialDatasetMock = collect([[
+            'id' => 1,
+            'binary_field' => md5('some_string', true),
+        ]]);
+
+        $changedDatasetMock = collect([[
+            'id' => 1,
+            'binary_field' => null,
+        ]]);
+
+        $this->mockGettingDatasetForChanges($changedDatasetMock, $initialDatasetMock, 'test_models');
+
+        $modelTestState = new ModelTestState(TestModel::class);
+        $modelTestState->assertChangesEqualsFixture('binary_string_to_null_changes');
+    }


The test cases only cover updating records with binary fields (null to binary and binary to null), but don't test creating new records with binary fields or deleting records that contain binary fields. Given that the binary conversion logic in TableTestState.php line 67 only applies to changed fields in updated records, there should be test coverage for created and deleted records with binary data to ensure they are handled correctly.

fix: Checking the state of a database with a binary field.

c95a1ab

AZabolotnikov requested a review from Copilot January 18, 2026 08:55

Copilot started reviewing on behalf of AZabolotnikov January 18, 2026 08:56 View session

AZabolotnikov self-assigned this Jan 18, 2026

Copilot AI reviewed Jan 18, 2026

View reviewed changes

tests/ModelTestStateTest.php Outdated Show resolved Hide resolved

src/Testing/TableTestState.php Outdated Show resolved Hide resolved

tests/ModelTestStateTest.php Outdated Show resolved Hide resolved

src/Testing/TableTestState.php Outdated Show resolved Hide resolved

fix: Checking the state of a database with a binary field.

03606be

AZabolotnikov requested a review from Copilot January 18, 2026 09:05

Copilot started reviewing on behalf of AZabolotnikov January 18, 2026 09:05 View session

fix: Checking the state of a database with a binary field.

b68918a

Copilot AI reviewed Jan 18, 2026

View reviewed changes

tests/ModelTestStateTest.php Outdated Show resolved Hide resolved

tests/ModelTestStateTest.php Show resolved Hide resolved

src/Testing/TableTestState.php Outdated Show resolved Hide resolved

Update tests/ModelTestStateTest.php

4b349e7

Co-authored-by: Copilot <[email protected]>

AZabolotnikov requested a review from Copilot January 18, 2026 09:17

Copilot started reviewing on behalf of AZabolotnikov January 18, 2026 09:17 View session

Copilot AI reviewed Jan 18, 2026

View reviewed changes

src/Testing/TableTestState.php Outdated Show resolved Hide resolved

src/Testing/TableTestState.php Outdated Show resolved Hide resolved

AZabolotnikov assigned DenTray and unassigned AZabolotnikov Jan 19, 2026

DenTray requested changes Jan 26, 2026

View reviewed changes

DenTray assigned AZabolotnikov and unassigned DenTray Jan 26, 2026

AZabolotnikov added 2 commits January 28, 2026 14:14

fix: Checking the state of a database with a binary field.

ba961a8

Merge remote-tracking branch 'origin/azabolotnikov/fix-db-check-binar…

bd8ca19

…y-field' into azabolotnikov/fix-db-check-binary-field

fix: Checking the state of a database with a binary field.

32f7886

AZabolotnikov requested a review from Copilot January 28, 2026 10:12

Copilot started reviewing on behalf of AZabolotnikov January 28, 2026 10:12 View session

fix: Checking the state of a database with a binary field.

f5ade29

AZabolotnikov requested a review from DenTray January 28, 2026 10:17

Copilot AI reviewed Jan 28, 2026

View reviewed changes

tests/ModelTestStateTest.php Show resolved Hide resolved

tests/ModelTestStateTest.php Show resolved Hide resolved

tests/support/Mock/Casts/BinaryCast.php Show resolved Hide resolved

src/Testing/TableTestState.php Outdated Show resolved Hide resolved

Update src/Testing/TableTestState.php

1b6250a

Co-authored-by: Copilot <[email protected]>

AZabolotnikov requested a review from Copilot January 28, 2026 10:23

Copilot started reviewing on behalf of AZabolotnikov January 28, 2026 10:23 View session

Merge branch 'master' into azabolotnikov/fix-db-check-binary-field

9848df9

Copilot AI reviewed Jan 28, 2026

View reviewed changes

	if (Arr::has($item, $jsonField)) {
	if (Arr::has($item, $jsonField) && !is_null($item[$jsonField])) {

	$item[$jsonField] = $this->isBinary($value)
	$item[$jsonField] = ($this->isBinary($value))

		return !is_null($data)
		&& !mb_check_encoding($data, 'UTF-8');

	return !is_null($data)
	&& !mb_check_encoding($data, 'UTF-8');
	return !mb_check_encoding($data, 'UTF-8');

-        'binary_field' => BinaryCast::class,
-    ];
+];
+protected function binaryField(): Attribute
+{
+    return Attribute::make(
+        get: fn (string $value) => bin2hex($value),
+        set: fn (string $value) => md5($value, true)
+    );
+}

	$modelTestState->assertChangesEqualsFixture('assert_changes_binary_string.json');
	$modelTestState->assertChangesEqualsFixture('null_to_binary_string_changes');

	$changedDatasetMock = collect([[

	$changedDatasetMock = collect([[

	$this->assertEquals(['json_field', 'castable_field', 'binary_field'], $jsonFields);
	$this->assertEquals(['json_field', 'castable_field'], $jsonFields);

fix: checking the state of a database with a binary field. #240

Are you sure you want to change the base?

fix: checking the state of a database with a binary field. #240

Uh oh!

Conversation

AZabolotnikov commented Jan 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

DenTray Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

DenTray Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

DenTray Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

DenTray Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

AZabolotnikov Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DenTray Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DenTray Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

DenTray Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

AZabolotnikov commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

AZabolotnikov commented Jan 18, 2026 •

edited

Loading

AZabolotnikov Jan 28, 2026 •

edited

Loading

AZabolotnikov commented Jan 28, 2026 •

edited

Loading