Level23\Druid\Tasks\TaskBuilder

Complexity

Total Complexity

13

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Test Coverage

Coverage

93.94%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	execute()	0	5	1
B	validateInterval()	0	30	8
A	toArray()	0	5	1
A	toJson()	0	12	2
A	taskId()	0	5	1

<?php
declare(strict_types=1);

namespace Level23\Druid\Tasks;

use InvalidArgumentException;
use Level23\Druid\DruidClient;
use Level23\Druid\Interval\IntervalInterface;

abstract class TaskBuilder
{
    /**
     * @var DruidClient
     */
    protected $client;

    /**
     * The task ID. If this is not explicitly specified, Druid generates the task ID using task type,
     * data source name, interval, and date-time stamp.
     *
     * @var string|null
     */
    protected $taskId = null;

    /**
     * Check if the given interval is valid for the given dataSource.
     *
     * @param string                                    $dataSource
     * @param \Level23\Druid\Interval\IntervalInterface $interval
     *
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     */
    protected function validateInterval(string $dataSource, IntervalInterface $interval): void
    {
        $fromStr = $interval->getStart()->format('Y-m-d\TH:i:s.000\Z');
        $toStr   = $interval->getStop()->format('Y-m-d\TH:i:s.000\Z');

        $foundFrom = false;
        $foundTo   = false;

        // Get all intervals and check if our interval is among them.
        $intervals = array_keys($this->client->metadata()->intervals($dataSource));

        foreach ($intervals as $dateStr) {

            if (!$foundFrom && substr($dateStr, 0, strlen($fromStr)) === $fromStr) {
                $foundFrom = true;
            }

            if (!$foundTo && substr($dateStr, -strlen($toStr)) === $toStr) {
                $foundTo = true;
            }

            if ($foundFrom && $foundTo) {
                return;
            }
        }

        throw new InvalidArgumentException(
            'Error, invalid interval given. The given dates do not match a complete interval!' . PHP_EOL .
            'Given interval: ' . $interval->getInterval() . PHP_EOL .
            'Valid intervals: ' . implode(', ', $intervals)
        );
    }

    /**
     * Execute the index task. We will return the task identifier.
     *
     * @param \Level23\Druid\Context\TaskContext|array $context
     *
     * @return string
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     */
    public function execute($context = []): string
    {
        $task = $this->buildTask($context);

        return $this->client->executeTask($task);
    }

    /**
     * Return the task in Json format.
     *
     * @param \Level23\Druid\Context\TaskContext|array $context
     *
     * @return string
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     */
    public function toJson($context = []): string
    {
        $task = $this->buildTask($context);

        $json = \json_encode($task->toArray(), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
        if (\JSON_ERROR_NONE !== \json_last_error()) {
            throw new InvalidArgumentException(
                'json_encode error: ' . \json_last_error_msg()
            );
        }

        return (string)$json;
    }

    /**
     * Return the task as array
     *
     * @param \Level23\Druid\Context\TaskContext|array $context
     *
     * @return array
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     */
    public function toArray($context = []): array
    {
        $task = $this->buildTask($context);

        return $task->toArray();
    }

    /**
     * The task ID. If this is not explicitly specified, Druid generates the task ID using task type,
     * data source name, interval, and date-time stamp.
     *
     * @param string $taskId
     *
     * @return $this
     */
    public function taskId(string $taskId)
    {
        $this->taskId = $taskId;

        return $this;
    }

    /**
     * @param \Level23\Druid\Context\TaskContext|array $context
     *
     * @return \Level23\Druid\Tasks\TaskInterface
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     */
    abstract protected function buildTask($context): TaskInterface;
}