IndexService - Code Metrics - Inspection of "update" - ongr-io/ElasticsearchBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — upgrade ( f08820...3a8411 )

by Simonas

created 2019-02-19 14:45 UTC

IndexService D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	455
Duplicated Lines	8.13 %

Coupling/Cohesion

Components	1
Dependencies	14

Importance

Changes

Metric	Value
wmc	58
lcom	1
cbo	14
dl	37
loc	455
c	0
b	0
f	0
rs	4.5599

39 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getTypeName()	0	4	1
A	getClient()	0	4	1
A	getIndexName()	0	4	1
A	getConverter()	0	4	1
A	getEventDispatcher()	0	4	1
A	getBulkCommitSize()	0	4	1
A	setBulkCommitSize()	0	5	1
A	getCommitMode()	0	4	1
A	setCommitMode()	0	5	1
A	getStopwatch()	0	4	1
A	setStopwatch()	0	5	1
A	createIndex()	0	4	1
A	dropIndex()	0	4	1
A	dropAndCreateIndex()	0	12	3
A	indexExists()	0	4	1
A	find()	0	14	1
A	findByIds()	0	7	1
A	findBy()	0	30	5
A	findOneBy()	0	4	1
A	createSearch()	0	4	1
A	getScrollConfiguration()	0	10	2
A	findDocuments()	10	10	1
A	findArray()	10	10	1
A	findRaw()	10	10	1
A	executeSearch()	0	4	1
A	getIndexDocumentCount()	0	12	1
A	remove()	0	16	2
A	update()	0	21	1
A	search()	0	19	2
A	bulk()	0	19	3
A	persist()	7	7	1
B	commit()	0	56	6
A	flush()	0	4	1
A	refresh()	0	4	1
A	scroll()	0	6	1
A	clearScroll()	0	4	1
A	clearElasticIndexCache()	0	4	1
A	stopwatch()	0	6	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like IndexService often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use IndexService, and based on these observations, apply Extract Interface, too.

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\ElasticsearchBundle\Service;

use Elasticsearch\Client;
use ONGR\ElasticsearchBundle\Event\BulkEvent;
use ONGR\ElasticsearchBundle\Event\CommitEvent;
use ONGR\ElasticsearchBundle\Event\Events;
use ONGR\ElasticsearchBundle\Exception\BulkWithErrorsException;
use ONGR\ElasticsearchBundle\Result\ArrayIterator;
use ONGR\ElasticsearchBundle\Result\Converter;
use ONGR\ElasticsearchBundle\Result\RawIterator;
use ONGR\ElasticsearchDSL\Query\FullText\QueryStringQuery;
use ONGR\ElasticsearchDSL\Query\Compound\BoolQuery;
use ONGR\ElasticsearchDSL\Query\TermLevel\IdsQuery;
use ONGR\ElasticsearchDSL\Search;
use ONGR\ElasticsearchDSL\Sort\FieldSort;
use ONGR\ElasticsearchBundle\Result\DocumentIterator;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

/**
 * Document repository class.
 */
class IndexService
{
    private $client;

    private $indexName;

    private $converter;

    private $eventDispatcher;

    private $stopwatch;

    private $bulkCommitSize = 100;

    private $bulkQueries = [];

    private $commitMode = 'refresh';

    /**
     * @deprecated will be removed in v7 since there will be no more types in the indexes.
     */
    private $typeName;

    public function __construct(Client $client, Converter $converter, EventDispatcherInterface $eventDispatcher, array $mapping = [])
    {
        $this->client = $client;
        $this->typeName = $mapping['type'];

        $this->converter = $converter;
        $this->eventDispatcher = $eventDispatcher;
    }

    /**
     * @deprecated will be removed in v7 since there will be no more types in the indexes.
     */
    public function getTypeName(): string
    {
        return $this->typeName;

    }

    public function getClient(): Client
    {
        return $this->client;
    }

    public function getIndexName(): string
    {
        return $this->indexName;
    }

    public function getConverter(): Converter
    {
        return $this->converter;
    }

    public function getEventDispatcher(): EventDispatcherInterface
    {
        return $this->eventDispatcher;
    }

    public function getBulkCommitSize(): int
    {
        return $this->bulkCommitSize;
    }

    public function setBulkCommitSize(int $bulkCommitSize)
    {
        $this->bulkCommitSize = $bulkCommitSize;
        return $this;
    }

    public function getCommitMode(): string
    {
        return $this->commitMode;
    }

    public function setCommitMode(string $commitMode): IndexService
    {
        $this->commitMode = $commitMode;
        return $this;
    }

    public function getStopwatch()
    {
        return $this->stopwatch;
    }

    public function setStopwatch($stopwatch)
    {
        $this->stopwatch = $stopwatch;
        return $this;
    }

    public function createIndex($noMapping = false): array

