Add:getSummaryStatistics

tatevikg1 · tatevikg1 · commit 34e9ae0df566 · 2026-03-19T20:31:32.000+04:00
diff --git a/src/Domain/Analytics/Repository/UserMessageViewRepository.php b/src/Domain/Analytics/Repository/UserMessageViewRepository.php
@@ -4,6 +4,7 @@
 
 namespace PhpList\Core\Domain\Analytics\Repository;
 
+use DateTimeInterface;
 use PhpList\Core\Domain\Common\Repository\AbstractRepository;
 use PhpList\Core\Domain\Common\Repository\CursorPaginationTrait;
 use PhpList\Core\Domain\Common\Repository\Interfaces\PaginatableRepositoryInterface;
@@ -21,4 +22,23 @@ public function countByMessageId(int $messageId): int
             ->getQuery()
             ->getSingleScalarResult();
     }
+
+    /**
+     * Counts views between two dates.
+     *
+     * @param DateTimeInterface $start
+     * @param DateTimeInterface $end
+     * @return int
+     */
+    public function countBetween(DateTimeInterface $start, DateTimeInterface $end): int
+    {
+        return (int) $this->createQueryBuilder('umv')
+            ->select('COUNT(umv.id)')
+            ->where('umv.viewed >= :start')
+            ->andWhere('umv.viewed <= :end')
+            ->setParameter('start', $start)
+            ->setParameter('end', $end)
+            ->getQuery()
+            ->getSingleScalarResult();
+    }
 }
diff --git a/src/Domain/Analytics/Service/AnalyticsService.php b/src/Domain/Analytics/Service/AnalyticsService.php
@@ -4,11 +4,14 @@
 
 namespace PhpList\Core\Domain\Analytics\Service;
 
+use DateTimeImmutable;
+use PhpList\Core\Domain\Analytics\Repository\UserMessageViewRepository;
 use PhpList\Core\Domain\Analytics\Service\Manager\LinkTrackManager;
 use PhpList\Core\Domain\Analytics\Service\Manager\UserMessageViewManager;
 use PhpList\Core\Domain\Messaging\Repository\MessageRepository;
 use PhpList\Core\Domain\Messaging\Repository\UserMessageBounceRepository;
 use PhpList\Core\Domain\Messaging\Repository\UserMessageForwardRepository;
+use PhpList\Core\Domain\Messaging\Repository\UserMessageRepository;
 use PhpList\Core\Domain\Subscription\Repository\SubscriberRepository;
 
 class AnalyticsService
@@ -19,7 +22,9 @@ public function __construct(
         private readonly MessageRepository $messageRepository,
         private readonly UserMessageBounceRepository $messageBounceRepository,
         private readonly UserMessageForwardRepository $messageForwardRepository,
-        private readonly SubscriberRepository $subscriberRepository
+        private readonly SubscriberRepository $subscriberRepository,
+        private readonly UserMessageRepository $userMessageRepository,
+        private readonly UserMessageViewRepository $userMessageViewRepository
     ) {
     }
 
@@ -180,6 +185,86 @@ public function getTopDomains(int $limit = 50, int $minSubscribers = 5): array
         ];
     }
 
