Added segment information into sales funnels

remp/novydenik#1228
remp2020 · Mar 25, 2024 · a6c4850 · a6c4850
1 parent 7d21105
commit a6c4850
Show file tree

Hide file tree

Showing 8 changed files with 146 additions and 24 deletions.
diff --git a/src/Models/Config/SegmentSlowRecalculateThreshold.php b/src/Models/Config/SegmentSlowRecalculateThreshold.php
@@ -0,0 +1,20 @@
+<?php
+declare(strict_types=1);
+
+namespace Crm\SegmentModule\Models\Config;
+
+use DomainException;
+
+class SegmentSlowRecalculateThreshold
+{
+    public function __construct(public readonly ?int $thresholdInSeconds)
+    {
+        if ($thresholdInSeconds === null) {
+            return;
+        }
+
+        if ($thresholdInSeconds < 0) {
+            throw new DomainException('Threshold must be a positive number.');
+        }
+    }
+}
diff --git a/src/Models/Config/SegmentSlowRecalculateThresholdFactory.php b/src/Models/Config/SegmentSlowRecalculateThresholdFactory.php
@@ -0,0 +1,39 @@
+<?php
+declare(strict_types=1);
+
+namespace Crm\SegmentModule\Models\Config;
+
+use Crm\ApplicationModule\Models\Config\ApplicationConfig;
+use Exception;
+use Tracy\Debugger;
+
+class SegmentSlowRecalculateThresholdFactory
+{
+    private const SLOW_RECALCULATE_THRESHOLD_CONFIG_KEY = 'segment_slow_recalculate_threshold';
+
+    public function __construct(
+        private readonly ApplicationConfig $applicationConfig,
+    ) {
+    }
+
+    public function build(): SegmentSlowRecalculateThreshold
+    {
+        try {
+            $threshold = $this->applicationConfig->get(self::SLOW_RECALCULATE_THRESHOLD_CONFIG_KEY);
+            if (!is_numeric($threshold)) {
+                throw new Exception('Threshold must be a number.');
+            }
+
+            return new SegmentSlowRecalculateThreshold($threshold);
+        } catch (Exception $exception) {
+            $errorMessage = sprintf(
+                'Bad value in configuration for `%s`. %s',
+                self::SLOW_RECALCULATE_THRESHOLD_CONFIG_KEY,
+                $exception->getMessage()
+            );
+            Debugger::log($errorMessage, Debugger::WARNING);
+
+            return new SegmentSlowRecalculateThreshold(null);
+        }
+    }
+}
diff --git a/src/Presenters/StoredSegmentsPresenter.php b/src/Presenters/StoredSegmentsPresenter.php
@@ -11,6 +11,7 @@
 use Crm\ApplicationModule\Models\Widget\WidgetManager;
 use Crm\SegmentModule\Forms\SegmentFormFactory;
 use Crm\SegmentModule\Forms\SegmentRecalculationSettingsFormFactory;
+use Crm\SegmentModule\Models\Config\SegmentSlowRecalculateThresholdFactory;
 use Crm\SegmentModule\Models\SegmentException;
 use Crm\SegmentModule\Models\SegmentFactoryInterface;
 use Crm\SegmentModule\Models\SegmentWidgetInterface;
