FlowMap::getNodeMap() - Code Metrics - Inspection of "left overs" - fab2s/NodalFlow - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 82eb11...0228a6 )

by Fabrice

created 2018-01-08 13:20 UTC

FlowMap::getNodeMap() A

↳ Parent: FlowMap

Complexity

Conditions	4
Paths	3

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.2
c	0
b	0
f	0
cc	4
eloc	7
nc	3
nop	0

<?php

/*
 * This file is part of NodalFlow.
 *     (c) Fabrice de Stefanis / https://github.com/fab2s/NodalFlow
 * This source file is licensed under the MIT license which you will
 * find in the LICENSE file or at https://opensource.org/licenses/MIT
 */

namespace fab2s\NodalFlow\Flows;

use fab2s\NodalFlow\NodalFlowException;
use fab2s\NodalFlow\Nodes\AggregateNodeInterface;
use fab2s\NodalFlow\Nodes\BranchNodeInterface;
use fab2s\NodalFlow\Nodes\NodeInterface;

/**
 * class FlowMap
 * Do not implement Serializable interface on purpose
 *
 * @SEE https://externals.io/message/98834#98834
 */
class FlowMap implements FlowMapInterface
{
    /**
     * Flow map
     *
     * @var array
     */
    protected $nodeMap = [];

    /**
     * @var NodeInterface[]
     */
    protected $reverseMap = [];

    /**
     * The default Node Map values
     *
     * @var array
     */
    protected $nodeMapDefault = [
        'class'           => null,
        'flowId'          => null,
        'hash'            => null,
        'index'           => null,
        'isATraversable'  => null,
        'isAReturningVal' => null,
        'isAFlow'         => null,
    ];

    /**
     * The default Node stats values
     *
     * @var array
     */
    protected $nodeIncrements = [
        'num_exec'     => 0,
        'num_iterate'  => 0,
        'num_break'    => 0,
        'num_continue' => 0,
    ];

    /**
     * The Flow map default values
     *
     * @var array
     */
    protected $flowMapDefault = [
        'class'    => null,
        'id'       => null,
        'start'    => null,
        'end'      => null,
        'elapsed'  => null,
        'duration' => null,
        'mib'      => null,
    ];

    /**
     * @var array
     */
    protected $incrementTotals = [];

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

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

    /**
     * @var FlowRegistryInterface
     */
    protected $registry;

    /**
     * @var array
     */
    protected $registryData = [];

    /**
     * @var FlowInterface
     */
    protected $flow;

    /**
     * @var string
     */
    protected $flowId;

    /**
     * Instantiate a Flow Status
     *
     * @param FlowInterface $flow
     * @param array         $flowIncrements
     *
     * @throws NodalFlowException
     */
    public function __construct(FlowInterface $flow, array $flowIncrements = [])
    {
        $this->flow     = $flow;
        $this->flowId   = $this->flow->getId();
        $this->registry = (new FlowRegistry)->registerFlow($flow);
        $this->initDefaults()->setRefs()->setFlowIncrement($flowIncrements);
    }

    /**
     * If you don't feel like doing this at home, I completely
     * understand, I'd be very happy to hear about a better and
     * more efficient way
     */
    public function __wakeup()
    {
        $this->registry->load($this->flow, $this->registryData);
        $this->setRefs();
    }

    /**
     * @param NodeInterface $node
     * @param int           $index
     *
     * @throws NodalFlowException
     *
     * @return $this
     */
    public function register(NodeInterface $node, $index)
    {
        $this->registry->registerNode($node);
        $nodeId                 = $node->getId();
        $this->nodeMap[$nodeId] = array_replace($this->nodeMapDefault, [
            'class'           => get_class($node),
            'flowId'          => $this->flowId,
            'hash'            => $nodeId,
            'index'           => $index,
            'isATraversable'  => $node->isTraversable(),
            'isAReturningVal' => $node->isReturningVal(),
            'isAFlow'         => $node->isFlow(),
        ], $this->nodeIncrements);

        $this->setNodeIncrement($node);

        if (isset($this->reverseMap[$index])) {
            // replacing a node, maintain nodeMap accordingly
            unset($this->nodeMap[$this->reverseMap[$index]->getId()]);
        }

        $this->reverseMap[$index] = $node;

        return $this;
    }

