AbstractBootstrapCommand::rollback() - Code Metrics - Inspection of "Add bootstrap SMS console command" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#302)

by Michiel

created 2020-04-20 12:01 UTC

AbstractBootstrapCommand::rollback() A

↳ Parent: AbstractBootstrapCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/**
 * Copyright 2020 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupMiddleware\MiddlewareBundle\Console\Command;

use Broadway\EventHandling\EventBusInterface;
use Rhumsaa\Uuid\Uuid;
use Surfnet\Stepup\Configuration\Value\Institution;
use Surfnet\StepupMiddleware\ApiBundle\Configuration\Repository\InstitutionConfigurationOptionsRepository;
use Surfnet\StepupMiddleware\ApiBundle\Identity\Repository\IdentityRepository;
use Surfnet\StepupMiddleware\ApiBundle\Identity\Repository\UnverifiedSecondFactorRepository;
use Surfnet\StepupMiddleware\ApiBundle\Identity\Repository\VerifiedSecondFactorRepository;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Command as MiddlewareCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Identity\Command\VetSecondFactorCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Pipeline\Pipeline;
use Surfnet\StepupMiddleware\MiddlewareBundle\Service\DBALConnectionHelper;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;

abstract class AbstractBootstrapCommand extends Command
{
    /** @var Pipeline  */
    private $pipeline;
    /** @var EventBusInterface  */
    private $eventBus;
    /** @var DBALConnectionHelper  */
    private $connection;
    /** @var IdentityRepository  */
    protected $identityRepository;
    /** @var UnverifiedSecondFactorRepository  */
    protected $unverifiedSecondFactorRepository;
    /** @var VerifiedSecondFactorRepository */
    protected $verifiedSecondFactorRepository;
    /** @var InstitutionConfigurationOptionsRepository */
    private $institutionConfigurationRepository;
    /** @var TokenStorageInterface */
    protected $tokenStorage;

    public function __construct(
        Pipeline $pipeline,
        EventBusInterface $eventBus,
        DBALConnectionHelper $connection,
        IdentityRepository $identityRepository,
        UnverifiedSecondFactorRepository $unverifiedSecondFactorRepository,
        VerifiedSecondFactorRepository $verifiedSecondFactorRepository,
        InstitutionConfigurationOptionsRepository $institutionConfigurationOptionsRepository,
        TokenStorageInterface $tokenStorage
    ) {
        $this->pipeline = $pipeline;
        $this->eventBus = $eventBus;
        $this->connection = $connection;
        $this->identityRepository = $identityRepository;
        $this->unverifiedSecondFactorRepository = $unverifiedSecondFactorRepository;
        $this->verifiedSecondFactorRepository = $verifiedSecondFactorRepository;
        $this->institutionConfigurationRepository = $institutionConfigurationOptionsRepository;
        $this->tokenStorage = $tokenStorage;
        parent::__construct();
    }

    protected function beginTransaction()
    {
        $this->connection->beginTransaction();
    }

    protected function finishTransaction()
    {
        $this->eventBus->flush();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $this->connection->commit();
    }

    protected function rollback()
    {
        $this->connection->rollBack();
    }

    protected function process(MiddlewareCommand $command)
    {
        $this->pipeline->process($command);
    }

    protected function requiresMailVerification($institution)
    {
        $configuration = $this->institutionConfigurationRepository->findConfigurationOptionsFor(new Institution($institution));
        if ($configuration) {
            return $configuration->verifyEmailOption->isEnabled();
        }
        return true;
    }

    protected function vetSecondFactor($tokenType, $actorId, $identity, $secondFactorId, $verifiedSecondFactor, $phoneNumber)
    {
        $command = new VetSecondFactorCommand();
        $command->UUID = (string) Uuid::uuid4();
        $command->authorityId = $actorId;
        $command->identityId = $identity->id;
        $command->secondFactorId = $secondFactorId;
        $command->registrationCode = $verifiedSecondFactor->registrationCode;
        $command->secondFactorType = $tokenType;
        $command->secondFactorIdentifier = $phoneNumber;
        $command->documentNumber = '123987';
        $command->identityVerified = true;
        $this->pipeline->process($command);
    }
}


