SolrIndexTask::__construct() - Code Metrics - Inspection of "Test the right task" - Firesphere/silverstripe-solr-search - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — hans/logtests ( 76c086...71695d )

by Simon

created 2019-08-24 21:53 UTC

SolrIndexTask::__construct() A

↳ Parent: SolrIndexTask

Complexity

Conditions	2
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
eloc	5
c	4
b	0
f	0
dl	0
loc	9
ccs	6
cts	6
cp	1
rs	10
cc	2
nc	1
nop	0
crap	2

<?php


namespace Firesphere\SolrSearch\Tasks;

use Exception;
use Firesphere\SolrSearch\Factories\DocumentFactory;
use Firesphere\SolrSearch\Helpers\SolrLogger;
use Firesphere\SolrSearch\Indexes\BaseIndex;
use Firesphere\SolrSearch\Services\SolrCoreService;
use Firesphere\SolrSearch\Traits\LoggerTrait;
use GuzzleHttp\Exception\GuzzleException;
use Psr\Log\LoggerInterface;
use SilverStripe\Control\Director;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\BuildTask;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ValidationException;
use SilverStripe\Versioned\Versioned;

/**
 * Class SolrIndexTask
 * @package Firesphere\SolrSearch\Tasks
 */
class SolrIndexTask extends BuildTask
{
    use LoggerTrait;
    /**
     * @var string
     */
    private static $segment = 'SolrIndexTask';

    /**
     * @var string
     */
    protected $title = 'Solr Index update';

    /**
     * @var string
     */
    protected $description = 'Add or update documents to an existing Solr core.';

    /**
     * @var bool
     */
    protected $debug = false;

    /**
     * @var SolrCoreService
     */
    protected $service;

    /**
     * SolrIndexTask constructor. Sets up the document factory
     */
    public function __construct()
    {
        parent::__construct();
        // Only index live items.
        // The old FTS module also indexed Draft items. This is unnecessary
        Versioned::set_reading_mode(Versioned::DRAFT . '.' . Versioned::LIVE);
        $this->setService(Injector::inst()->get(SolrCoreService::class));
        $this->setLogger(Injector::inst()->get(LoggerInterface::class));
        $this->setDebug(Director::isDev() || Director::is_cli());
    }

    /**
     * @param SolrCoreService $service
     * @return SolrIndexTask
     */
    public function setService(SolrCoreService $service): SolrIndexTask
    {
        $this->service = $service;

        return $this;
    }

    /**
     * @param bool $debug
     * @return SolrIndexTask
     */
    public function setDebug(bool $debug): SolrIndexTask
    {
        $this->debug = $debug;

        return $this;
    }

    /**
     * Implement this method in the task subclass to
     * execute via the TaskRunner
     *
     * @param HTTPRequest $request
     * @return int|bool
     * @throws Exception
     * @throws GuzzleException
     * @todo defer to background because it may run out of memory
     */
    public function run($request)
    {
        $startTime = time();
        [$vars, $group, $isGroup] = $this->taskSetup($request);
        $groups = 0;
        $indexes = $this->service->getValidIndexes($request->getVar('index'));

        foreach ($indexes as $indexName) {
            /** @var BaseIndex $index */
            $index = Injector::inst()->get($indexName, false);

            $indexClasses = $index->getClasses();
            $classes = $this->getClasses($vars, $indexClasses);
            if (!count($classes)) {
                continue;
            }

            $vars = $this->clearIndex($vars, $indexName, $index);

            $groups = $this->indexClassForIndex($classes, $isGroup, $index, $group);
        }
        $this->getLogger()->info(
            sprintf('It took me %d seconds to do all the indexing%s', (time() - $startTime), PHP_EOL)
        );
        // Grab the latest logs from indexing if needed
        $solrLogger = new SolrLogger();
        $solrLogger->saveSolrLog('Config');

        return $groups;
    }

    /**
     * @param HTTPRequest $request
     * @return array
     */
    protected function taskSetup($request): array
    {
        $vars = $request->getVars();
        $this->debug = $this->debug || isset($vars['debug']);
        $group = $vars['group'] ?? 0;
        $start = $vars['start'] ?? 0;
        $group = ($start > $group) ? $start : $group;
        $isGroup = isset($vars['group']);

        return [$vars, $group, $isGroup];
    }

