AbstractContentPushHandler::reset() - Code Metrics - Inspection of "Rewrite Consumers (#1041)" - superdesk/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f785fb...b21f25 )

by Rafał

created 2020-02-13 14:37 UTC

AbstractContentPushHandler::reset() A

↳ Parent: AbstractContentPushHandler

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?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\MessageHandler;

use Doctrine\DBAL\Exception\NotNullConstraintViolationException;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\NonUniqueResultException;
use Psr\Log\LoggerInterface;
use Sentry\Breadcrumb;
use Sentry\State\HubInterface;
use SWP\Bundle\BridgeBundle\Doctrine\ORM\PackageRepository;
use SWP\Bundle\CoreBundle\Hydrator\PackageHydratorInterface;
use SWP\Bundle\CoreBundle\Model\PackageInterface;
use SWP\Bundle\CoreBundle\Model\Tenant;
use SWP\Component\Bridge\Events;
use SWP\Component\Bridge\Model\ItemInterface;
use SWP\Component\Bridge\Transformer\DataTransformerInterface;
use SWP\Component\MultiTenancy\Context\TenantContextInterface;
use Symfony\Component\Cache\ResettableInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
use Symfony\Component\Messenger\Handler\MessageHandlerInterface;

abstract class AbstractContentPushHandler implements MessageHandlerInterface
{
    protected $logger;

    protected $packageRepository;

    protected $eventDispatcher;

    protected $jsonToPackageTransformer;

    protected $packageObjectManager;

    protected $tenantContext;

    protected $packageHydrator;

    public function __construct(
        LoggerInterface $logger,
        PackageRepository $packageRepository,
        EventDispatcherInterface $eventDispatcher,
        DataTransformerInterface $jsonToPackageTransformer,
        EntityManagerInterface $packageObjectManager,
        TenantContextInterface $tenantContext,
        HubInterface $sentryHub,
        PackageHydratorInterface $packageHydrator
    ) {
        $this->logger = $logger;
        $this->packageRepository = $packageRepository;
        $this->eventDispatcher = $eventDispatcher;
        $this->jsonToPackageTransformer = $jsonToPackageTransformer;
        $this->packageObjectManager = $packageObjectManager;
        $this->tenantContext = $tenantContext;
        $this->sentryHub = $sentryHub;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->packageHydrator = $packageHydrator;
    }

    public function execute(int $tenantId, PackageInterface $package): void
    {
        try {
            $this->doExecute($tenantId, $package);
        } catch (NonUniqueResultException | NotNullConstraintViolationException $e) {
            $this->logException($e, $package, 'Unhandled NonUnique or NotNullConstraint exception');

            $cacheDriver = $this->packageObjectManager->getConfiguration()->getMetadataCacheImpl();
            $cacheDriver->flushAll();

            throw $e;
        } catch (DBALException | ORMException $e) {

            $this->logException($e, $package);

            throw $e;
        } catch (Exception $e) {

            $this->logException($e, $package);

            throw $e;
        } finally {
            $this->reset();
        }
    }

    private function doExecute(int $tenantId, PackageInterface $package): void
    {
        $packageType = $package->getType();
        if (ItemInterface::TYPE_TEXT !== $packageType && ItemInterface::TYPE_COMPOSITE !== $packageType) {
            return;
        }

        $this->tenantContext->setTenant($this->packageObjectManager->find(Tenant::class, $tenantId));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        /** @var PackageInterface $existingPackage */
        $existingPackage = $this->findExistingPackage($package);
        if (null !== $existingPackage) {
            $existingPackage = $this->packageHydrator->hydrate($package, $existingPackage);

            $this->eventDispatcher->dispatch(Events::PACKAGE_PRE_UPDATE, new GenericEvent($existingPackage, ['eventName' => Events::PACKAGE_PRE_UPDATE]));
            $this->packageObjectManager->flush();
            $this->eventDispatcher->dispatch(Events::PACKAGE_POST_UPDATE, new GenericEvent($existingPackage, ['eventName' => Events::PACKAGE_POST_UPDATE]));
            $this->eventDispatcher->dispatch(Events::PACKAGE_PROCESSED, new GenericEvent($existingPackage, ['eventName' => Events::PACKAGE_PROCESSED]));
            $this->packageObjectManager->flush();

            $this->reset();
            $this->logger->info(sprintf('Package %s was updated', $existingPackage->getGuid()));

            return;
        }

        $this->eventDispatcher->dispatch(Events::PACKAGE_PRE_CREATE, new GenericEvent($package, ['eventName' => Events::PACKAGE_PRE_CREATE]));
        $this->packageRepository->add($package);
        $this->eventDispatcher->dispatch(Events::PACKAGE_POST_CREATE, new GenericEvent($package, ['eventName' => Events::PACKAGE_POST_CREATE]));
        $this->eventDispatcher->dispatch(Events::PACKAGE_PROCESSED, new GenericEvent($package, ['eventName' => Events::PACKAGE_PROCESSED]));
        $this->packageObjectManager->flush();

        $this->logger->info(sprintf('Package %s was created', $package->getGuid()));
        $this->reset();
    }

