Level23\Druid\Aggregations\DoublesSketchAggregator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	toArray()	0	17	3

<?php
declare(strict_types=1);

namespace Level23\Druid\Aggregations;

class DoublesSketchAggregator implements AggregatorInterface
{
    /**
     * A String for the name of the input field (can contain sketches or raw numeric values).
     *
     * @var string
     */
    protected $metricName;

    /**
     * A String for the output (result) name of the calculation.
     *
     * @var string
     */
    protected $outputName;

    /**
     * Parameter that determines the accuracy and size of the sketch. Higher k means higher accuracy but more space to
     * store sketches. Must be a power of 2 from 2 to 32768. See accuracy information in the DataSketches documentation
     * for details.
     *
     * @var int|null
     */
    protected $sizeAndAccuracy;

    /**
     * This parameter is a temporary solution to avoid a known issue. It may be removed in a future release after the
     * bug is fixed. This parameter defines the maximum number of items to store in each sketch. If a sketch reaches
     * the limit, the query can throw IllegalStateException. To workaround this issue, increase the maximum stream
     * length. See accuracy information in the DataSketches documentation for how many bytes are required per stream
     * length.
     *
     * @var int|null
     */
    protected $maxStreamLength;

    /**
     * @param string   $metricName      A String for the name of the input field (can contain sketches or raw numeric
     *                                  values).
     * @param string   $outputName      A String for the output (result) name of the calculation.
     * @param int|null $sizeAndAccuracy Parameter that determines the accuracy and size of the sketch. Higher k means
     *                                  higher accuracy but more space to store sketches. Must be a power of 2 from 2
     *                                  to 32768. See accuracy information in the DataSketches documentation for
     *                                  details.
     * @param int|null $maxStreamLength This parameter is a temporary solution to avoid a known issue. It may be
     *                                  removed in a future release after the bug is fixed. This parameter defines the
     *                                  maximum number of items to store in each sketch. If a sketch reaches the limit,
     *                                  the query can throw IllegalStateException. To workaround this issue, increase
     *                                  the maximum stream length. See accuracy information in the DataSketches
     *                                  documentation for how many bytes are required per stream length.
     *
     * @see https://druid.apache.org/docs/latest/development/extensions-core/datasketches-quantiles.html
     */
    public function __construct(
        string $metricName,
        string $outputName = '',
        ?int $sizeAndAccuracy = null,
        ?int $maxStreamLength = null
    ) {
        $this->metricName      = $metricName;
        $this->outputName      = $outputName ?: $metricName;
        $this->sizeAndAccuracy = $sizeAndAccuracy;
        $this->maxStreamLength = $maxStreamLength;
    }

    public function toArray(): array
    {
        $result = [
            'type'      => 'quantilesDoublesSketch',
            'name'      => $this->outputName,
            'fieldName' => $this->metricName,
        ];

        if ($this->sizeAndAccuracy) {

The expression $this->sizeAndAccuracy of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $result['k'] = $this->sizeAndAccuracy;
        }

        if ($this->maxStreamLength) {

The expression $this->maxStreamLength of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $result['maxStreamLength'] = $this->maxStreamLength;
        }

        return $result;
    }
}