feat: VOL-5664 welcome page now appears for external users to agree t…

…erms and conditions

app/api/module/Api/config/command-map.config.php

@@ -375,6 +375,7 @@
     TransferCommand\User\DeletePartner::class => CommandHandler\User\DeletePartner::class,
     TransferCommand\User\UpdateUserLastLoginAt::class => CommandHandler\User\UpdateUserLastLoginAt::class,
     TransferCommand\User\RegisterConsultantAndOperator::class => CommandHandler\User\RegisterConsultantAndOperator::class,
+    TransferCommand\User\AgreeTerms::class => CommandHandler\User\AgreeTerms::class,
 
     // Transfer - Team
     TransferCommand\Team\CreateTeam::class => CommandHandler\Team\CreateTeam::class,

app/api/module/Api/config/validation-map/user.config.php

@@ -41,4 +41,5 @@
     CommandHandler\User\UpdateUserSelfserve::class                              => CanManageUser::class,
     CommandHandler\User\UpdateUserSelfserveFactory::class                       => CanManageUser::class,
     CommandHandler\User\UpdateUserLastLoginAt::class                            => NotIsAnonymousUser::class,
+    CommandHandler\User\AgreeTerms::class                                       => IsExternalUser::class,
 ];

app/api/module/Api/src/Domain/CommandHandler/User/AgreeTerms.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dvsa\Olcs\Api\Domain\CommandHandler\User;
+
+use Dvsa\Olcs\Api\Domain\AuthAwareInterface;
+use Dvsa\Olcs\Api\Domain\AuthAwareTrait;
+use Dvsa\Olcs\Api\Domain\CacheAwareInterface;
+use Dvsa\Olcs\Api\Domain\CacheAwareTrait;
+use Dvsa\Olcs\Api\Domain\CommandHandler\AbstractCommandHandler;
+use Dvsa\Olcs\Api\Domain\Repository\User as UserRepository;
+use Dvsa\Olcs\Api\Entity\User\User;
+use Dvsa\Olcs\Transfer\Command\CommandInterface;
+
+final class AgreeTerms extends AbstractCommandHandler implements AuthAwareInterface, CacheAwareInterface
+{
+    use AuthAwareTrait;
+    use CacheAwareTrait;
+
+    public const SUCCESS_MSG = 'Terms and conditions accepted';
+
+    protected $repoServiceName = 'User';
+
+    public function handleCommand(CommandInterface $command)
+    {
+        $userId = $this->getCurrentUser()->getId();
+
+        /**
+         * @var UserRepository $repo
+         * @var User           $user
+         */
+        $repo = $this->getRepo();
+
+        $user = $repo->fetchById($userId);
+        $user->agreeTermsAndConditions();
+        $repo->save($user);
+
+        $this->clearUserCaches([$userId]);
+
+        $this->result->addId('User', $userId);
+        $this->result->addMessage(self::SUCCESS_MSG);
+
+        return $this->result;
+    }
+}

app/api/module/Api/src/Domain/CommandHandler/User/RegisterConsultantAndOperator.php

@@ -10,6 +10,7 @@
 use Dvsa\Olcs\Api\Domain\CommandHandler\AbstractUserCommandHandler;
 use Dvsa\Olcs\Api\Domain\CommandHandler\TransactionedInterface;
 use Dvsa\Olcs\Api\Entity\User\Role as RoleEntity;
+use Dvsa\Olcs\Api\Entity\User\User as UserEntity;
 use Dvsa\Olcs\Transfer\Command\CommandInterface;
 use Dvsa\Olcs\Transfer\Command\User\RegisterUserSelfserve as RegisterUserSelfServeCommand;
 
@@ -32,10 +33,19 @@ public function handleCommand(CommandInterface $command)
 
         $this->result->merge($this->handleSideEffect(RegisterUserSelfServeCommand::create($consultantDetails)));
 
