ReplayEventsCommand::configure() - Code Metrics - Inspection of "Feature/component info" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#312)

unknown

created 2020-09-17 12:16 UTC

ReplayEventsCommand::configure() A

↳ Parent: ReplayEventsCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

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

namespace Surfnet\StepupMiddleware\MiddlewareBundle\Console\Command;

use Surfnet\StepupMiddleware\MiddlewareBundle\Service\EventStreamReplayer;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\FormatterHelper;
use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\HttpKernel\KernelInterface;

class ReplayEventsCommand extends Command
{
    /**
     * @var EventStreamReplayer
     */
    private $replayer;

    public function __construct(EventStreamReplayer $eventStreamReplayer)
    {
        parent::__construct();
        $this->replayer = $eventStreamReplayer;
    }

    protected function configure()
    {
        $this
            ->setName('middleware:event:replay')
            ->setDescription(
                'Wipes all read models and repopulates the tables from the event store. Use the 
                --no-interaction option to perform the event replay without the additional confirmation question.'
            )
            ->addOption(
                'increments',
                'i',
                InputOption::VALUE_REQUIRED,
                'The amount of events that are replayed at once (repeated until all events are replayed)',
                1000
            );
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        /** @var KernelInterface $kernel */
        $kernel = $this->getApplication()->getKernel();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        $environment = $kernel->getEnvironment();
        /** @var FormatterHelper $formatter */
        $formatter = $this->getHelper('formatter');

        // Be careful, when using the no-interaction option you will not get the confirmation question
        $noInteraction = $input->getOption('no-interaction');

        if (!in_array($environment, ['dev_event_replay', 'prod_event_replay', 'smoketest_event_replay'])) {
            $output->writeln($formatter->formatBlock(
                [
                    '',
                    'This command may only be executed using env "dev_event_replay", "prod_event_replay", or 
                    "smoketest_event_replay"',
                    ''
                ],
                'error'
            ));

            return;
        }

        /** @var QuestionHelper $interrogator */
        $interrogator = $this->getHelper('question');
        if ($environment === 'prod_event_replay') {
            $wantToRunOnProd = new ConfirmationQuestion(
                '<question>You have selected to run this on production. Have you disabled all access to the production '
                .'environment? (y/N)</question>',
                false
            );

            if (!$interrogator->ask($input, $output, $wantToRunOnProd)) {
                $output->writeln('<comment>Not starting the replay</comment>');

                return;
            }
        }

        $increments = (int)$input->getOption('increments');
        if ($increments < 1) {
            $output->writeln(
                $formatter->formatBlock(
                    sprintf('Increments must be a positive integer, "%s" given', $input->getOption('increments')),
                    'error'
                )
            );

            return;
        }

        if (!$noInteraction) {
            $output->writeln(['', $formatter->formatBlock(['', 'WARNING!!!!', ''], 'error'), '']);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

            $question = <<<QUESTION
You are about to WIPE all read data and recreate all data based on the events present, in steps of %d.

  <%s>>> This can take a while and should not be interrupted <<</%s>

Are you sure you wish to continue? (y/N)
QUESTION;

            $question = sprintf($question, $increments, 'error', 'error');
            $areYouSure = new ConfirmationQuestion(sprintf("<question>%s</question>\n", $question), false);
            if (!$interrogator->ask($input, $output, $areYouSure)) {
                $output->writeln('<comment>Replay cancelled!</comment>');

                return;
            }
        }

        $output->writeln(['', $formatter->formatBlock('Starting Event Replay', 'info')]);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $output->writeln(
            $formatter->formatBlock(' >> If it is interrupted it must be rerun till completed', 'comment')
        );

        $this->replayer->replayEvents($output, $increments);
    }
}


