Xhgui_Storage_Mongo::removeWatchedFunction() - Code Metrics - Inspection of "Introduce multiple storage drivers" - perftools/xhgui - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#268)

unknown

created 2019-08-04 20:58 UTC

Xhgui_Storage_Mongo::removeWatchedFunction() A

↳ Parent: Xhgui_Storage_Mongo

Complexity

Conditions	2
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0
cc	2
nc	3
nop	1

<?php

/**
 * Class Xhgui_Storage_Mongo
 */
class Xhgui_Storage_Mongo extends Xhgui_Storage_Abstract implements
    \Xhgui_StorageInterface,
    \Xhgui_WatchedFunctionsStorageInterface
{

    protected $config;

    /**
     * @var \MongoDB
     */
    protected $connection;

    /**
     * @var int
     */
    protected $defaultPerPage = 25;

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

    /**
     * @var \MongoClient
     */
    protected $mongoClient;

    /**
     * Mongo constructor.
     * @param $config
     * @throws \MongoConnectionException
     * @throws \MongoException
     */
    public function __construct($config, $collection = 'results')
    {
        $this->config = $config;
        // set default number of rows for all results. This can be changed
        // for each query
        $this->defaultPerPage = $config['page.limit'];

        $this->collectionName = $collection;

        // make sure options is an array
        if (empty($config['db.options'])) {
            $config['db.options'] = array();
        }

        $config['db.options']['connect'] = true;
    }

    /**
     * @inheritDoc
     * @param $options
     * @param bool $projections
     * @return Xhgui_Storage_ResultSet
     * @throws \MongoCursorException
     */
    public function find(\Xhgui_Storage_Filter $filter, $projections = false)
    {
        $sort = [];
        switch ($filter->getSort()) {
            case 'ct':
            case 'wt':
            case 'cpu':
            case 'mu':
            case 'pmu':
                $sort['profile.main().' . $filter->getSort()] = $filter->getDirection() === 'asc' ? 1 : -1;
                break;
            case 'time':
                $sort['meta.request_ts'] = $filter->getDirection() === 'asc' ? 1 : -1;
                break;
        }

        $conditions = $this->getConditions($filter);

        $ret = $this->getCollection()
                    ->find($conditions)
                    ->sort($sort)
                    ->skip((int)($filter->getPage() - 1) * $filter->getPerPage())
                    ->limit($filter->getPerPage());


        $result = new \Xhgui_Storage_ResultSet(iterator_to_array($ret));
        return $result;
    }

    /**
     * @inheritDoc
     * @param $options
     * @return int
     * @throws \MongoCursorTimeoutException
     * @throws \MongoException
     */
    public function count(\Xhgui_Storage_Filter $filter)
    {
        $conditions = $this->getConditions($filter);

        $ret = $this->getCollection()->find($conditions, array('_id' => 1))->count();
        return $ret;
    }

    /**
     * @inheritDoc
     * @param $id
     * @return array|null
     * @throws \MongoException
     */
    public function findOne($id)
    {
        $ret = $this->getCollection()
                    ->findOne(['_id' => new \MongoId($id)]);
        return $ret;
    }

    /**
     * @inheritDoc
     * @param $id
     * @return array|bool
     * @throws MongoCursorException
     * @throws MongoCursorTimeoutException
     * @throws MongoException
     */
    public function remove($id)
    {
        return $this->getCollection()->remove(
            array('_id' => new MongoId($id)),
            array('w' => 1)
        );
    }

    /**
     * @inheritDoc
     */
    public function drop()
    {
        // TODO: Implement drop() method.
    }

    /**
     * @inheritDoc
     * @param $match
     * @param $col
     * @param int $percentile
     * @codeCoverageIgnore despite appearances this is very simple function and there is nothing to test here.
     * @return array
     * @throws \MongoException
     */
    public function aggregate(\Xhgui_Storage_Filter $filter, $col, $percentile = 1)
    {

        $conditions = $this->getConditions($filter);
        $param = [
            ['$match' => $conditions],
            [
                '$project' => [
                    'date'           => '$meta.request_ts',
                    'profile.main()' => 1
                ]
            ],
            [
                '$group' => [
                    '_id'        => '$date',
                    'row_count'  => ['$sum' => 1],
                    'wall_times' => ['$push' => '$profile.main().wt'],
                    'cpu_times'  => ['$push' => '$profile.main().cpu'],
                    'mu_times'   => ['$push' => '$profile.main().mu'],
                    'pmu_times'  => ['$push' => '$profile.main().pmu'],
                ]
            ],
            [
                '$project' => [
                    'date'       => '$date',
                    'row_count'  => '$row_count',
                    'raw_index'  => [
                        '$multiply' => [
                            '$row_count',
                            $percentile / 100
                        ]
                    ],
                    'wall_times' => '$wall_times',
                    'cpu_times'  => '$cpu_times',
                    'mu_times'   => '$mu_times',
                    'pmu_times'  => '$pmu_times',
                ]
            ],
            [
                '$sort' => ['_id' => 1]
            ],
        ];
        $ret = $this->getCollection()->aggregate(
            $param,
            [
                'cursor' => ['batchSize' => 0]
            ]
        );

        return $ret;
    }

    /**
     * @inheritDoc
     * @return array
     */
    public function getWatchedFunctions()
    {
        $ret = [];
        try {
            $cursor = $this->getConnection()->watches->find()->sort(['name' => 1]);
            $ret = [];
            foreach ($cursor as $row) {
                $ret[] = ['id' => $row['_id']->__toString(), 'name' => $row['name']];
            }
        } catch (\Exception $e) {
            // if something goes wrong just return empty array
            // @todo add exception
        }
        return $ret;
    }

    /**
     * @inheritDoc
     * @param $name
     * @return bool
     */
    public function addWatchedFunction($name)

    {

        $name = trim($name);
        if (empty($name)) {
            return false;
        }

        try {
            $id = new \MongoId();

            $data = [
                '_id'  => $id,
                'name' => $name
            ];
            $this->getConnection()->watches->insert($data);

            return true;
        } catch (\Exception $e) {
            // if something goes wrong just ignore for now
            // @todo add exception
        }
        return false;
    }

    /**
     * @inheritDoc
     * @param $id
     * @param $name
     * @return bool
     */
    public function updateWatchedFunction($id, $name)

    {
        $name = trim($name);
        if (empty($name)) {
            return false;
        }

        try {
            $id = new \MongoId($id);
            $data = [
                '_id'  => $id,
                'name' => $name
            ];
            $this->getConnection()->watches->save($data);

            return true;
        } catch (\Exception $e) {

        }

        return false;
    }

    /**
     * @inheritDoc
     * @param $id
     * @return bool
     */
    public function removeWatchedFunction($id)
    {

        try {
            $id = new \MongoId($id);

            $this->getConnection()->watches->remove(['_id' => $id]);

            return true;
        } catch (\Exception $e) {

        }
        return false;
    }

    /**
     * Convert filter into mongo condition
     *
     * @param \Xhgui_Storage_Filter $filter
     * @return array
     */
    protected function getConditions(\Xhgui_Storage_Filter $filter)
    {
        $conditions = [];
        if (null !== $filter->getStartDate()) {

            $conditions['meta.request_ts']['$gte'] = new \MongoDate(
                $this->getDateTimeFromString($filter->getStartDate(), 'start')->format('U')
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        if (null !== $filter->getEndDate()) {

            $conditions['meta.request_ts']['$lte'] = new \MongoDate(
                $this->getDateTimeFromString($filter->getEndDate(), 'end')->format('U')
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        if (null !== $filter->getUrl()) {

            $conditions['meta.simple_url'] = new \MongoRegex('/'.preg_quote($filter->getUrl(), '/').'/');
        }

        if (null !== $filter->getIp()) {
            $conditions['meta.SERVER.REMOTE_ADDR'] = $filter->getIp();
        }

        if (null !== $filter->getCookie()) {

            $conditions['meta.SERVER.HTTP_COOKIE'] = new \MongoRegex('/'.preg_quote($filter->getCookie(), '/').'/');
        }

        foreach ([
                     'method'      => 'method',
                     'application' => 'application',
                     'version'     => 'version',
                     'branch'      => 'branch',
                     'controller'  => 'controller',
                     'action'      => 'action',
                 ] as $dbField => $field) {
            $method = 'get' . ucfirst($field);
            if ($filter->{$method}()) {
                $conditions['meta.' . $dbField] = $filter->{$method}();
            }
        }

        return $conditions;
    }

    /**
     * Get mongo client from config
     *
     * @return MongoClient
     * @throws MongoConnectionException
     */
    public function getMongoClient()
    {
        if (empty($this->mongoClient)) {
            $this->mongoClient = new \MongoClient($this->config['db.host'], $this->config['db.options']);
        }
        return $this->mongoClient;
    }

    /**
     * Set prepared mongo client.
     *
     * @param MongoClient $mongoClient
     */
    public function setMongoClient($mongoClient)
    {
        $this->mongoClient = $mongoClient;
    }

    /**
     * Get connection.
     *
     * @return MongoDB
     * @throws MongoConnectionException
     */
    public function getConnection()
    {
        if (empty($this->connection)) {
            $this->connection = $this->getMongoClient()->{$this->config['db.db']};
        }

        return $this->connection;
    }

    /**
     * Set existing connection
     *
     * @param MongoDB $connection
     */
    public function setConnection($connection)
    {
        $this->connection = $connection;
    }

    /**
     * Select specific connection
     *
     * @return MongoCollection
     * @throws Exception
     */
    public function getCollection()
    {
        return $this->getConnection()->selectCollection($this->collectionName);
    }
}


1		<?php
2
3		/**
4		* Class Xhgui_Storage_Mongo
5		*/
6		class Xhgui_Storage_Mongo extends Xhgui_Storage_Abstract implements
7		\Xhgui_StorageInterface,
8		\Xhgui_WatchedFunctionsStorageInterface
9		{
10
11		protected $config;
12
13		/**
14		* @var \MongoDB
15		*/
16		protected $connection;
17
18		/**
19		* @var int
20		*/
21		protected $defaultPerPage = 25;
22
23		/**
24		* @var string
25		*/
26		protected $collectionName;
27
28		/**
29		* @var \MongoClient
30		*/
31		protected $mongoClient;
32
33		/**
34		* Mongo constructor.
35		* @param $config
36		* @throws \MongoConnectionException
37		* @throws \MongoException
38		*/
39		public function __construct($config, $collection = 'results')
40		{
41		$this->config = $config;
42		// set default number of rows for all results. This can be changed
43		// for each query
44		$this->defaultPerPage = $config['page.limit'];
45
46		$this->collectionName = $collection;
47
48		// make sure options is an array
49		if (empty($config['db.options'])) {
50		$config['db.options'] = array();
51		}
52
53		$config['db.options']['connect'] = true;
54		}
55
56		/**
57		* @inheritDoc
58		* @param $options
59		* @param bool $projections
60		* @return Xhgui_Storage_ResultSet
61		* @throws \MongoCursorException
62		*/
63		public function find(\Xhgui_Storage_Filter $filter, $projections = false)
64		{
65		$sort = [];
66		switch ($filter->getSort()) {
67		case 'ct':
68		case 'wt':
69		case 'cpu':
70		case 'mu':
71		case 'pmu':
72		$sort['profile.main().' . $filter->getSort()] = $filter->getDirection() === 'asc' ? 1 : -1;
73		break;
74		case 'time':
75		$sort['meta.request_ts'] = $filter->getDirection() === 'asc' ? 1 : -1;
76		break;
77		}
78
79		$conditions = $this->getConditions($filter);
80
81		$ret = $this->getCollection()
82		->find($conditions)
83		->sort($sort)
84		->skip((int)($filter->getPage() - 1) * $filter->getPerPage())
85		->limit($filter->getPerPage());
86
87
88		$result = new \Xhgui_Storage_ResultSet(iterator_to_array($ret));
89		return $result;
90		}
91
92		/**
93		* @inheritDoc
94		* @param $options
95		* @return int
96		* @throws \MongoCursorTimeoutException
97		* @throws \MongoException
98		*/
99		public function count(\Xhgui_Storage_Filter $filter)
100		{
101		$conditions = $this->getConditions($filter);
102
103		$ret = $this->getCollection()->find($conditions, array('_id' => 1))->count();
104		return $ret;
105		}
106
107		/**
108		* @inheritDoc
109		* @param $id
110		* @return array\|null
111		* @throws \MongoException
112		*/
113		public function findOne($id)
114		{
115		$ret = $this->getCollection()
116		->findOne(['_id' => new \MongoId($id)]);
117		return $ret;
118		}
119
120		/**
121		* @inheritDoc
122		* @param $id
123		* @return array\|bool
124		* @throws MongoCursorException
125		* @throws MongoCursorTimeoutException
126		* @throws MongoException
127		*/
128		public function remove($id)
129		{
130		return $this->getCollection()->remove(
131		array('_id' => new MongoId($id)),
132		array('w' => 1)
133		);
134		}
135
136		/**
137		* @inheritDoc
138		*/
139		public function drop()
140		{
141		// TODO: Implement drop() method.
142		}
143
144		/**
145		* @inheritDoc
146		* @param $match
147		* @param $col
148		* @param int $percentile
149		* @codeCoverageIgnore despite appearances this is very simple function and there is nothing to test here.
150		* @return array
151		* @throws \MongoException
152		*/
153		public function aggregate(\Xhgui_Storage_Filter $filter, $col, $percentile = 1)
154		{
155
156		$conditions = $this->getConditions($filter);
157		$param = [
158		['$match' => $conditions],
159		[
160		'$project' => [
161		'date' => '$meta.request_ts',
162		'profile.main()' => 1
163		]
164		],
165		[
166		'$group' => [
167		'_id' => '$date',
168		'row_count' => ['$sum' => 1],
169		'wall_times' => ['$push' => '$profile.main().wt'],
170		'cpu_times' => ['$push' => '$profile.main().cpu'],
171		'mu_times' => ['$push' => '$profile.main().mu'],
172		'pmu_times' => ['$push' => '$profile.main().pmu'],
173		]
174		],
175		[
176		'$project' => [
177		'date' => '$date',
178		'row_count' => '$row_count',
179		'raw_index' => [
180		'$multiply' => [
181		'$row_count',
182		$percentile / 100
183		]
184		],
185		'wall_times' => '$wall_times',
186		'cpu_times' => '$cpu_times',
187		'mu_times' => '$mu_times',
188		'pmu_times' => '$pmu_times',
189		]
190		],
191		[
192		'$sort' => ['_id' => 1]
193		],
194		];
195		$ret = $this->getCollection()->aggregate(
196		$param,
197		[
198		'cursor' => ['batchSize' => 0]
199		]
200		);
201
202		return $ret;
203		}
204
205		/**
206		* @inheritDoc
207		* @return array
208		*/
209		public function getWatchedFunctions()
210		{
211		$ret = [];
212		try {
213		$cursor = $this->getConnection()->watches->find()->sort(['name' => 1]);
214		$ret = [];
215		foreach ($cursor as $row) {
216		$ret[] = ['id' => $row['_id']->__toString(), 'name' => $row['name']];
217		}
218		} catch (\Exception $e) {
219		// if something goes wrong just return empty array
220		// @todo add exception
221		}
222		return $ret;
223		}
224
225		/**
226		* @inheritDoc
227		* @param $name
228		* @return bool
229		*/
230	View Code Duplication	public function addWatchedFunction($name)
		0 ignored issues – show Duplication introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
231		{
232
233		$name = trim($name);
234		if (empty($name)) {
235		return false;
236		}
237
238		try {
239		$id = new \MongoId();
240
241		$data = [
242		'_id' => $id,
243		'name' => $name
244		];
245		$this->getConnection()->watches->insert($data);
246
247		return true;
248		} catch (\Exception $e) {
249		// if something goes wrong just ignore for now
250		// @todo add exception
251		}
252		return false;
253		}
254
255		/**
256		* @inheritDoc
257		* @param $id
258		* @param $name
259		* @return bool
260		*/
261	View Code Duplication	public function updateWatchedFunction($id, $name)
		0 ignored issues – show Duplication introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
262		{
263		$name = trim($name);
264		if (empty($name)) {
265		return false;
266		}
267
268		try {
269		$id = new \MongoId($id);
270		$data = [
271		'_id' => $id,
272		'name' => $name
273		];
274		$this->getConnection()->watches->save($data);
275
276		return true;
277		} catch (\Exception $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
278		}
279
280		return false;
281		}
282
283		/**
284		* @inheritDoc
285		* @param $id
286		* @return bool
287		*/
288		public function removeWatchedFunction($id)
289		{
290
291		try {
292		$id = new \MongoId($id);
293
294		$this->getConnection()->watches->remove(['_id' => $id]);
295
296		return true;
297		} catch (\Exception $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
298		}
299		return false;
300		}
301
302		/**
303		* Convert filter into mongo condition
304		*
305		* @param \Xhgui_Storage_Filter $filter
306		* @return array
307		*/
308		protected function getConditions(\Xhgui_Storage_Filter $filter)
309		{
310		$conditions = [];
311	View Code Duplication	if (null !== $filter->getStartDate()) {
		0 ignored issues – show Duplication introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
312		$conditions['meta.request_ts']['$gte'] = new \MongoDate(
313		$this->getDateTimeFromString($filter->getStartDate(), 'start')->format('U')
		0 ignored issues – show Documentation introduced 2019-06-19 22:38 UTC by Report Bug Copy Issue Report `$filter->getStartDate()` is of type `object<DateTime>`, but the function expects a `string\|integer`. 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...
314		);
315		}
316
317	View Code Duplication	if (null !== $filter->getEndDate()) {
		0 ignored issues – show Duplication introduced 2019-05-19 16:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
318		$conditions['meta.request_ts']['$lte'] = new \MongoDate(
319		$this->getDateTimeFromString($filter->getEndDate(), 'end')->format('U')
		0 ignored issues – show Documentation introduced 2019-06-19 22:38 UTC by Report Bug Copy Issue Report `$filter->getEndDate()` is of type `object<DateTime>`, but the function expects a `string\|integer`. 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...
320		);
321		}
322
323	View Code Duplication	if (null !== $filter->getUrl()) {
		0 ignored issues – show Duplication introduced 2019-08-04 15:24 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
324		$conditions['meta.simple_url'] = new \MongoRegex('/'.preg_quote($filter->getUrl(), '/').'/');
325		}
326
327		if (null !== $filter->getIp()) {
328		$conditions['meta.SERVER.REMOTE_ADDR'] = $filter->getIp();
329		}
330
331	View Code Duplication	if (null !== $filter->getCookie()) {
		0 ignored issues – show Duplication introduced 2019-08-04 15:24 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
332		$conditions['meta.SERVER.HTTP_COOKIE'] = new \MongoRegex('/'.preg_quote($filter->getCookie(), '/').'/');
333		}
334
335		foreach ([
336		'method' => 'method',
337		'application' => 'application',
338		'version' => 'version',
339		'branch' => 'branch',
340		'controller' => 'controller',
341		'action' => 'action',
342		] as $dbField => $field) {
343		$method = 'get' . ucfirst($field);
344		if ($filter->{$method}()) {
345		$conditions['meta.' . $dbField] = $filter->{$method}();
346		}
347		}
348
349		return $conditions;
350		}
351
352		/**
353		* Get mongo client from config
354		*
355		* @return MongoClient
356		* @throws MongoConnectionException
357		*/
358		public function getMongoClient()
359		{
360		if (empty($this->mongoClient)) {
361		$this->mongoClient = new \MongoClient($this->config['db.host'], $this->config['db.options']);
362		}
363		return $this->mongoClient;
364		}
365
366		/**
367		* Set prepared mongo client.
368		*
369		* @param MongoClient $mongoClient
370		*/
371		public function setMongoClient($mongoClient)
372		{
373		$this->mongoClient = $mongoClient;
374		}
375
376		/**
377		* Get connection.
378		*
379		* @return MongoDB
380		* @throws MongoConnectionException
381		*/
382		public function getConnection()
383		{
384		if (empty($this->connection)) {
385		$this->connection = $this->getMongoClient()->{$this->config['db.db']};
386		}
387
388		return $this->connection;
389		}
390
391		/**
392		* Set existing connection
393		*
394		* @param MongoDB $connection
395		*/
396		public function setConnection($connection)
397		{
398		$this->connection = $connection;
399		}
400
401		/**
402		* Select specific connection
403		*
404		* @return MongoCollection
405		* @throws Exception
406		*/
407		public function getCollection()
408		{
409		return $this->getConnection()->selectCollection($this->collectionName);
410		}
411		}
412

perftools / xhgui

Pull Request — master (#268)

Xhgui_Storage_Mongo::removeWatchedFunction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like