@@ -60,7 +61,8 @@ public function __construct(
         SegmentGroupsRepository $segmentGroupsRepository,
         AccessToken $accessToken,
         WidgetManager $widgetManager,
-        LazyWidgetManager $lazyWidgetManager
+        LazyWidgetManager $lazyWidgetManager,
+        private SegmentSlowRecalculateThresholdFactory $segmentSlowRecalculateThresholdFactory,
     ) {
         parent::__construct();
 
@@ -83,16 +85,7 @@ public function renderDefault()
         $this->template->segmentGroups = $this->segmentGroupsRepository->all();
         $this->template->segments = $this->segmentsRepository->all();
         $this->template->deletedSegments = $this->segmentsRepository->deleted();
-
-        $segmentSlowRecalculateThreshold = $this->applicationConfig->get('segment_slow_recalculate_threshold');
-        if (!is_numeric($segmentSlowRecalculateThreshold) || $segmentSlowRecalculateThreshold < 0) {
-            Debugger::log(
-                'Bad value in configuration for `segment_slow_recalculate_threshold`. Value must be positive number.',
-                Debugger::WARNING
-            );
-        } else {
-            $this->template->segmentSlowRecalculateThreshold = $this->applicationConfig->get('segment_slow_recalculate_threshold');
-        }
+        $this->template->segmentSlowRecalculateThresholdInSeconds = $this->segmentSlowRecalculateThresholdFactory->build()->thresholdInSeconds;
     }
 
     /**
@@ -124,16 +117,7 @@ public function renderShow($id, $data = false)
         $segmentRow = $this->loadSegment($id);
         $this->template->segment = $segmentRow;
         $this->template->showData = $data;
-
-        $segmentSlowRecalculateThreshold = $this->applicationConfig->get('segment_slow_recalculate_threshold');
-        if (!is_numeric($segmentSlowRecalculateThreshold) || $segmentSlowRecalculateThreshold < 0) {
-            Debugger::log(
-                'Bad value in configuration for `segment_slow_recalculate_threshold`. Value must be positive number.',
-                Debugger::WARNING
-            );
-        } else {
-            $this->template->segmentSlowRecalculateThreshold = $this->applicationConfig->get('segment_slow_recalculate_threshold');
-        }
+        $this->template->segmentSlowRecalculateThresholdInSeconds = $this->segmentSlowRecalculateThresholdFactory->build()->thresholdInSeconds;
 
         $segment = $this->segmentFactory->buildSegment($segmentRow->code);
 

diff --git a/src/Tests/Config/SegmentSlowRecalculateThresholdFactoryTest.php b/src/Tests/Config/SegmentSlowRecalculateThresholdFactoryTest.php
@@ -0,0 +1,47 @@
+<?php
+declare(strict_types=1);
+
+namespace Crm\SegmentModule\Tests\Config;
+
+use Crm\ApplicationModule\Models\Config\ApplicationConfig;
+use Crm\SegmentModule\Models\Config\SegmentSlowRecalculateThresholdFactory;
+use PHPUnit\Framework\TestCase;
+
+class SegmentSlowRecalculateThresholdFactoryTest extends TestCase
+{
+    public function testBuild(): void
+    {
+        $mockedApplicationConfig = $this->createMock(ApplicationConfig::class);
+        $mockedApplicationConfig->expects($this->once())
+            ->method('get')
+            ->with('segment_slow_recalculate_threshold')
+            ->willReturn(10);
+
+        $factory = new SegmentSlowRecalculateThresholdFactory($mockedApplicationConfig);
+        $this->assertSame(10, $factory->build()->thresholdInSeconds);
+    }
+
+    public function testBuildWithDomainException(): void
+    {
+        $mockedApplicationConfig = $this->createMock(ApplicationConfig::class);
+        $mockedApplicationConfig->expects($this->once())
+            ->method('get')
+            ->with('segment_slow_recalculate_threshold')
+            ->willReturn(-1);
+
+        $factory = new SegmentSlowRecalculateThresholdFactory($mockedApplicationConfig);
+        $this->assertNull($factory->build()->thresholdInSeconds);
+    }
+
+    public function testBuildWithException(): void
+    {
+        $mockedApplicationConfig = $this->createMock(ApplicationConfig::class);
+        $mockedApplicationConfig->expects($this->once())
+            ->method('get')
+            ->with('segment_slow_recalculate_threshold')
+            ->willReturn('not a valid value');
+
+        $factory = new SegmentSlowRecalculateThresholdFactory($mockedApplicationConfig);
+        $this->assertNull($factory->build()->thresholdInSeconds);
+    }
+}
diff --git a/src/Tests/Config/SegmentSlowRecalculateThresholdTest.php b/src/Tests/Config/SegmentSlowRecalculateThresholdTest.php
@@ -0,0 +1,31 @@
+<?php
+declare(strict_types=1);
+
+namespace Crm\SegmentModule\Tests\Config;
+
+use Crm\SegmentModule\Models\Config\SegmentSlowRecalculateThreshold;
+use DomainException;
+use PHPUnit\Framework\TestCase;
+
+class SegmentSlowRecalculateThresholdTest extends TestCase
+{
+    public function testThreshold(): void
+    {
+        $threshold = new SegmentSlowRecalculateThreshold(10);
+        $this->assertSame(10, $threshold->thresholdInSeconds);
+    }
+
+    public function testNegativeThreshold(): void
+    {
+        $this->expectException(DomainException::class);
+        $this->expectExceptionMessage('Threshold must be a positive number.');
+
+        new SegmentSlowRecalculateThreshold(-1);
+    }
+
+    public function testNotSetThreshold(): void
+    {
+        $threshold = new SegmentSlowRecalculateThreshold(null);
+        $this->assertNull($threshold->thresholdInSeconds);
+    }
+}
diff --git a/src/config/config.neon b/src/config/config.neon
@@ -34,4 +34,5 @@ services:
 	- Crm\SegmentModule\Seeders\SegmentsSeeder
 	- Crm\SegmentModule\Seeders\ConfigSeeder
 	- Crm\SegmentModule\Segment\SegmentCriteria
-	- Crm\SegmentModule\Events\BeforeSegmentCodeUpdateHandler
+	- Crm\SegmentModule\Events\BeforeSegmentCodeUpdateHandler
+	- Crm\SegmentModule\Models\Config\SegmentSlowRecalculateThresholdFactory
diff --git a/src/templates/StoredSegments/default.latte b/src/templates/StoredSegments/default.latte
@@ -46,7 +46,7 @@
               <td>~{$segment->cache_count}</td>
               <td>
                 {if isset($segment->cache_count_time)}
-                  <span {if isset($segmentSlowRecalculateThreshold) && $segment->cache_count_time > $segmentSlowRecalculateThreshold}style="color: red;"{/if}>
+                  <span {if $segmentSlowRecalculateThresholdInSeconds !== null && $segment->cache_count_time > $segmentSlowRecalculateThresholdInSeconds}style="color: red;"{/if}>
                     {$segment->cache_count_time}&nbsp;s
                   </span>
                 {/if}

diff --git a/src/templates/StoredSegments/show.latte b/src/templates/StoredSegments/show.latte
@@ -76,7 +76,7 @@
             {/if}
 
             {if $segment->cache_count_time}
-              <span {if isset($segmentSlowRecalculateThreshold) && $segment->cache_count_time > $segmentSlowRecalculateThreshold}style="color: red;"{/if}>
+              <span {if $segmentSlowRecalculateThresholdInSeconds !== null && $segment->cache_count_time > $segmentSlowRecalculateThresholdInSeconds}style="color: red;"{/if}>
                 {_segment.fields.time}: {$segment->cache_count_time}&nbsp;s
               </span>
             {/if})