    /**
     * @param $vars
     * @param array $classes
     * @return bool|array
     */
    protected function getClasses($vars, array $classes): array
    {
        if (isset($vars['class'])) {
            return array_intersect($classes, [$vars['class']]);
        }

        return $classes;
    }

    /**
     * @param $vars
     * @param $indexName
     * @param BaseIndex $index
     * @return mixed
     * @throws Exception
     */
    protected function clearIndex($vars, $indexName, BaseIndex $index)
    {
        if (!empty($vars['clear'])) {
            $this->getLogger()->info(sprintf('Clearing index %s', $indexName));
            $this->service->doManipulate(ArrayList::create([]), SolrCoreService::DELETE_TYPE_ALL, $index);
        }

        return $vars;
    }

    /**
     * @param $classes
     * @param $isGroup
     * @param BaseIndex $index
     * @param $group
     * @return int
     * @throws Exception
     * @throws GuzzleException
     */
    protected function indexClassForIndex($classes, $isGroup, BaseIndex $index, $group): int
    {
        $groups = 0;
        foreach ($classes as $class) {
            $groups = $this->indexClass($isGroup, $class, $index, $group);
        }

        return $groups;
    }

    /**
     * @param bool $isGroup
     * @param string $class
     * @param BaseIndex $index
     * @param int $group
     * @return int
     * @throws GuzzleException
     * @throws ValidationException
     */
    private function indexClass($isGroup, $class, BaseIndex $index, int $group): int
    {
        $this->getLogger()->info(sprintf('Indexing %s for %s', $class, $index->getIndexName()), []);

        $batchLength = DocumentFactory::config()->get('batchLength');
        $groups = (int)ceil($class::get()->count() / $batchLength);
        $groups = $isGroup ? $group : $groups;
        while ($group <= $groups) { // Run from oldest to newest
            try {
                $this->doReindex($group, $class, $batchLength, $index);
            } catch (Exception $error) {
                $this->logException($index->getIndexName(), $group, $error);
                $group++;
                continue;
            }
            $group++;
            $this->getLogger()->info(sprintf('Indexed group %s', $group));
        }

        return $groups;
    }

    /**
     * @param int $group
     * @param string $class
     * @param int $batchLength
     * @param BaseIndex $index
     * @throws Exception
     */
    private function doReindex($group, $class, $batchLength, BaseIndex $index): void
    {
        // Generate filtered list of local records
        $baseClass = DataObject::getSchema()->baseDataClass($class);
        $client = $index->getClient();
        /** @var DataList|DataObject[] $items */
        $items = DataObject::get($baseClass)
            ->sort('ID ASC')
            ->limit($batchLength, ($group * $batchLength));
        $update = $client->createUpdate();
        if ($items->count()) {
            $this->service->setInDebugMode($this->debug);
            $this->service->updateIndex($index, $items, $update);
            $update->addCommit();
            $client->update($update);
        }
    }

    /**
     * @param string $index
     * @param int $group
     * @param Exception $exception
     * @throws GuzzleException
     * @throws ValidationException
     */
    private function logException($index, int $group, Exception $exception)
    {
        $this->getLogger()->error($exception->getMessage());
        $msg = sprintf(
            "Error indexing core %s on group %s," . PHP_EOL .
            "Please log in to the CMS to find out more about Indexing errors" . PHP_EOL .
            'Last known error:',
            $index,
            $group
        );
        SolrLogger::logMessage('ERROR', $msg, $index);
    }
}