    {
        return $this->getClient()->indices()->create($this->indexSettings);
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function dropIndex(): array
    {
        return $this->getClient()->indices()->delete(['index' => $this->getIndexName()]);
    }

    public function dropAndCreateIndex($noMapping = false)
    {
        try {
            if ($this->indexExists()) {
                $this->dropIndex();
            }
        } catch (\Exception $e) {
            // Do nothing, our target is to create new index.
        }

        return $this->createIndex($noMapping);
    }

    public function indexExists(): bool
    {
        return $this->getClient()->indices()->exists(['index' => $this->getIndexName()]);
    }

    /**
     * Returns a single document by provided ID or null if a document was not found.
     *
     * @param string $id      Document ID to find
     * @param array  $params  Custom parameters added to the query url
     *
     * @return object
     */
    public function find($id, $params = [])
    {
        $requestParams = [
            'index' => $this->getIndexName(),
            'type' => $this->getTypeName(),

            'id' => $id,
        ];

        $requestParams = array_merge($requestParams, $params);

        $result = $this->getClient()->get($requestParams);

        return $this->getConverter()->convertToDocument($result, $this);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    public function findByIds(array $ids): DocumentIterator
    {
        $search = $this->createSearch();
        $search->addQuery(new IdsQuery($ids));

        return $this->findDocuments($search);
    }

    /**
     * Finds documents by a set of criteria.
     *
     * @param array      $criteria   Example: ['group' => ['best', 'worst'], 'job' => 'medic'].
     * @param array|null $orderBy    Example: ['name' => 'ASC', 'surname' => 'DESC'].
     * @param int|null   $limit      Default is 10.
     * @param int|null   $offset     Default is 0.
     *
     * @return array|DocumentIterator The objects.
     */
    public function findBy(
        array $criteria,
        array $orderBy = [],
        int $limit = 10,
        int $offset = 0
    ) {
        $search = $this->createSearch();
        $search->setSize($limit);
        $search->setFrom($offset);

        foreach ($criteria as $field => $value) {
            if (preg_match('/^!(.+)$/', $field)) {
                $boolType = BoolQuery::MUST_NOT;
                $field = preg_replace('/^!/', '', $field);
            } else {
                $boolType = BoolQuery::MUST;
            }

            $search->addQuery(
                new QueryStringQuery(is_array($value) ? implode(' OR ', $value) : $value, ['default_field' => $field]),
                $boolType
            );
        }

        foreach ($orderBy as $field => $direction) {
            $search->addSort(new FieldSort($field, $direction));
        }

        return $this->findDocuments($search);
    }

    /**
     * Finds a single document by a set of criteria.
     *
     * @param array      $criteria   Example: ['group' => ['best', 'worst'], 'job' => 'medic'].
     * @param array|null $orderBy    Example: ['name' => 'ASC', 'surname' => 'DESC'].
     *
     * @return object|null The object.
     */
    public function findOneBy(array $criteria, array $orderBy = [])
    {
        return $this->findBy($criteria, $orderBy, 1, null)->current();
    }

    public function createSearch(): Search
    {
        return new Search();
    }

    public function getScrollConfiguration($raw, $scrollDuration): array
    {
        $scrollConfig = [];
        if (isset($raw['_scroll_id'])) {
            $scrollConfig['_scroll_id'] = $raw['_scroll_id'];
            $scrollConfig['duration'] = $scrollDuration;
        }

        return $scrollConfig;
    }

    public function findDocuments(Search $search): DocumentIterator

    {
        $results = $this->executeSearch($search);

        return new DocumentIterator(
            $results,
            $this->getManager(),

            $this->getScrollConfiguration($results, $search->getScroll())
        );
    }

    public function findArray(Search $search): ArrayIterator

    {
        $results = $this->executeSearch($search);

        return new ArrayIterator(
            $results,
            $this->getManager(),

            $this->getScrollConfiguration($results, $search->getScroll())
        );
    }

    public function findRaw(Search $search): RawIterator

    {
        $results = $this->executeSearch($search);

        return new RawIterator(
            $results,
            $this->getManager(),

            $this->getScrollConfiguration($results, $search->getScroll())
        );
    }

    private function executeSearch(Search $search): array
    {
        return $this->search([$this->getTypeName()], $search->toArray(), $search->getUriParams());

    }

    public function getIndexDocumentCount(): int
    {
        $body = [
            'index' => $this->getIndexName(),
            'type' => $this->getTypeName(),

            'body' => [],
        ];

        $results = $this->getClient()->count($body);

        return $results['count'];
    }

    public function remove($id, $routing = null)
    {
        $params = [
            'index' => $this->getIndexName(),
            'type' => $this->getTypeName(),

            'id' => $id,
        ];

        if ($routing) {
            $params['routing'] = $routing;
        }

        $response = $this->getClient()->delete($params);

        return $response;
    }

    public function update($id, array $fields = [], $script = null, array $params = []): array
    {
        $body = array_filter(
            [
                'doc' => $fields,
                'script' => $script,
            ]
        );

        $params = array_merge(
            [
                'id' => $id,
                'index' => $this->getIndexName(),
                'type' => $this->getTypeName(),

                'body' => $body,
            ],
            $params
        );

        return $this->getClient()->update($params);
    }

    public function search(array $query, array $params = []): array
    {
        $requestParams = [
            'index' => $this->getIndexName(),
            'type' => $this->getTypeName(),

            'body' => $query,
        ];


        if (!empty($params)) {
            $params = array_merge($requestParams, $params);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        }

//        $this->stopwatch('start', 'search');
        $result = $this->client->search($requestParams);
//        $this->stopwatch('stop', 'search');

        return $result;
    }

    public function bulk(string $operation, array $header, array $query = []): array
    {
        $this->eventDispatcher->dispatch(
            Events::BULK,
            new BulkEvent($operation, $this->getTypeName(), $header, $query)

        );

        $this->bulkQueries[] = $header;

        if (!empty($query)) $this->bulkQueries[] = $query;

        $response = [];
        // %2 is not very accurate, but better than use counter. This place is experimental for now.
        if ($this->getBulkCommitSize() >= count($this->bulkQueries % 2)) {
            $response = $this->commit();
        }

        return $response;
    }

    /**
     * Adds document to next flush.
     *
     * @param object $document
     */
    public function persist($document)

    {
        $documentArray = $this->converter->convertToArray($document);
        $type = $this->getMetadataCollector()->getDocumentType(get_class($document));


        $this->bulk('index', $type, $documentArray);
    }

    public function commit(array $params = []): array
    {
        $bulkResponse = [];
        if (!empty($this->bulkQueries)) {
            $this->eventDispatcher->dispatch(
                Events::PRE_COMMIT,
                new CommitEvent($this->getCommitMode(), $this->bulkQueries)
            );

//            $this->stopwatch('start', 'bulk');
            $bulkResponse = $this->client->bulk(
                array_merge(
                    [
                    'index' => $this->getIndexName(),
                    'body' => $this->bulkQueries,
                    ],
                    $params
                )
            );
//            $this->stopwatch('stop', 'bulk');

            if ($bulkResponse['errors']) {
                throw new BulkWithErrorsException(
                    json_encode($bulkResponse),
                    0,
                    null,
                    $bulkResponse
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

            $this->stopwatch('start', 'refresh');

            switch ($this->getCommitMode()) {
                case 'flush':
                    $this->getClient()->indices()->flush();
                    break;
                case 'flush_synced':
                    $this->getClient()->indices()->flushSynced();
                    break;
                case 'refresh':
                    $this->getClient()->indices()->refresh();
                    break;
            }

            $this->eventDispatcher->dispatch(
                Events::POST_COMMIT,
                new CommitEvent($this->getCommitMode(), $this->bulkQueries, $bulkResponse)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

            $this->bulkQueries = [];

            $this->stopwatch('stop', $this->getCommitMode());
        }

        return $bulkResponse;
    }

    public function flush(array $params = []): array
    {
        return $this->client->indices()->flush(array_merge(['index' => $this->getIndexName()], $params));
    }

    public function refresh(array $params = []): array
    {
        return $this->client->indices()->refresh(array_merge(['index' => $this->getIndexName()], $params));
    }

    public function scroll($scrollId, $scrollDuration = '5m'): array
    {
        $results = $this->getClient()->scroll(['scroll_id' => $scrollId, 'scroll' => $scrollDuration]);

        return $results;
    }

    public function clearScroll($scrollId): array
    {
        return $this->getClient()->clearScroll(['scroll_id' => $scrollId]);
    }

    public function clearElasticIndexCache(): array
    {
        return $this->getClient()->indices()->clearCache(['index' => $this->getIndexName()]);
    }

    private function stopwatch($action, $name): void
    {
        if ($this->stopwatch && ($action == 'start' || $action == 'stop')) {
            $this->stopwatch->$action('ongr_es: '.$name, 'ongr_es');
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the ONGR package.
5			*
6			* (c) NFQ Technologies UAB <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace ONGR\ElasticsearchBundle\Service;
13
14			use Elasticsearch\Client;
15			use ONGR\ElasticsearchBundle\Event\BulkEvent;
16			use ONGR\ElasticsearchBundle\Event\CommitEvent;
17			use ONGR\ElasticsearchBundle\Event\Events;
18			use ONGR\ElasticsearchBundle\Exception\BulkWithErrorsException;
19			use ONGR\ElasticsearchBundle\Result\ArrayIterator;
20			use ONGR\ElasticsearchBundle\Result\Converter;
21			use ONGR\ElasticsearchBundle\Result\RawIterator;
22			use ONGR\ElasticsearchDSL\Query\FullText\QueryStringQuery;
23			use ONGR\ElasticsearchDSL\Query\Compound\BoolQuery;
24			use ONGR\ElasticsearchDSL\Query\TermLevel\IdsQuery;
25			use ONGR\ElasticsearchDSL\Search;
26			use ONGR\ElasticsearchDSL\Sort\FieldSort;
27			use ONGR\ElasticsearchBundle\Result\DocumentIterator;
28			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
29
30			/**
31			* Document repository class.
32			*/
33			class IndexService
34			{
35			private $client;
36
37			private $indexName;
38
39			private $converter;
40

ongr-io / ElasticsearchBundle