groove/Part-DB-server
1
0
Fork 0
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2026-07-27 03:31:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Return full path and sort structures by full pathes in list tools

Browse source
This commit is contained in:
Jan Böhmer 2026-07-25 21:03:05 +02:00
parent f14418d889
commit e323ed9803
12 changed files with 106 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

11
tests/Serializer/StructuralElementOverviewNormalizerTest.php
View file

@ -38,15 +38,18 @@ final class StructuralElementOverviewNormalizerTest extends TestCase
public function testNormalize(): void
{
$overview = new StructuralElementOverview(id: 42, name: 'Test Node');
$overview = new StructuralElementOverview(id: 42, name: 'Test Node', full_path: 'Parent → Test Node');
//Must be a plain array with exactly id+name, no JSON-LD "@id"/"@type" clutter
$this->assertSame(['id' => 42, 'name' => 'Test Node'], $this->service->normalize($overview));
//Must be a plain array with exactly id+name+full_path, no JSON-LD "@id"/"@type" clutter
$this->assertSame(
['id' => 42, 'name' => 'Test Node', 'full_path' => 'Parent → Test Node'],
$this->service->normalize($overview)
);
}
public function testSupportsNormalization(): void
{
$this->assertFalse($this->service->supportsNormalization(new \stdClass()));
$this->assertTrue($this->service->supportsNormalization(new StructuralElementOverview(id: 1, name: 'X')));
$this->assertTrue($this->service->supportsNormalization(new StructuralElementOverview(id: 1, name: 'X', full_path: 'X')));
}
}

51
tests/State/Mcp/StructuralElementProcessorsTest.php
View file

@ -81,9 +81,10 @@ class StructuralElementProcessorsTest extends WebTestCase
self::assertGreaterThanOrEqual(7, count($result));
foreach ($result as $overview) {
self::assertInstanceOf(StructuralElementOverview::class, $overview);
//The list tool is a lean id+name overview only
//The list tool is a lean id+name+full_path overview only
self::assertIsInt($overview->id);
self::assertIsString($overview->name);
self::assertIsString($overview->full_path);
}
}
@ -96,6 +97,8 @@ class StructuralElementProcessorsTest extends WebTestCase
self::assertCount(1, $result);
self::assertSame('Node 3', $result[0]->name);
//Node 3 is a root node, so its full path is just its own name
self::assertSame('Node 3', $result[0]->full_path);
$node3 = $this->em->getRepository(Category::class)->findOneBy(['name' => 'Node 3']);
self::assertSame($node3->getID(), $result[0]->id);
@ -113,6 +116,47 @@ class StructuralElementProcessorsTest extends WebTestCase
self::assertSame('Node 3', $result[0]->name);
}
public function testListIncludesFullPathForNestedElements(): void
{
$result = $this->listProcessor->process(
new StructuralElementSearchInput(keyword: 'Node 1.1.1'),
$this->getOperationForClass(Category::class)
);
self::assertCount(1, $result);
self::assertSame('Node 1.1.1', $result[0]->name);
self::assertSame('Node 1 → Node 1.1 → Node 1.1.1', $result[0]->full_path);
}
public function testListIsSortedByFullPathSoParentsPrecedeTheirChildren(): void
{
$result = $this->listProcessor->process(new StructuralElementSearchInput(), $this->getOperationForClass(Category::class));
$fullPaths = array_map(static fn (StructuralElementOverview $overview): string => $overview->full_path, $result);
//The list must be sorted by full_path itself, not e.g. by name
$sorted = $fullPaths;
sort($sorted, SORT_NATURAL | SORT_FLAG_CASE);
self::assertSame($sorted, $fullPaths);
//Since parent paths are always a prefix of their children's paths, sorting by full_path means
//"Node 1" is immediately followed by all of its descendants ("Node 1 → ...") before any sibling
//root node that sorts after "Node 1" (e.g. "Node 2") appears.
$node1Index = array_search('Node 1', $fullPaths, true);
$node11Index = array_search('Node 1 → Node 1.1', $fullPaths, true);
$node111Index = array_search('Node 1 → Node 1.1 → Node 1.1.1', $fullPaths, true);
$node2Index = array_search('Node 2', $fullPaths, true);
self::assertNotFalse($node1Index);
self::assertNotFalse($node11Index);
self::assertNotFalse($node111Index);
self::assertNotFalse($node2Index);
self::assertLessThan($node11Index, $node1Index);
self::assertLessThan($node111Index, $node11Index);
self::assertLessThan($node2Index, $node111Index);
}
public function testListRejectsNonStructuralResourceClass(): void
{
$this->expectException(\LogicException::class);
@ -183,7 +227,7 @@ class StructuralElementProcessorsTest extends WebTestCase
self::assertNotNull($operation, sprintf('mcp tool "%s" not found on %s', $toolName, $entityClass));
$serializer = self::getContainer()->get(SerializerInterface::class);
$overview = new StructuralElementOverview(id: 123, name: 'Regression test node');
$overview = new StructuralElementOverview(id: 123, name: 'Regression test node', full_path: 'Parent → Regression test node');
$result = $serializer->serialize([$overview], 'jsonld', [
'groups' => $operation->getNormalizationContext()['groups'] ?? null,
@ -195,7 +239,8 @@ class StructuralElementProcessorsTest extends WebTestCase
self::assertArrayHasKey('hydra:member', $decoded);
self::assertSame(123, $decoded['hydra:member'][0]['id'] ?? null);
self::assertSame('Regression test node', $decoded['hydra:member'][0]['name'] ?? null);
//The list_X tools are a lean id+name overview - no JSON-LD "@id"/"@type" clutter per item
self::assertSame('Parent → Regression test node', $decoded['hydra:member'][0]['full_path'] ?? null);
//The list_X tools are a lean overview - no JSON-LD "@id"/"@type" clutter per item
self::assertArrayNotHasKey('@id', $decoded['hydra:member'][0]);
self::assertArrayNotHasKey('@type', $decoded['hydra:member'][0]);
}