+    public function getSummaryStatistics(): array
+    {
+        $now = new DateTimeImmutable();
+        $thisMonthStart = $now->modify('first day of this month 00:00:00');
+        $lastMonthStart = $now->modify('first day of last month 00:00:00');
+        $lastMonthEnd = $thisMonthStart->modify('-1 second');
+
+        $totalSubscribers = $this->subscriberRepository->count([]);
+        $subscribersThisMonth = $this->subscriberRepository->countCreatedBetween($thisMonthStart, $now);
+        $subscribersLastMonth = $this->subscriberRepository->countCreatedBetween($lastMonthStart, $lastMonthEnd);
+
+        $activeCampaigns = $this->messageRepository->countActiveBetween($thisMonthStart, $now);
+        $activeCampaignsLastMonth = $this->messageRepository->countActiveBetween($lastMonthStart, $lastMonthEnd);
+
+        $sentTotal = $this->userMessageRepository->countSentBetween($thisMonthStart, $now);
+        $openTotal = $this->userMessageViewRepository->countBetween($thisMonthStart, $now);
+        $bounceTotal = $this->messageBounceRepository->countBetween($thisMonthStart, $now);
+
+        $sentTotalLastMonth = $this->userMessageRepository->countSentBetween($lastMonthStart, $lastMonthEnd);
+        $openTotalLastMonth = $this->userMessageViewRepository->countBetween($lastMonthStart, $lastMonthEnd);
+        $bounceTotalLastMonth = $this->messageBounceRepository->countBetween($lastMonthStart, $lastMonthEnd);
+
+        $openRate = $this->calculateRate($openTotal, $sentTotal);
+        $openRateLastMonth = $this->calculateRate($openTotalLastMonth, $sentTotalLastMonth);
+
+        $bounceRate = $this->calculateRate($bounceTotal, $sentTotal);
+        $bounceRateLastMonth = $this->calculateRate($bounceTotalLastMonth, $sentTotalLastMonth);
+
+        return [
+            'total_subscribers' => [
+                'value' => $totalSubscribers,
+                'change_vs_last_month' => $this->calculateChange($subscribersThisMonth, $subscribersLastMonth),
+            ],
+            'active_campaigns' => [
+                'value' => $activeCampaigns,
+                'change_vs_last_month' => $this->calculateChange($activeCampaigns, $activeCampaignsLastMonth),
+            ],
+            'open_rate' => [
+                'value' => $openRate,
+                'change_vs_last_month' => $this->calculateChange($openRate, $openRateLastMonth),
+            ],
+            'bounce_rate' => [
+                'value' => $bounceRate,
+                'change_vs_last_month' => $this->calculateChange($bounceRate, $bounceRateLastMonth),
+            ],
+        ];
+    }
+
+    /**
+     * Calculate rate as a percentage.
+     *
+     * @param int $numerator
+     * @param int $denominator
+     * @return float
+     */
+    private function calculateRate(int $numerator, int $denominator): float
+    {
+        if ($denominator === 0) {
+            return 0.0;
+        }
+
+        return round(($numerator / $denominator) * 100, 2);
+    }
+
+    /**
+     * Calculate percentage change between current and previous value.
+     *
+     * @param float|int $current
+     * @param float|int $previous
+     * @return float
+     */
+    private function calculateChange(float|int $current, float|int $previous): float
+    {
+        if ($previous == 0) {
+            return $current > 0 ? 100.0 : 0.0;
+        }
+
+        return round((($current - $previous) / $previous) * 100, 2);
+    }
+
     /**
      * Get domains with most unconfirmed subscribers
      *
diff --git a/src/Domain/Messaging/Repository/MessageRepository.php b/src/Domain/Messaging/Repository/MessageRepository.php
@@ -5,6 +5,7 @@
 namespace PhpList\Core\Domain\Messaging\Repository;
 
 use DateTimeImmutable;
+use DateTimeInterface;
 use Doctrine\ORM\AbstractQuery;
 use PhpList\Core\Domain\Common\Model\Filter\FilterRequestInterface;
 use PhpList\Core\Domain\Common\Model\PaginatedResult;
@@ -145,4 +146,24 @@ public function getNonEmptyFields(int $id): array
 
         return $message;
     }
+
+    /**
+     * Counts active campaigns between two dates.
+     * "Active" here means messages that were sent (or in process) during this period.
+     *
+     * @param DateTimeInterface $start
+     * @param DateTimeInterface $end
+     * @return int
+     */
+    public function countActiveBetween(DateTimeInterface $start, DateTimeInterface $end): int
+    {
+        return (int) $this->createQueryBuilder('m')
+            ->select('COUNT(m.id)')
+            ->where('m.metadata.sent >= :start')
+            ->andWhere('m.metadata.sent <= :end')
+            ->setParameter('start', $start)
+            ->setParameter('end', $end)
+            ->getQuery()
+            ->getSingleScalarResult();
+    }
 }
diff --git a/src/Domain/Messaging/Repository/UserMessageBounceRepository.php b/src/Domain/Messaging/Repository/UserMessageBounceRepository.php
@@ -4,6 +4,7 @@
 
 namespace PhpList\Core\Domain\Messaging\Repository;
 
