feat: Unread counter on Messages tab (dvsa/olcs-selfserve#70)

* WIP * Updated navigation and tests * Fix tests * Revert phpunit; Restore composer lock from closed branch * Resolve tab highlighting issues * chore: Whitespace for CodeSniffer --------- Co-authored-by: Saul Wilcox <saul.wilcox@dvsa.gov.uk>
dvsa · Feb 28, 2024 · a16cfaa · a16cfaa
1 parent b696ed9
commit a16cfaa
Show file tree

Hide file tree

Showing 9 changed files with 150 additions and 52 deletions.
diff --git a/app/selfserve/composer.lock b/app/selfserve/composer.lock
diff --git a/app/selfserve/module/Olcs/config/module.config.php b/app/selfserve/module/Olcs/config/module.config.php
@@ -1081,6 +1081,13 @@
                     'id' => 'dashboard-messaging',
                     'label' => 'dashboard-nav-messaging',
                     'route' => 'conversations',
+                    'pages' => array(
+                        array(
+                            'id' => 'messaging-create-conversation',
+                            'label' => 'New Conversation',
+                            'route' => 'conversations/new',
+                        ),
+                    ),
                 ),
             ),
         ),

diff --git a/app/selfserve/module/Olcs/src/Controller/ConversationsController.php b/app/selfserve/module/Olcs/src/Controller/ConversationsController.php
@@ -17,6 +17,7 @@
 use Dvsa\Olcs\Transfer\Query\Messaging\Conversations\ByOrganisation as ByOrganisationQuery;
 use Dvsa\Olcs\Utils\Translation\NiTextTranslation;
 use Laminas\Http\Response;
+use Laminas\Navigation\Navigation;
 use Laminas\View\Model\ViewModel;
 use LmcRbacMvc\Service\AuthorizationService;
 use Olcs\Form\Model\Form\Message\Reply as ReplyForm;
@@ -34,17 +35,20 @@ class ConversationsController extends AbstractController implements ToggleAwareI
     protected FlashMessengerHelperService $flashMessengerHelper;
     protected TableFactory $tableFactory;
     protected FormHelperService $formHelperService;
+    protected Navigation $navigationService;
 
     public function __construct(
         NiTextTranslation $niTextTranslationUtil,
         AuthorizationService $authService,
         FlashMessengerHelperService $flashMessengerHelper,
         TableFactory $tableFactory,
-        FormHelperService $formHelperService
+        FormHelperService $formHelperService,
+        Navigation $navigationService
     ) {
         $this->flashMessengerHelper = $flashMessengerHelper;
         $this->tableFactory = $tableFactory;
         $this->formHelperService = $formHelperService;
+        $this->navigationService = $navigationService;
 
         parent::__construct($niTextTranslationUtil, $authService);
     }
@@ -150,6 +154,8 @@ private function mapFormDataToCommand(\Laminas\Form\Form $form): Create
     /** @return ViewModel|Response */
     public function viewAction()
     {
+        $this->navigationService->findBy('id', 'dashboard-messaging')->setActive();
+
         $params = [
             'page'         => $this->params()->fromQuery('page', 1),
             'limit'        => $this->params()->fromQuery('limit', 10),

diff --git a/app/selfserve/module/Olcs/src/Controller/Factory/ConversationsControllerFactory.php b/app/selfserve/module/Olcs/src/Controller/Factory/ConversationsControllerFactory.php
@@ -8,6 +8,7 @@
 use Common\Service\Helper\FormHelperService;
 use Common\Service\Table\TableFactory;
 use Dvsa\Olcs\Utils\Translation\NiTextTranslation;
+use Laminas\Navigation\Navigation;
 use Psr\Container\ContainerInterface;
 use Laminas\ServiceManager\Factory\FactoryInterface;
 use LmcRbacMvc\Service\AuthorizationService;
@@ -25,13 +26,15 @@ public function __invoke(
         $flashMessengerHelper = $container->get(FlashMessengerHelperService::class);
         $tableFactory = $container->get(TableFactory::class);
         $formHelperService = $container->get(FormHelperService::class);
+        $navigationService = $container->get(Navigation::class);
 
         return new ConversationsController(
             $niTextTranslationUtil,
             $authService,
             $flashMessengerHelper,
             $tableFactory,
             $formHelperService,
+            $navigationService
         );
     }
 }
diff --git a/app/selfserve/module/Olcs/src/Controller/Listener/Navigation.php b/app/selfserve/module/Olcs/src/Controller/Listener/Navigation.php
@@ -5,6 +5,7 @@
 use Common\FeatureToggle;
 use Common\Rbac\User as RbacUser;
 use Common\Service\Cqrs\Query\QuerySender;
+use Dvsa\Olcs\Transfer\Query\Messaging\Messages\UnreadCountByOrganisationAndUser;
 use Laminas\EventManager\EventManagerInterface;
 use Laminas\EventManager\ListenerAggregateInterface;
 use Laminas\EventManager\ListenerAggregateTrait;
@@ -168,6 +169,8 @@ private function toggleMessagesTab(bool $shouldShowMessagesTab): void
     {
         $this->navigation->findBy('id', 'dashboard-messaging')
             ->setVisible($shouldShowMessagesTab);
+
+        $this->addUnreadMessagingCount();
     }
 
     private function shouldShowMessagesTab(): bool
@@ -201,4 +204,26 @@ public function setGovUkReferers(array $govUkReferers): void
     {
         $this->govUkReferers = $govUkReferers;
     }
+
+    public function getUnreadMessageCount(): int
+    {
+        $userOrganisationId = $this->identity->getUserData()['organisationUsers'][0]['organisation']['id'];
+
+        $unreadByOrganisation = $this->querySender->send(
+            UnreadCountByOrganisationAndUser::create(
+                [
+                    'organisation' => $userOrganisationId,
+                    'user' => $this->identity->getId(),
+                ]
+            )
+        );
+
+        return($unreadByOrganisation->getResult()['count'] ?? 0);
+    }
+
+    public function addUnreadMessagingCount(){
+        $this->navigation->findBy('id', 'dashboard-licences-applications')
+            ->findBy('id','dashboard-messaging')
+            ->set('unreadMessageCount', $this->getUnreadMessageCount());
+    }
 }