1		<?php
2
3
4		namespace Firesphere\SolrSearch\Tasks;
5
6		use Exception;
7		use Firesphere\SolrSearch\Factories\DocumentFactory;
8		use Firesphere\SolrSearch\Helpers\SolrLogger;
9		use Firesphere\SolrSearch\Indexes\BaseIndex;
10		use Firesphere\SolrSearch\Services\SolrCoreService;
11		use Firesphere\SolrSearch\Traits\LoggerTrait;
12		use GuzzleHttp\Exception\GuzzleException;
13		use Psr\Log\LoggerInterface;
14		use SilverStripe\Control\Director;
15		use SilverStripe\Control\HTTPRequest;
16		use SilverStripe\Core\Injector\Injector;
17		use SilverStripe\Dev\BuildTask;
18		use SilverStripe\ORM\ArrayList;
19		use SilverStripe\ORM\DataList;
20		use SilverStripe\ORM\DataObject;
21		use SilverStripe\ORM\ValidationException;
22		use SilverStripe\Versioned\Versioned;
23
24		/**
25		* Class SolrIndexTask
26		* @package Firesphere\SolrSearch\Tasks
27		*/
28		class SolrIndexTask extends BuildTask
29		{
30		use LoggerTrait;
31		/**
32		* @var string
33		*/
34		private static $segment = 'SolrIndexTask';
35
36		/**
37		* @var string
38		*/
39		protected $title = 'Solr Index update';
40
41		/**
42		* @var string
43		*/
44		protected $description = 'Add or update documents to an existing Solr core.';
45
46		/**
47		* @var bool
48		*/
49		protected $debug = false;
50
51		/**
52		* @var SolrCoreService
53		*/
54		protected $service;
55
56		/**
57		* SolrIndexTask constructor. Sets up the document factory
58		*/
59	12	public function __construct()
60		{
61	12	parent::__construct();
62		// Only index live items.
63		// The old FTS module also indexed Draft items. This is unnecessary
64	12	Versioned::set_reading_mode(Versioned::DRAFT . '.' . Versioned::LIVE);
65	12	$this->setService(Injector::inst()->get(SolrCoreService::class));
66	12	$this->setLogger(Injector::inst()->get(LoggerInterface::class));
67	12	$this->setDebug(Director::isDev() \|\| Director::is_cli());
68	12	}
69
70		/**
71		* @param SolrCoreService $service
72		* @return SolrIndexTask
73		*/
74	12	public function setService(SolrCoreService $service): SolrIndexTask
75		{
76	12	$this->service = $service;
77
78	12	return $this;
79		}
80
81		/**
82		* @param bool $debug
83		* @return SolrIndexTask
84		*/
85	12	public function setDebug(bool $debug): SolrIndexTask
86		{
87	12	$this->debug = $debug;
88
89	12	return $this;
90		}
91
92		/**
93		* Implement this method in the task subclass to
94		* execute via the TaskRunner
95		*
96		* @param HTTPRequest $request
97		* @return int\|bool
98		* @throws Exception
99		* @throws GuzzleException
100		* @todo defer to background because it may run out of memory
101		*/
102	11	public function run($request)
103		{
104	11	$startTime = time();
105	11	[$vars, $group, $isGroup] = $this->taskSetup($request);
106	11	$groups = 0;
107	11	$indexes = $this->service->getValidIndexes($request->getVar('index'));
108
109	11	foreach ($indexes as $indexName) {
110		/** @var BaseIndex $index */
111	11	$index = Injector::inst()->get($indexName, false);
112
113	11	$indexClasses = $index->getClasses();
114	11	$classes = $this->getClasses($vars, $indexClasses);
115	11	if (!count($classes)) {
116		continue;
117		}
118
119	11	$vars = $this->clearIndex($vars, $indexName, $index);
120
121	11	$groups = $this->indexClassForIndex($classes, $isGroup, $index, $group);
122		}
123	11	$this->getLogger()->info(
124	11	sprintf('It took me %d seconds to do all the indexing%s', (time() - $startTime), PHP_EOL)
125		);
126		// Grab the latest logs from indexing if needed
127	11	$solrLogger = new SolrLogger();
128	11	$solrLogger->saveSolrLog('Config');
129
130	11	return $groups;
131		}
132
133		/**
134		* @param HTTPRequest $request
135		* @return array
136		*/
137	11	protected function taskSetup($request): array
138		{
139	11	$vars = $request->getVars();
140	11	$this->debug = $this->debug \|\| isset($vars['debug']);
141	11	$group = $vars['group'] ?? 0;
142	11	$start = $vars['start'] ?? 0;
143	11	$group = ($start > $group) ? $start : $group;
144	11	$isGroup = isset($vars['group']);
145
146	11	return [$vars, $group, $isGroup];
147		}
148
149		/**
150		* @param $vars
151		* @param array $classes
152		* @return bool\|array
153		*/
154	11	protected function getClasses($vars, array $classes): array
155		{
156	11	if (isset($vars['class'])) {
157	1	return array_intersect($classes, [$vars['class']]);
158		}
159
160	10	return $classes;
161		}
162
163		/**
164		* @param $vars
165		* @param $indexName
166		* @param BaseIndex $index
167		* @return mixed
168		* @throws Exception
169		*/
170	11	protected function clearIndex($vars, $indexName, BaseIndex $index)
171		{
172	11	if (!empty($vars['clear'])) {
173	1	$this->getLogger()->info(sprintf('Clearing index %s', $indexName));
174	1	$this->service->doManipulate(ArrayList::create([]), SolrCoreService::DELETE_TYPE_ALL, $index);
175		}
176
177	11	return $vars;
178		}
179
180		/**
181		* @param $classes
182		* @param $isGroup
183		* @param BaseIndex $index
184		* @param $group
185		* @return int
186		* @throws Exception
187		* @throws GuzzleException
188		*/
189	11	protected function indexClassForIndex($classes, $isGroup, BaseIndex $index, $group): int
190		{
191	11	$groups = 0;
192	11	foreach ($classes as $class) {
193	11	$groups = $this->indexClass($isGroup, $class, $index, $group);
194		}
195
196	11	return $groups;
197		}
198
199		/**
200		* @param bool $isGroup
201		* @param string $class
202		* @param BaseIndex $index
203		* @param int $group
204		* @return int
205		* @throws GuzzleException
206		* @throws ValidationException
207		*/
208	11	private function indexClass($isGroup, $class, BaseIndex $index, int $group): int
209		{
210	11	$this->getLogger()->info(sprintf('Indexing %s for %s', $class, $index->getIndexName()), []);
211
212	11	$batchLength = DocumentFactory::config()->get('batchLength');
213	11	$groups = (int)ceil($class::get()->count() / $batchLength);
214	11	$groups = $isGroup ? $group : $groups;
215	11	while ($group <= $groups) { // Run from oldest to newest
216		try {
217	11	$this->doReindex($group, $class, $batchLength, $index);
218		} catch (Exception $error) {
219		$this->logException($index->getIndexName(), $group, $error);
220		$group++;
221		continue;
222		}
223	11	$group++;
224	11	$this->getLogger()->info(sprintf('Indexed group %s', $group));
225		}
226
227	11	return $groups;
228		}
229
230		/**
231		* @param int $group
232		* @param string $class
233		* @param int $batchLength
234		* @param BaseIndex $index
235		* @throws Exception
236		*/
237	11	private function doReindex($group, $class, $batchLength, BaseIndex $index): void
238		{
239		// Generate filtered list of local records
240	11	$baseClass = DataObject::getSchema()->baseDataClass($class);
241	11	$client = $index->getClient();
242		/** @var DataList\|DataObject[] $items */
243	11	$items = DataObject::get($baseClass)
244	11	->sort('ID ASC')
245	11	->limit($batchLength, ($group * $batchLength));
246	11	$update = $client->createUpdate();
247	11	if ($items->count()) {
248	1	$this->service->setInDebugMode($this->debug);
249	1	$this->service->updateIndex($index, $items, $update);
250	1	$update->addCommit();
251	1	$client->update($update);
252		}
253	11	}
254
255		/**
256		* @param string $index
257		* @param int $group
258		* @param Exception $exception
259		* @throws GuzzleException
260		* @throws ValidationException
261		*/
262		private function logException($index, int $group, Exception $exception)
263		{
264		$this->getLogger()->error($exception->getMessage());
265		$msg = sprintf(
266		"Error indexing core %s on group %s," . PHP_EOL .
267		"Please log in to the CMS to find out more about Indexing errors" . PHP_EOL .
268		'Last known error:',
269		$index,
270		$group
271		);
272		SolrLogger::logMessage('ERROR', $msg, $index);
273		}
274		}
275

Firesphere / silverstripe-solr-search

Push — hans/logtests ( 76c086...71695d )

SolrIndexTask::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like