+use DateTimeInterface;
 use PhpList\Core\Domain\Common\Repository\AbstractRepository;
 use PhpList\Core\Domain\Common\Repository\CursorPaginationTrait;
 use PhpList\Core\Domain\Common\Repository\Interfaces\PaginatableRepositoryInterface;
@@ -26,6 +27,25 @@ public function getCountByMessageId(int $messageId): int
             ->getSingleScalarResult();
     }
 
+    /**
+     * Counts bounces between two dates.
+     *
+     * @param DateTimeInterface $start
+     * @param DateTimeInterface $end
+     * @return int
+     */
+    public function countBetween(DateTimeInterface $start, DateTimeInterface $end): int
+    {
+        return (int) $this->createQueryBuilder('umb')
+            ->select('COUNT(umb.id)')
+            ->where('umb.createdAt >= :start')
+            ->andWhere('umb.createdAt <= :end')
+            ->setParameter('start', $start)
+            ->setParameter('end', $end)
+            ->getQuery()
+            ->getSingleScalarResult();
+    }
+
     public function existsByMessageIdAndUserId(int $messageId, int $subscriberId): bool
     {
         return (bool) $this->createQueryBuilder('umb')
diff --git a/src/Domain/Messaging/Repository/UserMessageRepository.php b/src/Domain/Messaging/Repository/UserMessageRepository.php
@@ -18,6 +18,27 @@ public function findByUserAndMessage(Subscriber $subscriber, Message $campaign):
         return $this->findOneBy(['user' => $subscriber, 'message' => $campaign]);
     }
 
+    /**
+     * Counts how many user messages have status "sent" between the given dates.
+     *
+     * @param DateTimeInterface $start
+     * @param DateTimeInterface $end
+     * @return int
+     */
+    public function countSentBetween(DateTimeInterface $start, DateTimeInterface $end): int
+    {
+        return (int) $this->createQueryBuilder('um')
+            ->select('COUNT(um)')
+            ->where('um.createdAt >= :start')
+            ->andWhere('um.createdAt <= :end')
+            ->andWhere('um.status = :status')
+            ->setParameter('start', $start)
+            ->setParameter('end', $end)
+            ->setParameter('status', UserMessageStatus::Sent->value)
+            ->getQuery()
+            ->getSingleScalarResult();
+    }
+
     /**
      * Counts how many user messages have status "sent" since the given time.
      */
diff --git a/src/Domain/Subscription/Repository/SubscriberRepository.php b/src/Domain/Subscription/Repository/SubscriberRepository.php
@@ -4,6 +4,7 @@
 
 namespace PhpList\Core\Domain\Subscription\Repository;
 
+use DateTimeInterface;
 use Doctrine\ORM\QueryBuilder;
 use InvalidArgumentException;
 use PhpList\Core\Domain\Common\Model\Filter\FilterRequestInterface;
@@ -256,4 +257,23 @@ public function getDataById(int $subscriberId): array
             ->getQuery()
             ->getArrayResult()[0] ?? [];
     }
+
+    /**
+     * Counts subscribers created between two dates.
+     *
+     * @param DateTimeInterface $start
+     * @param DateTimeInterface $end
+     * @return int
+     */
+    public function countCreatedBetween(DateTimeInterface $start, DateTimeInterface $end): int
+    {
+        return (int) $this->createQueryBuilder('s')
+            ->select('COUNT(s.id)')
+            ->where('s.createdAt >= :start')
+            ->andWhere('s.createdAt <= :end')
+            ->setParameter('start', $start)
+            ->setParameter('end', $end)
+            ->getQuery()
+            ->getSingleScalarResult();
+    }
 }
diff --git a/tests/Unit/Domain/Analytics/Service/AnalyticsServiceTest.php b/tests/Unit/Domain/Analytics/Service/AnalyticsServiceTest.php
@@ -6,6 +6,7 @@
 
 use DateTime;
 use PhpList\Core\Domain\Analytics\Model\LinkTrack;