diff --git a/app/selfserve/module/Olcs/src/Service/Data/MessagingAppOrLicNo.php b/app/selfserve/module/Olcs/src/Service/Data/MessagingAppOrLicNo.php
@@ -63,8 +63,7 @@ public function formatDataForGroups(array $data): array
 
     private function prefixArrayKey(array &$array, string $prefix): void
     {
-        foreach ($array as $k => $v)
-        {
+        foreach ($array as $k => $v) {
             $array[$prefix . $k] = $v;
             unset($array[$k]);
         }

diff --git a/app/selfserve/module/Olcs/view/partials/tabs-nav.phtml b/app/selfserve/module/Olcs/view/partials/tabs-nav.phtml
@@ -7,6 +7,15 @@
         <?php echo $this->escapeHtml($this->translate($page->getLabel())); ?>
         <?php echo $page->get('count') ? '('.$page->get('count').')' : '';?>
         </a>
+        <?php if ($page->id == "dashboard-messaging" && $page->get('unreadMessageCount') > 0): ?>
+          <div class="notification-count">
+            <span class="notification-count__number">
+            <?php
+            echo $page->get('unreadMessageCount');
+            ?>
+            </span>
+          </div>
+        <?php endif; ?>
       </li>
     <?php endif; ?>
   <?php endforeach; ?>

diff --git a/app/selfserve/test/Olcs/src/Controller/ConversationsControllerTest.php b/app/selfserve/test/Olcs/src/Controller/ConversationsControllerTest.php
@@ -17,6 +17,7 @@
 use Laminas\Http\Response as HttpResponse;
 use Laminas\Mvc\Controller\Plugin\Params;
 use Dvsa\Olcs\Transfer\Command\Messaging\Message\Create as CreateMessageCommand;
+use Laminas\Navigation\Navigation;
 use Laminas\View\Model\ViewModel;
 use Mockery as m;
 use Mockery\Adapter\Phpunit\MockeryTestCase as TestCase;
@@ -36,6 +37,7 @@ public function setUp(): void
         $this->mockFlashMessengerHelper = m::mock(FlashMessengerHelperService::class)->makePartial();
         $this->mockTableFactory = m::mock(TableFactory::class)->makePartial();
         $this->mockFormHelperService = m::mock(FormHelperService::class)->makePartial();
+        $this->mockNavigation = m::mock(Navigation::class)->shouldIgnoreMissing();
         $this->mockForm = m::mock(Form::class);
         $this->mockParams = m::mock(Params::class);
 
@@ -49,6 +51,7 @@ public function setUp(): void
         $this->setMockedProperties($reflectionClass, 'flashMessengerHelper', $this->mockFlashMessengerHelper);
         $this->setMockedProperties($reflectionClass, 'tableFactory', $this->mockTableFactory);
         $this->setMockedProperties($reflectionClass, 'formHelperService', $this->mockFormHelperService);
+        $this->setMockedProperties($reflectionClass, 'navigationService', $this->mockNavigation);
 
         $this->mockFormHelperService->shouldReceive('createForm')
                                     ->once()
@@ -120,6 +123,10 @@ public function testViewAction(): void
                                )
                                ->andReturn($table);
 
+        $this->mockNavigation
+            ->shouldReceive('findBy->setActive')
+            ->once();
+
         $view = $this->sut->viewAction();
         $this->assertInstanceOf(ViewModel::class, $view);
         $this->assertEquals($table, $view->getVariable('table'));