ConsumerHandlerCommand::getNotificationDispatcher() - Code Metrics - Inspection of "DevKit updates" - sonata-project/SonataNotificationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.x-dev-kit ( 0a4698 )

unknown

created 2016-06-25 00:07 UTC

getNotificationDispatcher() A

↳ Parent: ConsumerHandlerCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

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

<?php

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\NotificationBundle\Command;

use Sonata\NotificationBundle\Backend\BackendInterface;
use Sonata\NotificationBundle\Backend\QueueDispatcherInterface;
use Sonata\NotificationBundle\Consumer\ConsumerInterface;
use Sonata\NotificationBundle\Event\IterateEvent;
use Sonata\NotificationBundle\Exception\HandlingException;
use Sonata\NotificationBundle\Model\MessageInterface;
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

class ConsumerHandlerCommand extends ContainerAwareCommand
{
    /**
     * {@inheritdoc}
     */
    public function configure()
    {
        $this->setName('sonata:notification:start');
        $this->setDescription('Listen for incoming messages');
        $this->addOption('iteration', 'i', InputOption::VALUE_OPTIONAL, 'Only run n iterations before exiting', false);
        $this->addOption('type', null, InputOption::VALUE_OPTIONAL, 'Use a specific backed based on a message type, "all" with doctrine backend will handle all notifications no matter their type', null);
        $this->addOption('show-details', 'd', InputOption::VALUE_OPTIONAL, 'Show consumers return details', true);
    }

    /**
     * {@inheritdoc}
     */
    public function execute(InputInterface $input, OutputInterface $output)
    {
        $startDate = new \DateTime();

        $output->writeln(sprintf('[%s] <info>Checking listeners</info>', $startDate->format('r')));
        foreach ($this->getNotificationDispatcher()->getListeners() as $type => $listeners) {
            $output->writeln(sprintf(' - %s', $type));
            foreach ($listeners as $listener) {
                if (!$listener[0] instanceof ConsumerInterface) {
                    throw new \RuntimeException(sprintf('The registered service does not implement the ConsumerInterface (class=%s', get_class($listener[0])));
                }

                $output->writeln(sprintf('   > %s', get_class($listener[0])));
            }
        }

        $type = $input->getOption('type');
        $showDetails = $input->getOption('show-details');

        $output->write(sprintf('[%s] <info>Retrieving backend</info> ...', $startDate->format('r')));
        $backend = $this->getBackend($type);

        $output->writeln('');
        $output->write(sprintf('[%s] <info>Initialize backend</info> ...', $startDate->format('r')));

        // initialize the backend
        $backend->initialize();

        $output->writeln(' done!');

        if ($type === null) {
            $output->writeln(sprintf('[%s] <info>Starting the backend handler</info> - %s', $startDate->format('r'), get_class($backend)));
        } else {
            $output->writeln(sprintf('[%s] <info>Starting the backend handler</info> - %s (type: %s)', $startDate->format('r'), get_class($backend), $type));
        }

        $startMemoryUsage = memory_get_usage(true);
        $i = 0;
        $iterator = $backend->getIterator();
        foreach ($iterator as $message) {
            ++$i;

            if (!$message instanceof MessageInterface) {
                throw new \RuntimeException('The iterator must return a MessageInterface instance');
            }

            if (!$message->getType()) {
                $output->write('<error>Skipping : no type defined </error>');
                continue;
            }

            $date = new \DateTime();
            $output->write(sprintf('[%s] <info>%s</info> #%s: ', $date->format('r'), $message->getType(), $i));
            $memoryUsage = memory_get_usage(true);

            try {
                $start = microtime(true);
                $returnInfos = $backend->handle($message, $this->getNotificationDispatcher());

                $currentMemory = memory_get_usage(true);

                $output->writeln(sprintf('<comment>OK! </comment> - %0.04fs, %ss, %s, %s - %s = %s, %0.02f%%',
                    microtime(true) - $start,
                    $date->format('U') - $message->getCreatedAt()->format('U'),
                    $this->formatMemory($currentMemory - $memoryUsage),
                    $this->formatMemory($currentMemory),
                    $this->formatMemory($startMemoryUsage),
                    $this->formatMemory($currentMemory - $startMemoryUsage),
                    ($currentMemory - $startMemoryUsage) / $startMemoryUsage * 100
                ));

                if ($showDetails && null !== $returnInfos) {
                    $output->writeln($returnInfos->getReturnMessage());
                }
            } catch (HandlingException $e) {
                $output->writeln(sprintf('<error>KO! - %s</error>', $e->getPrevious()->getMessage()));
            } catch (\Exception $e) {
                $output->writeln(sprintf('<error>KO! - %s</error>', $e->getMessage()));
            }

            $this->getEventDispatcher()->dispatch(IterateEvent::EVENT_NAME, new IterateEvent($iterator, $backend, $message));

            if ($input->getOption('iteration') && $i >= (int) $input->getOption('iteration')) {
                $output->writeln('End of iteration cycle');

                return;
            }
        }
    }