    /**
     * @param string $nodeId
     *
     * @return int|null
     */
    public function getNodeIndex($nodeId)
    {
        return isset($this->nodeMap[$nodeId]) ? $this->nodeMap[$nodeId]['index'] : null;
    }

    /**
     * Triggered right before the flow starts
     *
     * @return $this
     */
    public function flowStart()
    {
        $this->flowStats['start'] = microtime(true);

        return $this;
    }

    /**
     * Triggered right after the flow stops
     *
     * @return $this
     */
    public function flowEnd()
    {
        $this->flowStats['end']     = microtime(true);
        $this->flowStats['mib']     = memory_get_peak_usage(true) / 1048576;
        $this->flowStats['elapsed'] = $this->flowStats['end'] - $this->flowStats['start'];

        $this->flowStats = array_replace($this->flowStats, $this->duration($this->flowStats['elapsed']));

        return $this;
    }

    /**
     * Let's be fast at incrementing while we are at it
     *
     * @param string $nodeHash
     *
     * @return array
     */
    public function &getNodeStat($nodeHash)
    {
        return $this->nodeMap[$nodeHash];
    }

    /**
     * Get/Generate Node Map
     *
     * @return array
     */
    public function getNodeMap()
    {
        foreach ($this->flow->getNodes() as $node) {
            $nodeId = $node->getId();
            if ($node instanceof BranchNodeInterface || $node instanceof AggregateNodeInterface) {
                $this->nodeMap[$nodeId]['nodes'] = $node->getPayload()->getNodeMap();
                continue;
            }
        }

        return $this->nodeMap;
    }

    /**
     * Get the latest Node stats
     *
     * @return array<string,integer|string>
     */
    public function getStats()
    {
        $this->resetTotals();
        foreach ($this->flow->getNodes() as $node) {
            $nodeMap = $this->nodeMap[$node->getId()];
            foreach ($this->incrementTotals as $srcKey => $totalKey) {
                if (isset($nodeMap[$srcKey])) {
                    $this->flowStats[$totalKey] += $nodeMap[$srcKey];
                }
            }

            if ($node instanceof BranchNodeInterface) {
                $childFlowId                               = $node->getPayload()->getId();
                $this->flowStats['branches'][$childFlowId] = $node->getPayload()->getStats();
                foreach ($this->incrementTotals as $srcKey => $totalKey) {
                    if (isset($this->flowStats['branches'][$childFlowId][$totalKey])) {
                        $this->flowStats[$totalKey] += $this->flowStats['branches'][$childFlowId][$totalKey];
                    }
                }
            }
        }

        $flowStatus = $this->flow->getFlowStatus();
        if ($flowStatus !== null) {
            $this->flowStats['flow_status'] = $flowStatus->getStatus();
        }

        return $this->flowStats;
    }

    /**
     * @param string $nodeHash
     * @param string $key
     *
     * @return $this
     */
    public function incrementNode($nodeHash, $key)
    {
        ++$this->nodeMap[$nodeHash][$key];

        return $this;
    }

    /**
     * @param string $key
     *
     * @return $this
     */
    public function incrementFlow($key)
    {
        ++$this->flowStats[$key];

        return $this;
    }

    /**
     * Resets Nodes stats, can be used prior to Flow's re-exec
     *
     * @return $this
     */
    public function resetNodeStats()
    {
        foreach ($this->nodeMap as &$nodeStat) {
            foreach ($this->nodeIncrements as $key => $value) {
                if (isset($nodeStat[$key])) {
                    $nodeStat[$key] = $value;
                }
            }
        }

        return $this;
    }

