Add a new attribute to skip when an error occurs. Review.

dunglas · dunglas · commit a7c18acf7d3d · 2019-03-21T13:24:32.000+01:00
diff --git a/src/Symfony/Component/Validator/Constraints/NotPwned.php b/src/Symfony/Component/Validator/Constraints/NotPwned.php
@@ -29,4 +29,5 @@ class NotPwned extends Constraint
 
     public $message = 'This password has been leaked in a data breach, it must not be used. Please use another password.';
     public $threshold = 1;
+    public $skipOnError = false;
 }
diff --git a/src/Symfony/Component/Validator/Constraints/NotPwnedValidator.php b/src/Symfony/Component/Validator/Constraints/NotPwnedValidator.php
@@ -29,6 +29,7 @@
 class NotPwnedValidator extends ConstraintValidator
 {
     private const RANGE_API = 'https://api.pwnedpasswords.com/range/%s';
+
     private $httpClient;
 
     public function __construct(HttpClientInterface $httpClient = null)
@@ -60,13 +61,20 @@ public function validate($value, Constraint $constraint)
             return;
         }
 
-        $httpClient = $this->httpClient;
-
         $hash = strtoupper(sha1($value));
         $hashPrefix = substr($hash, 0, 5);
         $url = sprintf(self::RANGE_API, $hashPrefix);
 
-        $result = $httpClient->request('GET', $url)->getContent();
+        try {
+            $result = $this->httpClient->request('GET', $url)->getContent();
+        } catch (ExceptionInterface $e) {
+            if ($constraint->skipOnError) {
+                return;
+            }
+
+            throw $e;
+        }
+
         foreach (explode("\r\n", $result) as $line) {
             list($hashSuffix, $count) = explode(':', $line);
 
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/NotPwnedTest.php b/src/Symfony/Component/Validator/Tests/Constraints/NotPwnedTest.php
@@ -23,5 +23,6 @@ public function testDefaultValues()
     {
         $constraint = new NotPwned();
         $this->assertSame(1, $constraint->threshold);
+        $this->assertFalse($constraint->skipOnError);
     }
 }
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/NotPwnedValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/NotPwnedValidatorTest.php
@@ -44,6 +44,10 @@ protected function createValidator()
             $this->returnCallback(function (string $method, string $url): ResponseInterface {
                 if (self::PASSWORD_TRIGGERING_AN_ERROR_RANGE_URL === $url) {
                     throw new class('Problem contacting the Have I been Pwned API.') extends \Exception implements ServerExceptionInterface {
+                        public function getResponse(): ResponseInterface
+                        {
+                            throw new \RuntimeException('Not implemented');
+                        }
                     };
                 }
 
@@ -96,16 +100,14 @@ public function testThresholdReached()
 
     public function testThresholdNotReached()
     {
-        $constraint = new NotPwned(['threshold' => 10]);
-        $this->validator->validate(self::PASSWORD_LEAKED, $constraint);
+        $this->validator->validate(self::PASSWORD_LEAKED, new NotPwned(['threshold' => 10]));
 
         $this->assertNoViolation();
     }
 
     public function testValidPassword()
     {
-        $constraint = new NotPwned();
-        $this->validator->validate(self::PASSWORD_NOT_LEAKED, $constraint);
+        $this->validator->validate(self::PASSWORD_NOT_LEAKED, new NotPwned());
 
         $this->assertNoViolation();
     }
@@ -134,4 +136,10 @@ public function testApiError()
     {
         $this->validator->validate(self::PASSWORD_TRIGGERING_AN_ERROR, new NotPwned());
     }
+
+    public function testApiErrorSkipped()
+    {
+        $this->validator->validate(self::PASSWORD_TRIGGERING_AN_ERROR, new NotPwned(['skipOnError' => true]));
+        $this->assertTrue(true); // No exception have been thrown
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -29,4 +29,5 @@ class NotPwned extends Constraint`
`29`	`29`
`30`	`30`	`public $message = 'This password has been leaked in a data breach, it must not be used. Please use another password.';`
`31`	`31`	`public $threshold = 1;`
	`32`	`+ public $skipOnError = false;`
`32`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,6 @@ public function testDefaultValues()`
`23`	`23`	`{`
`24`	`24`	`$constraint = new NotPwned();`
`25`	`25`	`$this->assertSame(1, $constraint->threshold);`
	`26`	`+ $this->assertFalse($constraint->skipOnError);`
`26`	`27`	`}`
`27`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,10 @@ protected function createValidator()`
`44`	`44`	`$this->returnCallback(function (string $method, string $url): ResponseInterface {`
`45`	`45`	`if (self::PASSWORD_TRIGGERING_AN_ERROR_RANGE_URL === $url) {`
`46`	`46`	`throw new class('Problem contacting the Have I been Pwned API.') extends \Exception implements ServerExceptionInterface {`
	`47`	`+ public function getResponse(): ResponseInterface`
	`48`	`+ {`
	`49`	`+ throw new \RuntimeException('Not implemented');`
	`50`	`+ }`
`47`	`51`	`};`
`48`	`52`	`}`
`49`	`53`
`@@ -96,16 +100,14 @@ public function testThresholdReached()`
`96`	`100`
`97`	`101`	`public function testThresholdNotReached()`
`98`	`102`	`{`
`99`		`- $constraint = new NotPwned(['threshold' => 10]);`
`100`		`- $this->validator->validate(self::PASSWORD_LEAKED, $constraint);`
	`103`	`+ $this->validator->validate(self::PASSWORD_LEAKED, new NotPwned(['threshold' => 10]));`
`101`	`104`
`102`	`105`	`$this->assertNoViolation();`
`103`	`106`	`}`
`104`	`107`
`105`	`108`	`public function testValidPassword()`
`106`	`109`	`{`
`107`		`- $constraint = new NotPwned();`
`108`		`- $this->validator->validate(self::PASSWORD_NOT_LEAKED, $constraint);`
	`110`	`+ $this->validator->validate(self::PASSWORD_NOT_LEAKED, new NotPwned());`
`109`	`111`
`110`	`112`	`$this->assertNoViolation();`
`111`	`113`	`}`
`@@ -134,4 +136,10 @@ public function testApiError()`
`134`	`136`	`{`
`135`	`137`	`$this->validator->validate(self::PASSWORD_TRIGGERING_AN_ERROR, new NotPwned());`
`136`	`138`	`}`
	`139`	`+`
	`140`	`+ public function testApiErrorSkipped()`
	`141`	`+ {`
	`142`	`+ $this->validator->validate(self::PASSWORD_TRIGGERING_AN_ERROR, new NotPwned(['skipOnError' => true]));`
	`143`	`+ $this->assertTrue(true); // No exception have been thrown`
	`144`	`+ }`
`137`	`145`	`}`