MessageManagerBackend - Code Metrics - sonata-project/SonataNotificationBundle - Measure and Improve Code Quality continuously with Scrutinizer

MessageManagerBackend A
last analyzed 2020-08-28 02:03 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	178
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

Metric	Value
wmc	17
lcom	1
cbo	9
dl	0
loc	178
rs	10
c	0
b	0
f	0

11 Methods

Rating	Name	Size	Complexity
A	__construct()	9	1
A	setTypes()	4	1
A	publish()	6	1
A	create()	9	1
A	createAndPublish()	4	1
A	getIterator()	4	1
A	initialize()	3	1
A	setDispatcher()	4	1
A	handle()	25	2
B	getStatus()	26	6
A	cleanup()	4	1

<?php

declare(strict_types=1);

/*
 * 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\Backend;

use Laminas\Diagnostics\Result\Failure;
use Laminas\Diagnostics\Result\Success;
use Laminas\Diagnostics\Result\Warning;
use Sonata\NotificationBundle\Consumer\ConsumerEvent;
use Sonata\NotificationBundle\Exception\HandlingException;
use Sonata\NotificationBundle\Iterator\MessageManagerMessageIterator;
use Sonata\NotificationBundle\Model\MessageInterface;
use Sonata\NotificationBundle\Model\MessageManagerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

class MessageManagerBackend implements BackendInterface
{
    /**
     * @var MessageManagerInterface
     */
    protected $messageManager;

    /**
     * @var array
     */
    protected $checkLevel;

    /**
     * @var int
     */
    protected $pause;

    /**
     * @var int
     */
    protected $maxAge;

    /**
     * @var MessageManagerBackendDispatcher|null
     */
    protected $dispatcher = null;

    /**
     * @var array
     */
    protected $types;

    /**
     * @var int
     */
    protected $batchSize;

    /**
     * @param int $pause
     * @param int $maxAge
     * @param int $batchSize
     */
    public function __construct(MessageManagerInterface $messageManager, array $checkLevel, $pause = 500000, $maxAge = 86400, $batchSize = 10, array $types = [])
    {
        $this->messageManager = $messageManager;
        $this->checkLevel = $checkLevel;
        $this->pause = $pause;
        $this->maxAge = $maxAge;
        $this->batchSize = $batchSize;
        $this->types = $types;
    }

    /**
     * @param array $types
     */
    public function setTypes($types): void
    {
        $this->types = $types;
    }

    /**
     * {@inheritdoc}
     */
    public function publish(MessageInterface $message)
    {
        $this->messageManager->save($message);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $message;
    }

    /**
     * {@inheritdoc}
     */
    public function create($type, array $body)
    {
        $message = $this->messageManager->create();
        $message->setType($type);
        $message->setBody($body);
        $message->setState(MessageInterface::STATE_OPEN);

        return $message;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * {@inheritdoc}
     */
    public function createAndPublish($type, array $body)
    {
        return $this->publish($this->create($type, $body));
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator()
    {
        return new MessageManagerMessageIterator($this->messageManager, $this->types, $this->pause, $this->batchSize);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * {@inheritdoc}
     */
    public function initialize(): void
    {
    }

    public function setDispatcher(MessageManagerBackendDispatcher $dispatcher): void
    {
        $this->dispatcher = $dispatcher;
    }

    /**
     * {@inheritdoc}
     */
    public function handle(MessageInterface $message, EventDispatcherInterface $dispatcher)
    {
        $event = new ConsumerEvent($message);

        try {
            $message->setStartedAt(new \DateTime());
            $message->setState(MessageInterface::STATE_IN_PROGRESS);
            $this->messageManager->save($message);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

            $dispatcher->dispatch($event, $message->getType());

            $message->setCompletedAt(new \DateTime());
            $message->setState(MessageInterface::STATE_DONE);
            $this->messageManager->save($message);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

            return $event->getReturnInfo();
        } catch (\Exception $e) {
            $message->setCompletedAt(new \DateTime());
            $message->setState(MessageInterface::STATE_ERROR);

            $this->messageManager->save($message);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

            throw new HandlingException('Error while handling a message', 0, $e);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getStatus()
    {
        try {
            $states = $this->messageManager->countStates();
        } catch (\Exception $e) {
            return new Failure(sprintf('Unable to retrieve message information - %s (Database)', $e->getMessage()));
        }

        if ($states[MessageInterface::STATE_IN_PROGRESS] > $this->checkLevel[MessageInterface::STATE_IN_PROGRESS]) {
            return new Failure('Too many messages processed at the same time (Database)');
        }

        if ($states[MessageInterface::STATE_ERROR] > $this->checkLevel[MessageInterface::STATE_ERROR]) {
            return new Failure('Too many errors (Database)');
        }

        if ($states[MessageInterface::STATE_OPEN] > $this->checkLevel[MessageInterface::STATE_OPEN]) {
            return new Warning('Too many messages waiting to be processed (Database)');
        }

        if ($states[MessageInterface::STATE_DONE] > $this->checkLevel[MessageInterface::STATE_DONE]) {
            return new Warning('Too many processed messages, please clean the database (Database)');
        }

        return new Success('Ok (Database)');
    }

    /**
     * {@inheritdoc}
     */
    public function cleanup(): void
    {
        $this->messageManager->cleanup($this->maxAge);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\NotificationBundle\Backend;
15
16			use Laminas\Diagnostics\Result\Failure;
17			use Laminas\Diagnostics\Result\Success;
18			use Laminas\Diagnostics\Result\Warning;
19			use Sonata\NotificationBundle\Consumer\ConsumerEvent;
20			use Sonata\NotificationBundle\Exception\HandlingException;
21			use Sonata\NotificationBundle\Iterator\MessageManagerMessageIterator;
22			use Sonata\NotificationBundle\Model\MessageInterface;
23			use Sonata\NotificationBundle\Model\MessageManagerInterface;
24			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
25
26			class MessageManagerBackend implements BackendInterface
27			{
28			/**
29			* @var MessageManagerInterface
30			*/
31			protected $messageManager;
32
33			/**
34			* @var array
35			*/
36			protected $checkLevel;
37
38			/**
39			* @var int
40			*/
41			protected $pause;
42
43			/**
44			* @var int
45			*/
46			protected $maxAge;
47
48			/**
49			* @var MessageManagerBackendDispatcher\|null
50			*/
51			protected $dispatcher = null;
52
53			/**
54			* @var array
55			*/
56			protected $types;
57
58			/**
59			* @var int
60			*/
61			protected $batchSize;
62
63			/**
64			* @param int $pause
65			* @param int $maxAge
66			* @param int $batchSize
67			*/
68			public function __construct(MessageManagerInterface $messageManager, array $checkLevel, $pause = 500000, $maxAge = 86400, $batchSize = 10, array $types = [])
69			{
70			$this->messageManager = $messageManager;
71			$this->checkLevel = $checkLevel;
72			$this->pause = $pause;
73			$this->maxAge = $maxAge;
74			$this->batchSize = $batchSize;
75			$this->types = $types;
76			}
77
78			/**
79			* @param array $types
80			*/
81			public function setTypes($types): void
82			{
83			$this->types = $types;
84			}
85
86			/**
87			* {@inheritdoc}
88			*/
89			public function publish(MessageInterface $message)
90			{
91			$this->messageManager->save($message);
			0 ignored issues – show Documentation introduced 2020-03-30 11:59 UTC by Report Bug Copy Issue Report `$message` is of type `object<Sonata\Notificati...Model\MessageInterface>`, but the function expects a `object<Sonata\Doctrine\Model\T>`. 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...
92
93			return $message;
94			}
95
96			/**
97			* {@inheritdoc}
98			*/
99			public function create($type, array $body)
100			{
101			$message = $this->messageManager->create();
102			$message->setType($type);
103			$message->setBody($body);
104			$message->setState(MessageInterface::STATE_OPEN);
105
106			return $message;
			0 ignored issues – show Bug Best Practice introduced 2020-03-30 11:59 UTC by Report Bug Copy Issue Report The return type of `return $message;` (`Sonata\Doctrine\Model\T`) is incompatible with the return type declared by the interface `Sonata\NotificationBundl...ackendInterface::create` of type `Sonata\NotificationBundle\Model\MessageInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
107			}
108
109			/**
110			* {@inheritdoc}
111			*/
112			public function createAndPublish($type, array $body)
113			{
114			return $this->publish($this->create($type, $body));
115			}
116
117			/**
118			* {@inheritdoc}
119			*/
120			public function getIterator()
121			{
122			return new MessageManagerMessageIterator($this->messageManager, $this->types, $this->pause, $this->batchSize);
			0 ignored issues – show Bug Best Practice introduced 2015-11-22 19:11 UTC by Report Bug Copy Issue Report The return type of `return new \Sonata\Notif...use, $this->batchSize);` (`Sonata\NotificationBundl...eManagerMessageIterator`) is incompatible with the return type declared by the interface `Sonata\NotificationBundl...dInterface::getIterator` of type `Sonata\NotificationBundl...essageIteratorInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
123			}
124
125			/**
126			* {@inheritdoc}
127			*/
128			public function initialize(): void
129			{
130			}
131
132			public function setDispatcher(MessageManagerBackendDispatcher $dispatcher): void
133			{
134			$this->dispatcher = $dispatcher;
135			}
136
137			/**
138			* {@inheritdoc}
139			*/
140			public function handle(MessageInterface $message, EventDispatcherInterface $dispatcher)
141			{
142			$event = new ConsumerEvent($message);
143
144			try {
145			$message->setStartedAt(new \DateTime());
146			$message->setState(MessageInterface::STATE_IN_PROGRESS);
147			$this->messageManager->save($message);
			0 ignored issues – show Documentation introduced 2020-03-30 11:59 UTC by Report Bug Copy Issue Report `$message` is of type `object<Sonata\Notificati...Model\MessageInterface>`, but the function expects a `object<Sonata\Doctrine\Model\T>`. 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...
148
149			$dispatcher->dispatch($event, $message->getType());
150
151			$message->setCompletedAt(new \DateTime());
152			$message->setState(MessageInterface::STATE_DONE);
153			$this->messageManager->save($message);
			0 ignored issues – show Documentation introduced 2020-03-30 11:59 UTC by Report Bug Copy Issue Report `$message` is of type `object<Sonata\Notificati...Model\MessageInterface>`, but the function expects a `object<Sonata\Doctrine\Model\T>`. 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...
154
155			return $event->getReturnInfo();
156			} catch (\Exception $e) {
157			$message->setCompletedAt(new \DateTime());
158			$message->setState(MessageInterface::STATE_ERROR);
159
160			$this->messageManager->save($message);
			0 ignored issues – show Documentation introduced 2020-03-30 11:59 UTC by Report Bug Copy Issue Report `$message` is of type `object<Sonata\Notificati...Model\MessageInterface>`, but the function expects a `object<Sonata\Doctrine\Model\T>`. 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...
161
162			throw new HandlingException('Error while handling a message', 0, $e);
163			}
164			}
165
166			/**
167			* {@inheritdoc}
168			*/
169			public function getStatus()
170			{
171			try {
172			$states = $this->messageManager->countStates();
173			} catch (\Exception $e) {
174			return new Failure(sprintf('Unable to retrieve message information - %s (Database)', $e->getMessage()));
175			}
176
177			if ($states[MessageInterface::STATE_IN_PROGRESS] > $this->checkLevel[MessageInterface::STATE_IN_PROGRESS]) {
178			return new Failure('Too many messages processed at the same time (Database)');
179			}
180
181			if ($states[MessageInterface::STATE_ERROR] > $this->checkLevel[MessageInterface::STATE_ERROR]) {
182			return new Failure('Too many errors (Database)');
183			}
184
185			if ($states[MessageInterface::STATE_OPEN] > $this->checkLevel[MessageInterface::STATE_OPEN]) {
186			return new Warning('Too many messages waiting to be processed (Database)');
187			}
188
189			if ($states[MessageInterface::STATE_DONE] > $this->checkLevel[MessageInterface::STATE_DONE]) {
190			return new Warning('Too many processed messages, please clean the database (Database)');
191			}
192
193			return new Success('Ok (Database)');
194			}
195
196			/**
197			* {@inheritdoc}
198			*/
199			public function cleanup(): void
200			{
201			$this->messageManager->cleanup($this->maxAge);
202			}
203			}
204

sonata-project / SonataNotificationBundle

MessageManagerBackend A last analyzed 2020-08-28 02:03 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

Duplication Side-by-Side

Filter issues like

MessageManagerBackend A
last analyzed 2020-08-28 02:03 UTC