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

feat: add CachedService with cached collections and delta

Browse Source 
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
This commit is contained in:
Sebastian Krupinski
2026-10-07 22:02:45 -04:00
parent 4e12d41ee9
commit 852ead324f
10 changed files with 750 additions and 215 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/php/Support/FakeLiveMailService.php
+82
View File
@@ -0,0 +1,82 @@
<?php
declare(strict_types=1);
namespace KTXT\ProviderImap\Tests\Support;
use Generator;
use KTXF\Resource\Filter\IFilter;
use KTXF\Resource\Sort\ISort;
use KTXM\ProviderImap\Client\Mailbox;
use KTXM\ProviderImap\Client\Protocol\Command\Argument\FetchOptions;
use KTXM\ProviderImap\Client\Protocol\Parser\FetchMessageParser;
use KTXM\ProviderImap\Providers\CollectionResource;
use KTXM\ProviderImap\Service\Live\LiveMailService;
/**
* LiveMailService without a server: mailboxes, UIDs and flags are set by the test.
*/
final class FakeLiveMailService extends LiveMailService
{
public ?int $uidValidity = null;
public ?int $uidNext = null;
/** @var array<int, list<string>> */
public array $flags = [];
/** @var int[] */
public array $unfetchable = [];
public array $fetchBatches = [];
public int $selects = 0;
public ?int $bodyTextLimit = null;
/** @var Mailbox[] */
public array $mailboxList = [];
/** @var string[] */
public array $failing = [];
/** @var list<array{0: string, 1: array}> */
public array $calls = [];
public function collectionList(?string $location = null, ?IFilter $filter = null, ?ISort $sort = null): array
{
$this->calls[] = ['collectionList', [$location, $filter]];
$list = [];
foreach ($this->mailboxList as $mailbox) {
$list[$mailbox->name()] = (new CollectionResource('imap', 'svc'))->fromImap($mailbox);
}
return $list;
}
public function mailboxFetch(string $identifier): ?Mailbox
{
if (in_array($identifier, $this->failing, true)) {
return null;
}
$this->selects++;
return new Mailbox($identifier, '/', [], count($this->flags), 0, $this->uidValidity, 0, [], true, $this->uidNext);
}
public function entityFlags(string $collection): Generator
{
yield from $this->flags;
}
public function messageFetch(string $collection, ?FetchOptions $options = null, int ...$uids): Generator
{
$this->fetchBatches[] = $uids;
if (preg_match('/BODY\.PEEK\[TEXT\]<0\.(\d+)>/', (string) $options?->toCommand(), $matches) === 1) {
$this->bodyTextLimit = (int) $matches[1];
}
foreach ($uids as $uid) {
if (in_array($uid, $this->unfetchable, true)) {
continue;
}
$flags = implode(' ', $this->flags[$uid] ?? []);
yield $uid => FetchMessageParser::parse("* {$uid} FETCH (UID {$uid} FLAGS ({$flags}))");
}
}
public function entityPatch(string $collection, array $flagsToAdd = [], array $flagsToRemove = [], int ...$uids): void
{
$this->calls[] = ['entityPatch', [$collection, $flagsToAdd, $flagsToRemove, $uids]];
}
}
tests/php/Support/FakeMailboxStore.php
+83
View File
@@ -0,0 +1,83 @@
<?php
declare(strict_types=1);
namespace KTXT\ProviderImap\Tests\Support;
use KTXM\ProviderImap\Providers\CollectionResource;
use KTXM\ProviderImap\Stores\MailboxStore;
/**
* In-memory MailboxStore: documents, state, change sequence and a single lock.
*/
final class FakeMailboxStore extends MailboxStore
{
/** @var array<string, array> */
public array $documents = [];
public ?string $lockOwner = null;
/** Fixed time for listedAt; null = now */
public ?int $clock = null;
public function upsert(string $tenantId, string $serviceId, CollectionResource $collection): void
{
$name = (string) $collection->identifier();
$this->documents[$name] = [
...($this->documents[$name] ?? self::STATE_DEFAULTS),
...$collection->toCacheMeta(),
'listedAt' => $this->clock ?? time(),
];
}
public function fetch(string $serviceId, string $name): ?array
{
return $this->documents[$name] ?? null;
}
public function list(string $serviceId): array
{
return $this->documents;
}
public function updateState(string $serviceId, string $name, array $state): void
{
$this->documents[$name] = array_replace($this->documents[$name], array_intersect_key($state, self::STATE_DEFAULTS));
}
public function acquireLock(string $serviceId, string $name, string $owner, int $ttl): bool
{
if ($this->lockOwner !== null && $this->lockOwner !== $owner) {
return false;
}
$this->lockOwner = $owner;
return true;
}
public function releaseLock(string $serviceId, string $name, string $owner): void
{
if ($this->lockOwner === $owner) {
$this->lockOwner = null;
}
}
public function reserveSequence(string $serviceId, string $name, int $count = 1): int
{
$this->documents[$name]['changeSeq'] += $count;
return $this->documents[$name]['changeSeq'] - $count + 1;
}
public function state(string $serviceId, string $name): array
{
return array_replace(self::STATE_DEFAULTS, array_intersect_key($this->documents[$name] ?? [], self::STATE_DEFAULTS));
}
public function listedAt(string $serviceId): ?int
{
$times = array_filter(array_column($this->documents, 'listedAt'));
return $times === [] ? null : max($times);
}
public function delete(string $serviceId, string $name): void
{
unset($this->documents[$name]);
}
}
tests/php/Support/FakeMessageFileStore.php
+41
View File
@@ -0,0 +1,41 @@
<?php
declare(strict_types=1);
namespace KTXT\ProviderImap\Tests\Support;
use KTXM\ProviderImap\Stores\MessageFileStore;
/**
* In-memory MessageFileStore.
*/
final class FakeMessageFileStore extends MessageFileStore
{
/** @var array<int, array<int, array>> content by UIDVALIDITY and UID */
private array $files = [];
public function write(string $tenantId, string $serviceId, string $mailbox, int $uidValidity, int $uid, array $content): void
{
$this->files[$uidValidity][$uid] = $content;
}
public function delete(string $tenantId, string $serviceId, string $mailbox, int $uidValidity, int ...$uids): void
{
foreach ($uids as $uid) {
unset($this->files[$uidValidity][$uid]);
}
}
public function deleteByMailbox(string $tenantId, string $serviceId, string $mailbox): void
{
$this->files = [];
}
/** @return int[] */
public function uids(int $uidValidity): array
{
$uids = array_keys($this->files[$uidValidity] ?? []);
sort($uids);
return $uids;
}
}
tests/php/Support/FakeMessageStore.php
+78
View File
@@ -0,0 +1,78 @@
<?php
declare(strict_types=1);
namespace KTXT\ProviderImap\Tests\Support;
use KTXM\ProviderImap\Providers\EntityResource;
use KTXM\ProviderImap\Stores\MessageStore;
/**
* In-memory MessageStore modelling addedSeq / modSeq / tombstones like the Mongo queries.
*/
final class FakeMessageStore extends MessageStore
{
/** @var array<int, array<int, array{flags: list<string>, addedSeq: int, modSeq: int, removedSeq: ?int}>> by UIDVALIDITY and UID */
private array $documents = [];
public function upsert(string $tenantId, string $serviceId, int $uidValidity, EntityResource $entity, int $seq): void
{
$meta = $entity->toCacheMeta();
$existing = $this->documents[$uidValidity][$meta['uid']] ?? null;
$this->documents[$uidValidity][$meta['uid']] = [
'flags' => $meta['flags'],
'addedSeq' => $existing['addedSeq'] ?? $seq,
'modSeq' => $seq,
'removedSeq' => null,
];
ksort($this->documents[$uidValidity]);
}
public function flags(string $serviceId, string $mailbox, int $uidValidity): array
{
$flags = [];
foreach ($this->documents[$uidValidity] ?? [] as $uid => $document) {
if ($document['removedSeq'] === null) {
$flags[$uid] = $document['flags'];
}
}
return $flags;
}
public function updateFlags(string $serviceId, string $mailbox, int $uidValidity, int $uid, array $flags, int $seq): void
{
$this->documents[$uidValidity][$uid]['flags'] = array_values($flags);
$this->documents[$uidValidity][$uid]['modSeq'] = $seq;
}
public function tombstone(string $serviceId, string $mailbox, int $uidValidity, int $seq, int ...$uids): void
{
foreach ($uids as $uid) {
$this->documents[$uidValidity][$uid]['removedSeq'] = $seq;
$this->documents[$uidValidity][$uid]['modSeq'] = $seq;
$this->documents[$uidValidity][$uid]['flags'] = [];
}
}
public function changes(string $serviceId, string $mailbox, int $uidValidity, int $since): array
{
$changes = ['additions' => [], 'modifications' => [], 'deletions' => []];
foreach ($this->documents[$uidValidity] ?? [] as $uid => $document) {
if ($document['removedSeq'] !== null) {
if ($document['addedSeq'] <= $since && $document['removedSeq'] > $since) {
$changes['deletions'][] = $uid;
}
} elseif ($document['addedSeq'] > $since) {
$changes['additions'][] = $uid;
} elseif ($document['modSeq'] > $since) {
$changes['modifications'][] = $uid;
}
}
return $changes;
}
public function deleteByMailbox(string $serviceId, string $mailbox): void
{
$this->documents = [];
}
}