    /**
     * Computes a human readable duration string from floating seconds
     *
     * @param float $seconds
     *
     * @return array<string,integer|string>
     */
    public function duration($seconds)
    {
        $result = [
            'hour'     => (int) floor($seconds / 3600),
            'min'      => (int) floor(($seconds / 60) % 60),
            'sec'      => $seconds % 60,
            'ms'       => (int) round(\fmod($seconds, 1) * 1000),
        ];

        $duration = '';
        foreach ($result as $unit => $value) {
            if (!empty($value) || $unit === 'ms') {
                $duration .= $value . "$unit ";
            }
        }

        $result['duration'] = trim($duration);

        return $result;
    }

    /**
     * @return $this
     */
    protected function setRefs()
    {
        $this->registryData              = &$this->registry->get($this->flowId);
        $this->registryData['flowStats'] = &$this->flowStats;
        $this->registryData['nodeStats'] = &$this->nodeMap;
        $this->registryData['nodes']     = &$this->reverseMap;

        return $this;
    }

    /**
     * @return $this
     */
    protected function initDefaults()
    {
        $this->flowIncrements = $this->nodeIncrements;
        foreach (array_keys($this->flowIncrements) as $key) {
            $totalKey                        = $key . '_total';
            $this->incrementTotals[$key]     = $totalKey;
            $this->flowIncrements[$totalKey] = 0;
        }

        $this->flowMapDefault = array_replace($this->flowMapDefault, $this->flowIncrements, [
            'class' => get_class($this->flow),
            'id'    => $this->flowId,
        ]);

        $this->flowStats = $this->flowMapDefault;

        return $this;
    }

    /**
     * @return $this
     */
    protected function resetTotals()
    {
        foreach ($this->incrementTotals as $totalKey) {
            $this->flowStats[$totalKey] = 0;
        }

        return $this;
    }

    /**
     * Set additional increment keys, use :
     *      'keyName' => int
     * to add keyName as increment, starting at int
     * or :
     *      'keyName' => 'existingIncrement'
     * to assign keyName as a reference to existingIncrement
     *
     * @param array $flowIncrements
     *
     * @throws NodalFlowException
     *
     * @return $this
     */
    protected function setFlowIncrement(array $flowIncrements)
    {
        foreach ($flowIncrements as $incrementKey => $target) {
            if (is_string($target)) {
                if (!isset($this->flowStats[$target])) {
                    throw new NodalFlowException('Cannot set reference on unset target');
                }

                $this->flowStats[$incrementKey]            = &$this->flowStats[$target];
                $this->flowStats[$incrementKey . '_total'] = &$this->flowStats[$target . '_total'];
                continue;
            }

            $this->flowIncrements[$incrementKey]  = $target;
            $this->incrementTotals[$incrementKey] = $incrementKey . '_total';
            $this->flowStats[$incrementKey]       = $target;
        }

        return $this;
    }

    /**
     * @param NodeInterface $node
     *
     * @throws NodalFlowException
     *
     * @return $this
     */
    protected function setNodeIncrement(NodeInterface $node)
    {
        $nodeId = $node->getId();
        foreach ($node->getNodeIncrements() as $incrementKey => $target) {
            if (is_string($target)) {
                if (!isset($this->nodeIncrements[$target])) {
                    throw new NodalFlowException('Tried to set an increment alias to an un-registered increment', 1, null, [
                        'aliasKey'  => $incrementKey,
                        'targetKey' => $target,
                    ]);
                }

                $this->nodeMap[$nodeId][$incrementKey] = &$this->nodeMap[$nodeId][$target];
                continue;
            }

            $this->nodeIncrements[$incrementKey]   = $target;
            $this->nodeMap[$nodeId][$incrementKey] = $target;
        }

        return $this;
    }
}


