Merge pull request #101 from julienloizelet/feat/code-standard-and-api-cache-fix

Feat/code standard and api cache fix

Author: julienloizelet

CHANGELOG.md

@@ -5,6 +5,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
+
+## [0.27.0] - 2022-07-29
+
+### Changed
+- *Breaking change*: Modify `getBouncerInstance` and `init` signatures
+
+### Fixed
+- Fix wrongly formatted range scoped decision retrieving
+- Fix cache updated decisions count
+
 ## [0.26.0] - 2022-07-28
 
 ### Changed

src/ApiCache.php

@@ -468,6 +468,7 @@ private function getCacheKey(string $scope, string $value): string
     private function saveRemediations(array $decisions): array
     {
         $errors = [];
+        $count = 0;
         foreach ($decisions as $decision) {
             $remediation = $this->formatRemediationFromDecision($decision);
             $type = $remediation[0];
@@ -492,9 +493,16 @@ private function saveRemediations(array $decisions): array
                 }
                 $cacheKey = $this->getCacheKey($decision['scope'], $address->toString());
                 $this->addRemediationToCacheItem($cacheKey, $type, $exp, $id);
+                ++$count;
             } elseif (Constants::SCOPE_RANGE === $decision['scope']) {
                 $range = Subnet::parseString($decision['value']);
-
+                if(null === $range) {
+                    $this->logger->warning('', [
+                        'type' => 'INVALID_RANGE_TO_ADD_FROM_REMEDIATION',
+                        'decision' => $decision,
+                    ]);
+                    continue;
+                }
                 $addressType = $range->getAddressType();
                 $isIpv6 = (Type::T_IPv6 === $addressType);
                 if ($isIpv6 || ($range->getNetworkPrefix() < 24)) {
@@ -527,13 +535,15 @@ private function saveRemediations(array $decisions): array
                         throw new BouncerException($message);
                     }
                 } while (0 !== strcmp($address->getComparableString(), $comparableEndAddress));
+                ++$count;
             } elseif (Constants::SCOPE_COUNTRY === $decision['scope']) {
                 $cacheKey = $this->getCacheKey($decision['scope'], $decision['value']);
                 $this->addRemediationToCacheItem($cacheKey, $type, $exp, $id);
+                ++$count;
             }
         }
 
-        return ['success' => $this->commit(), 'errors' => $errors];
+        return ['success' => $this->commit(), 'errors' => $errors, 'count' => $count];
     }
 
     /**
@@ -570,7 +580,13 @@ private function removeRemediations(array $decisions): array
                 }
             } elseif (Constants::SCOPE_RANGE === $decision['scope']) {
                 $range = Subnet::parseString($decision['value']);
-
+                if(null === $range) {
+                    $this->logger->warning('', [
+                        'type' => 'INVALID_RANGE_TO_REMOVE_FROM_REMEDIATION',
+                        'decision' => $decision,
+                    ]);
+                    continue;
+                }
                 $addressType = $range->getAddressType();
                 $isIpv6 = (Type::T_IPv6 === $addressType);
                 if ($isIpv6 || ($range->getNetworkPrefix() < 24)) {
@@ -751,8 +767,15 @@ public function pullUpdates(): array
         $nbNew = 0;
         if ($newDecisions) {
             $saveResult = $this->saveRemediations($newDecisions);
-            $addErrors = $saveResult['errors'];
-            $nbNew = \count($newDecisions);
+            if(!empty($saveResult['success'])){
+                $addErrors = $saveResult['errors']??0;
+                $nbNew = $saveResult['count']??0;
+            }
+            else{
+                $this->logger->warning('', [
+                    'type' => 'CACHE_UPDATED_FAILED',
+                    'message' => 'Something went wrong while committing to cache adapter']);
+            }
         }
 
         $this->logger->debug('', ['type' => 'CACHE_UPDATED', 'deleted' => $nbDeleted, 'new' => $nbNew]);

src/Constants.php

@@ -20,7 +20,7 @@ class Constants
     public const DEFAULT_LAPI_URL = 'http://localhost:8080';
 
     /** @var string The last version of this library */
-    public const VERSION = 'v0.26.0';
+    public const VERSION = 'v0.27.0';
 
     /** @var string The user agent used to send request to LAPI */
     public const BASE_USER_AGENT = 'PHP CrowdSec Bouncer/' . self::VERSION;

src/IBounce.php

@@ -17,7 +17,7 @@ interface IBounce
     /**
      * Init the bouncer.
      */
-    public function init(array $configs, array $forcedConfigs = []): Bouncer;
+    public function init(array $configs): Bouncer;
 
     /**
      * Init the logger.
@@ -27,7 +27,7 @@ public function initLogger(array $configs): void;
     /**
      * Get the bouncer instance.
      */
-    public function getBouncerInstance(array $settings, bool $forceReload = false): Bouncer;
+    public function getBouncerInstance(array $settings): Bouncer;
 
     /**
      * If there is any technical problem while bouncing, don't block the user. Bypass bouncing and log the error.

src/RestClient/Curl.php

@@ -52,7 +52,6 @@ public function request(
 
     /**
      * Retrieve Curl options.
-     *
      */
     private function createOptions(
         string $endpoint,

src/StandaloneBounce.php

@@ -26,7 +26,7 @@ class StandaloneBounce extends AbstractBounce
      * @throws ErrorException
      * @throws \Psr\Cache\InvalidArgumentException|BouncerException
      */
-    public function init(array $configs, array $forcedConfigs = []): Bouncer
+    public function init(array $configs): Bouncer
     {
         // Convert array of string to array of array with comparable IPs
         if (\is_array(($configs['trust_ip_forward_array']))) {
@@ -45,7 +45,7 @@ public function init(array $configs, array $forcedConfigs = []): Bouncer
             }
             $configs['trust_ip_forward_array'] = $finalForwardConfigs;
         }
-        $this->settings = array_merge($configs, $forcedConfigs);
+        $this->settings = $configs;
 
         return $this->getBouncerInstance($this->settings);
     }
@@ -57,12 +57,8 @@ public function init(array $configs, array $forcedConfigs = []): Bouncer
      * @throws ErrorException
      * @throws \Psr\Cache\InvalidArgumentException|BouncerException
      */
-    public function getBouncerInstance(array $settings, bool $forceReload = false): Bouncer
+    public function getBouncerInstance(array $settings): Bouncer
     {
-        // Singleton for this function (if no reload forcing)
-        if ($this->bouncer && !$forceReload) {
-            return $this->bouncer;
-        }
         $this->settings = array_merge($this->settings, $settings);
         $apiUserAgent = 'Standalone CrowdSec PHP Bouncer/' . Constants::VERSION;