bug #47499 [Uid][Validator] Stop to first ULID format violation (ogizanagi)

nicolas-grekas · nicolas-grekas · commit af1ab9e51573 · 2022-09-06T15:27:37.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [Uid][Validator] Stop to first ULID format violation | Q | A | ------------- | --- | Branch? | 5.4  | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | N/A | License | MIT | Doc PR | N/A Unlike the UUID validator, the ULID validator does not stop on the first violation raised, but continues adding a violation for each ULID format infringement. Which might make sense in some situations, but the same error message is set for each. In case of a string like `not-even-ulid-like`, you'll get 3 violations with the same message. IIMHO, 95% of the use-cases will consist of exposing the violation messages directly, so displaying 3 times the same message is unexpected. (getting different messages per violation type could be added as a new feature if needed) Commits ------- fdd73c7 [Validator][UID] Stop to first ULID format violation
diff --git a/src/Symfony/Component/Validator/Constraints/UlidValidator.php b/src/Symfony/Component/Validator/Constraints/UlidValidator.php
@@ -48,13 +48,17 @@ public function validate($value, Constraint $constraint)
                 ->setParameter('{{ value }}', $this->formatValue($value))
                 ->setCode(26 > \strlen($value) ? Ulid::TOO_SHORT_ERROR : Ulid::TOO_LONG_ERROR)
                 ->addViolation();
+
+            return;
         }
 
         if (\strlen($value) !== strspn($value, '0123456789ABCDEFGHJKMNPQRSTVWXYZabcdefghjkmnpqrstvwxyz')) {
             $this->context->buildViolation($constraint->message)
                 ->setParameter('{{ value }}', $this->formatValue($value))
                 ->setCode(Ulid::INVALID_CHARACTERS_ERROR)
                 ->addViolation();
+
+            return;
         }
 
         // Largest valid ULID is '7ZZZZZZZZZZZZZZZZZZZZZZZZZ'
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/UlidValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/UlidValidatorTest.php
@@ -78,6 +78,7 @@ public function getInvalidUlids()
             ['01ARZ3NDEKTSV4RRFFQ69G5FAVA', Ulid::TOO_LONG_ERROR],
             ['01ARZ3NDEKTSV4RRFFQ69G5FAO', Ulid::INVALID_CHARACTERS_ERROR],
             ['Z1ARZ3NDEKTSV4RRFFQ69G5FAV', Ulid::TOO_LARGE_ERROR],
+            ['not-even-ulid-like', Ulid::TOO_SHORT_ERROR],
         ];
     }
 

Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,7 @@ public function getInvalidUlids()`
`78`	`78`	`['01ARZ3NDEKTSV4RRFFQ69G5FAVA', Ulid::TOO_LONG_ERROR],`
`79`	`79`	`['01ARZ3NDEKTSV4RRFFQ69G5FAO', Ulid::INVALID_CHARACTERS_ERROR],`
`80`	`80`	`['Z1ARZ3NDEKTSV4RRFFQ69G5FAV', Ulid::TOO_LARGE_ERROR],`
	`81`	`+ ['not-even-ulid-like', Ulid::TOO_SHORT_ERROR],`
`81`	`82`	`];`
`82`	`83`	`}`
`83`	`84`