-        // Get the new consultant user entity and set the correct role.
+        /**
+         * Get the new consultant user entity and set the correct role
+         *
+         * @var UserEntity $consultantUser
+         * @var RoleEntity $operatorTcRole
+         */
         $consultantUser = $this->getRepo()->fetchById($this->result->getId('user'));
         $operatorTcRole = $this->getRepo('Role')->fetchByRole(RoleEntity::ROLE_OPERATOR_TC);
         $consultantUser->setRoles(new ArrayCollection([$operatorTcRole]));
+
+        //the consultant has already accepted terms and conditions
+        $consultantUser->agreeTermsAndConditions();
+
         $this->getRepo()->save($consultantUser);
         return $this->result;
     }

app/api/module/Api/src/Domain/QueryHandler/MyAccount/MyAccount.php

@@ -95,6 +95,7 @@ public function handleQuery(QueryInterface $query)
         $result = $this->result(
             $user,
             [
+                'termsAgreed',
                 'team',
                 'transportManager',
                 'partnerContactDetails',

app/api/module/Api/src/Entity/User/AbstractUser.php

@@ -205,6 +205,15 @@ abstract class AbstractUser implements BundleSerializableInterface, JsonSerializ
      */
     protected $translateToWelsh = 0;
 
+    /**
+     * Terms agreed
+     *
+     * @var boolean
+     *
+     * @ORM\Column(type="boolean", name="terms_agreed", nullable=false, options={"default": 0})
+     */
+    protected $termsAgreed = 0;
+
     /**
      * Transport manager
      *
@@ -303,6 +312,30 @@ public function getAccountDisabled()
         return $this->accountDisabled;
     }
 
+    /**
+     * Set the terms agreed
+     *
+     * @param boolean $termsAgreed new value being set
+     *
+     * @return User
+     */
+    public function setTermsAgreed($termsAgreed)
+    {
+        $this->termsAgreed = $termsAgreed;
+
+        return $this;
+    }
+
+    /**
+     * Get the terms agreed
+     *
+     * @return boolean
+     */
+    public function getTermsAgreed()
+    {
+        return $this->termsAgreed;
+    }
+
     /**
      * Set the contact details
      *

app/api/module/Api/src/Entity/User/User.php

@@ -765,4 +765,16 @@ public function canResetPassword(): bool
         //disabled users can't reset
         return !$this->isDisabled();
     }
+
+    public function agreeTermsAndConditions(): User
+    {
+        $this->termsAgreed = true;
+
+        return $this;
+    }
+
+    public function hasAgreedTermsAndConditions(): bool
+    {
+        return $this->termsAgreed;
+    }
 }

app/api/test/module/Api/src/Domain/CommandHandler/User/AgreeTermsTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dvsa\OlcsTest\Api\Domain\CommandHandler\User;
+
+use Dvsa\Olcs\Api\Domain\Repository\User as UserRepository;
+use Dvsa\Olcs\Api\Entity\User\User as UserEntity;
+use Dvsa\Olcs\Transfer\Command\User\AgreeTerms as Cmd;
+use Dvsa\Olcs\Transfer\Service\CacheEncryption;
+use Dvsa\OlcsTest\Api\Domain\CommandHandler\AbstractCommandHandlerTestCase;
+use Dvsa\Olcs\Api\Domain\CommandHandler\User\AgreeTerms;
+use LmcRbacMvc\Service\AuthorizationService;
+use Mockery as m;
+
+class AgreeTermsTest extends AbstractCommandHandlerTestCase
+{
+    public function setUp(): void
+    {
+        $this->sut = new AgreeTerms();
+        $this->mockRepo('User', UserRepository::class);
+
+        $this->mockedSmServices = [
+            AuthorizationService::class => m::mock(AuthorizationService::class),
+            CacheEncryption::class => m::mock(CacheEncryption::class),
+        ];
+
+        parent::setUp();
+    }
+
+    public function testHandleCommand()
+    {
+        $userId = 999;
+
+        $command = Cmd::create([]);
+
+        $loggedInUser = m::mock(UserEntity::class);
+        $loggedInUser->expects('getId')->andReturn($userId);
+
+        $this->mockedSmServices[AuthorizationService::class]->expects('getIdentity->getUser')
+            ->andReturn($loggedInUser);
+
+        $this->mockedSmServices[CacheEncryption::class]->expects('removeCustomItems')
+            ->with(CacheEncryption::USER_ACCOUNT_IDENTIFIER, [$userId]);
+
+        $userFromRepo = m::mock(UserEntity::class);
+        $userFromRepo->expects('agreeTermsAndConditions')->withNoArgs();
+
+        $this->repoMap['User']->expects('fetchById')->with($userId)->andReturn($userFromRepo);
+        $this->repoMap['User']->expects('save')->with($userFromRepo);
+
+        $expectedResult = [
+            'id' => [
+                'User' => $userId,
+            ],
+            'messages' => [
+                0 => AgreeTerms::SUCCESS_MSG
+            ],
+        ];
+
+        $this->assertEquals($expectedResult, $this->sut->handleCommand($command)->toArray());
+    }
+}

app/api/test/module/Api/src/Domain/CommandHandler/User/RegisterConsultantAndOperatorTest.php

@@ -70,6 +70,8 @@ public function testHandleCommand()
             ->once()
             ->andReturnSelf();
 
+        $consultant->expects('agreeTermsAndConditions')->withNoArgs();
+
         $this->repoMap['User']->shouldReceive('save')->with($consultant);
 
         $mockRole = m::mock(Role::class);

app/api/test/module/Api/src/Entity/User/UserEntityTest.php

@@ -1409,4 +1409,12 @@ public function dpOperatorAdminRoles(): array
             [RoleEntity::ROLE_OPERATOR_TC],
         ];
     }
+
+    public function testAgreeTermsAndConditions(): void
+    {
+        $user = new Entity('pid', Entity::USER_TYPE_OPERATOR);
+        $this->assertFalse($user->hasAgreedTermsAndConditions());
+        $user->agreeTermsAndConditions();
+        $this->assertTrue($user->hasAgreedTermsAndConditions());
+    }
 }

app/selfserve/module/Olcs/config/module.config.php

@@ -45,6 +45,7 @@
 use Olcs\Controller\SessionTimeoutController;
 use Olcs\Controller\UserForgotUsernameController;
 use Olcs\Controller\UserRegistrationController;
+use Olcs\Controller\WelcomeController;
 use Olcs\Form\Element\SearchDateRangeFieldset;
 use Olcs\Form\Element\SearchDateRangeFieldsetFactory;
 use Olcs\Form\Element\SearchFilterFieldset;
@@ -108,6 +109,16 @@
             ]
         ]
     ],
+    'welcome' => [
+        'type' => Segment::class,
+        'options' =>  [
+            'route' => '/welcome[/]',
+            'defaults' => [
+                'controller' => WelcomeController::class,
+                'action' => 'generic',
+            ],
+        ],
+    ],
     'cookies' => [
         'type' => 'segment',
         'options' =>  [
@@ -1412,6 +1423,7 @@
             \Olcs\Controller\Licence\Vehicle\Reprint\ReprintLicenceVehicleDiscConfirmationController::class => \Olcs\Controller\Licence\Vehicle\Reprint\ReprintLicenceVehicleDiscConfirmationControllerFactory::class,
             Olcs\Controller\ConversationsController::class                                                  => Olcs\Controller\Factory\ConversationsControllerFactory::class,
             PromptController::class                                                                         => \Olcs\Controller\PromptControllerFactory::class,
+            WelcomeController::class                                                                         => \Olcs\Controller\WelcomeControllerFactory::class,
             // Process Signature from GOV.UK Account
             \Olcs\Controller\SignatureVerificationController::class                                         => \Olcs\Controller\SignatureVerificationControllerFactory::class,
             // LVA Controller Factories

app/selfserve/module/Olcs/src/Controller/Auth/LoginController.php

@@ -189,6 +189,10 @@ protected function attemptAuthentication(Request $request): Result
 
     private function handleSuccessfulAuthentication(Request $request): Response
     {
+        if (!$this->currentUser->getIdentity()->getUserData()['termsAgreed']) {
+            return $this->redirectHelper->toRoute(static::ROUTE_INDEX);
+        }
+
         $gotoUrl = $request->getQuery('goto');
 
         if (empty($gotoUrl)) {

app/selfserve/module/Olcs/src/Controller/IndexController.php

@@ -32,6 +32,10 @@ public function indexAction()
             throw new \Exception('Unable to retrieve identity');
         }
 
+        if (!$identity->getUserData()['termsAgreed']) {
+            return $this->redirect()->toRoute('welcome', [], ['code' => 303]);
+        }
+
         // redir to the dashboard
         if ($this->isGranted(RefData::PERMISSION_SELFSERVE_DASHBOARD)) {
             if ($identity->getUserData()['eligibleForPrompt']) {

app/selfserve/module/Olcs/src/Controller/WelcomeController.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Olcs\Controller;
+
+use Common\Service\Helper\FormHelperService;
+use Common\Service\Helper\TranslationHelperService;
+use Common\Service\Table\TableFactory;
+use Dvsa\Olcs\Transfer\Command\User\AgreeTerms as AgreeTermsCmd;
+use Laminas\Http\Response;
+use Olcs\Form\Model\Form\AgreeTerms as AgreeTermsForm;
+use Permits\Data\Mapper\MapperManager;
+
+class WelcomeController extends AbstractSelfserveController
+{
+    protected $templateConfig = [
+        'generic' => 'pages/welcome',
+    ];
+
+    protected $formConfig = [
+        'generic' => [
+            'confirmationForm' => [
+                'formClass' => AgreeTermsForm::class
+            ]
+        ]
+    ];
+
+    protected $postConfig = [
+        'generic' => [
+            'command' => AgreeTermsCmd::class,
+            'step' => 'index',
+            'saveAndReturnStep' => 'index',
+        ],
+    ];
+
+    public function __construct(
+        TranslationHelperService $translationHelper,
+        FormHelperService $formHelper,
+        TableFactory $tableBuilder,
+        MapperManager $mapperManager
+    ) {
+        parent::__construct($translationHelper, $formHelper, $tableBuilder, $mapperManager);
+    }
+
+    /**
+     * @return Response|void
+     */
+    public function checkConditionalDisplay()
+    {
+        if (isset($this->postParams['form-actions']['signOut'])) {
+            return $this->conditionalDisplayNotMet('auth/logout');
+        }
+
+        if ($this->currentUser()->getUserData()['termsAgreed'] === true) {
+            return $this->conditionalDisplayNotMet('index');
+        }
+    }
+}

app/selfserve/module/Olcs/src/Controller/WelcomeControllerFactory.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Olcs\Controller;
+
+use Common\Service\Helper\FormHelperService;
+use Common\Service\Helper\TranslationHelperService;
+use Common\Service\Table\TableFactory;
+use Psr\Container\ContainerInterface;
+use Laminas\ServiceManager\Factory\FactoryInterface;
+use Permits\Data\Mapper\MapperManager;
+
+class WelcomeControllerFactory implements FactoryInterface
+{
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null): WelcomeController
+    {
+        $translationHelper = $container->get(TranslationHelperService::class);
+        $formHelper = $container->get(FormHelperService::class);
+        $tableBuilder = $container->get(TableFactory::class);
+        $mapperManager = $container->get(MapperManager::class);
+        return new WelcomeController($translationHelper, $formHelper, $tableBuilder, $mapperManager);
+    }
+}