Skip to content

refactor(federation): pass the peer to the merge plan as one array #1377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rubenvdlinde merged 2 commits into from
Nov 2, 2026
Merged

refactor(federation): pass the peer to the merge plan as one array #1377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4296e7
refactor(federation): pass the peer to the merge plan as one array
rubenvdlinde Nov 2, 2026
2f5ee7c
Merge remote-tracking branch 'origin/development' into refactor/sig-f…
rubenvdlinde Nov 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions lib/Service/Federation/FederationMerger.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,14 @@ class FederationMerger {
* locally-mirrored entries no longer in the peer catalog are WITHDRAWs
* (marked withdrawn + stale, never silently deleted).
*
* @param string $peerUrl The peer base URL (provenance instance).
* @param string $peerOrg The peer organisation name (provenance).
* @param array{url: string, organisation: string, syncedAt: string} $peer The peer: its base URL
* (provenance instance), its
* organisation name (provenance)
* and the ISO-8601 sync moment.
* @param array<int,array<string,mixed>> $peerEntries The peer's published entries (each MUST
* carry a stable id under 'id' or
* 'uuid').
* @param array<int,array<string,mixed>> $localMirrors The locally-stored mirrors of THIS peer.
* @param string $syncedAt The ISO-8601 sync moment.
*
* The reconciliation plan. Each create/update item is a full mirror data bag
* (with `_source`); each withdraw item is the existing local mirror data bag,
Expand All @@ -83,14 +84,11 @@ class FederationMerger {
* per-entry guards, each of which exists to keep the plan idempotent and to keep
* locally-owned entries out of it.
*/
public function plan(
string $peerUrl,
string $peerOrg,
array $peerEntries,
array $localMirrors,
string $syncedAt,
): array {
$create = [];
public function plan(array $peer, array $peerEntries, array $localMirrors): array {
$peerUrl = $peer['url'];
$peerOrg = $peer['organisation'];
$syncedAt = $peer['syncedAt'];
$create = [];
$update = [];
$withdraw = [];

Expand Down
13 changes: 6 additions & 7 deletions lib/Service/Federation/FederationService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,13 +373,12 @@ public function pullPeer(string $peerUrl): array {
}

$localMirrors = $this->loadPeerMirrors(peerUrl: $peerUrl, target: $target);
$plan = $this->merger->plan(
$peerUrl,
(string)($fetch['organisation'] ?? $peerUrl),
$fetch['entries'],
$localMirrors,
$this->now()
);
$peer = [
'url' => $peerUrl,
'organisation' => (string)($fetch['organisation'] ?? $peerUrl),
'syncedAt' => $this->now(),
];
$plan = $this->merger->plan(peer: $peer, peerEntries: $fetch['entries'], localMirrors: $localMirrors);

$created = $this->applyMirrors(
objectService: $objectService,
Expand Down
54 changes: 23 additions & 31 deletions tests/Unit/Service/FederationMergerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,9 @@ protected function setUp(): void {
*/
public function testNewPeerEntryIsCreatedWithProvenance(): void {
$plan = $this->merger->plan(
self::PEER,
self::ORG,
[['id' => 'p-1', 'name' => 'Service A']],
[],
self::NOW
peer: ['url' => self::PEER, 'organisation' => self::ORG, 'syncedAt' => self::NOW],
peerEntries: [['id' => 'p-1', 'name' => 'Service A']],
localMirrors: []
);

$this->assertCount(1, $plan['create']);
Expand All @@ -86,11 +84,9 @@ public function testNewPeerEntryIsCreatedWithProvenance(): void {
*/
public function testInboundSourceCannotBeSpoofed(): void {
$plan = $this->merger->plan(
self::PEER,
self::ORG,
[['id' => 'p-1', 'name' => 'X', '_source' => ['instance' => 'https://evil.example']]],
[],
self::NOW
peer: ['url' => self::PEER, 'organisation' => self::ORG, 'syncedAt' => self::NOW],
peerEntries: [['id' => 'p-1', 'name' => 'X', '_source' => ['instance' => 'https://evil.example']]],
localMirrors: []
);

$this->assertSame(self::PEER, $plan['create'][0]['_source']['instance']);
Expand All @@ -107,11 +103,9 @@ public function testChangedPeerEntryIsUpdated(): void {
];

$plan = $this->merger->plan(
self::PEER,
self::ORG,
[['id' => 'p-1', 'name' => 'New name']],
$local,
self::NOW
peer: ['url' => self::PEER, 'organisation' => self::ORG, 'syncedAt' => self::NOW],
peerEntries: [['id' => 'p-1', 'name' => 'New name']],
localMirrors: $local
);

$this->assertCount(0, $plan['create']);
Expand All @@ -132,11 +126,9 @@ public function testUnchangedRepullIsIdempotent(): void {
];

$plan = $this->merger->plan(
self::PEER,
self::ORG,
[['id' => 'p-1', 'name' => 'Same']],
$local,
'2026-06-15T13:00:00+00:00'
peer: ['url' => self::PEER, 'organisation' => self::ORG, 'syncedAt' => '2026-06-15T13:00:00+00:00'],
peerEntries: [['id' => 'p-1', 'name' => 'Same']],
localMirrors: $local
);

$this->assertSame([], $plan['create']);
Expand All @@ -156,11 +148,9 @@ public function testRemovedPeerEntryIsWithdrawn(): void {
];

$plan = $this->merger->plan(
self::PEER,
self::ORG,
[['id' => 'p-2', 'name' => 'Stays']],
$local,
self::NOW
peer: ['url' => self::PEER, 'organisation' => self::ORG, 'syncedAt' => self::NOW],
peerEntries: [['id' => 'p-2', 'name' => 'Stays']],
localMirrors: $local
);

$this->assertCount(0, $plan['create']);
Expand All @@ -187,7 +177,11 @@ public function testOtherPeersMirrorsAreUntouched(): void {
],
];

$plan = $this->merger->plan(self::PEER, self::ORG, [], $local, self::NOW);
$plan = $this->merger->plan(
peer: ['url' => self::PEER, 'organisation' => self::ORG, 'syncedAt' => self::NOW],
peerEntries: [],
localMirrors: $local
);

// The other peer's mirror is NOT withdrawn by THIS peer's empty pull.
$this->assertSame([], $plan['withdraw']);
Expand All @@ -202,11 +196,9 @@ public function testOtherPeersMirrorsAreUntouched(): void {
*/
public function testEntryWithoutStableIdIsSkipped(): void {
$plan = $this->merger->plan(
self::PEER,
self::ORG,
[['name' => 'No id']],
[],
self::NOW
peer: ['url' => self::PEER, 'organisation' => self::ORG, 'syncedAt' => self::NOW],
peerEntries: [['name' => 'No id']],
localMirrors: []
);

$this->assertSame([], $plan['create']);
Expand Down
5 changes: 5 additions & 0 deletions tests/Unit/Service/FederationServiceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,11 @@ function (array $object) use (&$saved) {
$this->assertNotEmpty($saved);
$mirror = $saved[0];
$this->assertSame('https://peer.example', $mirror['_source']['instance']);
$this->assertSame(expected: 'Gemeente Peer', actual: $mirror['_source']['organisation']);
$this->assertMatchesRegularExpression(
pattern: '/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\+00:00$/',
string: $mirror['_source']['syncedAt']
);
$this->assertTrue($service->isPeerSourced($mirror));
}//end testPullPeerMergesNewEntries()

Expand Down
Loading