feat: read BusProNet base data from the MyE&P API
This commit is contained in:
1 parent
1505f9b50b
commit
2e9328fc51
37 files changed
+2302
-148
No files matched your search
@@ -2,46 +2,39 @@
|
||||
|
||||
namespace App\BusProNet\DataProvider;
|
||||
|
||||
use App\BusProNet\ApiClient;
|
||||
use App\BusProNet\ApiClientException;
|
||||
use App\BusProNet\Model\Country;
|
||||
use App\BusProNet\Model\NotificationResponse;
|
||||
use App\BusProNet\ResponseParserException;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Symfony\Contracts\Cache\CacheInterface;
|
||||
use Symfony\Contracts\Cache\ItemInterface;
|
||||
use App\MyEp\Api\ApiClient;
|
||||
use App\MyEp\Api\ResponseMapper;
|
||||
use App\MyEp\Cache\StaleWhileErrorCache;
|
||||
|
||||
/**
|
||||
* Country base data, read from MyE&P rather than from BusProNet directly.
|
||||
*
|
||||
* Keyed by the raw BusProNet token, not by an ISO code: the token is what a hotel's
|
||||
* country and a teamer's nationality join against, and that vocabulary stays raw.
|
||||
*/
|
||||
class CountryDataProvider
|
||||
{
|
||||
private const CACHE_KEY = 'myep_countries';
|
||||
private const TTL = 3600;
|
||||
|
||||
public function __construct(
|
||||
private readonly ApiClient $apiClient,
|
||||
private readonly CacheInterface $cache,
|
||||
private readonly LoggerInterface $logger,
|
||||
private readonly ResponseMapper $responseMapper,
|
||||
private readonly StaleWhileErrorCache $cache,
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, Country> keyed by token
|
||||
*/
|
||||
public function getAll(): array
|
||||
{
|
||||
try {
|
||||
$countries = $this->cache->get('bpn_countries', function (ItemInterface $item) {
|
||||
$item->expiresAfter(3600);
|
||||
|
||||
$response = $this->apiClient->getBaseData(ApiClient::TYPE_BASE_DATA_COUNTRIES);
|
||||
|
||||
if ($response instanceof NotificationResponse) {
|
||||
$this->logger->error('Unable to fetch country base data from BusProNet. Code: '.$response->getCode().', Message: '.$response->getMessage());
|
||||
|
||||
throw new ApiClientException('Unable to fetch country base data from BusProNet');
|
||||
}
|
||||
|
||||
return $response->getItems();
|
||||
});
|
||||
} catch (ApiClientException|ResponseParserException $e) {
|
||||
$this->logger->error('Unable to fetch country base data from BusProNet: '.$e->getMessage());
|
||||
$countries = [];
|
||||
}
|
||||
|
||||
return $countries;
|
||||
return $this->cache->get(
|
||||
self::CACHE_KEY,
|
||||
self::TTL,
|
||||
fn (): array => $this->responseMapper->mapCountries($this->apiClient->get('api/countries')),
|
||||
);
|
||||
}
|
||||
|
||||
public function get(?string $token): ?Country
|
||||
|
||||
@@ -2,47 +2,40 @@
|
||||
|
||||
namespace App\BusProNet\DataProvider;
|
||||
|
||||
use App\BusProNet\ApiClient;
|
||||
use App\BusProNet\ApiClientException;
|
||||
use App\BusProNet\Model\Hotel;
|
||||
use App\BusProNet\Model\NotificationResponse;
|
||||
use App\BusProNet\ResponseParserException;
|
||||
use Psr\Cache\InvalidArgumentException;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Symfony\Contracts\Cache\CacheInterface;
|
||||
use Symfony\Contracts\Cache\ItemInterface;
|
||||
use App\MyEp\Api\ApiClient;
|
||||
use App\MyEp\Api\ResponseMapper;
|
||||
use App\MyEp\Cache\StaleWhileErrorCache;
|
||||
|
||||
/**
|
||||
* Hotel base data, read from MyE&P rather than from BusProNet directly.
|
||||
*
|
||||
* The models and the public interface are unchanged from when this spoke the BusProNet
|
||||
* socket protocol: every caller keys on the BusProNet idbuspro, which is exactly what
|
||||
* MyE&P reports as the hotel id.
|
||||
*/
|
||||
class HotelDataProvider
|
||||
{
|
||||
private const CACHE_KEY = 'myep_hotels';
|
||||
private const TTL = 3600;
|
||||
|
||||
public function __construct(
|
||||
private readonly ApiClient $apiClient,
|
||||
private readonly CacheInterface $cache,
|
||||
private readonly LoggerInterface $logger,
|
||||
private readonly ResponseMapper $responseMapper,
|
||||
private readonly StaleWhileErrorCache $cache,
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, Hotel> keyed by busProId
|
||||
*/
|
||||
public function getAll(): array
|
||||
{
|
||||
try {
|
||||
$hotels = $this->cache->get('bpn_hotels', function (ItemInterface $item) {
|
||||
$item->expiresAfter(3600);
|
||||
|
||||
$response = $this->apiClient->getBaseData(ApiClient::TYPE_BASE_DATA_HOTELS);
|
||||
|
||||
if ($response instanceof NotificationResponse) {
|
||||
$this->logger->error('Unable to fetch hotel base data from BusProNet. Code: '.$response->getCode().', Message: '.$response->getMessage());
|
||||
|
||||
throw new ApiClientException('Unable to fetch hotel base data from BusProNet');
|
||||
}
|
||||
|
||||
return $response->getItems();
|
||||
});
|
||||
} catch (ApiClientException|InvalidArgumentException|ResponseParserException $e) {
|
||||
$this->logger->error('Unable to fetch hotel base data from BusProNet: '.$e->getMessage());
|
||||
$hotels = [];
|
||||
}
|
||||
|
||||
return $hotels;
|
||||
return $this->cache->get(
|
||||
self::CACHE_KEY,
|
||||
self::TTL,
|
||||
fn (): array => $this->responseMapper->mapHotels($this->apiClient->get('api/hotels')),
|
||||
);
|
||||
}
|
||||
|
||||
public function get(int $busProId): ?Hotel
|
||||
@@ -50,12 +43,21 @@ class HotelDataProvider
|
||||
return $this->getAll()[$busProId] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return list<Hotel>
|
||||
*/
|
||||
public function findByCode(string $code): array
|
||||
{
|
||||
$hotels = [];
|
||||
|
||||
foreach ($this->getAll() as $hotel) {
|
||||
if (str_starts_with($hotel->getCode(), $code) || str_ends_with($hotel->getCode(), $code)) {
|
||||
$hotelCode = $hotel->getCode();
|
||||
|
||||
if (null === $hotelCode) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (str_starts_with($hotelCode, $code) || str_ends_with($hotelCode, $code)) {
|
||||
$hotels[] = $hotel;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,46 +2,39 @@
|
||||
|
||||
namespace App\BusProNet\DataProvider;
|
||||
|
||||
use App\BusProNet\ApiClient;
|
||||
use App\BusProNet\ApiClientException;
|
||||
use App\BusProNet\Model\NotificationResponse;
|
||||
use App\BusProNet\Model\Pickup;
|
||||
use App\BusProNet\ResponseParserException;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Symfony\Contracts\Cache\CacheInterface;
|
||||
use Symfony\Contracts\Cache\ItemInterface;
|
||||
use App\MyEp\Api\ApiClient;
|
||||
use App\MyEp\Api\ResponseMapper;
|
||||
use App\MyEp\Cache\StaleWhileErrorCache;
|
||||
|
||||
/**
|
||||
* Boarding point base data, read from MyE&P rather than from BusProNet directly.
|
||||
*
|
||||
* These are the stops themselves, without a departure time: a time belongs to a stop on
|
||||
* a given travel date and is carried by the destination's pickups instead.
|
||||
*/
|
||||
class PickupDataProvider
|
||||
{
|
||||
private const CACHE_KEY = 'myep_pickups';
|
||||
private const TTL = 3600;
|
||||
|
||||
public function __construct(
|
||||
private readonly ApiClient $apiClient,
|
||||
private readonly CacheInterface $cache,
|
||||
private readonly LoggerInterface $logger,
|
||||
private readonly ResponseMapper $responseMapper,
|
||||
private readonly StaleWhileErrorCache $cache,
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, Pickup> keyed by busProId
|
||||
*/
|
||||
public function getAll(): array
|
||||
{
|
||||
try {
|
||||
$pickups = $this->cache->get('bpn_pickups', function (ItemInterface $item) {
|
||||
$item->expiresAfter(3600);
|
||||
|
||||
$response = $this->apiClient->getBaseData(ApiClient::TYPE_BASE_DATA_PICKUPS);
|
||||
|
||||
if ($response instanceof NotificationResponse) {
|
||||
$this->logger->error('Unable to fetch pickup base data from BusProNet. Code: '.$response->getCode().', Message: '.$response->getMessage());
|
||||
|
||||
throw new ApiClientException('Unable to fetch pickup base data from BusProNet');
|
||||
}
|
||||
|
||||
return $response->getItems();
|
||||
});
|
||||
} catch (ApiClientException|ResponseParserException $e) {
|
||||
$this->logger->error('Unable to fetch pickup base data from BusProNet: '.$e->getMessage());
|
||||
$pickups = [];
|
||||
}
|
||||
|
||||
return $pickups;
|
||||
return $this->cache->get(
|
||||
self::CACHE_KEY,
|
||||
self::TTL,
|
||||
fn (): array => $this->responseMapper->mapPickups($this->apiClient->get('api/pickups')),
|
||||
);
|
||||
}
|
||||
|
||||
public function get(int $busProId): ?Pickup
|
||||
|
||||
@@ -12,7 +12,17 @@ class Hotel
|
||||
private ?string $street = null;
|
||||
private ?string $phone = null;
|
||||
private ?string $type = null;
|
||||
/**
|
||||
* The raw BusProNet abbreviation, which is not a standard: the same country turns
|
||||
* up as D, DEU, A, AT or AUT. It joins against the country base data by token.
|
||||
*/
|
||||
private ?string $country = null;
|
||||
|
||||
/**
|
||||
* The same country as lowercase ISO-3166-1 alpha-2, resolved by MyE&P. Null when
|
||||
* the source carries no country or none can be determined.
|
||||
*/
|
||||
private ?string $countryCode = null;
|
||||
private ?string $costUnit = null;
|
||||
|
||||
public function getId(): ?int
|
||||
@@ -123,6 +133,18 @@ class Hotel
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getCountryCode(): ?string
|
||||
{
|
||||
return $this->countryCode;
|
||||
}
|
||||
|
||||
public function setCountryCode(?string $countryCode): static
|
||||
{
|
||||
$this->countryCode = $countryCode;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getCostUnit(): ?string
|
||||
{
|
||||
return $this->costUnit;
|
||||
|
||||
@@ -63,10 +63,10 @@ class ApplicationFilterType extends AbstractType
|
||||
'required' => false,
|
||||
'placeholder' => 'nicht filtern',
|
||||
'choices' => [
|
||||
'Österreich' => 'a',
|
||||
'Österreich' => 'at',
|
||||
'Schweiz' => 'ch',
|
||||
'Frankreich' => 'f',
|
||||
'Italien' => 'i',
|
||||
'Frankreich' => 'fr',
|
||||
'Italien' => 'it',
|
||||
],
|
||||
])
|
||||
->add('apply', SubmitType::class, [
|
||||
|
||||
@@ -67,10 +67,10 @@ class AssignmentFilterType extends AbstractType
|
||||
'required' => false,
|
||||
'placeholder' => 'nicht filtern',
|
||||
'choices' => [
|
||||
'Österreich' => 'a',
|
||||
'Österreich' => 'at',
|
||||
'Schweiz' => 'ch',
|
||||
'Frankreich' => 'f',
|
||||
'Italien' => 'i',
|
||||
'Frankreich' => 'fr',
|
||||
'Italien' => 'it',
|
||||
],
|
||||
])
|
||||
->add('apply', SubmitType::class, [
|
||||
|
||||
@@ -41,11 +41,11 @@ class DestinationType extends AbstractType
|
||||
->add('country', ChoiceType::class, [
|
||||
'label' => 'Land',
|
||||
'choices' => [
|
||||
'Österreich' => 'a',
|
||||
'Österreich' => 'at',
|
||||
'Schweiz' => 'ch',
|
||||
'Frankreich' => 'f',
|
||||
'Italien' => 'i',
|
||||
'Deutschland' => 'd',
|
||||
'Frankreich' => 'fr',
|
||||
'Italien' => 'it',
|
||||
'Deutschland' => 'de',
|
||||
'Niederlande' => 'nl',
|
||||
],
|
||||
])
|
||||
|
||||
@@ -0,0 +1,139 @@
|
||||
<?php
|
||||
|
||||
namespace App\MyEp\Api;
|
||||
|
||||
use Psr\Cache\CacheItemPoolInterface;
|
||||
use Psr\Cache\InvalidArgumentException;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Symfony\Component\OptionsResolver\OptionsResolver;
|
||||
use Symfony\Contracts\HttpClient\Exception\ExceptionInterface as TransportException;
|
||||
use Symfony\Contracts\HttpClient\HttpClientInterface;
|
||||
|
||||
/**
|
||||
* Obtains and caches the client_credentials access token for the MyE&P API.
|
||||
*
|
||||
* MyE&P issues short-lived tokens (ten minutes), so a token is kept in the shared
|
||||
* cache until shortly before it expires rather than requested per call.
|
||||
*/
|
||||
class AccessTokenProvider
|
||||
{
|
||||
private const CACHE_KEY = 'myep.api.access_token';
|
||||
|
||||
/**
|
||||
* Assumed token lifetime when the response omits expires_in.
|
||||
*/
|
||||
private const DEFAULT_LIFETIME = 600;
|
||||
|
||||
/**
|
||||
* Dropped from every lifetime so a token is never handed out in the seconds
|
||||
* before it expires.
|
||||
*/
|
||||
private const EXPIRY_MARGIN = 60;
|
||||
|
||||
private const MINIMUM_LIFETIME = 30;
|
||||
|
||||
private array $config;
|
||||
|
||||
public function __construct(
|
||||
private readonly HttpClientInterface $myepClient,
|
||||
private readonly CacheItemPoolInterface $cache,
|
||||
private readonly LoggerInterface $logger,
|
||||
array $options,
|
||||
) {
|
||||
$this->config = $this->resolveOptions($options);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws ApiException
|
||||
*/
|
||||
public function getToken(): string
|
||||
{
|
||||
try {
|
||||
$item = $this->cache->getItem(self::CACHE_KEY);
|
||||
} catch (InvalidArgumentException $e) {
|
||||
throw new ApiException('Unable to read the cached MyE&P access token', 0, $e);
|
||||
}
|
||||
|
||||
if ($item->isHit()) {
|
||||
return $item->get();
|
||||
}
|
||||
|
||||
[$token, $lifetime] = $this->requestToken();
|
||||
|
||||
$item->set($token);
|
||||
$item->expiresAfter($lifetime);
|
||||
$this->cache->save($item);
|
||||
|
||||
return $token;
|
||||
}
|
||||
|
||||
/**
|
||||
* Drops the cached token so the next call fetches a fresh one. Used when the API
|
||||
* rejects a token the cache still considered valid.
|
||||
*/
|
||||
public function invalidate(): void
|
||||
{
|
||||
try {
|
||||
$this->cache->deleteItem(self::CACHE_KEY);
|
||||
} catch (InvalidArgumentException) {
|
||||
// the key is a constant, so it cannot be malformed; nothing to recover from
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array{0: string, 1: int} the token and the seconds it may be cached for
|
||||
*
|
||||
* @throws ApiException
|
||||
*/
|
||||
private function requestToken(): array
|
||||
{
|
||||
try {
|
||||
$response = $this->myepClient->request('POST', $this->config['token_path'], [
|
||||
'body' => [
|
||||
'grant_type' => 'client_credentials',
|
||||
'client_id' => $this->config['client_id'],
|
||||
'client_secret' => $this->config['client_secret'],
|
||||
'scope' => $this->config['scope'],
|
||||
],
|
||||
]);
|
||||
|
||||
$statusCode = $response->getStatusCode();
|
||||
$payload = $response->toArray(false);
|
||||
} catch (TransportException $e) {
|
||||
$this->logger->error('Unable to obtain a MyE&P access token', [
|
||||
'client_id' => $this->config['client_id'],
|
||||
'exception' => $e,
|
||||
]);
|
||||
|
||||
throw new ApiException('Unable to obtain a MyE&P access token', 0, $e);
|
||||
}
|
||||
|
||||
$token = $payload['access_token'] ?? null;
|
||||
|
||||
if (200 !== $statusCode || false === is_string($token) || '' === $token) {
|
||||
$this->logger->error('MyE&P rejected the access token request', [
|
||||
'client_id' => $this->config['client_id'],
|
||||
'status_code' => $statusCode,
|
||||
'error' => $payload['error'] ?? null,
|
||||
]);
|
||||
|
||||
throw new ApiException('MyE&P rejected the access token request with status '.$statusCode);
|
||||
}
|
||||
|
||||
$expiresIn = (int) ($payload['expires_in'] ?? self::DEFAULT_LIFETIME);
|
||||
|
||||
return [$token, max(self::MINIMUM_LIFETIME, $expiresIn - self::EXPIRY_MARGIN)];
|
||||
}
|
||||
|
||||
private function resolveOptions(array $options): array
|
||||
{
|
||||
$optionsResolver = new OptionsResolver();
|
||||
$optionsResolver->setRequired(['client_id', 'client_secret']);
|
||||
$optionsResolver->setDefaults([
|
||||
'token_path' => 'token',
|
||||
'scope' => 'api',
|
||||
]);
|
||||
|
||||
return $optionsResolver->resolve($options);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,105 @@
|
||||
<?php
|
||||
|
||||
namespace App\MyEp\Api;
|
||||
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
use Symfony\Contracts\HttpClient\Exception\ExceptionInterface as TransportException;
|
||||
use Symfony\Contracts\HttpClient\HttpClientInterface;
|
||||
use Symfony\Contracts\HttpClient\ResponseInterface;
|
||||
|
||||
/**
|
||||
* Reads the MyE&P JSON API. Every response is validated here so that callers only
|
||||
* ever see a decoded payload or an ApiException.
|
||||
*/
|
||||
class ApiClient
|
||||
{
|
||||
public function __construct(
|
||||
private readonly HttpClientInterface $myepClient,
|
||||
private readonly AccessTokenProvider $tokens,
|
||||
private readonly LoggerInterface $logger,
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws ApiException
|
||||
*/
|
||||
public function get(string $path, array $query = []): array
|
||||
{
|
||||
$response = $this->send($path, $query);
|
||||
|
||||
if (Response::HTTP_UNAUTHORIZED === $this->statusOf($response, $path)) {
|
||||
// tokens live ten minutes, so one expiring mid-run is routine rather than a fault
|
||||
$this->tokens->invalidate();
|
||||
$response = $this->send($path, $query);
|
||||
}
|
||||
|
||||
$statusCode = $this->statusOf($response, $path);
|
||||
|
||||
if (Response::HTTP_FORBIDDEN === $statusCode) {
|
||||
$this->logger->error('MyE&P denied a request for lack of scope', ['path' => $path]);
|
||||
|
||||
throw new ApiException(sprintf('MyE&P denied "%s": the API client lacks the required scope', $path));
|
||||
}
|
||||
|
||||
if ($statusCode < 200 || $statusCode >= 300) {
|
||||
$this->logger->error('MyE&P returned an unexpected status', [
|
||||
'path' => $path,
|
||||
'status_code' => $statusCode,
|
||||
]);
|
||||
|
||||
throw new ApiException(sprintf('MyE&P returned status %d for "%s"', $statusCode, $path));
|
||||
}
|
||||
|
||||
return $this->decode($response, $path);
|
||||
}
|
||||
|
||||
private function send(string $path, array $query): ResponseInterface
|
||||
{
|
||||
try {
|
||||
return $this->myepClient->request('GET', $path, [
|
||||
'auth_bearer' => $this->tokens->getToken(),
|
||||
'query' => $query,
|
||||
]);
|
||||
} catch (TransportException $e) {
|
||||
$this->logger->error('Request to MyE&P failed', ['path' => $path, 'exception' => $e]);
|
||||
|
||||
throw new ApiException(sprintf('Request to MyE&P endpoint "%s" failed', $path), 0, $e);
|
||||
}
|
||||
}
|
||||
|
||||
private function statusOf(ResponseInterface $response, string $path): int
|
||||
{
|
||||
try {
|
||||
return $response->getStatusCode();
|
||||
} catch (TransportException $e) {
|
||||
$this->logger->error('Request to MyE&P failed', ['path' => $path, 'exception' => $e]);
|
||||
|
||||
throw new ApiException(sprintf('Request to MyE&P endpoint "%s" failed', $path), 0, $e);
|
||||
}
|
||||
}
|
||||
|
||||
private function decode(ResponseInterface $response, string $path): array
|
||||
{
|
||||
try {
|
||||
$payload = $response->toArray(false);
|
||||
} catch (TransportException $e) {
|
||||
$this->logger->error('Unreadable response from MyE&P', ['path' => $path, 'exception' => $e]);
|
||||
|
||||
throw new ApiException(sprintf('Unreadable response from MyE&P endpoint "%s"', $path), 0, $e);
|
||||
}
|
||||
|
||||
// some MyE&P endpoints report upstream failures in the body while still
|
||||
// answering with 200, so the payload decides, not the status code
|
||||
if (isset($payload['error'])) {
|
||||
$this->logger->error('MyE&P reported an error', [
|
||||
'path' => $path,
|
||||
'error' => $payload['error'],
|
||||
]);
|
||||
|
||||
throw new ApiException(sprintf('MyE&P reported an error for "%s": %s', $path, (string) $payload['error']));
|
||||
}
|
||||
|
||||
return $payload;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
<?php
|
||||
|
||||
namespace App\MyEp\Api;
|
||||
|
||||
class ApiException extends \RuntimeException
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
<?php
|
||||
|
||||
namespace App\MyEp\Api;
|
||||
|
||||
/**
|
||||
* Normalizes the country code MyE&P resolves for a hotel.
|
||||
*
|
||||
* MyE&P maps the raw BusProNet abbreviations (D, A, AUT, DEU, …) to ISO-3166-1
|
||||
* alpha-2 and reports the result as countryCode. Anything that is not a two letter
|
||||
* code is dropped rather than stored: the value goes into a two character column and
|
||||
* addresses a flag icon, so a half-mapped token is worse than no country at all.
|
||||
*/
|
||||
final class CountryCode
|
||||
{
|
||||
public static function normalize(mixed $value): ?string
|
||||
{
|
||||
if (false === is_string($value)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$code = strtolower(trim($value));
|
||||
|
||||
return 1 === preg_match('/^[a-z]{2}$/', $code) ? $code : null;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,146 @@
|
||||
<?php
|
||||
|
||||
namespace App\MyEp\Api;
|
||||
|
||||
use App\BusProNet\Model\Country;
|
||||
use App\BusProNet\Model\Hotel;
|
||||
use App\BusProNet\Model\Pickup;
|
||||
use Psr\Log\LoggerInterface;
|
||||
|
||||
/**
|
||||
* Turns MyE&P list responses into the BusProNet models the application already works
|
||||
* with, keyed the way the data providers expose them.
|
||||
*
|
||||
* The id MyE&P reports for hotels and pickups is the BusProNet idbuspro, so it fills
|
||||
* both the id and the busProId of the models.
|
||||
*/
|
||||
class ResponseMapper
|
||||
{
|
||||
public function __construct(private readonly LoggerInterface $logger)
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, Hotel> keyed by busProId
|
||||
*/
|
||||
public function mapHotels(array $rows): array
|
||||
{
|
||||
$hotels = [];
|
||||
|
||||
foreach ($rows as $row) {
|
||||
if (null === $busProId = $this->readBusProId($row, 'hotel')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$hotel = new Hotel();
|
||||
$hotel
|
||||
->setId($busProId)
|
||||
->setBusProId($busProId)
|
||||
->setCode($this->readString($row, 'code'))
|
||||
->setName($this->readString($row, 'name'))
|
||||
->setCity($this->readString($row, 'city'))
|
||||
->setStreet($this->readString($row, 'street'))
|
||||
->setPhone($this->readString($row, 'phone'))
|
||||
->setCountry($this->readString($row, 'country'))
|
||||
->setCountryCode($this->readCountryCode($row))
|
||||
->setCostUnit($this->readString($row, 'costUnit'))
|
||||
;
|
||||
|
||||
$hotels[$busProId] = $hotel;
|
||||
}
|
||||
|
||||
return $hotels;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, Pickup> keyed by busProId
|
||||
*/
|
||||
public function mapPickups(array $rows): array
|
||||
{
|
||||
$pickups = [];
|
||||
|
||||
foreach ($rows as $row) {
|
||||
if (null === $busProId = $this->readBusProId($row, 'pickup')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$pickup = new Pickup();
|
||||
$pickup
|
||||
->setId($busProId)
|
||||
->setBusProId($busProId)
|
||||
->setCode($this->readString($row, 'code'))
|
||||
->setCity($this->readString($row, 'city'))
|
||||
->setStreet($this->readString($row, 'street'))
|
||||
;
|
||||
|
||||
// the time is a property of a boarding stop on a date, never of the stop itself
|
||||
$pickups[$busProId] = $pickup;
|
||||
}
|
||||
|
||||
return $pickups;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, Country> keyed by token
|
||||
*/
|
||||
public function mapCountries(array $rows): array
|
||||
{
|
||||
$countries = [];
|
||||
|
||||
foreach ($rows as $row) {
|
||||
$token = is_array($row) ? $this->readString($row, 'token') : null;
|
||||
|
||||
if (null === $token || '' === $token) {
|
||||
$this->logger->warning('Skipped a MyE&P country without a token', ['row' => $row]);
|
||||
continue;
|
||||
}
|
||||
|
||||
$country = new Country();
|
||||
$country
|
||||
->setId(isset($row['id']) ? (int) $row['id'] : null)
|
||||
->setName($this->readString($row, 'name'))
|
||||
->setToken($token)
|
||||
->setNationality($this->readString($row, 'nationality'))
|
||||
;
|
||||
|
||||
$countries[$token] = $country;
|
||||
}
|
||||
|
||||
return $countries;
|
||||
}
|
||||
|
||||
private function readCountryCode(array $row): ?string
|
||||
{
|
||||
$countryCode = CountryCode::normalize($row['countryCode'] ?? null);
|
||||
|
||||
if (null === $countryCode && null !== ($row['country'] ?? null)) {
|
||||
$this->logger->warning('MyE&P reported a hotel country it could not map to ISO', [
|
||||
'id' => $row['id'] ?? null,
|
||||
'country' => $row['country'],
|
||||
'countryCode' => $row['countryCode'] ?? null,
|
||||
]);
|
||||
}
|
||||
|
||||
return $countryCode;
|
||||
}
|
||||
|
||||
private function readBusProId(mixed $row, string $type): ?int
|
||||
{
|
||||
$busProId = is_array($row) ? (int) ($row['id'] ?? 0) : 0;
|
||||
|
||||
if (0 === $busProId) {
|
||||
$this->logger->warning(sprintf('Skipped a MyE&P %s without an id', $type), ['row' => $row]);
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
return $busProId;
|
||||
}
|
||||
|
||||
private function readString(array $row, string $key): ?string
|
||||
{
|
||||
$value = $row[$key] ?? null;
|
||||
|
||||
return null === $value ? null : (string) $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,120 @@
|
||||
<?php
|
||||
|
||||
namespace App\MyEp\Cache;
|
||||
|
||||
use Psr\Cache\CacheItemInterface;
|
||||
use Psr\Cache\CacheItemPoolInterface;
|
||||
use Psr\Cache\InvalidArgumentException;
|
||||
use Psr\Log\LoggerInterface;
|
||||
|
||||
/**
|
||||
* Caches a value and keeps the last successful one around far longer, so a MyE&P
|
||||
* outage degrades to slightly stale master data instead of empty dropdowns.
|
||||
*
|
||||
* Symfony's cache contract cannot express this: it discards the item when the
|
||||
* callback throws, which is exactly the case that needs the previous value.
|
||||
*/
|
||||
class StaleWhileErrorCache
|
||||
{
|
||||
private const LAST_GOOD_SUFFIX = '.last_good';
|
||||
|
||||
/**
|
||||
* How long a served stale value suppresses further upstream attempts. Without it
|
||||
* every call during an outage would try again, since the fresh key stays empty.
|
||||
*/
|
||||
private const RETRY_DELAY = 60;
|
||||
|
||||
public function __construct(
|
||||
private readonly CacheItemPoolInterface $cache,
|
||||
private readonly LoggerInterface $logger,
|
||||
private readonly int $staleLifetime = 604800,
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param callable(): array $producer
|
||||
*/
|
||||
public function get(string $key, int $ttl, callable $producer): array
|
||||
{
|
||||
try {
|
||||
$fresh = $this->cache->getItem($key);
|
||||
} catch (InvalidArgumentException $e) {
|
||||
$this->logger->error('Unusable MyE&P cache key', ['key' => $key, 'exception' => $e]);
|
||||
|
||||
return $this->produceUncached($key, $producer);
|
||||
}
|
||||
|
||||
if ($fresh->isHit()) {
|
||||
return $fresh->get();
|
||||
}
|
||||
|
||||
try {
|
||||
$value = $producer();
|
||||
} catch (\Throwable $e) {
|
||||
return $this->serveStale($key, $fresh, $e);
|
||||
}
|
||||
|
||||
$fresh->set($value);
|
||||
$fresh->expiresAfter($ttl);
|
||||
$this->cache->save($fresh);
|
||||
|
||||
$this->saveLastGood($key, $value);
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
private function serveStale(string $key, CacheItemInterface $fresh, \Throwable $e): array
|
||||
{
|
||||
try {
|
||||
$lastGood = $this->cache->getItem($key.self::LAST_GOOD_SUFFIX);
|
||||
} catch (InvalidArgumentException) {
|
||||
$lastGood = null;
|
||||
}
|
||||
|
||||
if (null === $lastGood || false === $lastGood->isHit()) {
|
||||
$this->logger->error('MyE&P request failed and no previous data is cached', [
|
||||
'key' => $key,
|
||||
'exception' => $e,
|
||||
]);
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
$this->logger->error('MyE&P request failed, serving the last known data', [
|
||||
'key' => $key,
|
||||
'exception' => $e,
|
||||
]);
|
||||
|
||||
$stale = $lastGood->get();
|
||||
|
||||
$fresh->set($stale);
|
||||
$fresh->expiresAfter(self::RETRY_DELAY);
|
||||
$this->cache->save($fresh);
|
||||
|
||||
return $stale;
|
||||
}
|
||||
|
||||
private function saveLastGood(string $key, array $value): void
|
||||
{
|
||||
try {
|
||||
$lastGood = $this->cache->getItem($key.self::LAST_GOOD_SUFFIX);
|
||||
} catch (InvalidArgumentException) {
|
||||
return;
|
||||
}
|
||||
|
||||
$lastGood->set($value);
|
||||
$lastGood->expiresAfter($this->staleLifetime);
|
||||
$this->cache->save($lastGood);
|
||||
}
|
||||
|
||||
private function produceUncached(string $key, callable $producer): array
|
||||
{
|
||||
try {
|
||||
return $producer();
|
||||
} catch (\Throwable $e) {
|
||||
$this->logger->error('MyE&P request failed', ['key' => $key, 'exception' => $e]);
|
||||
|
||||
return [];
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,155 @@
|
||||
<?php
|
||||
|
||||
namespace App\MyEp\Import;
|
||||
|
||||
use App\MyEp\Api\CountryCode;
|
||||
|
||||
/**
|
||||
* One travel date at one hotel, as the MyE&P travel export reports it. This is the
|
||||
* unit the destination table is keyed on.
|
||||
*/
|
||||
class DestinationRow
|
||||
{
|
||||
public function __construct(
|
||||
public readonly int $busProId,
|
||||
public readonly string $code,
|
||||
public readonly string $product,
|
||||
public readonly \DateTimeImmutable $dateFrom,
|
||||
public readonly \DateTimeImmutable $dateTo,
|
||||
public readonly int $hotelBusProId,
|
||||
public readonly string $hotelCode,
|
||||
public readonly string $hotelName,
|
||||
public readonly ?string $costUnit,
|
||||
/** lowercase ISO-3166-1 alpha-2, null when MyE&P could not resolve one */
|
||||
public readonly ?string $country,
|
||||
public readonly array $pickups,
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws InvalidRowException
|
||||
*/
|
||||
public static function fromArray(array $data): self
|
||||
{
|
||||
$hotel = $data['hotel'] ?? null;
|
||||
|
||||
if (false === is_array($hotel)) {
|
||||
throw new InvalidRowException('Travel export row without a hotel');
|
||||
}
|
||||
|
||||
$busProId = (int) ($data['busProId'] ?? 0);
|
||||
$hotelBusProId = (int) ($hotel['busProId'] ?? 0);
|
||||
|
||||
if (0 === $busProId || 0 === $hotelBusProId) {
|
||||
throw new InvalidRowException(sprintf('Travel export row with an unusable id pair (%d, %d)', $busProId, $hotelBusProId));
|
||||
}
|
||||
|
||||
return new self(
|
||||
$busProId,
|
||||
(string) ($data['code'] ?? ''),
|
||||
(string) ($data['product'] ?? ''),
|
||||
self::readDate($data, 'dateFrom'),
|
||||
self::readDate($data, 'dateTo'),
|
||||
$hotelBusProId,
|
||||
(string) ($hotel['code'] ?? ''),
|
||||
(string) ($hotel['name'] ?? ''),
|
||||
self::readNullableString($hotel, 'costUnit'),
|
||||
CountryCode::normalize($hotel['countryCode'] ?? null),
|
||||
self::readPickups($data['pickups'] ?? []),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* The columns an existing destination is refreshed with. The hotel name and code
|
||||
* are part of it because they do change upstream, and rows that keep an outdated
|
||||
* name drop out of the house matching.
|
||||
*/
|
||||
public function toUpdatePayload(\DateTimeImmutable $now): array
|
||||
{
|
||||
return [
|
||||
'code' => $this->code,
|
||||
'date_from' => $this->dateFrom->format('Y-m-d'),
|
||||
'date_to' => $this->dateTo->format('Y-m-d'),
|
||||
'product' => $this->product,
|
||||
'hotel' => $this->hotelName,
|
||||
'hotel_code' => $this->hotelCode,
|
||||
'pickups' => json_encode($this->pickups),
|
||||
'cost_unit' => $this->costUnit,
|
||||
'country' => $this->country,
|
||||
'updated_at' => $now->format('Y-m-d H:i:s'),
|
||||
];
|
||||
}
|
||||
|
||||
public function toInsertPayload(\DateTimeImmutable $now): array
|
||||
{
|
||||
return [
|
||||
'code' => $this->code,
|
||||
'bus_pro_id' => $this->busProId,
|
||||
'date_from' => $this->dateFrom->format('Y-m-d'),
|
||||
'date_to' => $this->dateTo->format('Y-m-d'),
|
||||
'product' => $this->product,
|
||||
'hotel' => $this->hotelName,
|
||||
'hotel_code' => $this->hotelCode,
|
||||
'hotel_bus_pro_id' => $this->hotelBusProId,
|
||||
'pickups' => json_encode($this->pickups),
|
||||
'cost_unit' => $this->costUnit,
|
||||
'country' => $this->country,
|
||||
'created_at' => $now->format('Y-m-d H:i:s'),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws InvalidRowException
|
||||
*/
|
||||
private static function readDate(array $data, string $key): \DateTimeImmutable
|
||||
{
|
||||
$value = $data[$key] ?? null;
|
||||
|
||||
if (false === is_string($value) || false === $date = \DateTimeImmutable::createFromFormat('!Y-m-d', $value)) {
|
||||
throw new InvalidRowException(sprintf('Travel export row with an unreadable %s', $key));
|
||||
}
|
||||
|
||||
return $date;
|
||||
}
|
||||
|
||||
/**
|
||||
* The shape here is what the destination table stores and what
|
||||
* App\BusProNet\Model\Pickup::fromArray() reads back.
|
||||
*/
|
||||
private static function readPickups(mixed $pickups): array
|
||||
{
|
||||
if (false === is_array($pickups)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$mapped = [];
|
||||
|
||||
foreach ($pickups as $pickup) {
|
||||
if (false === is_array($pickup)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$busProId = (int) ($pickup['busProId'] ?? 0);
|
||||
|
||||
if (0 === $busProId) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$mapped[] = [
|
||||
'busProId' => $busProId,
|
||||
'city' => self::readNullableString($pickup, 'city'),
|
||||
'street' => self::readNullableString($pickup, 'street'),
|
||||
'time' => self::readNullableString($pickup, 'time'),
|
||||
];
|
||||
}
|
||||
|
||||
return $mapped;
|
||||
}
|
||||
|
||||
private static function readNullableString(array $data, string $key): ?string
|
||||
{
|
||||
$value = $data[$key] ?? null;
|
||||
|
||||
return null === $value ? null : (string) $value;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
namespace App\MyEp\Import;
|
||||
|
||||
/**
|
||||
* A single unusable row of the travel export. Thrown per row so the import can skip
|
||||
* it and carry on instead of losing the whole run.
|
||||
*/
|
||||
class InvalidRowException extends \RuntimeException
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
<?php
|
||||
|
||||
namespace App\MyEp\Import;
|
||||
|
||||
use App\MyEp\Api\ApiClient;
|
||||
use App\MyEp\Api\ApiException;
|
||||
use Psr\Log\LoggerInterface;
|
||||
|
||||
/**
|
||||
* Reads the full travel export from MyE&P, one page at a time.
|
||||
*/
|
||||
class TravelExportClient
|
||||
{
|
||||
private const PATH = 'api/travels/export';
|
||||
private const PER_PAGE = 500;
|
||||
|
||||
/**
|
||||
* Stops a malformed meta block from turning the import into an endless loop.
|
||||
*/
|
||||
private const MAX_PAGES = 100;
|
||||
|
||||
public function __construct(
|
||||
private readonly ApiClient $apiClient,
|
||||
private readonly LoggerInterface $logger,
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @return DestinationRow[]
|
||||
*
|
||||
* @throws ApiException
|
||||
*/
|
||||
public function fetchAll(): array
|
||||
{
|
||||
$rows = [];
|
||||
$page = 1;
|
||||
$totalPages = 1;
|
||||
|
||||
do {
|
||||
$payload = $this->apiClient->get(self::PATH, [
|
||||
'page' => $page,
|
||||
'perPage' => self::PER_PAGE,
|
||||
]);
|
||||
|
||||
$data = $payload['data'] ?? null;
|
||||
|
||||
if (false === is_array($data)) {
|
||||
throw new ApiException('The MyE&P travel export did not contain a data list');
|
||||
}
|
||||
|
||||
foreach ($data as $item) {
|
||||
if (false === is_array($item)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
$rows[] = DestinationRow::fromArray($item);
|
||||
} catch (InvalidRowException $e) {
|
||||
$this->logger->warning('Skipped an unusable travel export row', [
|
||||
'reason' => $e->getMessage(),
|
||||
'row' => $item,
|
||||
]);
|
||||
}
|
||||
}
|
||||
|
||||
$totalPages = max(1, (int) ($payload['meta']['totalPages'] ?? 1));
|
||||
++$page;
|
||||
} while ($page <= $totalPages && $page <= self::MAX_PAGES && [] !== $data);
|
||||
|
||||
if ($totalPages > self::MAX_PAGES) {
|
||||
$this->logger->error('The MyE&P travel export reported more pages than are read', [
|
||||
'total_pages' => $totalPages,
|
||||
'max_pages' => self::MAX_PAGES,
|
||||
]);
|
||||
}
|
||||
|
||||
return $rows;
|
||||
}
|
||||
}
|
||||
@@ -12,7 +12,6 @@ use App\Security\OAuth2\MyEpClient;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Flagception\Manager\FeatureManagerInterface;
|
||||
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
|
||||
use Psr\Http\Client\ClientExceptionInterface;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Symfony\Component\HttpFoundation\RedirectResponse;
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
@@ -26,6 +25,8 @@ use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
|
||||
use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
|
||||
use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
|
||||
use Symfony\Component\Security\Http\Util\TargetPathTrait;
|
||||
use Symfony\Contracts\HttpClient\Exception\ExceptionInterface as HttpExceptionInterface;
|
||||
use Symfony\Contracts\HttpClient\HttpClientInterface;
|
||||
|
||||
class MyEpAuthenticator extends AbstractAuthenticator
|
||||
{
|
||||
@@ -46,6 +47,7 @@ class MyEpAuthenticator extends AbstractAuthenticator
|
||||
|
||||
public function __construct(
|
||||
private readonly MyEpClient $client,
|
||||
private readonly HttpClientInterface $myepClient,
|
||||
private readonly UserDataHandler $userDataHandler,
|
||||
private readonly EntityManagerInterface $entityManager,
|
||||
private readonly UrlGeneratorInterface $urlGenerator,
|
||||
@@ -84,25 +86,22 @@ class MyEpAuthenticator extends AbstractAuthenticator
|
||||
throw new CustomUserMessageAuthenticationException('Login via MyE&P nicht möglich');
|
||||
}
|
||||
|
||||
// A plain bearer request over the shared MyE&P client, so it inherits its
|
||||
// timeouts and transport retries. It deliberately does not go through
|
||||
// App\MyEp\Api\ApiClient: this token was just minted for this one request, so
|
||||
// there is no cached token to renew on a 401, and every failure here ends in
|
||||
// the same message anyway. Logging stays on the audit channel, unlike the
|
||||
// machine to machine traffic - a login attempt belongs in the audit trail.
|
||||
try {
|
||||
$provider = $this->client->getProvider();
|
||||
$url = $provider->getResourceOwnerDetailsUrl($accessToken);
|
||||
$userinfoRequest = $provider->getAuthenticatedRequest('GET', $url, $accessToken, [
|
||||
'headers' => [
|
||||
'Accept' => 'application/json',
|
||||
'Content-Type' => 'application/json',
|
||||
],
|
||||
$response = $this->myepClient->request('GET', 'api/userinfo', [
|
||||
'auth_bearer' => $accessToken->getToken(),
|
||||
'headers' => ['Accept' => 'application/json'],
|
||||
]);
|
||||
$userinfo = $response->toArray();
|
||||
} catch (HttpExceptionInterface $e) {
|
||||
$this->logger->error('Login via MyE&P failed due to unexpected userinfo response', [
|
||||
'exception' => $e,
|
||||
]);
|
||||
$response = $provider->getHttpClient()->sendRequest($userinfoRequest);
|
||||
} catch (ClientExceptionInterface $e) {
|
||||
$this->logger->error('Login via MyE&P failed due to unexpected userinfo response');
|
||||
throw new CustomUserMessageAuthenticationException('Login via MyE&P nicht möglich');
|
||||
}
|
||||
|
||||
$userinfo = json_decode($response->getBody(), true);
|
||||
|
||||
if (false === is_array($userinfo)) {
|
||||
$this->logger->error('Login via MyE&P failed due to unreadable userinfo payload');
|
||||
throw new CustomUserMessageAuthenticationException('Login via MyE&P nicht möglich');
|
||||
}
|
||||
|
||||
|
||||
@@ -61,6 +61,22 @@ abstract class AbstractFilterHandler
|
||||
|
||||
abstract protected function saveFilterSettings(AbstractFilterDto $filterDto): void;
|
||||
|
||||
/**
|
||||
* Country filters used to be stored as the raw BusProNet abbreviations, which the
|
||||
* destination table has since moved off. A session written before that switch would
|
||||
* otherwise keep filtering for a value no destination carries any more.
|
||||
*/
|
||||
protected function toIsoCountry(?string $country): ?string
|
||||
{
|
||||
return match ($country) {
|
||||
'a' => 'at',
|
||||
'd' => 'de',
|
||||
'f' => 'fr',
|
||||
'i' => 'it',
|
||||
default => $country,
|
||||
};
|
||||
}
|
||||
|
||||
protected function getSession(): SessionInterface
|
||||
{
|
||||
return $this->requestStack->getSession();
|
||||
|
||||
@@ -49,7 +49,7 @@ class ApplicationFilterHandler extends AbstractFilterHandler
|
||||
$filterDto->setIncludePast((bool) $data['include_past']);
|
||||
}
|
||||
if (isset($data['country'])) {
|
||||
$filterDto->setCountry($data['country']);
|
||||
$filterDto->setCountry($this->toIsoCountry($data['country']));
|
||||
}
|
||||
if (isset($data['teamer_name'])) {
|
||||
$filterDto->setTeamerName($data['teamer_name']);
|
||||
|
||||
@@ -49,7 +49,7 @@ class AssignmentFilterHandler extends AbstractFilterHandler
|
||||
$filterDto->setIncludePast((bool) $data['include_past']);
|
||||
}
|
||||
if (isset($data['country'])) {
|
||||
$filterDto->setCountry($data['country']);
|
||||
$filterDto->setCountry($this->toIsoCountry($data['country']));
|
||||
}
|
||||
if (isset($data['teamer_name'])) {
|
||||
$filterDto->setTeamerName($data['teamer_name']);
|
||||
|
||||
Reference in new issue
Block a user