ApiReader.php

<?php

/**
 * Copyright © Fastbolt Schraubengroßhandels GmbH.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Fastbolt\EntityImporter\Reader;

use Fastbolt\EntityImporter\EntityImporterDefinition;
use Fastbolt\EntityImporter\Reader\Api\PagePaginationStrategy;
use Fastbolt\EntityImporter\Reader\Api\PaginationStrategy;
use Fastbolt\EntityImporter\Types\ImportSourceDefinition\Api;
use Fastbolt\EntityImporter\Types\ImportSourceDefinition\ImportSourceDefinition;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Psr7\Response;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response as HttpResponse;
use Symfony\Component\HttpKernel\Exception\HttpException;
use Webmozart\Assert\Assert;

class ApiReader implements ReaderInterface
{
    /**
     * @var callable():Client
     */
    private $clientFactory;

    private EntityImporterDefinition $importerDefinition;

    private ImportSourceDefinition|Api $importSourceDefinition;

    private array $options;

    /**
     * @var array<int, array>
     */
    private array $data = [];

    private int $position = 0;

    private bool $readToEnd = false;

    /**
     * @param EntityImporterDefinition $importerDefinition
     * @param array                    $options
     * @param callable():Client        $clientFactory
     */
    public function __construct(
        EntityImporterDefinition $importerDefinition,
        array $options,
        callable $clientFactory
    ) {
        $this->clientFactory          = $clientFactory;
        $this->importerDefinition     = $importerDefinition;
        $this->options                = $options;

        /** @var Api $apiTmp */
        $apiTmp = $importerDefinition->getImportSourceDefinition();
        $this->importSourceDefinition = $apiTmp;

        Assert::keyExists($this->options, 'api_key');

        if (!isset($this->options['pagination_strategy'])) {
            $this->options['pagination_strategy'] = new PagePaginationStrategy(500);
        }
        if (!isset($this->options['serialized_format'])) {
            $this->options['serialized_format'] = 'json';
        }
    }

    /**
     * Return the current element
     *
     * @return array
     */
    public function current(): array
    {
        return $this->data[$this->position];
    }

    /**
     * Move forward to next element
     */
    public function next(): void
    {
        ++$this->position;
    }

    /**
     * Return the key of the current element
     */
    public function key(): int
    {
        return $this->position;
    }

    /**
     * Checks if current position is valid
     *
     * Returns true on success or false on failure.
     */
    public function valid(): bool
    {
        if (isset($this->data[$this->position])) {
            return true;
        }

        if ($this->readToEnd) {
            return false;
        }

        $this->loadBulkData($this->position);

        return isset($this->data[$this->position]);
    }

    /**
     * @param int $offset
     *
     * @return void
     */
    private function loadBulkData(int $offset): void
    {
        /** @var Api $importSourceDefinition */
        $importSourceDefinition = $this->importSourceDefinition;
        $clientFactory = $this->clientFactory;
        $client        = $clientFactory();

        /** @var PaginationStrategy $paginationStrategy */
        $paginationStrategy   = $this->options['pagination_strategy'];
        $paginationParameters = $paginationStrategy->getRequestParameters($offset);
        $queryParameters      = $importSourceDefinition->getQueryParameters();
        $requestParameters    = array_merge_recursive(
            [
                'verify'  => false,
                'headers' => [
                    'Accept'       => 'application/json',
                    'X-AUTH-TOKEN' => (string) $importSourceDefinition->getOptions()['api_key'],
                ],
            ],
            array_merge_recursive($queryParameters, $paginationParameters)
        );
        $url                  = $importSourceDefinition->getSource();
        $requestMethod        = Request::METHOD_GET;

        try {
            /** @var Response $response */
            $response = $client->request(
                $requestMethod,
                $url,
                $requestParameters
            );
        } catch (RequestException $exception) {
            $response = $exception->getResponse();
            throw new HttpException(
                $response ? $response->getStatusCode() : 0,
                sprintf(
                    'Connection error (%s request to %s returned %s (%s)) (%s).',
                    $requestMethod,
                    $url,
                    $response ? $response->getStatusCode() : 'null',
                    $response ? $response->getReasonPhrase() : 'empty response',
                    $exception->getMessage()
                )
            );
        }

        if ($response->getStatusCode() !== HttpResponse::HTTP_OK) {
            throw new HttpException(
                $response->getStatusCode(),
                sprintf(
                    'Connection error (%s request to %s returned %s (%s)).',
                    $requestMethod,
                    $url,
                    $response->getStatusCode(),
                    $response->getReasonPhrase()
                )
            );
        }

        if (($body = $response->getBody()->getContents()) === '') {
            throw new HttpException(
                $response->getStatusCode(),
                sprintf(
                    'Connection error (%s request to %s returned %s (%s), but resulted in empty data.).',
                    $requestMethod,
                    $url,
                    $response->getStatusCode(),
                    $response->getReasonPhrase()
                )
            );
        }

        $itemsPerPage = $paginationStrategy->getItemsPerPage();
        $startOffset  = $paginationStrategy->getPageStartOffset($offset);
        /** @var array<int,mixed> $data */
        $data = json_decode($body, true);
        if (count($data) !== $itemsPerPage) {
            $this->readToEnd = true;
        }
        foreach ($data as $dataOffset => $datum) {
            $this->data[$dataOffset + $startOffset] = $datum;
        }

        $x = 1;
    }

    /**
     * Rewind the Iterator to the first element
     */
    public function rewind(): void
    {
        $this->position = 0;
    }

    /**
     * @return array<int,array<int,mixed>>
     */
    public function getErrors(): array
    {
        return [];
    }
}