[Validator] Add constraint on unique elements collection(Assert\Unique) #26555

zzenmate · 2018-03-15T21:53:43Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	no
Fixed tickets	#26535
License	MIT
Doc PR	symfony/symfony-docs#...

zzenmate · 2018-03-15T21:56:16Z

Please, review feature.
If realization constraint is ok I will write tests and doc for this feature.

ostrolucky · 2018-03-16T00:12:13Z

src/Symfony/Component/Validator/Constraints/UniqueCollectionValidator.php

+            return;
+        }
+
+        if (!is_array($value) && !($value instanceof \Traversable && $value instanceof \ArrayAccess)) {


Scrap ($value instanceof \Traversable && $value instanceof \ArrayAccess) and replace with !$value instanceof \IteratorAggregate. It's apparently interface of Traversable highest up in a chain which guarantees iterator is rewindable

ostrolucky · 2018-03-16T00:14:35Z

src/Symfony/Component/Validator/Constraints/UniqueCollectionValidator.php

+
+        $collectionElements = [];
+        foreach ($value as $element) {
+            if (in_array($element, $collectionElements)) {


third argument to true is important here to avoid obscure bugs https://3v4l.org/9QGNo

ostrolucky · 2018-03-16T00:23:59Z

src/Symfony/Component/Validator/Constraints/UniqueCollectionValidator.php

+    public function validate($value, Constraint $constraint)
+    {
+        if (!$constraint instanceof UniqueCollection) {
+            throw new UnexpectedTypeException($constraint, __NAMESPACE__.'\UniqueCollection');


We can use ::class now

ostrolucky · 2018-03-16T00:25:49Z

src/Symfony/Component/Validator/Constraints/UniqueCollection.php

+ *
+ * @author Yevgeniy Zholkevskiy <[email protected]>
+ */
+class UniqueCollection extends Constraint


Symfony constraints don't tend to add such suffix. See e.g. constraint "All". Should be just Unique. Would be in line with #9888 as well.

ostrolucky · 2018-03-16T20:00:14Z

Would wait for a symfony team member to confirm, but I think this is pretty straight forward and feature should be accepted.

status: needs review

ostrolucky · 2018-03-17T23:05:14Z

src/Symfony/Component/Validator/Constraints/UniqueValidator.php

+            return;
+        }
+
+        if (!$value instanceof \IteratorAggregate) {


is_array part must stay, I wanted to change second part of condition only. This won't work with arrays now.

nicolas-grekas · 2018-03-19T14:50:34Z

@zzenmate please check fabbot's failure

ogizanagi

Thanks for your contribution!

ogizanagi · 2018-03-19T14:56:51Z

src/Symfony/Component/Validator/Constraints/UniqueValidator.php

+        foreach ($value as $element) {
+            if (in_array($element, $collectionElements, true)) {
+                $this->context->buildViolation($constraint->message)
+                              ->setParameter('{{ value }}', $this->formatValue($value))


Additionnally to fabbot reported issues, there is too much indentation here:

$this->context->buildViolation($constraint->message) - ->setParameter('{{ value }}', $this->formatValue($value)) - ->setCode(Unique::IS_NOT_UNIQUE) - ->addViolation(); + ->setParameter('{{ value }}', $this->formatValue($value)) + ->setCode(Unique::IS_NOT_UNIQUE) + ->addViolation();

ogizanagi · 2018-03-19T15:08:26Z

src/Symfony/Component/Validator/Constraints/UniqueValidator.php

+            return;
+        }
+
+        if (!is_array($value) && !$value instanceof \IteratorAggregate) {


I've seen @ostrolucky 's #26555 (comment), but actually, we don't need ArrayAccess here, right?
So !is_array($value) && !$value instanceof \Traversable would be enough.

I thought so too until recently. Apparently this is considered too unsafe, see #24577 (comment) and #25506

So, IIUC that's an issue we already have with AllValidator then?

Was it already raised somewhere and do we need to add a deprecation to warn about this issue if $value isn't implementing IteratorAggregate?

Dunno, what do you say @nicolas-grekas? I guess there should be an RFC to decide how to move forward in consistent way and let others to speak their mind about this.

I'd keep it as it is.

yceruto · 2018-03-19T16:42:27Z

src/Symfony/Component/Validator/Constraints/UniqueValidator.php

+            $collectionElements[] = $element;
+        }
+    }
+}


missing newline at end of file

zzenmate · 2018-03-20T12:41:18Z

status: needs review

ostrolucky

This test suite is IMO too noisy. Check e.g. RegexValidatorTest to learn how to utilize dataProviders to shrink this.

zzenmate · 2018-03-22T20:16:51Z

@ostrolucky Thank you for your advice! I have done it.
status: needs review

ostrolucky · 2018-04-01T22:47:40Z

src/Symfony/Component/Validator/Constraints/UniqueValidator.php

+        }
+
+        if (!is_array($value) && !$value instanceof \IteratorAggregate) {
+            throw new UnexpectedTypeException($value, 'IteratorAggregate');


Sorry but I think we should not throw here, to avoid issues like this one #26463

xabbuh

with a minor comment

xabbuh · 2018-09-24T10:43:07Z

src/Symfony/Component/Validator/Constraints/Unique.php

+ */
+class Unique extends Constraint
+{
+    const IS_NOT_UNIQUE = '7911c98d-b845-4da0-94b7-a8dac36bc55a';


public const

xabbuh · 2018-09-24T10:47:06Z

src/Symfony/Component/Validator/Constraints/UniqueValidator.php

+            return;
+        }
+
+        if (!is_array($value) && !$value instanceof \IteratorAggregate) {


I'd keep it as it is.

xabbuh · 2018-09-24T10:48:12Z

oh, please also mention the new constraint in the changelog of the component

nicolas-grekas · 2018-12-01T09:17:15Z

Friendly ping @zzenmate, could you please add an entry in the changelog file of the component?

nicolas-grekas · 2018-12-01T09:17:38Z

And create a doc issue/PR also please?

nicolas-grekas · 2019-03-13T15:48:24Z

Rebased, ready.

fabpot · 2019-03-25T11:42:51Z

Thank you @zzenmate.

…on(Assert\Unique) (zenmate, nicolas-grekas) This PR was merged into the 4.3-dev branch. Discussion ---------- [Validator] Add constraint on unique elements collection(Assert\Unique) | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | no  | Fixed tickets | #26535 | License | MIT | Doc PR | symfony/symfony-docs#...   Commits ------- d0eb13e Rebase and update to latest CS fc66683 Add UniqueCollection constraint and validator

fabpot · 2019-03-25T11:45:28Z

Translation added in e863621. Typo in the error message fixed in e3d42a9.

ro0NL · 2019-03-29T10:04:50Z

src/Symfony/Component/Validator/Constraints/UniqueValidator.php

+        }
+
+        if (!\is_array($value) && !$value instanceof \IteratorAggregate) {
+            throw new UnexpectedValueException($value, 'array|IteratorAggregate');


why not iterable?

see review chain

I thought so too until recently. Apparently this is considered too unsafe, see #24577 (comment) and #25506

?

was it a blocker for this PR?

i can pass a broken/unrewindbable iterator as aggregate just as easy. But i cant pass a working iterator/iterable directly. That's poor DX IMHO.

Consequencies of this validator being applied on non-rewindable iterators are much bigger than in #25506 so yes (generally, after validator validates the data, data is processed)

ro0NL · 2019-03-29T10:07:06Z

src/Symfony/Component/Validator/Constraints/Unique.php

+ *
+ * @author Yevgeniy Zholkevskiy <[email protected]>
+ */
+class Unique extends Constraint


UniqueCollection?

carsonbot added Status: Needs Review Validator Feature labels Mar 15, 2018

zzenmate changed the title ~~[Validator] Add UniqueCollection constraint and validator~~ [Validator] Add constraint on unique elements collection(Assert\UniqueCollection) Mar 15, 2018

carsonbot removed the Status: Needs Review label Mar 16, 2018

ostrolucky suggested changes Mar 16, 2018

View reviewed changes

carsonbot added the Status: Needs Work label Mar 16, 2018

nicolas-grekas added this to the 4.1 milestone Mar 16, 2018

zzenmate changed the title ~~[Validator] Add constraint on unique elements collection(Assert\UniqueCollection)~~ [Validator] Add constraint on unique elements collection(Assert\Unique) Mar 16, 2018

carsonbot added Status: Needs Review and removed Status: Needs Work labels Mar 16, 2018

ostrolucky reviewed Mar 17, 2018

View reviewed changes

ogizanagi reviewed Mar 19, 2018

View reviewed changes

carsonbot removed the Status: Needs Review label Mar 19, 2018

yceruto requested changes Mar 19, 2018

View reviewed changes

carsonbot added the Status: Needs Work label Mar 19, 2018

carsonbot added Status: Needs Review and removed Status: Needs Work labels Mar 20, 2018

ostrolucky suggested changes Mar 21, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Mar 21, 2018

carsonbot added Status: Needs Review and removed Status: Needs Work labels Mar 22, 2018

ostrolucky approved these changes Mar 22, 2018

View reviewed changes

carsonbot removed the Status: Needs Review label Mar 22, 2018

ostrolucky suggested changes Apr 1, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Reviewed labels Apr 1, 2018

nicolas-grekas modified the milestones: 4.1, next Apr 20, 2018

xabbuh approved these changes Sep 24, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Sep 24, 2018

fabpot approved these changes Oct 10, 2018

View reviewed changes

OskarStark approved these changes Nov 2, 2018

View reviewed changes

Add UniqueCollection constraint and validator

fc66683

nicolas-grekas force-pushed the unique-collection-constraint branch from ad8e7d4 to bfa3278 Compare March 13, 2019 15:46

nicolas-grekas added the Ready label Mar 13, 2019

Rebase and update to latest CS

d0eb13e

nicolas-grekas force-pushed the unique-collection-constraint branch from bfa3278 to d0eb13e Compare March 13, 2019 15:48

fabpot approved these changes Mar 25, 2019

View reviewed changes

fabpot merged commit d0eb13e into symfony:master Mar 25, 2019

OskarStark mentioned this pull request Mar 29, 2019

Documented the new Unique constraint symfony/symfony-docs#11247

Closed

ro0NL reviewed Mar 29, 2019

View reviewed changes

nicolas-grekas modified the milestones: next, 4.3 Apr 30, 2019

fabpot mentioned this pull request May 9, 2019

Release v4.3.0-BETA1 #31435

Merged

[Validator] Add constraint on unique elements collection(Assert\Unique) #26555

[Validator] Add constraint on unique elements collection(Assert\Unique) #26555

Conversation

zzenmate commented Mar 15, 2018

zzenmate commented Mar 15, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ostrolucky commented Mar 16, 2018

Choose a reason for hiding this comment

nicolas-grekas commented Mar 19, 2018

ogizanagi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zzenmate commented Mar 20, 2018

ostrolucky left a comment

Choose a reason for hiding this comment

zzenmate commented Mar 22, 2018

Choose a reason for hiding this comment

xabbuh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xabbuh commented Sep 24, 2018 • edited Loading

nicolas-grekas commented Dec 1, 2018

nicolas-grekas commented Dec 1, 2018

nicolas-grekas commented Mar 13, 2019 • edited Loading

fabpot commented Mar 25, 2019

fabpot commented Mar 25, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zzenmate commented Mar 15, 2018 •

edited

Loading

xabbuh commented Sep 24, 2018 •

edited

Loading

nicolas-grekas commented Mar 13, 2019 •

edited

Loading