Nodarx/provider_imap
1
0
Fork 0
generated from Nodarx/template
Code Issues 1 Pull Requests 5 Actions Packages Projects Releases Wiki Activity

feat: serve message lists from the cache

Browse Source 
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
This commit is contained in:
Sebastian Krupinski
2026-10-07 22:15:34 -04:00
parent 852ead324f
commit b1e92e5b07
9 changed files with 800 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/php/Unit/CachedServiceTest.php
+134
View File
@@ -12,8 +12,12 @@ use KTXM\ProviderImap\Providers\MessageProperties;
use KTXM\ProviderImap\Service\Cache\HarmonizationService;
use KTXM\ProviderImap\Service\Cache\MessageDeltaService;
use KTXM\ProviderImap\Service\Cache\MessageIngestor;
use KTXM\ProviderImap\Service\Cache\MessageQueryBuilder;
use KTXM\ProviderImap\Service\Live\LiveMailService;
use KTXF\Resource\Identifier\EntityIdentifier;
use KTXF\Resource\Range\RangeAnchorType;
use KTXF\Resource\Range\RangeType;
use KTXF\Resource\Sort\Sort;
use KTXT\ProviderImap\Tests\Support\FakeLiveMailService;
use KTXT\ProviderImap\Tests\Support\FakeMailboxStore;
use KTXT\ProviderImap\Tests\Support\FakeMessageFileStore;
@@ -23,6 +27,8 @@ use PHPUnit\Framework\TestCase;
final class CachedServiceTest extends TestCase
{
private FakeMailboxStore $mailboxes;
private FakeMessageStore $messages;
private FakeMessageFileStore $files;
private FakeLiveMailService $live;
private CachedService $service;
@@ -40,8 +46,14 @@ final class CachedServiceTest extends TestCase
new MessageIngestor($files, $messages, $this->mailboxes),
);
$this->messages = $messages;
$this->files = $files;
$this->service = new CachedServiceTestDouble(
$this->mailboxes,
$messages,
$files,
new MessageIngestor($files, $messages, $this->mailboxes),
new MessageQueryBuilder(),
$harmonizer,
new MessageDeltaService($this->mailboxes, $messages),
);
@@ -152,6 +164,128 @@ final class CachedServiceTest extends TestCase
$this->assertSame([5], $uids);
}
public function testListOfANotHarmonizedMailboxStreamsFromTheServerAndCaches(): void
{
$this->live->flags = [1 => [], 2 => ['\\Seen']];
$uids = $this->listedUids($this->service->entityListStream('INBOX'));
$this->assertSame([1, 2], $uids);
$this->assertCount(1, $this->calls('messageList'));
$this->assertSame([1, 2], $this->files->uids(7));
$this->assertSame([1 => [], 2 => ['seen']], $this->messages->flags('svc', 'INBOX', 7));
}
public function testListOfAHarmonizedMailboxComesFromTheCache(): void
{
$this->harmonized([1 => [], 2 => ['\\Seen'], 3 => []]);
$entities = iterator_to_array($this->service->entityListStream('INBOX'), false);
$this->assertSame([1, 2, 3], array_map(static fn ($entity): int => (int) $entity->identifier(), $entities));
$this->assertSame([], $this->calls('messageList'));
$this->assertSame(['seen' => true], $entities[1]->getProperties()->getFlags());
$this->assertSame('INBOX', $entities[1]->collection());
}
public function testListRangeIsAppliedLikeTheLiveService(): void
{
$this->harmonized([1 => [], 2 => [], 3 => [], 4 => []]);
$absolute = $this->service->entityListRange(RangeType::TALLY);
$absolute->setAnchor(RangeAnchorType::ABSOLUTE);
$absolute->setPosition(1);
$absolute->setTally(2);
$relative = $this->service->entityListRange(RangeType::TALLY);
$relative->setAnchor(RangeAnchorType::RELATIVE);
$relative->setPosition(3);
$relative->setTally(2);
$this->assertSame([2, 3], $this->listedUids($this->service->entityListStream('INBOX', null, null, $absolute)));
$this->assertSame([3, 4], $this->listedUids($this->service->entityListStream('INBOX', null, null, $relative)));
}
public function testMessagesMissingFromTheContentStoreAreFetchedAndCached(): void
{
$this->harmonized([1 => [], 2 => []]);
$this->files->delete('tenant', 'svc', 'INBOX', 7, 2);
$this->live->fetchBatches = [];
$this->assertSame([1, 2], $this->listedUids($this->service->entityListStream('INBOX')));
$this->assertSame([[2]], $this->live->fetchBatches);
$this->assertSame([1, 2], $this->files->uids(7));
}
public function testBodyFilterHasTheServerFindTheUids(): void
{
$this->harmonized([1 => [], 2 => [], 3 => []]);
$this->live->found = [3, 1];
$this->live->fetchBatches = [];
$filter = $this->service->entityListFilter();
$filter->condition('body', 'invoice');
$this->assertSame([3, 1], $this->listedUids($this->service->entityListStream('INBOX', $filter)));
$this->assertCount(1, $this->calls('entityFind'));
$this->assertSame([], $this->live->fetchBatches, 'content comes from the cache');
}
public function testOtherFiltersAreTranslatedForTheMetaStore(): void
{
$this->harmonized([1 => []]);
$filter = $this->service->entityListFilter();
$filter->condition('subject', 'report');
// keyed attributes: entityListSort() passes a plain list, which Sort::condition() ignores (existing bug)
$sort = new Sort(['received' => true]);
$sort->condition('received', false);
iterator_to_array($this->service->entityListStream('INBOX', $filter, $sort));
$this->assertSame([], $this->calls('entityFind'));
$this->assertArrayHasKey('subject', $this->messages->lastQuery[0]);
$this->assertSame(['received' => -1, 'uid' => 1], $this->messages->lastQuery[1]);
}
public function testListBulkIsTheStreamCollected(): void
{
$this->harmonized([1 => [], 2 => []]);
$this->assertCount(2, $this->service->entityListBulk('INBOX'));
}
/**
* Harmonize INBOX with the given server UIDs and flags.
*
* @param array<int, list<string>> $flags
*/
private function harmonized(array $flags): void
{
$this->live->flags = $flags;
$this->service->entityDelta('INBOX', '');
}
/**
* @return int[]
*/
private function listedUids(iterable $entities): array
{
$uids = [];
foreach ($entities as $entity) {
$uids[] = (int) $entity->identifier();
}
return $uids;
}
/**
* @return list<array>
*/
private function calls(string $method): array
{
return array_values(array_filter($this->live->calls, static fn (array $call): bool => $call[0] === $method));
}
/**
* @return list<array>
*/