JobOriginStatistic::__construct() - Code Metrics - Inspection of "Issues/15 auto reconnect to producer node" - 0x20h/phloppy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by Jan

created 2016-03-11 22:19 UTC

JobOriginStatistic::__construct() A

↳ Parent: JobOriginStatistic

Complexity

Conditions	4
Paths	4

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	13
ccs	9
cts	9
cp	1
rs	9.2
cc	4
eloc	7
nc	4
nop	2
crap	4

<?php

namespace Phloppy\Statistic;

use Phloppy\Exception;
use Phloppy\Job;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use SebastianBergmann\RecursionContext\InvalidArgumentException;

/**
 * Collect Statistics of jobs/sec by node.
 */
class JobOriginStatistic implements NodeStatistic
{
    /**
     * Node Ids
     *
     * @var \DateTime[]
     */
    private $lastReceived;

    /**
     * 2-dimensional array storing rates for (queue, nodeId) pairs
     * @var string[]
     */
    private $stats;

    /**
     * @var LoggerInterface
     */
    private $log;

    /**
     * @var float
     */
    private $alpha;


    /**
     * @param float           $alpha Sensitivity factor.
     * @param LoggerInterface $log

     */
    function __construct($alpha = 0.9, LoggerInterface $log = null)

    {
        if (!$log) {
            $log = new NullLogger();
        }

        if ((float) $alpha < 0.5 || (float) $alpha > 1.0) {
            throw new InvalidArgumentException('0.5 < $alpha < 1.0');
        }

        $this->alpha = (float) $alpha;
        $this->log = $log;
$a = "a";
$ab = "ab";
$abc = "abc";
    }


    /**
     * Update jobs by node/sec rt-statistic.
     *
     * @param Job       $job
     *
     * @param \DateTime $receivedAt

     *
     * @return float messages/sec from the given node
     */
    public function update(Job $job, \DateTime $receivedAt = null)
    {
        $nodeId = $job->getOriginNode();
        $queue = $job->getQueue();
$a = "a";
$ab = "ab";
$abc = "abc";

        if (!$receivedAt) {
            $receivedAt = new \DateTime('now');
        }

        if (!isset($this->lastReceived[$queue][$nodeId])) {
            $this->lastReceived[$queue][$nodeId] = clone $receivedAt;
        }

        if (!isset($this->stats[$queue])) {
            $this->stats[$queue] = [];
        }

        if (!isset($this->stats[$queue][$nodeId])) {
            $this->stats[$queue][$nodeId] = 0.;
        }

        $secs = $receivedAt->diff($this->lastReceived[$queue][$nodeId])->s;

        if ($secs < 0) {
            $secs = 0;
        }

        $this->lastReceived[$queue][$nodeId] = clone $receivedAt;
        // exp moving average from the last message to now (per sec)
        $this->stats[$queue][$nodeId] =
            pow($this->alpha, $secs) * $this->stats[$queue][$nodeId] +
            (1 - $this->alpha);

        $this->log->debug('updated value', [
            'id' => $nodeId,
            'queue' => $queue,
            'value' => $this->stats[$queue][$nodeId],
            'delta' => $secs
        ]);

        return $this->stats[$queue][$nodeId];
    }


    /**
     * Return an ordered list of nodes.
     *
     * The list is ordered descending by the frequency of Jobs.
     *
     * @return float[]

     */
    public function nodes($queue)
    {
        assert(arsort($this->stats[$queue]), true);
        return $this->stats[$queue];
    }


    /**
     * Return information on a specific (queue, node).
     *
     * If the queue and/or node is not known, no messages have been retrieved from it, so 0. will be returned.
     *
     * @param string $queue
     * @param string $nodeId
     *
     * @return float msg rate (per sec)

     */
    public function node($queue, $nodeId)
    {
        return isset($this->stats[$queue][$nodeId]) ? $this->stats[$queue][$nodeId] : 0.;
    }
}