1			<?php
2
3			/**
4			* Copyright 2014 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 Surfnet\StepupMiddleware\MiddlewareBundle\Service\EventStreamReplayer;
22			use Symfony\Component\Console\Command\Command;
23			use Symfony\Component\Console\Helper\FormatterHelper;
24			use Symfony\Component\Console\Helper\QuestionHelper;
25			use Symfony\Component\Console\Input\InputInterface;
26			use Symfony\Component\Console\Input\InputOption;
27			use Symfony\Component\Console\Output\OutputInterface;
28			use Symfony\Component\Console\Question\ConfirmationQuestion;
29			use Symfony\Component\HttpKernel\KernelInterface;
30
31			class ReplayEventsCommand extends Command
32			{
33			/**
34			* @var EventStreamReplayer
35			*/
36			private $replayer;
37
38			public function __construct(EventStreamReplayer $eventStreamReplayer)
39			{
40			parent::__construct();
41			$this->replayer = $eventStreamReplayer;
42			}
43
44			protected function configure()
45			{
46			$this
47			->setName('middleware:event:replay')
48			->setDescription(
49			'Wipes all read models and repopulates the tables from the event store. Use the
50			--no-interaction option to perform the event replay without the additional confirmation question.'
51			)
52			->addOption(
53			'increments',
54			'i',
55			InputOption::VALUE_REQUIRED,
56			'The amount of events that are replayed at once (repeated until all events are replayed)',
57			1000
58			);
59			}
60
61			protected function execute(InputInterface $input, OutputInterface $output)
62			{
63			/** @var KernelInterface $kernel */
64			$kernel = $this->getApplication()->getKernel();
			0 ignored issues – show Bug introduced 2015-12-15 13:40 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Console\Application` as the method `getKernel()` does only exist in the following sub-classes of `Symfony\Component\Console\Application`: `Symfony\Bundle\FrameworkBundle\Console\Application`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
65			$environment = $kernel->getEnvironment();
66			/** @var FormatterHelper $formatter */
67			$formatter = $this->getHelper('formatter');
68
69			// Be careful, when using the no-interaction option you will not get the confirmation question
70			$noInteraction = $input->getOption('no-interaction');
71
72			if (!in_array($environment, ['dev_event_replay', 'prod_event_replay', 'smoketest_event_replay'])) {
73			$output->writeln($formatter->formatBlock(
74			[
75			'',
76			'This command may only be executed using env "dev_event_replay", "prod_event_replay", or
77			"smoketest_event_replay"',
78			''
79			],
80			'error'
81			));
82
83			return;
84			}
85
86			/** @var QuestionHelper $interrogator */
87			$interrogator = $this->getHelper('question');
88			if ($environment === 'prod_event_replay') {
89			$wantToRunOnProd = new ConfirmationQuestion(
90			'<question>You have selected to run this on production. Have you disabled all access to the production '
91			.'environment? (y/N)</question>',
92			false
93			);
94
95			if (!$interrogator->ask($input, $output, $wantToRunOnProd)) {
96			$output->writeln('<comment>Not starting the replay</comment>');
97
98			return;
99			}
100			}
101
102			$increments = (int)$input->getOption('increments');
103			if ($increments < 1) {
104			$output->writeln(
105			$formatter->formatBlock(
106			sprintf('Increments must be a positive integer, "%s" given', $input->getOption('increments')),
107			'error'
108			)
109			);
110
111			return;
112			}
113
114			if (!$noInteraction) {
115			$output->writeln(['', $formatter->formatBlock(['', 'WARNING!!!!', ''], 'error'), '']);
			0 ignored issues – show Documentation introduced 2020-06-09 16:17 UTC by Report Bug Copy Issue Report `array('', $formatter->fo...!!', ''), 'error'), '')` is of type `array<integer,string,{"0..."string","2":"string"}>`, but the function expects a `string\|object<Symfony\Co...onsole\Output\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
116
117			$question = <<<QUESTION
118			You are about to WIPE all read data and recreate all data based on the events present, in steps of %d.
119
120			<%s>>> This can take a while and should not be interrupted <<</%s>
121
122			Are you sure you wish to continue? (y/N)
123			QUESTION;
124
125			$question = sprintf($question, $increments, 'error', 'error');
126			$areYouSure = new ConfirmationQuestion(sprintf("<question>%s</question>\n", $question), false);
127			if (!$interrogator->ask($input, $output, $areYouSure)) {
128			$output->writeln('<comment>Replay cancelled!</comment>');
129
130			return;
131			}
132			}
133
134			$output->writeln(['', $formatter->formatBlock('Starting Event Replay', 'info')]);
			0 ignored issues – show Documentation introduced 2020-06-09 16:17 UTC by Report Bug Copy Issue Report `array('', $formatter->fo...Event Replay', 'info'))` is of type `array<integer,string,{"0":"string","1":"string"}>`, but the function expects a `string\|object<Symfony\Co...onsole\Output\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
135			$output->writeln(
136			$formatter->formatBlock(' >> If it is interrupted it must be rerun till completed', 'comment')
137			);
138
139			$this->replayer->replayEvents($output, $increments);
140			}
141			}
142

OpenConext / Stepup-Middleware

Pull Request — develop (#312)

ReplayEventsCommand::configure() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like