FailedEntriesProvider::getFailedEntries() - Code Metrics - Inspection of "Failure Queue API (#1051)" - superdesk/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8e286a...78e0f9 )

by Rafał

created 2020-02-18 13:56 UTC

FailedEntriesProvider::getFailedEntries() B

↳ Parent: FailedEntriesProvider

Complexity

Conditions	6
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	32
rs	8.7857
c	0
b	0
f	0
cc	6
nc	3
nop	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Superdesk Web Publisher Core Bundle.
 *
 * Copyright 2020 Sourcefabric z.ú. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2020 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Bundle\CoreBundle\Provider;

use SWP\Bundle\CoreBundle\MessageHandler\Message\MessageInterface;
use SWP\Bundle\CoreBundle\Model\FailedEntry;
use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
use Symfony\Component\Messenger\Stamp\SentToFailureTransportStamp;
use Symfony\Component\Messenger\Stamp\StampInterface;
use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;

class FailedEntriesProvider
{
    /** @var ReceiverInterface */
    private $receiver;

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

    public function getFailedEntries(?int $max): array
    {
        $envelopes = $this->receiver->all($max);
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.
    }
}

        $rows = [];
        $history = [];
        foreach ($envelopes as $envelope) {
            $lastRedeliveryStampWithException = $this->getLastRedeliveryStampWithException($envelope);
            /** @var SentToFailureTransportStamp|null $sentToFailureTransportStamp */
            $sentToFailureTransportStamp = $envelope->last(SentToFailureTransportStamp::class);

            /** @var TransportMessageIdStamp $stamp */
            $stamp = $envelope->last(TransportMessageIdStamp::class);
            $redeliveryStamps = $this->getRedeliveryStamps($envelope);
            foreach ($redeliveryStamps as $redeliveryStamp) {
                $history[] = $redeliveryStamp->getRedeliveredAt();
            }

            $rows[] = new FailedEntry(
                (int) $stamp->getId(),
                get_class($envelope->getMessage()),
                null === $lastRedeliveryStampWithException ? null : $lastRedeliveryStampWithException->getRedeliveredAt(),
                null === $lastRedeliveryStampWithException ? null : $lastRedeliveryStampWithException->getExceptionMessage(),
                $sentToFailureTransportStamp->getOriginalReceiverName(),
                $history,
                $envelope->getMessage() instanceof MessageInterface ? $envelope->getMessage()->toArray() : [],
                $this->getExceptionTraceAsString($lastRedeliveryStampWithException)
            );
        }

        return $rows;
    }

    private function getLastRedeliveryStampWithException(Envelope $envelope): ?StampInterface
    {
        /** @var RedeliveryStamp $stamp */
        foreach (array_reverse($this->getRedeliveryStamps($envelope)) as $stamp) {
            if (null !== $stamp->getExceptionMessage()) {
                return $stamp;
            }
        }

        return null;
    }

    protected function getRedeliveryStamps(Envelope $envelope): array
    {
        return $envelope->all(RedeliveryStamp::class);
    }

    protected function getExceptionTraceAsString(StampInterface $lastRedeliveryStampWithException): ?string
    {
        /* @var RedeliveryStamp $lastRedeliveryStampWithException */
        return null === $lastRedeliveryStampWithException ? null : $lastRedeliveryStampWithException->getFlattenException()->getTraceAsString();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Superdesk Web Publisher Core Bundle.
7			*
8			* Copyright 2020 Sourcefabric z.ú. and contributors.
9			*
10			* For the full copyright and license information, please see the
11			* AUTHORS and LICENSE files distributed with this source code.
12			*
13			* @copyright 2020 Sourcefabric z.ú
14			* @license http://www.superdesk.org/license
15			*/
16
17			namespace SWP\Bundle\CoreBundle\Provider;
18
19			use SWP\Bundle\CoreBundle\MessageHandler\Message\MessageInterface;
20			use SWP\Bundle\CoreBundle\Model\FailedEntry;
21			use Symfony\Component\Messenger\Envelope;
22			use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
23			use Symfony\Component\Messenger\Stamp\SentToFailureTransportStamp;
24			use Symfony\Component\Messenger\Stamp\StampInterface;
25			use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
26			use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
27
28			class FailedEntriesProvider
29			{
30			/** @var ReceiverInterface */
31			private $receiver;
32
33			public function __construct(ReceiverInterface $receiver)
34			{
35			$this->receiver = $receiver;
36			}
37
38			public function getFailedEntries(?int $max): array
39			{
40			$envelopes = $this->receiver->all($max);
			0 ignored issues – show Bug introduced 2020-02-17 14:09 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Messen...eiver\ReceiverInterface` as the method `all()` does only exist in the following implementations of said interface: `Symfony\Component\Messen...ctrine\DoctrineReceiver`, `Symfony\Component\Messen...trine\DoctrineTransport`. 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...
41
42			$rows = [];
43			$history = [];
44			foreach ($envelopes as $envelope) {
45			$lastRedeliveryStampWithException = $this->getLastRedeliveryStampWithException($envelope);
46			/** @var SentToFailureTransportStamp\|null $sentToFailureTransportStamp */
47			$sentToFailureTransportStamp = $envelope->last(SentToFailureTransportStamp::class);
48
49			/** @var TransportMessageIdStamp $stamp */
50			$stamp = $envelope->last(TransportMessageIdStamp::class);
51			$redeliveryStamps = $this->getRedeliveryStamps($envelope);
52			foreach ($redeliveryStamps as $redeliveryStamp) {
53			$history[] = $redeliveryStamp->getRedeliveredAt();
54			}
55
56			$rows[] = new FailedEntry(
57			(int) $stamp->getId(),
58			get_class($envelope->getMessage()),
59			null === $lastRedeliveryStampWithException ? null : $lastRedeliveryStampWithException->getRedeliveredAt(),
60			null === $lastRedeliveryStampWithException ? null : $lastRedeliveryStampWithException->getExceptionMessage(),
61			$sentToFailureTransportStamp->getOriginalReceiverName(),
62			$history,
63			$envelope->getMessage() instanceof MessageInterface ? $envelope->getMessage()->toArray() : [],
64			$this->getExceptionTraceAsString($lastRedeliveryStampWithException)
65			);
66			}
67
68			return $rows;
69			}
70
71			private function getLastRedeliveryStampWithException(Envelope $envelope): ?StampInterface
72			{
73			/** @var RedeliveryStamp $stamp */
74			foreach (array_reverse($this->getRedeliveryStamps($envelope)) as $stamp) {
75			if (null !== $stamp->getExceptionMessage()) {
76			return $stamp;
77			}
78			}
79
80			return null;
81			}
82
83			protected function getRedeliveryStamps(Envelope $envelope): array
84			{
85			return $envelope->all(RedeliveryStamp::class);
86			}
87
88			protected function getExceptionTraceAsString(StampInterface $lastRedeliveryStampWithException): ?string
89			{
90			/* @var RedeliveryStamp $lastRedeliveryStampWithException */
91			return null === $lastRedeliveryStampWithException ? null : $lastRedeliveryStampWithException->getFlattenException()->getTraceAsString();
92			}
93			}
94

superdesk / web-publisher

Push — master ( 8e286a...78e0f9 )

FailedEntriesProvider::getFailedEntries() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like