    /**
     * @param string $type
     * @param string $backend
     *
     * @throws \RuntimeException
     */
    protected function throwTypeNotFoundException($type, $backend)
    {
        throw new \RuntimeException("The requested backend for the type '".$type." 'does not exist. \nMake sure the backend '".
                get_class($backend)."' \nsupports multiple queues and the routing_key is defined. (Currently rabbitmq only)");
    }

    /**
     * @param $memory
     *
     * @return string
     */
    private function formatMemory($memory)
    {
        if ($memory < 1024) {
            return $memory.'b';
        } elseif ($memory < 1048576) {
            return round($memory / 1024, 2).'Kb';
        }

        return round($memory / 1048576, 2).'Mb';
    }

    /**
     * @param string $type
     *
     * @return BackendInterface
     */
    private function getBackend($type = null)
    {
        $backend = $this->getContainer()->get('sonata.notification.backend');

        if ($type && !array_key_exists($type, $this->getNotificationDispatcher()->getListeners())) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            throw new \RuntimeException(sprintf('The type `%s` does not exist, available types: %s', $type, implode(', ', array_keys($this->getNotificationDispatcher()->getListeners()))));
        }

        if ($type !== null && !$backend instanceof QueueDispatcherInterface) {
            throw new \RuntimeException(sprintf('Unable to use the provided type %s with a non QueueDispatcherInterface backend', $type));
        }

        if ($backend instanceof QueueDispatcherInterface) {
            return $backend->getBackend($type);
        }