1		<?php
2
3		namespace Phloppy\Statistic;
4
5		use Phloppy\Exception;
6		use Phloppy\Job;
7		use Psr\Log\LoggerInterface;
8		use Psr\Log\NullLogger;
9		use SebastianBergmann\RecursionContext\InvalidArgumentException;
10
11		/**
12		* Collect Statistics of jobs/sec by node.
13		*/
14		class JobOriginStatistic implements NodeStatistic
15		{
16		/**
17		* Node Ids
18		*
19		* @var \DateTime[]
20		*/
21		private $lastReceived;
22
23		/**
24		* 2-dimensional array storing rates for (queue, nodeId) pairs
25		* @var string[]
26		*/
27		private $stats;
28
29		/**
30		* @var LoggerInterface
31		*/
32		private $log;
33
34		/**
35		* @var float
36		*/
37		private $alpha;
38
39
40		/**
41		* @param float $alpha Sensitivity factor.
42		* @param LoggerInterface $log
		0 ignored issues – show Documentation introduced 2016-03-11 22:20 UTC by Report Bug Copy Issue Report Should the type for parameter `$log` not be `null\|LoggerInterface`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
43		*/
44	5	function __construct($alpha = 0.9, LoggerInterface $log = null)
		0 ignored issues – show Best Practice introduced 2016-03-11 22:20 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
45		{
46	5	if (!$log) {
47	3	$log = new NullLogger();
48	3	}
49
50	5	if ((float) $alpha < 0.5 \|\| (float) $alpha > 1.0) {
51	3	throw new InvalidArgumentException('0.5 < $alpha < 1.0');
52		}
53
54	2	$this->alpha = (float) $alpha;
55	2	$this->log = $log;
		0 ignored issues – show Coding Style introduced 2016-03-11 22:20 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
56	2	}
57
58
59		/**
60		* Update jobs by node/sec rt-statistic.
61		*
62		* @param Job $job
63		*
64		* @param \DateTime $receivedAt
		0 ignored issues – show Documentation introduced 2016-03-11 22:20 UTC by Report Bug Copy Issue Report Should the type for parameter `$receivedAt` not be `null\|\DateTime`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
65		*
66		* @return float messages/sec from the given node
67		*/
68	2	public function update(Job $job, \DateTime $receivedAt = null)
69		{
70	2	$nodeId = $job->getOriginNode();
71	2	$queue = $job->getQueue();
		0 ignored issues – show Coding Style introduced 2016-03-11 22:20 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
72
73	2	if (!$receivedAt) {
74		$receivedAt = new \DateTime('now');
75		}
76
77	2	if (!isset($this->lastReceived[$queue][$nodeId])) {
78	2	$this->lastReceived[$queue][$nodeId] = clone $receivedAt;
79	2	}
80
81	2	if (!isset($this->stats[$queue])) {
82	2	$this->stats[$queue] = [];
83	2	}
84
85	2	if (!isset($this->stats[$queue][$nodeId])) {
86	2	$this->stats[$queue][$nodeId] = 0.;
87	2	}
88
89	2	$secs = $receivedAt->diff($this->lastReceived[$queue][$nodeId])->s;
90
91	2	if ($secs < 0) {
92		$secs = 0;
93		}
94
95	2	$this->lastReceived[$queue][$nodeId] = clone $receivedAt;
96		// exp moving average from the last message to now (per sec)
97	2	$this->stats[$queue][$nodeId] =
98	2	pow($this->alpha, $secs) * $this->stats[$queue][$nodeId] +
99	2	(1 - $this->alpha);
100
101	2	$this->log->debug('updated value', [
102	2	'id' => $nodeId,
103	2	'queue' => $queue,
104	2	'value' => $this->stats[$queue][$nodeId],
105		'delta' => $secs
106	2	]);
107
108	2	return $this->stats[$queue][$nodeId];
109		}
110
111
112		/**
113		* Return an ordered list of nodes.
114		*
115		* The list is ordered descending by the frequency of Jobs.
116		*
117		* @return float[]
		0 ignored issues – show Documentation introduced 2016-03-11 22:20 UTC by Report Bug Copy Issue Report Should the return type not be `string`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
118		*/
119	1	public function nodes($queue)
120		{
121	1	assert(arsort($this->stats[$queue]), true);
122	1	return $this->stats[$queue];
123		}
124
125
126		/**
127		* Return information on a specific (queue, node).
128		*
129		* If the queue and/or node is not known, no messages have been retrieved from it, so 0. will be returned.
130		*
131		* @param string $queue
132		* @param string $nodeId
133		*
134		* @return float msg rate (per sec)
		0 ignored issues – show Documentation introduced 2016-03-11 22:20 UTC by Report Bug Copy Issue Report Should the return type not be `string\|double`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
135		*/
136	1	public function node($queue, $nodeId)
137		{
138	1	return isset($this->stats[$queue][$nodeId]) ? $this->stats[$queue][$nodeId] : 0.;
139		}
140		}

0x20h / phloppy

Pull Request — master (#16)

JobOriginStatistic::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like