ldc-cocotte/tests/Unit/Domain/Services/PickupSchedulingServiceTest.php

545 lines
21 KiB
PHP
Raw Permalink Normal View History

2026-06-14 21:32:07 +02:00
<?php
declare(strict_types=1);
namespace Tests\Unit\Domain\Services;
2026-06-14 21:32:07 +02:00
use Carbon\CarbonImmutable;
use Carbon\WeekDay;
use Domain\Enums\RepeatFrequency;
use Domain\Models\Entities\PickupExceptionOnDate;
use Domain\Models\Entities\Shop;
use Domain\Models\ValueObjects\Entities\PickupExceptionId;
use Domain\Models\ValueObjects\Entities\ShopId;
use Domain\Models\ValueObjects\PickupTimeSlot;
use Domain\Models\ValueObjects\PickupWindow;
2026-06-14 21:32:07 +02:00
use Domain\Models\ValueObjects\ShopPickupOverride;
use Domain\Ports\Repositories\PickupExceptionRepository;
use Domain\Services\PickupSchedulingService;
use Shared\Helpers\UuidHelper;
2026-06-14 21:32:07 +02:00
function createTestShop(int $id = 1): Shop
{
return new Shop(
id: new ShopId(UuidHelper::v7()),
2026-06-14 21:32:07 +02:00
name: 'Test Shop',
address: '1 rue de Paris',
postcode: '75000',
city: 'Paris'
);
}
dataset('nominal_deadlines', [
'Before limit (Monday 10:00)' => ['2026-05-11 10:00:00', true],
'Right on the edge (Monday 14:00)' => ['2026-05-11 14:00:00', true],
'After limit (Monday 14:01)' => ['2026-05-11 14:01:00', false],
]);
dataset('example_2_deadlines', [
'Before nominal limit (Monday 11:00)' => ['2026-05-04 11:00:00', true],
'After nominal limit (Monday 15:00)' => ['2026-05-04 15:00:00', false],
]);
dataset('example_3_deadlines', [
'Before limit custom (Wednesday 22:00)' => ['2026-04-29 22:00:00', true],
'After limit custom (Thursday 00:01)' => ['2026-04-30 00:01:00', false],
]);
dataset('next_pickup_scenarios', [
'Monday 10:00 (Before cutoff)' => ['2026-05-11 10:00:00', '2026-05-15 14:00:00'],
'Monday 14:00 (At cutoff edge)' => ['2026-05-11 14:00:00', '2026-05-15 14:00:00'],
'Monday 14:01 (After cutoff)' => ['2026-05-11 14:01:00', '2026-05-22 14:00:00'],
'Tuesday 10:00 (After cutoff)' => ['2026-05-12 10:00:00', '2026-05-22 14:00:00'],
'Friday 10:00 (After cutoff)' => ['2026-05-15 10:00:00', '2026-05-22 14:00:00'],
'Friday 15:00 (After cutoff)' => ['2026-05-15 15:00:00', '2026-05-22 14:00:00'],
2026-06-14 21:32:07 +02:00
]);
dataset('current_cutoff_scenarios', [
'Monday 10:00 (Before cutoff)' => ['2026-05-11 10:00:00', '2026-05-11 14:00:00'],
'Monday 14:01 (After cutoff)' => ['2026-05-11 14:01:00', '2026-05-18 14:00:00'],
'Tuesday 10:00 (Next cutoff)' => ['2026-05-12 10:00:00', '2026-05-18 14:00:00'],
'Friday 10:00 (Next cutoff)' => ['2026-05-15 10:00:00', '2026-05-18 14:00:00'],
2026-06-14 21:32:07 +02:00
]);
describe('Pickup Scheduling Service', function (): void {
it(
'can sets Friday\'s visibility based on the standard deadline',
function (string $mockCurrentTime, bool $expectedVisibility): void {
// GIVEN
$now = CarbonImmutable::parse($mockCurrentTime);
$until = $now->addWeeks(2);
$shop = createTestShop(1);
$service = createServiceWithExceptions($now);
// WHEN
$results = $service->getTimeSlotsFor($shop, $until);
// THEN
$targetFriday = '2026-05-15';
$hasFridaySlot = array_any(
$results,
static fn (PickupTimeSlot $slot): bool => CarbonImmutable::instance($slot->getAt())->isSameDay($targetFriday)
);
2026-06-14 21:32:07 +02:00
// THEN
expect($hasFridaySlot)->toBe($expectedVisibility);
}
)->with('nominal_deadlines');
it('can remove pickup day if its a hollyday without replacement', function (): void {
// GIVEN
$now = CarbonImmutable::parse('2026-05-04 10:00:00');
$until = $now->addDays(10);
$shop = createTestShop(1);
$exceptions = [
createExceptionPivot(date: '2026-05-08', replacementDate: null, orderDeadlineAt: null),
];
$service = createServiceWithExceptions($now, $exceptions);
// WHEN
$results = $service->getTimeSlotsFor($shop, $until);
// THEN
expect($results)->toBeEmpty();
});
it(
'it can replace the holiday pickup day with another day if ordered before the default deadline',
function (string $mockCurrentTime, bool $expectedVisibility): void {
// GIVEN
$now = CarbonImmutable::parse($mockCurrentTime);
$until = $now->addDays(10);
$shop = createTestShop(1);
$exceptions = [
createExceptionPivot(date: '2026-05-08', replacementDate: '2026-05-07', orderDeadlineAt: null),
];
$service = createServiceWithExceptions($now, $exceptions);
// WHEN
$results = $service->getTimeSlotsFor($shop, $until);
// THEN
$targetReplacementDay = '2026-05-07';
$hasThursdaySlot = array_any(
$results,
static fn (PickupTimeSlot $slot): bool => CarbonImmutable::instance($slot->getAt())->isSameDay($targetReplacementDay)
);
2026-06-14 21:32:07 +02:00
// THEN
expect($hasThursdaySlot)->toBe($expectedVisibility);
}
)->with('example_2_deadlines');
it(
'can replace the holiday pickup day with another day if ordered before the custom deadline',
function (string $mockCurrentTime, bool $expectedVisibility): void {
// GIVEN
$now = CarbonImmutable::parse($mockCurrentTime);
$until = $now->addDays(15);
$shop = createTestShop(1);
$exceptions = [
createExceptionPivot(date: '2026-05-08', replacementDate: '2026-05-05', orderDeadlineAt: '2026-04-29 23:59:00'),
];
$service = createServiceWithExceptions($now, $exceptions);
// WHEN
$results = $service->getTimeSlotsFor($shop, $until);
// THEN
$targetReplacementDay = '2026-05-05';
$hasTuesdaySlot = array_any(
$results,
static fn (PickupTimeSlot $slot): bool => CarbonImmutable::instance($slot->getAt())->isSameDay($targetReplacementDay)
);
2026-06-14 21:32:07 +02:00
// THEN
expect($hasTuesdaySlot)->toBe($expectedVisibility);
}
)->with('example_3_deadlines');
it('cannot get timeslots except for a futur date', function (): void {
// GIVEN
$now = CarbonImmutable::parse('2026-05-15 12:00:00');
$pastUntilDate = $now->subDay();
$shop = createTestShop(1);
$service = createServiceWithExceptions($now);
// WHEN
// THEN
expect(fn () => $service->getTimeSlotsFor($shop, $pastUntilDate))
->toThrow(\InvalidArgumentException::class, 'Cannot get time slots for past days');
});
it('can return multiple chronological pickup days for a long period', function (): void {
// GIVEN
$now = CarbonImmutable::parse('2026-05-11 10:00:00'); // Monday
$until = $now->addWeeks(3);
$shop = createTestShop(1);
$service = createServiceWithExceptions($now);
// WHEN
$results = $service->getTimeSlotsFor($shop, $until);
// THEN
expect($results)->toHaveCount(3)
->and(CarbonImmutable::instance($results[0]->getAt())->isSameDay('2026-05-15'))->toBeTrue()
->and(CarbonImmutable::instance($results[1]->getAt())->isSameDay('2026-05-22'))->toBeTrue()
->and(CarbonImmutable::instance($results[2]->getAt())->isSameDay('2026-05-29'))->toBeTrue();
2026-06-14 21:32:07 +02:00
});
it('ignores pickup exceptions that do not fall on a Friday', function (): void {
// GIVEN
$now = CarbonImmutable::parse('2026-05-11 10:00:00'); // Monday
$until = $now->addDays(10);
$shop = createTestShop(1);
$exceptions = [
createExceptionPivot(
date: '2026-05-12', // Friday
replacementDate: '2026-05-14', // Thursday
orderDeadlineAt: null
),
];
$service = createServiceWithExceptions($now, $exceptions);
// WHEN
$results = $service->getTimeSlotsFor($shop, $until);
// THEN
expect($results)->toHaveCount(1)
->and(CarbonImmutable::instance($results[0]->getAt())->isSameDay('2026-05-15'))->toBeTrue();
2026-06-14 21:32:07 +02:00
});
it('excludes the current day if the order is placed on pickup day morning', function (): void {
// GIVEN
$now = CarbonImmutable::parse('2026-05-15 08:00:00'); // Friday
$until = $now->addWeeks(2);
$shop = createTestShop(1);
$service = createServiceWithExceptions($now);
// WHEN
$results = $service->getTimeSlotsFor($shop, $until);
// THEN
$hasTodaySlot = array_any(
$results,
static fn (PickupTimeSlot $slot): bool => CarbonImmutable::instance($slot->getAt())->isSameDay('2026-05-15')
);
2026-06-14 21:32:07 +02:00
// THEN
expect($hasTodaySlot)->toBeFalse();
});
it('calculates nextPickup correctly depending on current day and time', function (string $mockCurrentTime, string $expectedPickupTime): void {
// GIVEN
$now = CarbonImmutable::parse($mockCurrentTime);
$service = createServiceWithExceptions($now);
// WHEN
$pickup = $service->nextPickup();
// THEN
expect($pickup->format('Y-m-d H:i:s'))->toBe($expectedPickupTime);
})->with('next_pickup_scenarios');
it('calculates currentCutoff correctly', function (string $mockCurrentTime, string $expectedCutoffTime): void {
// GIVEN
$now = CarbonImmutable::parse($mockCurrentTime);
$service = createServiceWithExceptions($now);
// WHEN
$cutoff = $service->currentCutoff();
// THEN
expect($cutoff->format('Y-m-d H:i:s'))->toBe($expectedCutoffTime);
})->with('current_cutoff_scenarios');
it('returns the pickup day', function (): void {
// GIVEN
$now = CarbonImmutable::parse('2026-05-04 10:00:00');
$service = createServiceWithExceptions($now);
// WHEN
$pickupDay = $service->getPickupDay();
// THEN
expect($pickupDay->value)->toBe(WeekDay::Friday->value);
});
it('gets period from pickup day', function (): void {
// GIVEN
$now = CarbonImmutable::parse('2026-05-04 10:00:00'); // Monday 10:00
$service = createServiceWithExceptions($now);
// WHEN
$period = $service->getPeriodFromPickUpDay();
// next pickup is 2026-05-08 14:00:00
// default deadline is 2026-05-04 14:00:00
// THEN
expect($period->getStartDate()->format('Y-m-d H:i:s'))->toBe('2026-05-04 14:00:00')
->and($period->getEndDate()?->format('Y-m-d H:i:s'))->toBe('2026-05-08 23:59:59');
2026-06-14 21:32:07 +02:00
});
it('gets period for pickup date', function (): void {
// GIVEN
$now = CarbonImmutable::parse('2026-05-04 10:00:00');
$service = createServiceWithExceptions($now);
$pickupDate = CarbonImmutable::parse('2026-05-15 14:00:00');
// WHEN
$period = $service->getPeriodForPickupDate($pickupDate);
// THEN
expect($period->getStartDate()->format('Y-m-d H:i:s'))->toBe('2026-05-11 14:00:00')
->and($period->getEndDate()?->format('Y-m-d H:i:s'))->toBe('2026-05-15 23:59:59');
2026-06-14 21:32:07 +02:00
});
it('gets editable pickup exceptions for shop', function (): void {
// GIVEN
$now = CarbonImmutable::parse('2026-05-04 10:00:00');
$exception1 = new PickupExceptionOnDate(
id: new PickupExceptionId(UuidHelper::v7()),
2026-06-14 21:32:07 +02:00
date: CarbonImmutable::parse('2026-05-08'), // Friday
label: 'Test 1',
repeatable: false,
repeatFrequency: RepeatFrequency::YEARLY,
autoUpdated: false
);
$exception2 = new PickupExceptionOnDate(
id: new PickupExceptionId(UuidHelper::v7()),
2026-06-14 21:32:07 +02:00
date: CarbonImmutable::parse('2026-05-09'), // Saturday
label: 'Test 2',
repeatable: false,
repeatFrequency: RepeatFrequency::YEARLY,
autoUpdated: false
);
$shopException = new ShopPickupOverride(
exception: $exception1,
replacementDate: null,
orderDeadlineAt: null
);
$repo = \Mockery::mock(PickupExceptionRepository::class);
$repo->shouldReceive('getAllExceptions')->andReturn([$exception1, $exception2]);
$repo->shouldReceive('getExceptionsAssociatedWithShop')->andReturn([$shopException]);
$service = new class ($repo, $now) extends PickupSchedulingService
{
public function __construct(PickupExceptionRepository $repo, private readonly CarbonImmutable $now)
{
parent::__construct($repo);
}
#[\Override]
2026-06-14 21:32:07 +02:00
protected function getNow(): CarbonImmutable
{
return $this->now->timezoneName === 'UTC'
? $this->now->shiftTimezone(self::CUTOFF_TIME_ZONE)
: $this->now->setTimezone(self::CUTOFF_TIME_ZONE);
2026-06-14 21:32:07 +02:00
}
};
$shop = createTestShop(1);
// WHEN
$editable = $service->getEditablePickupExceptionsFor($shop);
// THEN
expect($editable)->toHaveCount(2);
// Test 1: is Friday, associated -> checked, replacement null
// THEN
expect($editable[0]->isPickupDay)->toBeTrue()
2026-06-14 21:32:07 +02:00
->and($editable[0]->missingSubsitute)->toBeTrue()
->and($editable[0]->passedDeadline)->toBeFalse();
// Test 2: not Friday, not associated
// THEN
expect($editable[1]->isPickupDay)->toBeFalse()
2026-06-14 21:32:07 +02:00
->and($editable[1]->missingSubsitute)->toBeFalse()
->and($editable[1]->passedDeadline)->toBeFalse();
});
it('enforces cutoff at 14h Paris time in winter (13h UTC)', function (): void {
$cutoffTimezone = new PickupSchedulingService(\Mockery::mock(PickupExceptionRepository::class));
// GIVEN: Monday 2 Nov 2026 14:00 Paris (13:00 UTC) vs 14:01 Paris (13:01 UTC)
$nowAtCutoff = CarbonImmutable::parse('2026-11-02 14:00:00', $cutoffTimezone->getCutoffTimezone());
$nowPastCutoff = CarbonImmutable::parse('2026-11-02 14:01:00', $cutoffTimezone->getCutoffTimezone());
$shop = createTestShop(1);
$until = $nowAtCutoff->addWeeks(2);
$serviceAtCutoff = createServiceWithExceptions($nowAtCutoff);
$servicePastCutoff = createServiceWithExceptions($nowPastCutoff);
// WHEN
$slotsAtCutoff = $serviceAtCutoff->getTimeSlotsFor($shop, $until);
$slotsPastCutoff = $servicePastCutoff->getTimeSlotsFor($shop, $until);
// THEN
$targetFriday = '2026-11-06';
$hasFridayAtCutoff = array_any(
$slotsAtCutoff,
static fn (PickupTimeSlot $slot): bool => CarbonImmutable::instance($slot->getAt())->isSameDay($targetFriday)
);
$hasFridayPastCutoff = array_any(
$slotsPastCutoff,
static fn (PickupTimeSlot $slot): bool => CarbonImmutable::instance($slot->getAt())->isSameDay($targetFriday)
);
expect($hasFridayAtCutoff)->toBeTrue()
->and($hasFridayPastCutoff)->toBeFalse();
});
it('resolves nominal, replacement, and closed pickup windows for a target pickup day', function (): void {
// GIVEN
$now = CarbonImmutable::parse('2026-05-04 08:00:00');
$targetFriday = CarbonImmutable::parse('2026-05-08');
$shop = createTestShop(1);
$nominalService = createServiceWithExceptions($now);
$closedService = createServiceWithExceptions($now, [
createExceptionPivot(date: '2026-05-08', replacementDate: null, orderDeadlineAt: null),
]);
$replacedService = createServiceWithExceptions($now, [
createExceptionPivot(date: '2026-05-08', replacementDate: '2026-05-07', orderDeadlineAt: '2026-05-04 16:00:00'),
]);
// WHEN
$nominalWindow = $nominalService->getPickupWindowFor($shop, $targetFriday);
$closedWindow = $closedService->getPickupWindowFor($shop, $targetFriday);
$replacedWindow = $replacedService->getPickupWindowFor($shop, $targetFriday);
// THEN
expect($nominalWindow)->toBeInstanceOf(PickupWindow::class)
->and($nominalWindow?->timeSlot->getAt()->format('Y-m-d'))->toBe('2026-05-08')
->and($nominalWindow?->deadline->format('Y-m-d H:i'))->toBe('2026-05-04 14:00')
->and($closedWindow)->toBeNull()
->and($replacedWindow)->toBeInstanceOf(PickupWindow::class)
->and($replacedWindow?->timeSlot->getAt()->format('Y-m-d'))->toBe('2026-05-07')
->and($replacedWindow?->deadline->format('Y-m-d H:i'))->toBe('2026-05-04 16:00');
});
it('uses Europe/Paris day boundaries when UTC date is still the previous day (00:30 Paris)', function (): void {
// GIVEN: Monday 2026-05-11 00:30 Europe/Paris = Sunday 2026-05-10 22:30 UTC
$repo = \Mockery::mock(PickupExceptionRepository::class);
$repo->shouldReceive('getExceptionsForShop')->andReturn([]);
$utcNow = CarbonImmutable::parse('2026-05-10 22:30:00', 'UTC');
$service = new class ($repo, $utcNow) extends PickupSchedulingService
{
public function __construct(PickupExceptionRepository $repo, private readonly CarbonImmutable $utcNow)
{
parent::__construct($repo);
}
#[\Override]
protected function getNow(): CarbonImmutable
{
return $this->utcNow;
}
};
$shop = createTestShop(1);
$targetToday = CarbonImmutable::parse('2026-05-11 00:00:00', 'Europe/Paris');
$untilNext = CarbonImmutable::parse('2026-05-16 00:00:00', 'Europe/Paris');
// WHEN
$windowForParisToday = $service->getPickupWindowFor($shop, $targetToday);
$slots = $service->getTimeSlotsFor($shop, $untilNext);
$period = $service->getPeriodFromPickUpDay();
// THEN: today in Paris (Monday 2026-05-11) is rejected as not in the future, Friday 15 is open
expect($windowForParisToday)->toBeNull()
->and($slots)->toHaveCount(1)
->and($slots[0]->getAt()->format('Y-m-d'))->toBe('2026-05-15')
->and($period->getStartDate()->setTimezone('Europe/Paris')->format('Y-m-d H:i'))->toBe('2026-05-11 14:00')
->and($period->getEndDate()?->setTimezone('Europe/Paris')->format('Y-m-d H:i'))->toBe('2026-05-15 23:59');
});
it('allows ordering for Friday even when Monday (CUTOFF_DAY) is a public holiday', function (): void {
// GIVEN: Whit Monday 2026-05-25 is a public holiday, Friday 2026-05-29 is open
$now = CarbonImmutable::parse('2026-05-25 10:00:00');
$until = $now->addWeeks(2);
$shop = createTestShop(1);
$exceptions = [
createExceptionPivot(date: '2026-05-25', replacementDate: null, orderDeadlineAt: null),
];
$service = createServiceWithExceptions($now, $exceptions);
// WHEN
$slots = $service->getTimeSlotsFor($shop, $until);
// THEN
$dates = array_map(static fn (PickupTimeSlot $slot): string => $slot->getAt()->format('Y-m-d'), $slots);
expect($dates)->toContain('2026-05-29');
});
2026-06-14 21:32:07 +02:00
});
/**
* @param array<int, \Domain\Models\ValueObjects\ShopPickupOverride> $exceptions
*/
function createServiceWithExceptions(CarbonImmutable $now, array $exceptions = []): PickupSchedulingService
{
/** @var \Mockery\MockInterface&\Domain\Ports\Repositories\PickupExceptionRepository $repo */
$repo = \Mockery::mock(PickupExceptionRepository::class);
$repo->shouldReceive('getExceptionsForShop')->andReturn($exceptions);
return new class ($repo, $now) extends PickupSchedulingService
{
public function __construct(
PickupExceptionRepository $repo,
private readonly CarbonImmutable $now
) {
parent::__construct($repo);
}
#[\Override]
protected function getNow(): CarbonImmutable
{
return $this->now->timezoneName === 'UTC'
? $this->now->shiftTimezone(self::CUTOFF_TIME_ZONE)
: $this->now->setTimezone(self::CUTOFF_TIME_ZONE);
2026-06-14 21:32:07 +02:00
}
};
}
function createExceptionPivot(string $date, ?string $replacementDate = null, ?string $orderDeadlineAt = null): ShopPickupOverride
{
static $idCounter = 1;
$pickupSchedulingService = new PickupSchedulingService(\Mockery::mock(PickupExceptionRepository::class));
$exception = new PickupExceptionOnDate(
id: new PickupExceptionId(UuidHelper::v7()),
date: CarbonImmutable::parse($date, $pickupSchedulingService->getCutoffTimezone()),
2026-06-14 21:32:07 +02:00
label: 'Test Exception',
repeatable: false,
repeatFrequency: RepeatFrequency::YEARLY,
autoUpdated: false
);
return new ShopPickupOverride(
exception: $exception,
replacementDate: $replacementDate ? CarbonImmutable::parse($replacementDate, $pickupSchedulingService->getCutoffTimezone()) : null,
orderDeadlineAt: $orderDeadlineAt ? CarbonImmutable::parse($orderDeadlineAt, $pickupSchedulingService->getCutoffTimezone()) : null
2026-06-14 21:32:07 +02:00
);
}