        return $backend;
    }

    /**
     * @return EventDispatcherInterface
     */
    private function getNotificationDispatcher()
    {
        return $this->getContainer()->get('sonata.notification.dispatcher');
    }

    /**
     * @return EventDispatcherInterface
     */
    private function getEventDispatcher()
    {
        return $this->getContainer()->get('event_dispatcher');
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sonata Project package.
5			*
6			* (c) Thomas Rabaix <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Sonata\NotificationBundle\Command;
13
14			use Sonata\NotificationBundle\Backend\BackendInterface;
15			use Sonata\NotificationBundle\Backend\QueueDispatcherInterface;
16			use Sonata\NotificationBundle\Consumer\ConsumerInterface;
17			use Sonata\NotificationBundle\Event\IterateEvent;
18			use Sonata\NotificationBundle\Exception\HandlingException;
19			use Sonata\NotificationBundle\Model\MessageInterface;
20			use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
21			use Symfony\Component\Console\Input\InputInterface;
22			use Symfony\Component\Console\Input\InputOption;
23			use Symfony\Component\Console\Output\OutputInterface;
24
25			class ConsumerHandlerCommand extends ContainerAwareCommand
26			{
27			/**
28			* {@inheritdoc}
29			*/
30			public function configure()
31			{
32			$this->setName('sonata:notification:start');
33			$this->setDescription('Listen for incoming messages');
34			$this->addOption('iteration', 'i', InputOption::VALUE_OPTIONAL, 'Only run n iterations before exiting', false);
35			$this->addOption('type', null, InputOption::VALUE_OPTIONAL, 'Use a specific backed based on a message type, "all" with doctrine backend will handle all notifications no matter their type', null);
36			$this->addOption('show-details', 'd', InputOption::VALUE_OPTIONAL, 'Show consumers return details', true);
37			}
38
39			/**
40			* {@inheritdoc}
41			*/
42			public function execute(InputInterface $input, OutputInterface $output)
43			{
44			$startDate = new \DateTime();
45
46			$output->writeln(sprintf('[%s] <info>Checking listeners</info>', $startDate->format('r')));
47			foreach ($this->getNotificationDispatcher()->getListeners() as $type => $listeners) {
48			$output->writeln(sprintf(' - %s', $type));
49			foreach ($listeners as $listener) {
50			if (!$listener[0] instanceof ConsumerInterface) {
51			throw new \RuntimeException(sprintf('The registered service does not implement the ConsumerInterface (class=%s', get_class($listener[0])));
52			}
53
54			$output->writeln(sprintf(' > %s', get_class($listener[0])));
55			}
56			}
57
58			$type = $input->getOption('type');
59			$showDetails = $input->getOption('show-details');
60
61			$output->write(sprintf('[%s] <info>Retrieving backend</info> ...', $startDate->format('r')));
62			$backend = $this->getBackend($type);
63
64			$output->writeln('');
65			$output->write(sprintf('[%s] <info>Initialize backend</info> ...', $startDate->format('r')));
66
67			// initialize the backend
68			$backend->initialize();
69
70			$output->writeln(' done!');
71
72			if ($type === null) {
73			$output->writeln(sprintf('[%s] <info>Starting the backend handler</info> - %s', $startDate->format('r'), get_class($backend)));
74			} else {
75			$output->writeln(sprintf('[%s] <info>Starting the backend handler</info> - %s (type: %s)', $startDate->format('r'), get_class($backend), $type));
76			}
77
78			$startMemoryUsage = memory_get_usage(true);
79			$i = 0;
80			$iterator = $backend->getIterator();
81			foreach ($iterator as $message) {
82			++$i;
83
84			if (!$message instanceof MessageInterface) {
85			throw new \RuntimeException('The iterator must return a MessageInterface instance');
86			}
87
88			if (!$message->getType()) {
89			$output->write('<error>Skipping : no type defined </error>');
90			continue;
91			}
92
93			$date = new \DateTime();
94			$output->write(sprintf('[%s] <info>%s</info> #%s: ', $date->format('r'), $message->getType(), $i));
95			$memoryUsage = memory_get_usage(true);
96
97			try {
98			$start = microtime(true);
99			$returnInfos = $backend->handle($message, $this->getNotificationDispatcher());
100
101			$currentMemory = memory_get_usage(true);
102
103			$output->writeln(sprintf('<comment>OK! </comment> - %0.04fs, %ss, %s, %s - %s = %s, %0.02f%%',
104			microtime(true) - $start,
105			$date->format('U') - $message->getCreatedAt()->format('U'),
106			$this->formatMemory($currentMemory - $memoryUsage),
107			$this->formatMemory($currentMemory),
108			$this->formatMemory($startMemoryUsage),
109			$this->formatMemory($currentMemory - $startMemoryUsage),
110			($currentMemory - $startMemoryUsage) / $startMemoryUsage * 100
111			));
112
113			if ($showDetails && null !== $returnInfos) {
114			$output->writeln($returnInfos->getReturnMessage());
115			}
116			} catch (HandlingException $e) {
117			$output->writeln(sprintf('<error>KO! - %s</error>', $e->getPrevious()->getMessage()));
118			} catch (\Exception $e) {
119			$output->writeln(sprintf('<error>KO! - %s</error>', $e->getMessage()));
120			}
121
122			$this->getEventDispatcher()->dispatch(IterateEvent::EVENT_NAME, new IterateEvent($iterator, $backend, $message));
123
124			if ($input->getOption('iteration') && $i >= (int) $input->getOption('iteration')) {
125			$output->writeln('End of iteration cycle');
126
127			return;
128			}
129			}
130			}
131
132			/**
133			* @param string $type
134			* @param string $backend
135			*
136			* @throws \RuntimeException
137			*/
138			protected function throwTypeNotFoundException($type, $backend)
139			{
140			throw new \RuntimeException("The requested backend for the type '".$type." 'does not exist. \nMake sure the backend '".
141			get_class($backend)."' \nsupports multiple queues and the routing_key is defined. (Currently rabbitmq only)");
142			}
143
144			/**
145			* @param $memory
146			*
147			* @return string
148			*/
149			private function formatMemory($memory)
150			{
151			if ($memory < 1024) {
152			return $memory.'b';
153			} elseif ($memory < 1048576) {
154			return round($memory / 1024, 2).'Kb';
155			}
156
157			return round($memory / 1048576, 2).'Mb';
158			}
159
160			/**
161			* @param string $type
162			*
163			* @return BackendInterface
164			*/
165			private function getBackend($type = null)
166			{
167			$backend = $this->getContainer()->get('sonata.notification.backend');
168
169			if ($type && !array_key_exists($type, $this->getNotificationDispatcher()->getListeners())) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-22 19:11 UTC by Report Bug Copy Issue Report The expression `$type` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
170			throw new \RuntimeException(sprintf('The type `%s` does not exist, available types: %s', $type, implode(', ', array_keys($this->getNotificationDispatcher()->getListeners()))));
171			}
172
173			if ($type !== null && !$backend instanceof QueueDispatcherInterface) {
174			throw new \RuntimeException(sprintf('Unable to use the provided type %s with a non QueueDispatcherInterface backend', $type));
175			}
176
177			if ($backend instanceof QueueDispatcherInterface) {
178			return $backend->getBackend($type);
179			}
180
181			return $backend;
182			}
183
184			/**
185			* @return EventDispatcherInterface
186			*/
187			private function getNotificationDispatcher()
188			{
189			return $this->getContainer()->get('sonata.notification.dispatcher');
190			}
191
192			/**
193			* @return EventDispatcherInterface
194			*/
195			private function getEventDispatcher()
196			{
197			return $this->getContainer()->get('event_dispatcher');
198			}
199			}
200

sonata-project / SonataNotificationBundle

Push — 3.x-dev-kit ( 0a4698 )

getNotificationDispatcher() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like