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

Add error handling when misuse of find() with array values #11237

Closed
wants to merge 1 commit into from
Closed

Add error handling when misuse of find() with array values #11237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions src/UnitOfWork.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1781,6 +1781,10 @@ public function addToIdentityMap($entity)
*/
final public static function getIdHashByIdentifier(array $identifier): string
{
if (array_filter($identifier, 'is_array')) {
throw new UnexpectedValueException('Unexpected identifier value: Expecting scalar, got array.');
}
Comment on lines +1784 to +1786
Copy link
Member

Choose a reason for hiding this comment

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

I think, we can handle this case in the mapper function below. And we could throw that exception if we encounter anything that is not a scalar or stringable.

Copy link
Author

Choose a reason for hiding this comment

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

Done in new PR targeting 3.1.x branch #11285

Copy link
Author

Choose a reason for hiding this comment

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

@derrabus Unfortunately we cannot do that because it breaks the find by custom id object feature :

$ vendor/bin/phpunit

1) Doctrine\Tests\ORM\Functional\CustomIdObjectTypeTest::testFindByCustomIdObject
UnexpectedValueException: Unexpected identifier value: Expecting scalar, got object.

2) Doctrine\Tests\ORM\Functional\CustomIdObjectTypeTest::testFetchJoinCustomIdObject
UnexpectedValueException: Unexpected identifier value: Expecting scalar, got object.

3) Doctrine\Tests\ORM\Functional\CustomIdObjectTypeTest::testFetchJoinWhereCustomIdObject
UnexpectedValueException: Unexpected identifier value: Expecting scalar, got object.

4) Doctrine\Tests\ORM\Functional\PaginationTest::testCustomIdTypeWithoutOutputWalker
UnexpectedValueException: Unexpected identifier value: Expecting scalar, got object.

# etc...

Copy link
Member

Choose a reason for hiding this comment

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

But those custom IDs need to be stringable, otherwise the implode below would fail. I don't understand the issue here.

Copy link
Author

Choose a reason for hiding this comment

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

In this PR I'm just checking that the "array" type is invalid.
So the only check we can do inside the mapper function is to check that $value is an array

if (is_array($value)) {
    throw new UnexpectedValueException(...);
}

This bit of code is not dealing with other types like objects.

Do you want me to move the is_array($value) condition in the mapper function then ?

Copy link
Member

Choose a reason for hiding this comment

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

In this PR I'm just checking that the "array" type is invalid.

Which is a bit arbitrary. If we add validation here, let's do it properly and catch everything that we don't accept.

This bit of code is not dealing with other types like objects.

But it should.

Copy link
Author

Choose a reason for hiding this comment

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

So you mean we should do something like

if (! is_scalar($value) && ! ($value instanceof Stringable)) ...

?

Copy link
Author

@symfonyaml symfonyaml Feb 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@derrabus I commited in the new PR targeting 3.1.x, I hope that's what we want 🤞

Copy link
Member

Choose a reason for hiding this comment

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

Thank you!


return implode(
' ',
array_map(
Expand Down
26 changes: 26 additions & 0 deletions tests/Tests/ORM/Functional/IdentifierFunctionalTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?php

declare(strict_types=1);

namespace Doctrine\Tests\ORM\Functional;

use Doctrine\Tests\Models\CMS\CmsUser;
use Doctrine\Tests\OrmFunctionalTestCase;
use UnexpectedValueException;

class IdentifierFunctionalTest extends OrmFunctionalTestCase
{
protected function setUp(): void
{
$this->useModelSet('cms');

parent::setUp();
}

public function testIdentifierArrayValue(): void
{
$this->expectException(UnexpectedValueException::class);
$this->expectExceptionMessage('Unexpected identifier value: Expecting scalar, got array.');
$this->_em->find(CmsUser::class, ['id' => ['array']]);
}
}
Loading