MarathonStoreJobBusinessCase::isDependencyCircular()

Complexity

Conditions	8
Paths	8

Size

Total Lines	56
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	18
CRAP Score	8.0093

Importance

Changes

0

<?php
    private function isDependencyCircular(MarathonAppEntity $entity, $immediateChildren, &$path = [])
    {
        // Invariant: path will not have duplicates for acyclic dependency tree
        if ($this->hasDuplicates($path)) {
            return true;
        }

        // if we hit leaf (emptyarray), and have no
        // cycle yet, then remove the leaf and return false
        // removing leaf will help maintain a proper path from root to leaf
        // For tree : A ---> B ---> D
        //                      |-> C
        // When we reach node D, path will be [A, B, D]
        // so we pop off D so that the next append will properly show [A, B, C] (legit path)
        if (empty($entity->dependencies)) {
            array_pop($path);
            return false;
        }

        foreach ($entity->dependencies as $dependency) {
            // add this key in path as we will explore its child now
            $path[] = $entity->getKey();

            /** @var MarathonAppEntity $dependEntity */
            $dependEntity = $this->jobRepositoryLocal->getJob($dependency);

            if (!$dependEntity) {
                throw new \Exception(sprintf('Dependency chain on non-existing app "%s"', $dependency));
            }

            if (!$dependEntity instanceof MarathonAppEntity) {
                throw new \RuntimeException('Expected MarathonAppEntity. Found something else');
            }


            // check if dependency has cycle
            if ($this->isDependencyCircular($dependEntity, count($dependEntity->dependencies), $path)) {
                return true;
            }

            // tracking immediateChildren, this helps us with
            // removing knowing when to pop off key for intermediary dependency
            // For tree: A ---> B ---> D
            //              |      |-> C

43% of this comment could be valid code. Did you maybe forget this after debugging?

            //              |->E
            // for B intermediate Child will be 2.
            // when we process D, it will be reduced to 1 and with C to 0
            // then we will pop B to generate path [A, E] when we reach E.
            $immediateChildren--;
            if ($immediateChildren == 0) {
                array_pop($path);
            }
        }

        return false;
    }