feat: improved contingents api performance with db backed snapshots

2026-08-20 11:46:03 +02:00
parent d5f9f4ef10
commit 351fbab498
20 changed files with 1521 additions and 109 deletions
@@ -0,0 +1,228 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Tests\Service;
+
+use App\BpnConnect\ContingentsClient;
+use App\BpnConnect\Exception\BpnConnectException;
+use App\BpnConnect\Model\ContingentCalendarEntry;
+use App\BpnConnect\Model\ContingentCalendarMeta;
+use App\BpnConnect\Model\ContingentCalendarResponse;
+use App\BpnConnect\Model\ContingentStatus;
+use App\Entity\Groups\Accommodation;
+use App\Entity\Groups\ContingentDay;
+use App\Entity\Groups\ContingentSyncState;
+use App\Repository\Groups\ContingentDayRepository;
+use App\Repository\Groups\ContingentSyncStateRepository;
+use App\Service\ContingentSnapshotManager;
+use Doctrine\ORM\EntityManagerInterface;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
+
+class ContingentSnapshotManagerTest extends TestCase
+{
+    private ContingentsClient&MockObject $client;
+    private ContingentDayRepository&MockObject $dayRepository;
+    private ContingentSyncStateRepository&MockObject $syncStateRepository;
+    private EntityManagerInterface&MockObject $entityManager;
+
+    protected function setUp(): void
+    {
+        $this->client = $this->createMock(ContingentsClient::class);
+        $this->dayRepository = $this->createMock(ContingentDayRepository::class);
+        $this->syncStateRepository = $this->createMock(ContingentSyncStateRepository::class);
+        $this->entityManager = $this->createMock(EntityManagerInterface::class);
+    }
+
+    public function testAddsMissingDaysAndMarksSnapshotChanged(): void
+    {
+        $this->dayRepository->method('findByAccommodationAndDateRange')->willReturn([]);
+        $this->dayRepository->method('findStatusFingerprintParts')->willReturn(['2026-07-01:OK', '2026-07-02:BLOCKED']);
+        $this->client->method('getContingentCalendar')->willReturn($this->response([
+            new ContingentCalendarEntry('2026-07-01', ContingentStatus::Ok),
+            new ContingentCalendarEntry('2026-07-02', ContingentStatus::Blocked),
+        ]));
+
+        $this->entityManager->expects(self::exactly(3))->method('persist');
+
+        $result = $this->sync();
+
+        self::assertTrue($result->successful);
+        self::assertTrue($result->changed);
+        self::assertSame(2, $result->added);
+        self::assertSame(0, $result->updated);
+        self::assertSame(0, $result->removed);
+    }
+
+    public function testUpdatesChangedStatusAndRemovesVanishedDays(): void
+    {
+        $existing = [
+            '2026-07-01' => $this->day('2026-07-01', ContingentStatus::Ok),
+            '2026-07-02' => $this->day('2026-07-02', ContingentStatus::Ok),
+            '2026-07-03' => $this->day('2026-07-03', ContingentStatus::Ok),
+        ];
+
+        $this->dayRepository->method('findByAccommodationAndDateRange')->willReturn($existing);
+        $this->dayRepository->method('findStatusFingerprintParts')->willReturn(['2026-07-01:OK']);
+        $this->client->method('getContingentCalendar')->willReturn($this->response([
+            new ContingentCalendarEntry('2026-07-01', ContingentStatus::Ok),
+            new ContingentCalendarEntry('2026-07-02', ContingentStatus::OnRequest),
+        ]));
+
+        $this->entityManager->expects(self::once())->method('remove');
+
+        $result = $this->sync();
+
+        self::assertSame(0, $result->added);
+        self::assertSame(1, $result->updated);
+        self::assertSame(1, $result->removed);
+        self::assertSame(ContingentStatus::OnRequest, $existing['2026-07-02']->getStatus());
+    }
+
+    public function testUnchangedFingerprintDoesNotMoveChangedAt(): void
+    {
+        $state = new ContingentSyncState($this->accommodation());
+        $state->setContentHash(hash('sha256', '2026-07-01:OK'));
+
+        $this->syncStateRepository->method('findOneByAccommodation')->willReturn($state);
+        $this->dayRepository->method('findByAccommodationAndDateRange')->willReturn([
+            '2026-07-01' => $this->day('2026-07-01', ContingentStatus::Ok),
+        ]);
+        $this->dayRepository->method('findStatusFingerprintParts')->willReturn(['2026-07-01:OK']);
+        $this->client->method('getContingentCalendar')->willReturn($this->response([
+            new ContingentCalendarEntry('2026-07-01', ContingentStatus::Ok),
+        ]));
+
+        $result = $this->sync();
+
+        self::assertFalse($result->changed);
+        self::assertNull($state->getChangedAt());
+        self::assertNotNull($state->getSyncedAt());
+    }
+
+    public function testUpstreamFailureKeepsSnapshotAndRecordsError(): void
+    {
+        $state = new ContingentSyncState($this->accommodation());
+        $this->syncStateRepository->method('findOneByAccommodation')->willReturn($state);
+        $this->client->method('getContingentCalendar')->willThrowException(new BpnConnectException('upstream down'));
+
+        $this->dayRepository->expects(self::never())->method('findByAccommodationAndDateRange');
+        $this->entityManager->expects(self::never())->method('remove');
+
+        $result = $this->sync();
+
+        self::assertFalse($result->successful);
+        self::assertSame('upstream down', $result->error);
+        self::assertSame(1, $state->getFailureCount());
+        self::assertNull($state->getSyncedAt());
+    }
+
+    public function testEmptyUpstreamResponseDoesNotWipeAPopulatedRange(): void
+    {
+        $state = new ContingentSyncState($this->accommodation());
+        $this->syncStateRepository->method('findOneByAccommodation')->willReturn($state);
+        $this->dayRepository->method('findByAccommodationAndDateRange')->willReturn([
+            '2026-07-01' => $this->day('2026-07-01', ContingentStatus::Ok),
+        ]);
+        $this->client->method('getContingentCalendar')->willReturn($this->response([]));
+
+        $this->entityManager->expects(self::never())->method('remove');
+
+        $result = $this->sync();
+
+        self::assertFalse($result->successful);
+        self::assertSame(1, $state->getFailureCount());
+    }
+
+    public function testDaysOutsideTheRequestedWindowAreIgnored(): void
+    {
+        $this->dayRepository->method('findByAccommodationAndDateRange')->willReturn([]);
+        $this->dayRepository->method('findStatusFingerprintParts')->willReturn([]);
+        $this->client->method('getContingentCalendar')->willReturn($this->response([
+            new ContingentCalendarEntry('2026-06-30', ContingentStatus::Ok),
+            new ContingentCalendarEntry('2026-07-01', ContingentStatus::Ok),
+            new ContingentCalendarEntry('2026-08-01', ContingentStatus::Ok),
+        ]));
+
+        $result = $this->sync();
+
+        self::assertSame(1, $result->added);
+    }
+
+    public function testNearTermSyncDoesNotShrinkTheHorizonEstablishedByTheFullRun(): void
+    {
+        $state = new ContingentSyncState($this->accommodation());
+        $state->recordSuccess(new \DateTimeImmutable('2026-08-20'), new \DateTimeImmutable('2028-08-20'));
+
+        $this->syncStateRepository->method('findOneByAccommodation')->willReturn($state);
+        $this->dayRepository->method('findByAccommodationAndDateRange')->willReturn([]);
+        $this->dayRepository->method('findStatusFingerprintParts')->willReturn([]);
+        $this->client->method('getContingentCalendar')->willReturn($this->response([
+            new ContingentCalendarEntry('2026-07-01', ContingentStatus::Ok),
+        ]));
+
+        // The near-term job syncs only to 2026-07-03 but must not discard the 24-month reach.
+        $this->sync();
+
+        self::assertSame('2028-08-20', $state->getHorizonTo()?->format('Y-m-d'));
+    }
+
+    public function testHorizonGrowsWhenAFurtherWindowIsSynced(): void
+    {
+        $state = new ContingentSyncState($this->accommodation());
+        $state->recordSuccess(new \DateTimeImmutable('2026-08-20'), new \DateTimeImmutable('2026-01-01'));
+
+        $this->syncStateRepository->method('findOneByAccommodation')->willReturn($state);
+        $this->dayRepository->method('findByAccommodationAndDateRange')->willReturn([]);
+        $this->dayRepository->method('findStatusFingerprintParts')->willReturn([]);
+        $this->client->method('getContingentCalendar')->willReturn($this->response([
+            new ContingentCalendarEntry('2026-07-01', ContingentStatus::Ok),
+        ]));
+
+        $this->sync();
+
+        self::assertSame('2026-07-03', $state->getHorizonTo()?->format('Y-m-d'));
+    }
+
+    private function sync(): \App\Model\ContingentSyncResult
+    {
+        $manager = new ContingentSnapshotManager(
+            $this->client,
+            $this->dayRepository,
+            $this->syncStateRepository,
+            $this->entityManager,
+            $this->createMock(LoggerInterface::class),
+        );
+
+        return $manager->sync(
+            $this->accommodation(),
+            new \DateTimeImmutable('2026-07-01'),
+            new \DateTimeImmutable('2026-07-03'),
+        );
+    }
+
+    private function accommodation(): Accommodation
+    {
+        return (new Accommodation())->setCalendarCode('HOTEL1');
+    }
+
+    private function day(string $date, ContingentStatus $status): ContingentDay
+    {
+        return (new ContingentDay())
+            ->setDate(new \DateTimeImmutable($date))
+            ->setStatus($status);
+    }
+
+    /**
+     * @param ContingentCalendarEntry[] $entries
+     */
+    private function response(array $entries): ContingentCalendarResponse
+    {
+        return new ContingentCalendarResponse(
+            new ContingentCalendarMeta('2026-07-01', '2026-07-03', 'days', 'HOTEL1', 1, count($entries)),
+            $entries,
+        );
+    }
+}
@@ -0,0 +1,102 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Tests\Service;
+
+use App\BpnConnect\Model\ContingentStatus;
+use App\Entity\Groups\Accommodation;
+use App\Entity\Groups\ContingentDay;
+use App\Entity\Groups\ContingentSyncState;
+use App\Repository\Groups\ContingentDayRepository;
+use App\Repository\Groups\ContingentSyncStateRepository;
+use App\Service\ContingentSnapshotReader;
+use Carbon\CarbonImmutable;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
+
+class ContingentSnapshotReaderTest extends TestCase
+{
+    private ContingentDayRepository&MockObject $dayRepository;
+    private ContingentSyncStateRepository&MockObject $syncStateRepository;
+
+    protected function setUp(): void
+    {
+        $this->dayRepository = $this->createMock(ContingentDayRepository::class);
+        $this->syncStateRepository = $this->createMock(ContingentSyncStateRepository::class);
+    }
+
+    public function testReturnsNullWhenNothingHasEverSynced(): void
+    {
+        $this->syncStateRepository->method('findOneByAccommodation')->willReturn(null);
+        $this->dayRepository->expects(self::never())->method('findByHotelCodeAndDateRange');
+
+        self::assertNull($this->read());
+    }
+
+    public function testReturnsNullWhenTheSnapshotIsStale(): void
+    {
+        $this->syncStateRepository->method('findOneByAccommodation')->willReturn($this->state('-7 hours'));
+        $this->dayRepository->expects(self::never())->method('findByHotelCodeAndDateRange');
+
+        self::assertNull($this->read());
+    }
+
+    public function testReturnsStatusesWhenRecentlySynced(): void
+    {
+        $this->syncStateRepository->method('findOneByAccommodation')->willReturn($this->state('-10 minutes'));
+        $this->dayRepository->method('findByHotelCodeAndDateRange')->willReturn([
+            '2026-09-01' => $this->day(ContingentStatus::Ok),
+            '2026-09-02' => $this->day(ContingentStatus::OnRequest),
+        ]);
+
+        self::assertSame([
+            '2026-09-01' => ContingentStatus::Ok,
+            '2026-09-02' => ContingentStatus::OnRequest,
+        ], $this->read());
+    }
+
+    public function testStillUsableJustInsideTheStalenessWindow(): void
+    {
+        $this->syncStateRepository->method('findOneByAccommodation')->willReturn($this->state('-5 hours'));
+        $this->dayRepository->method('findByHotelCodeAndDateRange')->willReturn([]);
+
+        self::assertSame([], $this->read());
+    }
+
+    public function testReturnsNullForAnAccommodationWithoutACalendarCode(): void
+    {
+        $this->syncStateRepository->expects(self::never())->method('findOneByAccommodation');
+
+        self::assertNull($this->read(new Accommodation()));
+    }
+
+    /**
+     * @return array<string, ContingentStatus>|null
+     */
+    private function read(?Accommodation $accommodation = null): ?array
+    {
+        $reader = new ContingentSnapshotReader(
+            $this->dayRepository,
+            $this->syncStateRepository,
+            $this->createMock(LoggerInterface::class),
+        );
+
+        return $reader->statusesFor(
+            $accommodation ?? (new Accommodation())->setCalendarCode('HOTEL1'),
+            new \DateTimeImmutable('2026-09-01'),
+            new \DateTimeImmutable('2026-09-03'),
+        );
+    }
+
+    private function state(string $syncedAgo): ContingentSyncState
+    {
+        return (new ContingentSyncState())->setSyncedAt(CarbonImmutable::now()->modify($syncedAgo)->toDateTimeImmutable());
+    }
+
+    private function day(ContingentStatus $status): ContingentDay
+    {
+        return (new ContingentDay())->setStatus($status);
+    }
+}