Surfnet\StepupSelfService\SelfServiceBundle\Service\IdentityService

Complexity

Total Complexity

16

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	updateIdentity()	0	7	1
A	switchLocale()	0	23	3
A	loadUserByIdentifier()	0	3	1
A	processCommand()	0	18	3
A	supportsClass()	0	3	1
A	__construct()	0	6	1
A	createIdentity()	0	11	1
A	refreshUser()	0	3	1
A	findByNameIdAndInstitution()	0	26	4

<?php

declare(strict_types = 1);

/**
 * Copyright 2014 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.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Surfnet\StepupSelfService\SelfServiceBundle\Service;

use Exception;
use Psr\Log\LoggerInterface;
use Surfnet\StepupBundle\Command\SwitchLocaleCommand;
use Surfnet\StepupMiddlewareClient\Identity\Dto\IdentitySearchQuery;
use Surfnet\StepupMiddlewareClientBundle\Command\Command;
use Surfnet\StepupMiddlewareClientBundle\Identity\Command\CreateIdentityCommand;
use Surfnet\StepupMiddlewareClientBundle\Identity\Command\ExpressLocalePreferenceCommand;
use Surfnet\StepupMiddlewareClientBundle\Identity\Command\UpdateIdentityCommand;
use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\Identity;
use Surfnet\StepupMiddlewareClientBundle\Identity\Service\IdentityService as ApiIdentityService;
use Surfnet\StepupSelfService\SelfServiceBundle\Exception\RuntimeException;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Core\User\UserProviderInterface;

/**

Missing short description in doc comment

 * @SuppressWarnings(PHPMD.CouplingBetweenObjects) -- Hard to reduce due to different commands and queries used.
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

readonly class IdentityService implements UserProviderInterface
{
    public function __construct(

Missing doc comment for function __construct()

        private ApiIdentityService $apiIdentityService,
        private CommandService $commandService,
        private TokenStorageInterface $tokenStorage,
        private LoggerInterface $logger,
    ) {
    }

    /**

Parameter $identifier should have a doc-comment as per coding-style.

     * For now this functionality is disabled, unsure if actually needed.
     * If needed, the userIdentifier is the UUID
     * of the identity, so it can be fetched rather easy
     */

Missing @return tag in function comment

    public function loadUserByIdentifier(string $identifier): UserInterface
    {
        throw new RuntimeException(sprintf('Cannot Load User By Identifier "%s"', $identifier));
    }

    /**

Parameter $user should have a doc-comment as per coding-style.

     * For now this functionality is disabled, unsure if actually needed
     */

Missing @return tag in function comment

    public function refreshUser(UserInterface $user): void
    {
        throw new RuntimeException(sprintf('Cannot Refresh User "%s"', $user->getUsername()));

The method getUsername() does not exist on Symfony\Component\Security\Core\User\UserInterface. It seems like you code against a sub-type of Symfony\Component\Security\Core\User\UserInterface such as Surfnet\StepupSelfService\SelfServiceBundle\Security\Authentication\AuthenticatedIdentity.

    }

    public function supportsClass(string $class): bool

Missing doc comment for function supportsClass()

    {
        return $class === Identity::class;
    }

    /**

Missing short description in doc comment

Parameter $nameId should have a doc-comment as per coding-style.

Parameter $institution should have a doc-comment as per coding-style.

     * @throws RuntimeException
     */

Missing @return tag in function comment

    public function findByNameIdAndInstitution(string $nameId, string $institution): ?Identity
    {
        $searchQuery = new IdentitySearchQuery();
        $searchQuery->setNameId($nameId);
        $searchQuery->setInstitution($institution);

        try {
            $result = $this->apiIdentityService->search($searchQuery);
        } catch (Exception $e) {
            $message = sprintf('Exception when searching identity: "%s"', $e->getMessage());
            $this->logger->critical($message);
            throw new RuntimeException($message, 0, $e);
        }

        $elements = $result->getElements();
        if ($elements === []) {
            return null;
        }

        if (count($elements) === 1) {
            return reset($elements);
        }

        throw new RuntimeException(sprintf(

The opening parenthesis of a multi-line function call should be the last content on the line.

            'Got an unexpected amount of identities, expected 0 or 1, got "%d"',
            count($elements)
        ));

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**

Parameter $identity should have a doc-comment as per coding-style.

     * Save or Update an existing Identity
     */

Missing @return tag in function comment

    public function createIdentity(Identity $identity): void
    {
        $command = new CreateIdentityCommand();
        $command->id              = $identity->id;
        $command->nameId          = $identity->nameId;
        $command->institution     = $identity->institution;
        $command->email           = $identity->email;
        $command->commonName      = $identity->commonName;
        $command->preferredLocale = $identity->preferredLocale;

        $this->processCommand($command);
    }

    public function updateIdentity(Identity $identity): void

Missing doc comment for function updateIdentity()

    {
        $command = new UpdateIdentityCommand($identity->id, $identity->institution);

It seems like $identity->id can also be of type null; however, parameter $id of Surfnet\StepupMiddlewareClientBundle\Identity\Command\UpdateIdentityCommand::__construct() does only seem to accept string, maybe add an additional type check?

        $command->email      = $identity->email;
        $command->commonName = $identity->commonName;

        $this->processCommand($command);
    }

    public function switchLocale(SwitchLocaleCommand $command): bool

Missing doc comment for function switchLocale()

    {
        /** @var TokenInterface|null */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $token = $this->tokenStorage->getToken();

        if ($token === null) {
            throw new RuntimeException('Cannot switch locales when unauthenticated');
        }

        /** @var Identity $identity */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $identity = $token->getUser()->getIdentity();

The method getIdentity() does not exist on Symfony\Component\Security\Core\User\UserInterface. It seems like you code against a sub-type of Symfony\Component\Security\Core\User\UserInterface such as Surfnet\StepupSelfService\SelfServiceBundle\Security\Authentication\AuthenticatedIdentity.

        $expressLocalePreferenceCommand = new ExpressLocalePreferenceCommand();
        $expressLocalePreferenceCommand->identityId = $command->identityId;
        $expressLocalePreferenceCommand->preferredLocale = $command->locale;

        $result = $this->commandService->execute($expressLocalePreferenceCommand);

        if ($result->isSuccessful()) {
            $identity->preferredLocale = $command->locale;
        }

        return $result->isSuccessful();
    }

    public function processCommand(Command $command): void

Missing doc comment for function processCommand()

    {
        $messageTemplate = 'Exception when saving Identity "%s": with command "%s", error: "%s"';

        try {
            $result = $this->commandService->execute($command);
        } catch (Exception $e) {
            $message = sprintf($messageTemplate, $command->id, $command::class, $e->getMessage());

Accessing id on the interface Surfnet\StepupMiddlewareClientBundle\Command\Command suggest that you code against a concrete implementation. How about adding an instanceof check?

            $this->logger->critical($message);

            throw new RuntimeException($message, 0, $e);
        }

        if (!$result->isSuccessful()) {
            $note = sprintf($messageTemplate, $command->id, $command::class, implode('", "', $result->getErrors()));
            $this->logger->critical($note);

            throw new RuntimeException($note);
        }
    }
}