[Campaign] Add phpredis support

Campaign/.env.example

@@ -72,6 +72,7 @@ DB_PORT=3306
 
 # Redis client to be used. Available values are:
 # - predis: default value, used if nothing is set
+# - phpredis: use if you have installed the php-redis extension for better performance
 # - mock: fake implementation for tests
 # It's recommended to set this variable only for testing scenarios.
 # REDIS_CLIENT=
@@ -85,6 +86,9 @@ REDIS_HOST=redis
 # Redis connection port. 6379 is the default port used by Redis installation.
 REDIS_PORT=6379
 
+# Specifies if the underlying redis connection resource should be left open when a script ends its lifecycle. Default: false
+REDIS_PERSISTENT=false
+
 # Alternative Redis connection configuration.
 # The accepted format of a single connection is
 #
@@ -249,3 +253,10 @@ MAXMIND_DATABASE=resources/assets/maxmind/GeoLite2-Country.mmdb
 # In the case of same amount of variants the banner from more recent campaign is prioritized.
 
 #PRIORITIZE_BANNERS_ON_SAME_POSITION=
+
+# Flag whether the one time banners should be enabled or not.
+#
+# If this option is set to `true`, the user and browser one time banners are used in Showtime.
+# If you are not using the one time banners, set this option to `false` for better performance.
+# The default value is `true`.
+ONE_TIME_BANNER_ENABLED=true

Campaign/app/Contracts/Crm/Segment.php

@@ -6,7 +6,6 @@
 use App\Contracts\SegmentAggregator;
 use App\Contracts\SegmentContract;
 use App\Contracts\SegmentException;
-use App\Jobs\CacheSegmentJob;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\ConnectException;
 use Illuminate\Support\Collection;
@@ -27,13 +26,20 @@ class Segment implements SegmentContract
 
     private $redis;
 
-    public function __construct(Client $client, \Predis\Client $redis)
+    public function __construct(Client $client, \Predis\Client|\Redis $redis)
     {
         $this->client = $client;
         $this->providerData = new \stdClass;
         $this->redis = $redis;
     }
 
+    public function setRedisClient(\Predis\Client|\Redis $redis): self
+    {
+        $this->redis = $redis;
+
+        return $this;
+    }
+
     public function provider(): string
     {
         return static::PROVIDER_ALIAS;
@@ -128,7 +134,10 @@ public function getProviderData()
 
     public function addUserToCache(CampaignSegment $campaignSegment, string $userId): bool
     {
-        return $this->redis->sadd(SegmentAggregator::cacheKey($campaignSegment), [$userId]) ?: false;
+        return $this->redis->sadd(
+            SegmentAggregator::cacheKey($campaignSegment),
+            $this->redis instanceof \Redis ? $userId : [$userId]
+        ) ?: false;
     }
 
     public function removeUserFromCache(CampaignSegment $campaignSegment, string $userId): bool

Campaign/app/Contracts/SegmentAggregator.php

@@ -48,12 +48,20 @@ public function list(): Collection
 
     public function checkUser(CampaignSegment $campaignSegment, string $userId): bool
     {
+        if (!isset($this->contracts[$campaignSegment->provider])) {
+            return false;
+        }
+
         return $this->contracts[$campaignSegment->provider]
             ->checkUser($campaignSegment, $userId);
     }
 
     public function checkBrowser(CampaignSegment $campaignSegment, string $browserId): bool
     {
+        if (!isset($this->contracts[$campaignSegment->provider])) {
+            return false;
+        }
+
         return $this->contracts[$campaignSegment->provider]
             ->checkBrowser($campaignSegment, $browserId);
     }
@@ -66,6 +74,10 @@ public function users(CampaignSegment $campaignSegment): Collection
 
     public function cacheEnabled(CampaignSegment $campaignSegment): bool
     {
+        if (!isset($this->contracts[$campaignSegment->provider])) {
+            return false;
+        }
+
         return $this->contracts[$campaignSegment->provider]
             ->cacheEnabled($campaignSegment);
     }
@@ -136,6 +148,15 @@ public function getErrors()
         return $this->errors;
     }
 
+    public function refreshRedisClient(Client|\Redis $redisClient): void
+    {
+        foreach ($this->contracts as $contract) {
+            if (method_exists($contract, 'setRedisClient')) {
+                $contract->setRedisClient($redisClient);
+            }
+        }
+    }
+
     /**
      * SegmentAggregator contains Guzzle clients which have properties defined as closures.
      * It's not possible to serialize closures in plain PHP, but Laravel provides a workaround.
@@ -158,9 +179,16 @@ public function serializeToRedis()
         Redis::set(\App\Models\Alignment\Map::ALIGNMENTS_MAP_REDIS_KEY, $alignmentsMap->alignments()->toJson());
     }
 
-    public static function unserializeFromRedis(Client $redisClient): ?SegmentAggregator
+    public static function unserializeFromRedis(Client|\Redis $redisClient): ?SegmentAggregator
     {
         $serializedClosure = $redisClient->get(self::SEGMENT_AGGREGATOR_REDIS_KEY);
-        return $serializedClosure ? unserialize($serializedClosure)() : null;
+
+        /* @var ?SegmentAggregator $segmentAggregator */
+        $segmentAggregator = $serializedClosure ? unserialize($serializedClosure)() : null;
+
+        // set the redis to avoid duplicated connection
+        $segmentAggregator?->refreshRedisClient($redisClient);
+
+        return $segmentAggregator;
     }
 }

Campaign/app/Http/Showtime/LazyDeviceDetector.php

@@ -3,17 +3,15 @@
 namespace App\Http\Showtime;
 
 use DeviceDetector\Cache\PSR6Bridge;
-use Predis\ClientInterface;
+use Psr\Cache\CacheItemPoolInterface;
 
 class LazyDeviceDetector
 {
     private $detector;
 
-    private $redis;
-
-    public function __construct(ClientInterface $redis)
-    {
-        $this->redis = $redis;
+    public function __construct(
+        private readonly CacheItemPoolInterface $cachePool
+    ) {
     }
 
     public function get($userAgent)
@@ -22,7 +20,7 @@ public function get($userAgent)
             $this->detector = new \DeviceDetector\DeviceDetector();
             $this->detector->setCache(
                 new PSR6Bridge(
-                    new \Cache\Adapter\Predis\PredisCachePool($this->redis)
+                    $this->cachePool
                 )
             );
         }