+use PhpList\Core\Domain\Analytics\Repository\UserMessageViewRepository;
 use PhpList\Core\Domain\Analytics\Service\AnalyticsService;
 use PhpList\Core\Domain\Analytics\Service\Manager\LinkTrackManager;
 use PhpList\Core\Domain\Analytics\Service\Manager\UserMessageViewManager;
@@ -16,6 +17,7 @@
 use PhpList\Core\Domain\Messaging\Repository\MessageRepository;
 use PhpList\Core\Domain\Messaging\Repository\UserMessageBounceRepository;
 use PhpList\Core\Domain\Messaging\Repository\UserMessageForwardRepository;
+use PhpList\Core\Domain\Messaging\Repository\UserMessageRepository;
 use PhpList\Core\Domain\Subscription\Model\Subscriber;
 use PhpList\Core\Domain\Subscription\Repository\SubscriberRepository;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -30,6 +32,8 @@ class AnalyticsServiceTest extends TestCase
     private UserMessageBounceRepository|MockObject $userMessageBounceRepository;
     private UserMessageForwardRepository|MockObject $userMessageForwardRepository;
     private SubscriberRepository|MockObject $subscriberRepository;
+    private UserMessageRepository|MockObject $userMessageRepository;
+    private UserMessageViewRepository|MockObject $userMessageViewRepository;
 
     protected function setUp(): void
     {
@@ -39,14 +43,18 @@ protected function setUp(): void
         $this->userMessageBounceRepository = $this->createMock(UserMessageBounceRepository::class);
         $this->userMessageForwardRepository = $this->createMock(UserMessageForwardRepository::class);
         $this->subscriberRepository = $this->createMock(SubscriberRepository::class);
+        $this->userMessageRepository = $this->createMock(UserMessageRepository::class);
+        $this->userMessageViewRepository = $this->createMock(UserMessageViewRepository::class);
 
         $this->subject = new AnalyticsService(
             $this->linkTrackManager,
             $this->userMessageViewManager,
             $this->messageRepository,
             $this->userMessageBounceRepository,
             $this->userMessageForwardRepository,
-            $this->subscriberRepository
+            $this->subscriberRepository,
+            $this->userMessageRepository,
+            $this->userMessageViewRepository
         );
     }
 
@@ -328,4 +336,34 @@ public function testGetTopLocalParts(): void
         self::assertSame(1, $result['localParts'][1]['count']);
         self::assertSame(20, $result['localParts'][1]['percentage']);
     }
+
+    public function testGetSummaryStatistics(): void
+    {
+        $this->subscriberRepository->method('count')->willReturn(1000);
+        $this->subscriberRepository->method('countCreatedBetween')->willReturnOnConsecutiveCalls(100, 50);
+
+        $this->messageRepository->method('countActiveBetween')->willReturnOnConsecutiveCalls(5, 4);
+
+        $this->userMessageRepository->method('countSentBetween')->willReturnOnConsecutiveCalls(500, 400);
+        $this->userMessageViewRepository->method('countBetween')->willReturnOnConsecutiveCalls(250, 160);
+        $this->userMessageBounceRepository->method('countBetween')->willReturnOnConsecutiveCalls(10, 8);
+
+        $result = $this->subject->getSummaryStatistics();
+
+        self::assertArrayHasKey('total_subscribers', $result);
+        self::assertSame(1000, $result['total_subscribers']['value']);
+        self::assertEquals(100.0, $result['total_subscribers']['change_vs_last_month']);
+
+        self::assertArrayHasKey('active_campaigns', $result);
+        self::assertSame(5, $result['active_campaigns']['value']);
+        self::assertEquals(25.0, $result['active_campaigns']['change_vs_last_month']);
+
+        self::assertArrayHasKey('open_rate', $result);
+        self::assertEquals(50.0, $result['open_rate']['value']);
+        self::assertEquals(25.0, $result['open_rate']['change_vs_last_month']);
+
+        self::assertArrayHasKey('bounce_rate', $result);
+        self::assertEquals(2.0, $result['bounce_rate']['value']);
+        self::assertEquals(0.0, $result['bounce_rate']['change_vs_last_month']);
+    }
 }