    protected function findExistingPackage(PackageInterface $package)
    {
        $existingPackage = $this->packageRepository->findOneBy(['guid' => $package->getEvolvedFrom() ?? $package->getGuid()]);
        if (null === $existingPackage && null !== $package->getEvolvedFrom()) {
            $existingPackage = $this->packageRepository->findOneBy(['guid' => $package->getGuid()]);
        }

        if (null === $existingPackage) {
            // check for updated items (with evolved from)
            $existingPackage = $this->packageRepository->findOneBy(['evolvedFrom' => $package->getGuid()]);
        }

        return $existingPackage;
    }

    protected function reset(): void
    {
        $this->packageObjectManager->clear();
        if ($this->tenantContext instanceof ResettableInterface) {
            $this->tenantContext->reset();
        }
    }

    protected function logException(\Exception $e, PackageInterface $package, string $defaultMessage = 'Unhandled exception'): void
    {
        $this->logger->error('' !== $e->getMessage() ? $e->getMessage() : $defaultMessage, ['trace' => $e->getTraceAsString()]);
        $this->sentryHub->addBreadcrumb(new Breadcrumb(
            Breadcrumb::LEVEL_DEBUG,
            Breadcrumb::TYPE_DEFAULT,
            'publishing',
            'Package',
            [
                'guid' => $package->getGuid(),
                'headline' => $package->getHeadline(),
            ]
        ));
        $this->sentryHub->captureException($e);
    }
}


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\MessageHandler;
18
19			use Doctrine\DBAL\Exception\NotNullConstraintViolationException;
20			use Doctrine\ORM\EntityManagerInterface;
21			use Doctrine\ORM\NonUniqueResultException;
22			use Psr\Log\LoggerInterface;
23			use Sentry\Breadcrumb;
24			use Sentry\State\HubInterface;
25			use SWP\Bundle\BridgeBundle\Doctrine\ORM\PackageRepository;
26			use SWP\Bundle\CoreBundle\Hydrator\PackageHydratorInterface;
27			use SWP\Bundle\CoreBundle\Model\PackageInterface;
28			use SWP\Bundle\CoreBundle\Model\Tenant;
29			use SWP\Component\Bridge\Events;
30			use SWP\Component\Bridge\Model\ItemInterface;
31			use SWP\Component\Bridge\Transformer\DataTransformerInterface;
32			use SWP\Component\MultiTenancy\Context\TenantContextInterface;
33			use Symfony\Component\Cache\ResettableInterface;
34			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
35			use Symfony\Component\EventDispatcher\GenericEvent;
36			use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
37
38			abstract class AbstractContentPushHandler implements MessageHandlerInterface
39			{
40			protected $logger;
41
42			protected $packageRepository;
43
44			protected $eventDispatcher;
45
46			protected $jsonToPackageTransformer;
47
48			protected $packageObjectManager;
49
50			protected $tenantContext;
51
52			protected $packageHydrator;
53
54			public function __construct(
55			LoggerInterface $logger,
56			PackageRepository $packageRepository,
57			EventDispatcherInterface $eventDispatcher,
58			DataTransformerInterface $jsonToPackageTransformer,
59			EntityManagerInterface $packageObjectManager,
60			TenantContextInterface $tenantContext,
61			HubInterface $sentryHub,
62			PackageHydratorInterface $packageHydrator
63			) {
64			$this->logger = $logger;
65			$this->packageRepository = $packageRepository;
66			$this->eventDispatcher = $eventDispatcher;
67			$this->jsonToPackageTransformer = $jsonToPackageTransformer;
68			$this->packageObjectManager = $packageObjectManager;
69			$this->tenantContext = $tenantContext;
70			$this->sentryHub = $sentryHub;
			0 ignored issues – show Bug introduced 2020-02-04 14:23 UTC by Report Bug Copy Issue Report The property `sentryHub` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
71			$this->packageHydrator = $packageHydrator;
72			}
73
74			public function execute(int $tenantId, PackageInterface $package): void
75			{
76			try {
77			$this->doExecute($tenantId, $package);
78			} catch (NonUniqueResultException \| NotNullConstraintViolationException $e) {
79			$this->logException($e, $package, 'Unhandled NonUnique or NotNullConstraint exception');
80
81			$cacheDriver = $this->packageObjectManager->getConfiguration()->getMetadataCacheImpl();
82			$cacheDriver->flushAll();
83
84			throw $e;
85			} catch (DBALException \| ORMException $e) {
			0 ignored issues – show Bug introduced 2020-02-04 14:23 UTC by Report Bug Copy Issue Report The class `SWP\Bundle\CoreBundle\MessageHandler\ORMException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
86			$this->logException($e, $package);
87
88			throw $e;
89			} catch (Exception $e) {
			0 ignored issues – show Bug introduced 2020-02-04 14:23 UTC by Report Bug Copy Issue Report The class `SWP\Bundle\CoreBundle\MessageHandler\Exception` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
90			$this->logException($e, $package);
91
92			throw $e;
93			} finally {
94			$this->reset();
95			}
96			}
97
98			private function doExecute(int $tenantId, PackageInterface $package): void
99			{
100			$packageType = $package->getType();
101			if (ItemInterface::TYPE_TEXT !== $packageType && ItemInterface::TYPE_COMPOSITE !== $packageType) {
102			return;
103			}
104
105			$this->tenantContext->setTenant($this->packageObjectManager->find(Tenant::class, $tenantId));
			0 ignored issues – show Documentation introduced 2020-02-04 14:23 UTC by Report Bug Copy Issue Report `$this->packageObjectMana...nant::class, $tenantId)` is of type `object\|null`, but the function expects a `object<SWP\Component\Mul...\Model\TenantInterface>`. 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...
106
107			/** @var PackageInterface $existingPackage */
108			$existingPackage = $this->findExistingPackage($package);
109			if (null !== $existingPackage) {
110			$existingPackage = $this->packageHydrator->hydrate($package, $existingPackage);
111
112			$this->eventDispatcher->dispatch(Events::PACKAGE_PRE_UPDATE, new GenericEvent($existingPackage, ['eventName' => Events::PACKAGE_PRE_UPDATE]));
113			$this->packageObjectManager->flush();
114			$this->eventDispatcher->dispatch(Events::PACKAGE_POST_UPDATE, new GenericEvent($existingPackage, ['eventName' => Events::PACKAGE_POST_UPDATE]));
115			$this->eventDispatcher->dispatch(Events::PACKAGE_PROCESSED, new GenericEvent($existingPackage, ['eventName' => Events::PACKAGE_PROCESSED]));
116			$this->packageObjectManager->flush();
117
118			$this->reset();
119			$this->logger->info(sprintf('Package %s was updated', $existingPackage->getGuid()));
120
121			return;
122			}
123
124			$this->eventDispatcher->dispatch(Events::PACKAGE_PRE_CREATE, new GenericEvent($package, ['eventName' => Events::PACKAGE_PRE_CREATE]));
125			$this->packageRepository->add($package);
126			$this->eventDispatcher->dispatch(Events::PACKAGE_POST_CREATE, new GenericEvent($package, ['eventName' => Events::PACKAGE_POST_CREATE]));
127			$this->eventDispatcher->dispatch(Events::PACKAGE_PROCESSED, new GenericEvent($package, ['eventName' => Events::PACKAGE_PROCESSED]));
128			$this->packageObjectManager->flush();
129
130			$this->logger->info(sprintf('Package %s was created', $package->getGuid()));
131			$this->reset();
132			}
133
134			protected function findExistingPackage(PackageInterface $package)
135			{
136			$existingPackage = $this->packageRepository->findOneBy(['guid' => $package->getEvolvedFrom() ?? $package->getGuid()]);
137			if (null === $existingPackage && null !== $package->getEvolvedFrom()) {
138			$existingPackage = $this->packageRepository->findOneBy(['guid' => $package->getGuid()]);
139			}
140
141			if (null === $existingPackage) {
142			// check for updated items (with evolved from)
143			$existingPackage = $this->packageRepository->findOneBy(['evolvedFrom' => $package->getGuid()]);
144			}
145
146			return $existingPackage;
147			}
148
149			protected function reset(): void
150			{
151			$this->packageObjectManager->clear();
152			if ($this->tenantContext instanceof ResettableInterface) {
153			$this->tenantContext->reset();
154			}
155			}
156
157			protected function logException(\Exception $e, PackageInterface $package, string $defaultMessage = 'Unhandled exception'): void
158			{
159			$this->logger->error('' !== $e->getMessage() ? $e->getMessage() : $defaultMessage, ['trace' => $e->getTraceAsString()]);
160			$this->sentryHub->addBreadcrumb(new Breadcrumb(
161			Breadcrumb::LEVEL_DEBUG,
162			Breadcrumb::TYPE_DEFAULT,
163			'publishing',
164			'Package',
165			[
166			'guid' => $package->getGuid(),
167			'headline' => $package->getHeadline(),
168			]
169			));
170			$this->sentryHub->captureException($e);
171			}
172			}
173

superdesk / web-publisher

Push — master ( f785fb...b21f25 )

AbstractContentPushHandler::reset() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like