refactor(*): Apply code smell advices

Author: julienloizelet

src/ApiCache.php

@@ -76,7 +76,7 @@ class ApiCache
     /**
      * @var array
      */
-    private $cacheKey = [];
+    private $cacheKeys = [];
 
     /**
      * @var array|null
@@ -151,11 +151,11 @@ public function configure(
     private function getScopes(): ?array
     {
         if (null === $this->scopes) {
-            $scopes = [Constants::SCOPE_IP, Constants::SCOPE_RANGE];
+            $finalScopes = [Constants::SCOPE_IP, Constants::SCOPE_RANGE];
             if (!empty($this->geolocConfig['enabled'])) {
-                $scopes[] = Constants::SCOPE_COUNTRY;
+                $finalScopes[] = Constants::SCOPE_COUNTRY;
             }
-            $this->scopes = $scopes;
+            $this->scopes = $finalScopes;
         }
 
         return $this->scopes;
@@ -368,21 +368,21 @@ private function saveRemediationsForCacheKey(array $decisions, string $cacheKey)
      */
     private function getCacheKey(string $scope, string $value): string
     {
-        if (!isset($this->cacheKey[$scope][$value])) {
+        if (!isset($this->cacheKeys[$scope][$value])) {
             switch ($scope) {
                 case Constants::SCOPE_RANGE:
                 case Constants::SCOPE_IP:
-                    $this->cacheKey[$scope][$value] = Constants::SCOPE_IP.':'.$value;
+                    $this->cacheKeys[$scope][$value] = Constants::SCOPE_IP.':'.$value;
                     break;
                 case Constants::SCOPE_COUNTRY:
-                    $this->cacheKey[$scope][$value] = Constants::SCOPE_COUNTRY.':'.$value;
+                    $this->cacheKeys[$scope][$value] = Constants::SCOPE_COUNTRY.':'.$value;
                     break;
                 default:
-                    throw new Exception('Unknown scope:'.$scope);
+                    throw new BouncerException('Unknown scope:'.$scope);
             }
         }
 
-        return $this->cacheKey[$scope][$value];
+        return $this->cacheKeys[$scope][$value];
     }
 
     /**

src/Geolocation.php

@@ -52,7 +52,7 @@ private function getMaxMindCountry(string $ip, string $databaseType, string $dat
                         $record = $reader->city($ip);
                         break;
                     default:
-                        throw new Exception("Unknown MaxMind database type:$databaseType");
+                        throw new BouncerException("Unknown MaxMind database type:$databaseType");
                 }
                 $result['country'] = $record->country->isoCode;
             } catch (AddressNotFoundException $e) {
@@ -85,14 +85,11 @@ public function getCountryResult(array $geolocConfig, string $ip): array
 
             return $result;
         }
-        switch ($geolocConfig['type']) {
-            case Constants::GEOLOCATION_TYPE_MAXMIND:
-                $configPath = $geolocConfig[Constants::GEOLOCATION_TYPE_MAXMIND];
-                $result =
-                    $this->getMaxMindCountry($ip, $configPath['database_type'], $configPath['database_path']);
-                break;
-            default:
-                throw new Exception('Unknown Geolocation type:'.$geolocConfig['type']);
+        if (Constants::GEOLOCATION_TYPE_MAXMIND === $geolocConfig['type']) {
+            $configPath = $geolocConfig[Constants::GEOLOCATION_TYPE_MAXMIND];
+            $result = $this->getMaxMindCountry($ip, $configPath['database_type'], $configPath['database_path']);
+        } else {
+            throw new BouncerException('Unknown Geolocation type:'.$geolocConfig['type']);
         }
 
         if ($saveInSession) {

tests/WatcherClient.php

@@ -11,6 +11,8 @@ class WatcherClient
     public const WATCHER_LOGIN = 'PhpUnitTestMachine';
     public const WATCHER_PASSWORD = 'PhpUnitTestMachinePassword';
 
+    public const HOURS24 = '+24 hours';
+
     /** @var LoggerInterface */
     private $logger;
 
@@ -53,7 +55,7 @@ public function setInitialState(): void
         $this->deleteAllDecisions();
         $now = new DateTime();
         $this->addDecision($now, '12h', '+12 hours', TestHelpers::BAD_IP, 'captcha');
-        $this->addDecision($now, '24h', '+24 hours', TestHelpers::BAD_IP.'/'.TestHelpers::IP_RANGE, 'ban');
+        $this->addDecision($now, '24h', self::HOURS24, TestHelpers::BAD_IP.'/'.TestHelpers::IP_RANGE, 'ban');
         $this->addDecision($now, '24h', '+24 hours', TestHelpers::JAPAN, 'captcha', Constants::SCOPE_COUNTRY);
     }
 
@@ -65,9 +67,9 @@ public function setSecondState(): void
         $now = new DateTime();
         $this->addDecision($now, '36h', '+36 hours', TestHelpers::NEWLY_BAD_IP, 'ban');
         $this->addDecision($now, '48h', '+48 hours', TestHelpers::NEWLY_BAD_IP.'/'.TestHelpers::IP_RANGE, 'captcha');
-        $this->addDecision($now, '24h', '+24 hours', TestHelpers::JAPAN, 'captcha', Constants::SCOPE_COUNTRY);
-        $this->addDecision($now, '24h', '+24 hours', TestHelpers::IP_JAPAN, 'ban');
-        $this->addDecision($now, '24h', '+24 hours', TestHelpers::IP_FRANCE, 'ban');
+        $this->addDecision($now, '24h', self::HOURS24, TestHelpers::JAPAN, 'captcha', Constants::SCOPE_COUNTRY);
+        $this->addDecision($now, '24h', self::HOURS24, TestHelpers::IP_JAPAN, 'ban');
+        $this->addDecision($now, '24h', self::HOURS24, TestHelpers::IP_FRANCE, 'ban');
     }
 
     /**

tests/end-to-end/utils/watcherClient.js

@@ -52,7 +52,7 @@ const ip2long = (argIpParam) => {
     );
     argIP = argIP.match(pattern);
     if (!argIP) {
-        return false;
+        throw new Error(`${argIpParam} is not a valid IP`);
     }
     argIP[0] = 0;
     for (i = 1; i < 5; i += 1) {
@@ -68,7 +68,9 @@ const ip2long = (argIpParam) => {
         argIP[3] >= argIP[7] ||
         argIP[4] >= argIP[8]
     ) {
-        return false;
+        throw new Error(
+            `Something went wrong with ${argIpParam} ip2long process`,
+        );
     }
     return (
         argIP[1] * (argIP[0] === 1 || 16777216) +