1			<?php
2
3			/**
4			* Copyright 2020 SURFnet bv
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19			namespace Surfnet\StepupMiddleware\MiddlewareBundle\Console\Command;
20
21			use Broadway\EventHandling\EventBusInterface;
22			use Rhumsaa\Uuid\Uuid;
23			use Surfnet\Stepup\Configuration\Value\Institution;
24			use Surfnet\StepupMiddleware\ApiBundle\Configuration\Repository\InstitutionConfigurationOptionsRepository;
25			use Surfnet\StepupMiddleware\ApiBundle\Identity\Repository\IdentityRepository;
26			use Surfnet\StepupMiddleware\ApiBundle\Identity\Repository\UnverifiedSecondFactorRepository;
27			use Surfnet\StepupMiddleware\ApiBundle\Identity\Repository\VerifiedSecondFactorRepository;
28			use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Command as MiddlewareCommand;
29			use Surfnet\StepupMiddleware\CommandHandlingBundle\Identity\Command\VetSecondFactorCommand;
30			use Surfnet\StepupMiddleware\CommandHandlingBundle\Pipeline\Pipeline;
31			use Surfnet\StepupMiddleware\MiddlewareBundle\Service\DBALConnectionHelper;
32			use Symfony\Component\Console\Command\Command;
33			use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
34
35			abstract class AbstractBootstrapCommand extends Command
36			{
37			/** @var Pipeline */
38			private $pipeline;
39			/** @var EventBusInterface */
40			private $eventBus;
41			/** @var DBALConnectionHelper */
42			private $connection;
43			/** @var IdentityRepository */
44			protected $identityRepository;
45			/** @var UnverifiedSecondFactorRepository */
46			protected $unverifiedSecondFactorRepository;
47			/** @var VerifiedSecondFactorRepository */
48			protected $verifiedSecondFactorRepository;
49			/** @var InstitutionConfigurationOptionsRepository */
50			private $institutionConfigurationRepository;
51			/** @var TokenStorageInterface */
52			protected $tokenStorage;
53
54			public function __construct(
55			Pipeline $pipeline,
56			EventBusInterface $eventBus,
57			DBALConnectionHelper $connection,
58			IdentityRepository $identityRepository,
59			UnverifiedSecondFactorRepository $unverifiedSecondFactorRepository,
60			VerifiedSecondFactorRepository $verifiedSecondFactorRepository,
61			InstitutionConfigurationOptionsRepository $institutionConfigurationOptionsRepository,
62			TokenStorageInterface $tokenStorage
63			) {
64			$this->pipeline = $pipeline;
65			$this->eventBus = $eventBus;
66			$this->connection = $connection;
67			$this->identityRepository = $identityRepository;
68			$this->unverifiedSecondFactorRepository = $unverifiedSecondFactorRepository;
69			$this->verifiedSecondFactorRepository = $verifiedSecondFactorRepository;
70			$this->institutionConfigurationRepository = $institutionConfigurationOptionsRepository;
71			$this->tokenStorage = $tokenStorage;
72			parent::__construct();
73			}
74
75			protected function beginTransaction()
76			{
77			$this->connection->beginTransaction();
78			}
79
80			protected function finishTransaction()
81			{
82			$this->eventBus->flush();
			0 ignored issues – show Bug introduced 2020-04-20 06:58 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Broadway\EventHandling\EventBusInterface` as the method `flush()` does only exist in the following implementations of said interface: `Surfnet\StepupMiddleware...ndling\BufferedEventBus`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
83			$this->connection->commit();
84			}
85
86			protected function rollback()
87			{
88			$this->connection->rollBack();
89			}
90
91			protected function process(MiddlewareCommand $command)
92			{
93			$this->pipeline->process($command);
94			}
95
96			protected function requiresMailVerification($institution)
97			{
98			$configuration = $this->institutionConfigurationRepository->findConfigurationOptionsFor(new Institution($institution));
99			if ($configuration) {
100			return $configuration->verifyEmailOption->isEnabled();
101			}
102			return true;
103			}
104
105			protected function vetSecondFactor($tokenType, $actorId, $identity, $secondFactorId, $verifiedSecondFactor, $phoneNumber)
106			{
107			$command = new VetSecondFactorCommand();
108			$command->UUID = (string) Uuid::uuid4();
109			$command->authorityId = $actorId;
110			$command->identityId = $identity->id;
111			$command->secondFactorId = $secondFactorId;
112			$command->registrationCode = $verifiedSecondFactor->registrationCode;
113			$command->secondFactorType = $tokenType;
114			$command->secondFactorIdentifier = $phoneNumber;
115			$command->documentNumber = '123987';
116			$command->identityVerified = true;
117			$this->pipeline->process($command);
118			}
119			}
120

OpenConext / Stepup-Middleware

Pull Request — develop (#302)

AbstractBootstrapCommand::rollback() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like