1			<?php
2
3			/*
4			* This file is part of NodalFlow.
5			* (c) Fabrice de Stefanis / https://github.com/fab2s/NodalFlow
6			* This source file is licensed under the MIT license which you will
7			* find in the LICENSE file or at https://opensource.org/licenses/MIT
8			*/
9
10			namespace fab2s\NodalFlow\Flows;
11
12			use fab2s\NodalFlow\NodalFlowException;
13			use fab2s\NodalFlow\Nodes\AggregateNodeInterface;
14			use fab2s\NodalFlow\Nodes\BranchNodeInterface;
15			use fab2s\NodalFlow\Nodes\NodeInterface;
16
17			/**
18			* class FlowMap
19			* Do not implement Serializable interface on purpose
20			*
21			* @SEE https://externals.io/message/98834#98834
22			*/
23			class FlowMap implements FlowMapInterface
24			{
25			/**
26			* Flow map
27			*
28			* @var array
29			*/
30			protected $nodeMap = [];
31
32			/**
33			* @var NodeInterface[]
34			*/
35			protected $reverseMap = [];
36
37			/**
38			* The default Node Map values
39			*
40			* @var array
41			*/
42			protected $nodeMapDefault = [
43			'class' => null,
44			'flowId' => null,
45			'hash' => null,
46			'index' => null,
47			'isATraversable' => null,
48			'isAReturningVal' => null,
49			'isAFlow' => null,
50			];
51
52			/**
53			* The default Node stats values
54			*
55			* @var array
56			*/
57			protected $nodeIncrements = [
58			'num_exec' => 0,
59			'num_iterate' => 0,
60			'num_break' => 0,
61			'num_continue' => 0,
62			];
63
64			/**
65			* The Flow map default values
66			*
67			* @var array
68			*/
69			protected $flowMapDefault = [
70			'class' => null,
71			'id' => null,
72			'start' => null,
73			'end' => null,
74			'elapsed' => null,
75			'duration' => null,
76			'mib' => null,
77			];
78
79			/**
80			* @var array
81			*/
82			protected $incrementTotals = [];
83
84			/**
85			* @var array
86			*/
87			protected $flowIncrements;
88
89			/**
90			* @var array
91			*/
92			protected $flowStats;
93
94			/**
95			* @var FlowRegistryInterface
96			*/
97			protected $registry;
98
99			/**
100			* @var array
101			*/
102			protected $registryData = [];
103
104			/**
105			* @var FlowInterface
106			*/
107			protected $flow;
108
109			/**
110			* @var string
111			*/
112			protected $flowId;
113
114			/**
115			* Instantiate a Flow Status
116			*
117			* @param FlowInterface $flow
118			* @param array $flowIncrements
119			*
120			* @throws NodalFlowException
121			*/
122			public function __construct(FlowInterface $flow, array $flowIncrements = [])
123			{
124			$this->flow = $flow;
125			$this->flowId = $this->flow->getId();
126			$this->registry = (new FlowRegistry)->registerFlow($flow);
127			$this->initDefaults()->setRefs()->setFlowIncrement($flowIncrements);
128			}
129
130			/**
131			* If you don't feel like doing this at home, I completely
132			* understand, I'd be very happy to hear about a better and
133			* more efficient way
134			*/
135			public function __wakeup()
136			{
137			$this->registry->load($this->flow, $this->registryData);
138			$this->setRefs();
139			}
140
141			/**
142			* @param NodeInterface $node
143			* @param int $index
144			*
145			* @throws NodalFlowException
146			*
147			* @return $this
148			*/
149			public function register(NodeInterface $node, $index)
150			{
151			$this->registry->registerNode($node);
152			$nodeId = $node->getId();
153			$this->nodeMap[$nodeId] = array_replace($this->nodeMapDefault, [
154			'class' => get_class($node),
155			'flowId' => $this->flowId,
156			'hash' => $nodeId,
157			'index' => $index,
158			'isATraversable' => $node->isTraversable(),
159			'isAReturningVal' => $node->isReturningVal(),
160			'isAFlow' => $node->isFlow(),
161			], $this->nodeIncrements);
162
163			$this->setNodeIncrement($node);
164
165			if (isset($this->reverseMap[$index])) {
166			// replacing a node, maintain nodeMap accordingly
167			unset($this->nodeMap[$this->reverseMap[$index]->getId()]);
168			}
169
170			$this->reverseMap[$index] = $node;
171
172			return $this;
173			}
174
175			/**
176			* @param string $nodeId
177			*
178			* @return int\|null
179			*/
180			public function getNodeIndex($nodeId)
181			{
182			return isset($this->nodeMap[$nodeId]) ? $this->nodeMap[$nodeId]['index'] : null;
183			}
184
185			/**
186			* Triggered right before the flow starts
187			*
188			* @return $this
189			*/
190			public function flowStart()
191			{
192			$this->flowStats['start'] = microtime(true);
193
194			return $this;
195			}
196
197			/**
198			* Triggered right after the flow stops
199			*
200			* @return $this
201			*/
202			public function flowEnd()
203			{
204			$this->flowStats['end'] = microtime(true);
205			$this->flowStats['mib'] = memory_get_peak_usage(true) / 1048576;
206			$this->flowStats['elapsed'] = $this->flowStats['end'] - $this->flowStats['start'];
207
208			$this->flowStats = array_replace($this->flowStats, $this->duration($this->flowStats['elapsed']));
209
210			return $this;
211			}
212
213			/**
214			* Let's be fast at incrementing while we are at it
215			*
216			* @param string $nodeHash
217			*
218			* @return array
219			*/
220			public function &getNodeStat($nodeHash)
221			{
222			return $this->nodeMap[$nodeHash];
223			}
224
225			/**
226			* Get/Generate Node Map
227			*
228			* @return array
229			*/
230			public function getNodeMap()
231			{
232			foreach ($this->flow->getNodes() as $node) {
233			$nodeId = $node->getId();
234			if ($node instanceof BranchNodeInterface \|\| $node instanceof AggregateNodeInterface) {
235			$this->nodeMap[$nodeId]['nodes'] = $node->getPayload()->getNodeMap();
236			continue;
237			}
238			}
239
240			return $this->nodeMap;
241			}
242
243			/**
244			* Get the latest Node stats
245			*
246			* @return array<string,integer\|string>
247			*/
248			public function getStats()
249			{
250			$this->resetTotals();
251			foreach ($this->flow->getNodes() as $node) {
252			$nodeMap = $this->nodeMap[$node->getId()];
253			foreach ($this->incrementTotals as $srcKey => $totalKey) {
254			if (isset($nodeMap[$srcKey])) {
255			$this->flowStats[$totalKey] += $nodeMap[$srcKey];
256			}
257			}
258
259			if ($node instanceof BranchNodeInterface) {
260			$childFlowId = $node->getPayload()->getId();
261			$this->flowStats['branches'][$childFlowId] = $node->getPayload()->getStats();
262			foreach ($this->incrementTotals as $srcKey => $totalKey) {
263			if (isset($this->flowStats['branches'][$childFlowId][$totalKey])) {
264			$this->flowStats[$totalKey] += $this->flowStats['branches'][$childFlowId][$totalKey];
265			}
266			}
267			}
268			}
269
270			$flowStatus = $this->flow->getFlowStatus();
271			if ($flowStatus !== null) {
272			$this->flowStats['flow_status'] = $flowStatus->getStatus();
273			}
274
275			return $this->flowStats;
276			}
277
278			/**
279			* @param string $nodeHash
280			* @param string $key
281			*
282			* @return $this
283			*/
284			public function incrementNode($nodeHash, $key)
285			{
286			++$this->nodeMap[$nodeHash][$key];
287
288			return $this;
289			}
290
291			/**
292			* @param string $key
293			*
294			* @return $this
295			*/
296			public function incrementFlow($key)
297			{
298			++$this->flowStats[$key];
299
300			return $this;
301			}
302
303			/**
304			* Resets Nodes stats, can be used prior to Flow's re-exec
305			*
306			* @return $this
307			*/
308			public function resetNodeStats()
309			{
310			foreach ($this->nodeMap as &$nodeStat) {
311			foreach ($this->nodeIncrements as $key => $value) {
312			if (isset($nodeStat[$key])) {
313			$nodeStat[$key] = $value;
314			}
315			}
316			}
317
318			return $this;
319			}
320
321			/**
322			* Computes a human readable duration string from floating seconds
323			*
324			* @param float $seconds
325			*
326			* @return array<string,integer\|string>
327			*/
328			public function duration($seconds)
329			{
330			$result = [
331			'hour' => (int) floor($seconds / 3600),
332			'min' => (int) floor(($seconds / 60) % 60),
333			'sec' => $seconds % 60,
334			'ms' => (int) round(\fmod($seconds, 1) * 1000),
335			];
336
337			$duration = '';
338			foreach ($result as $unit => $value) {
339			if (!empty($value) \|\| $unit === 'ms') {
340			$duration .= $value . "$unit ";
341			}
342			}
343
344			$result['duration'] = trim($duration);
345
346			return $result;
347			}
348
349			/**
350			* @return $this
351			*/
352			protected function setRefs()
353			{
354			$this->registryData = &$this->registry->get($this->flowId);
355			$this->registryData['flowStats'] = &$this->flowStats;
356			$this->registryData['nodeStats'] = &$this->nodeMap;
357			$this->registryData['nodes'] = &$this->reverseMap;
358
359			return $this;
360			}
361
362			/**
363			* @return $this
364			*/
365			protected function initDefaults()
366			{
367			$this->flowIncrements = $this->nodeIncrements;
368			foreach (array_keys($this->flowIncrements) as $key) {
369			$totalKey = $key . '_total';
370			$this->incrementTotals[$key] = $totalKey;
371			$this->flowIncrements[$totalKey] = 0;
372			}
373
374			$this->flowMapDefault = array_replace($this->flowMapDefault, $this->flowIncrements, [
375			'class' => get_class($this->flow),
376			'id' => $this->flowId,
377			]);
378
379			$this->flowStats = $this->flowMapDefault;
380
381			return $this;
382			}
383
384			/**
385			* @return $this
386			*/
387			protected function resetTotals()
388			{
389			foreach ($this->incrementTotals as $totalKey) {
390			$this->flowStats[$totalKey] = 0;
391			}
392
393			return $this;
394			}
395
396			/**
397			* Set additional increment keys, use :
398			* 'keyName' => int
399			* to add keyName as increment, starting at int
400			* or :
401			* 'keyName' => 'existingIncrement'
402			* to assign keyName as a reference to existingIncrement
403			*
404			* @param array $flowIncrements
405			*
406			* @throws NodalFlowException
407			*
408			* @return $this
409			*/
410			protected function setFlowIncrement(array $flowIncrements)
411			{
412			foreach ($flowIncrements as $incrementKey => $target) {
413			if (is_string($target)) {
414			if (!isset($this->flowStats[$target])) {
415			throw new NodalFlowException('Cannot set reference on unset target');
416			}
417
418			$this->flowStats[$incrementKey] = &$this->flowStats[$target];
419			$this->flowStats[$incrementKey . '_total'] = &$this->flowStats[$target . '_total'];
420			continue;
421			}
422
423			$this->flowIncrements[$incrementKey] = $target;
424			$this->incrementTotals[$incrementKey] = $incrementKey . '_total';
425			$this->flowStats[$incrementKey] = $target;
426			}
427
428			return $this;
429			}
430
431			/**
432			* @param NodeInterface $node
433			*
434			* @throws NodalFlowException
435			*
436			* @return $this
437			*/
438			protected function setNodeIncrement(NodeInterface $node)
439			{
440			$nodeId = $node->getId();
441			foreach ($node->getNodeIncrements() as $incrementKey => $target) {
442			if (is_string($target)) {
443			if (!isset($this->nodeIncrements[$target])) {
444			throw new NodalFlowException('Tried to set an increment alias to an un-registered increment', 1, null, [
445			'aliasKey' => $incrementKey,
446			'targetKey' => $target,
447			]);
448			}
449
450			$this->nodeMap[$nodeId][$incrementKey] = &$this->nodeMap[$nodeId][$target];
451			continue;
452			}
453
454			$this->nodeIncrements[$incrementKey] = $target;
455			$this->nodeMap[$nodeId][$incrementKey] = $target;
456			}
457
458			return $this;
459			}
460			}
461

fab2s / NodalFlow

Push — master ( 82eb11...0228a6 )

FlowMap::getNodeMap() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like