DoctrineResourceFlushTrait::gatherResourceAndAssociated() - Code Metrics - Inspection of "Almost finished refactoring doctrine flush and pur..." - components-web-app/api-components-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( 6f7970...605cbe )

by Daniel
created 2022-11-11 17:36 UTC
gatherResourceAndAssociated() A

↳ Parent: DoctrineResourceFlushTrait
Complexity

Conditions	3
Paths	4
Size

Total Lines	20
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	12
Importance

Changes
Metric	Value
cc	3
eloc	9
c	0
b	0
f	0
nc	4
nop	4
dl	0
loc	20
ccs	0
cts	10
cp	0
crap	12
rs	9.9666
<?php

/*
 * This file is part of the Silverback API Components Bundle Project
 *
 * (c) Daniel West <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Silverback\ApiComponentsBundle\EventListener\Doctrine;

use ApiPlatform\Api\IriConverterInterface;
use ApiPlatform\Api\ResourceClassResolverInterface;
use ApiPlatform\Api\UrlGeneratorInterface;
use ApiPlatform\Exception\InvalidArgumentException;
use ApiPlatform\Metadata\GetCollection;
use Doctrine\Common\Util\ClassUtils;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Event\OnFlushEventArgs;
use Doctrine\ORM\Event\PostFlushEventArgs;
use Doctrine\ORM\PersistentCollection;
use Doctrine\ORM\UnitOfWork;
use Doctrine\Persistence\ManagerRegistry;
use Doctrine\Persistence\ObjectManager;
use Doctrine\Persistence\ObjectRepository;
use Silverback\ApiComponentsBundle\Entity\Component\Collection;
use Silverback\ApiComponentsBundle\Entity\Core\ComponentPosition;
use Silverback\ApiComponentsBundle\Entity\Core\PageDataInterface;
use Silverback\ApiComponentsBundle\HttpCache\ResourceChangedPropagatorInterface;
use Symfony\Component\PropertyAccess\PropertyAccess;
use Symfony\Component\PropertyAccess\PropertyAccessor;

trait DoctrineResourceFlushTrait
{
    private PropertyAccessor $propertyAccessor;
    private ObjectRepository|EntityRepository $collectionRepository;
    private ObjectRepository|EntityRepository $positionRepository;

    private \SplObjectStorage $updatedResources;
    private array $pageDataPropertiesChanged = [];
    private array $updatedCollectionClassToIriMapping = [];

    public function __construct(
        private readonly IriConverterInterface $iriConverter,
        ManagerRegistry $entityManager,
        private readonly ResourceChangedPropagatorInterface $resourceChangedPropagator,
        private readonly ResourceClassResolverInterface $resourceClassResolver
    ) {
        $this->propertyAccessor = PropertyAccess::createPropertyAccessor();
        $this->collectionRepository = $entityManager->getRepository(Collection::class);
        $this->positionRepository = $entityManager->getRepository(ComponentPosition::class);
        $this->reset();
    }

    public function onFlush(OnFlushEventArgs $eventArgs): void
    {
        $em = $eventArgs->getObjectManager();
        $uow = $em->getUnitOfWork();
        $uow = $em->getUnitOfWork();

        foreach ($uow->getScheduledEntityInsertions() as $entity) {
            $this->gatherResourceAndAssociated($entity, 'created', $em, $uow);
        }

        foreach ($uow->getScheduledEntityUpdates() as $entity) {
            $this->gatherResourceAndAssociated($entity, 'updated', $em, $uow);
        }

        foreach ($uow->getScheduledEntityDeletions() as $entity) {
            $this->gatherResourceAndAssociated($entity, 'deleted', $em, $uow);
        }
    }

    public function postFlush(PostFlushEventArgs $eventArgs): void
    {
        $this->refreshUpdatedEntities($eventArgs->getObjectManager());
        $this->collectDynamicComponentPositionResources();
        $this->collectRelatedCollectionComponentResources();
        $this->purgeResources();
    }

    private function refreshUpdatedEntities(ObjectManager $om): void
    {
        foreach ($this->updatedResources as $updatedResource) {
            $data = $this->updatedResources[$updatedResource];
            if ($om->contains($updatedResource)) {
                $om->refresh($updatedResource);
                $this->resourceChangedPropagator->add($updatedResource, $data['type']);
            }
        }
    }

    private function gatherResourceAndAssociated(object $entity, string $type, ObjectManager $em, UnitOfWork $uow): void
    {
        $changeSet = $uow->getEntityChangeSet($entity);
        $this->collectUpdatedResource($entity, $type);

        $associationMappings = $em->getClassMetadata(ClassUtils::getClass($entity))->getAssociationMappings();

        if ($entity instanceof PageDataInterface) {
            $this->pageDataPropertiesChanged = array_keys($changeSet);
        }

        if ('updated' === $type) {
            $this->gatherUpdatedAssociatedEntities($associationMappings, $changeSet);

            return;
        }

        // created and deleted - full entity change, all properties to check
        // catch any related resources that may have changed backwards relation or database cascades
        $this->gatherAllAssociatedEntities($entity, $associationMappings);
    }

    private function gatherUpdatedAssociatedEntities(array $associationMappings, array $changeSet): void
    {
        foreach ($changeSet as $field => $values) {
            // detect whether changed field was an association
            if (!isset($associationMappings[$field])) {
                continue;
            }

            if (isset($associationMappings[$field]['inversedBy'])) {
                $notNullValues = array_filter($values);
                foreach ($notNullValues as $entityInverseValuesUpdated) {
                    // note: the resource may get removed if orphaned
                    $this->collectUpdatedResource($entityInverseValuesUpdated, 'updated');
                }
            }
        }
    }

    private function gatherAllAssociatedEntities(object $entity, array $associationMappings): void
    {
        foreach (array_keys($associationMappings) as $property) {
            if (!$associationMappings[$property]['inversedBy'] ||
                !$this->propertyAccessor->isReadable($entity, $property) ||
                !$assocEntity = $this->propertyAccessor->getValue($entity, $property)
            ) {
                continue;
            }

            if ($assocEntity instanceof PersistentCollection) {
                foreach ($assocEntity as $oneToManyEntity) {
                    if (!$oneToManyEntity) {
                        continue;
                    }
                    $this->collectUpdatedResource($oneToManyEntity, 'updated');
                }

                return;
            }
            $this->collectUpdatedResource($assocEntity, 'updated');
        }
    }

    private function collectUpdatedResource($resource, string $type): void
    {
        if (!$resource) {
            return;
        }
        $this->addResourceIrisFromObject($resource, $type);
    }

    private function addResourceIrisFromObject($resource, string $type): void
    {
        if (
            isset($this->updatedResources[$resource]) &&
            $this->updatedResources[$resource]['type'] === $type
        ) {
            return;
        }

        try {
            $resourceClass = $this->resourceClassResolver->getResourceClass($resource);
        } catch (InvalidArgumentException $e) {
            return;
        }


        // collect get collection iris for clearing the collection components in the cache later
        if (!isset($this->updatedCollectionClassToIriMapping[$resourceClass])) {
            try {
                $collectionIri = $this->iriConverter->getIriFromResource($resource, UrlGeneratorInterface::ABS_PATH, (new GetCollection())->withClass($resourceClass));
                $this->updatedCollectionClassToIriMapping[$resourceClass] = $collectionIri;
            }catch (InvalidArgumentException $e) {}

        }

        // keep a record of all the resources we are triggering updates for related from the database changes
        $resourceIri = $this->iriConverter->getIriFromResource($resource);

        $this->updatedResources[$resource] = [
            'iri' => $resourceIri,
            'type' => $type,
        ];
    }

    private function collectDynamicComponentPositionResources(): void
    {
        foreach ($this->pageDataPropertiesChanged as $pageDataProperty) {
            $positions = $this->positionRepository->findBy([
                'pageDataProperty' => $pageDataProperty,
            ]);
            foreach ($positions as $position) {
                $this->collectUpdatedResource($position, 'updated');
                $this->resourceChangedPropagator->add($position, 'updated');
            }
        }
    }

    private function collectRelatedCollectionComponentResources(): void
    {
        if (empty($this->updatedCollectionClassToIriMapping)) {
            return;
        }

        foreach ($this->updatedCollectionClassToIriMapping as $resourceIri) {
            $collections = $this->collectionRepository->findBy([
                'resourceIri' => $resourceIri,
            ]);
            foreach ($collections as $collection) {
                $this->collectUpdatedResource($collection, 'updated');
                $this->resourceChangedPropagator->add($collection, 'updated');
            }
        }
    }

    private function purgeResources(): void
    {
        $this->resourceChangedPropagator->propagate();
        $this->reset();
    }

    private function reset(): void
    {
        $this->updatedResources = new \SplObjectStorage();
        $this->pageDataPropertiesChanged = [];
        $this->updatedCollectionClassToIriMapping = [];
    }
}

components-web-app / api-components-bundle

Push — main ( 6f7970...605cbe )

gatherResourceAndAssociated() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
