Skip to content

Commit aa82e5b

Browse files
LaurentHuzardLaurentHuzard
committed
fix: added header "allow-post" only on resources with POST and header "allow" has now the right method.
1 parent 8e79818 commit aa82e5b

File tree

5 files changed

+165
-73
lines changed

5 files changed

+165
-73
lines changed

‎features/main/ldp_resources.feature‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎src/State/Processor/RespondProcessor.php‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,13 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
9393
$headers['Accept-Patch'] = $acceptPatch;
9494
}
9595

96-
$headers['Accept-Post'] = 'text/turtle, application/ld+json';
97-
$headers['Allow'] = $this->getAllowedMethods($context['resource_class'] ?? null);
96+
$allowedMethods = $this->getAllowedMethods($context['resource_class'] ?? null, $operation->getUriTemplate());
97+
$headers['Allow'] = implode(', ', $allowedMethods);
98+
99+
$outputFormats = $operation->getOutputFormats();
100+
if (\is_array($outputFormats) && [] !== $outputFormats && \in_array('POST', $allowedMethods, true)) {
101+
$headers['Accept-Post'] = implode(', ', array_merge(...array_values($outputFormats)));
102+
}
98103

99104
$method = $request->getMethod();
100105
$originalData = $context['original_data'] ?? null;
@@ -159,18 +164,20 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
159164
);
160165
}
161166

162-
private function getAllowedMethods(?string $resourceClass): string
167+
private function getAllowedMethods(?string $resourceClass, ?string $currentUriTemplate): array
163168
{
164169
$allowedMethods = self::DEFAULT_ALLOWED_METHOD;
165-
if (null !== $resourceClass && null !== $this->resourceClassResolver && $this->resourceClassResolver->isResourceClass($resourceClass)) {
166-
$resourceMetadataCollection = $this->resourceCollectionMetadataFactory ? $this->resourceCollectionMetadataFactory->create($resourceClass) : new ResourceMetadataCollection($resourceClass);
170+
if (null !== $currentUriTemplate && null !== $resourceClass && $this->resourceClassResolver->isResourceClass($resourceClass)) {
171+
$resourceMetadataCollection =$this->resourceCollectionMetadataFactory ? $this->resourceCollectionMetadataFactory->create($resourceClass) : new ResourceMetadataCollection($resourceClass);
167172
foreach ($resourceMetadataCollection as $resource) {
168173
foreach ($resource->getOperations() as $operation) {
169-
$allowedMethods[] = $operation->getMethod();
174+
if ($operation->getUriTemplate() === $currentUriTemplate) {
175+
$allowedMethods[] = $operation->getMethod();
176+
}
170177
}
171178
}
172179
}
173180

174-
return implode(', ', array_unique($allowedMethods));
181+
return array_unique($allowedMethods);
175182
}
176183
}

‎src/State/Tests/Processor/RespondProcessorTest.php‎

Lines changed: 26 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
use ApiPlatform\Metadata\ApiResource;
1717
use ApiPlatform\Metadata\Delete;
1818
use ApiPlatform\Metadata\Get;
19+
use ApiPlatform\Metadata\GetCollection;
1920
use ApiPlatform\Metadata\HttpOperation;
20-
use ApiPlatform\Metadata\Patch;
2121
use ApiPlatform\Metadata\Post;
2222
use ApiPlatform\Metadata\Put;
2323
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
@@ -42,6 +42,19 @@ protected function setUp(): void
4242
->willReturn(true);
4343

4444
$this->resourceMetadataCollectionFactory = $this->createMock(ResourceMetadataCollectionFactoryInterface::class);
45+
$this->resourceMetadataCollectionFactory
46+
->method('create')
47+
->willReturn(
48+
new ResourceMetadataCollection('DummyResource', [
49+
new ApiResource(operations: [
50+
new Get(uriTemplate: '/dummy_resources/{dummyResourceId}{._format}', name: 'get'),
51+
new GetCollection(uriTemplate: '/dummy_resources{._format}', name: 'get_collections'),
52+
new Post(uriTemplate: '/dummy_resources{._format}', name: 'post'),
53+
new Delete(uriTemplate: '/dummy_resources/{dummyResourceId}{._format}', name: 'delete'),
54+
new Put(uriTemplate: '/dummy_resources/{dummyResourceId}{._format}', name: 'put'),
55+
]),
56+
])
57+
);
4558

4659
$this->processor = new RespondProcessor(
4760
null,
@@ -51,57 +64,36 @@ protected function setUp(): void
5164
);
5265
}
5366

54-
public function testHeadersAcceptPostIsSetCorrectly(): void
67+
public function testHeadersAcceptPostIsReturnWhenPostAllowed(): void
5568
{
56-
$this->resourceMetadataCollectionFactory
57-
->method('create')
58-
->willReturn(new ResourceMetadataCollection('DummyResourceClass'));
59-
60-
$operation = new HttpOperation('GET');
69+
$operation = (new HttpOperation('GET', '/dummy_resources{._format}', outputFormats: ['jsonld' => ['application/ld+json'], 'json' => ['application/json']]));
6170
$context = [
62-
'resource_class' => 'SomeResourceClass',
71+
'resource_class' => 'DummyResource',
6372
'request' => $this->createGetRequest(),
6473
];
6574

6675
/** @var Response $response */
6776
$response = $this->processor->process(null, $operation, [], $context);
68-
69-
$this->assertSame('text/turtle, application/ld+json', $response->headers->get('Accept-Post'));
77+
$this->assertSame('application/ld+json, application/json', $response->headers->get('Accept-Post'));
7078
}
7179

72-
public function testHeaderAllowHasHeadOptionsByDefault(): void
80+
public function testHeadersAcceptPostIsNotSetWhenPostIsNotAllowed(): void
7381
{
74-
$this->resourceMetadataCollectionFactory
75-
->method('create')
76-
->willReturn(new ResourceMetadataCollection('DummyResourceClass'));
77-
78-
$operation = new HttpOperation('GET');
82+
$operation = (new HttpOperation('GET', '/dummy_resources/{dummyResourceId}{._format}'));
7983
$context = [
80-
'resource_class' => 'SomeResourceClass',
84+
'resource_class' => 'DummyResource',
8185
'request' => $this->createGetRequest(),
8286
];
8387

8488
/** @var Response $response */
8589
$response = $this->processor->process(null, $operation, [], $context);
8690

87-
$this->assertSame('OPTIONS, HEAD', $response->headers->get('Allow'));
91+
$this->assertNull($response->headers->get('Accept-Post'));
8892
}
8993

9094
public function testHeaderAllowReflectsResourceAllowedMethods(): void
9195
{
92-
$this->resourceMetadataCollectionFactory
93-
->method('create')
94-
->willReturn(
95-
new ResourceMetadataCollection('DummyResource', [
96-
new ApiResource(operations: [
97-
'get' => new Get(name: 'get'),
98-
'post' => new Post(name: 'post'),
99-
'delete' => new Delete(name: 'delete'),
100-
]),
101-
])
102-
);
103-
104-
$operation = new HttpOperation('GET');
96+
$operation = (new HttpOperation('GET', '/dummy_resources{._format}'));
10597
$context = [
10698
'resource_class' => 'SomeResourceClass',
10799
'request' => $this->createGetRequest(),
@@ -115,30 +107,13 @@ public function testHeaderAllowReflectsResourceAllowedMethods(): void
115107
$this->assertStringContainsString('HEAD', $allowHeader);
116108
$this->assertStringContainsString('GET', $allowHeader);
117109
$this->assertStringContainsString('POST', $allowHeader);
118-
$this->assertStringContainsString('DELETE', $allowHeader);
119-
$this->assertStringNotContainsString('PATCH', $allowHeader);
120-
$this->assertStringNotContainsString('PUT', $allowHeader);
121-
}
122-
123-
public function testHeaderAllowReflectsAllowedResourcesGetPutPatch(): void
124-
{
125-
$this->resourceMetadataCollectionFactory
126-
->method('create')
127-
->willReturn(
128-
new ResourceMetadataCollection('DummyResource', [
129-
new ApiResource(operations: [
130-
'get' => new Get(name: 'get'),
131-
'patch' => new Patch(name: 'patch'),
132-
'put' => new Put(name: 'put'),
133-
]),
134-
])
135-
);
110+
$this->assertStringNotContainsString('DELETE', $allowHeader);
136111

137-
$operation = new HttpOperation('GET');
138112
$context = [
139113
'resource_class' => 'SomeResourceClass',
140114
'request' => $this->createGetRequest(),
141115
];
116+
$operation = (new HttpOperation('GET', '/dummy_resources/{dummyResourceId}{._format}'));
142117

143118
/** @var Response $response */
144119
$response = $this->processor->process(null, $operation, [], $context);
@@ -147,10 +122,9 @@ public function testHeaderAllowReflectsAllowedResourcesGetPutPatch(): void
147122
$this->assertStringContainsString('OPTIONS', $allowHeader);
148123
$this->assertStringContainsString('HEAD', $allowHeader);
149124
$this->assertStringContainsString('GET', $allowHeader);
150-
$this->assertStringContainsString('PATCH', $allowHeader);
151125
$this->assertStringContainsString('PUT', $allowHeader);
126+
$this->assertStringContainsString('DELETE', $allowHeader);
152127
$this->assertStringNotContainsString('POST', $allowHeader);
153-
$this->assertStringNotContainsString('DELETE', $allowHeader);
154128
}
155129

156130
private function createGetRequest(): Request

‎tests/Fixtures/TestBundle/Entity/DummyGetPostDeleteOperation.php‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@
2424
#[ORM\Entity]
2525
class DummyGetPostDeleteOperation
2626
{
27-
/**
28-
* @var int|null The id
29-
*/
3027
#[ORM\Column(type: 'integer')]
3128
#[ORM\Id]
3229
#[ORM\GeneratedValue(strategy: 'AUTO')]

‎tests/Functional/State/RespondProcessorTest.php‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the API Platform project.
5+
*
6+
* (c) Kévin Dunglas <dunglas@gmail.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
declare(strict_types=1);
13+
14+
namespace ApiPlatform\Tests\Functional\State;
15+
16+
use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;
17+
use ApiPlatform\Tests\Fixtures\TestBundle\Entity\DummyGetPostDeleteOperation;
18+
use ApiPlatform\Tests\RecreateSchemaTrait;
19+
use ApiPlatform\Tests\SetupClassResourcesTrait;
20+
use Doctrine\ORM\EntityManagerInterface;
21+
use Doctrine\ORM\Tools\SchemaTool;
22+
23+
class RespondProcessorTest extends ApiTestCase
24+
{
25+
use RecreateSchemaTrait;
26+
use SetupClassResourcesTrait;
27+
28+
/**
29+
* @return class-string[]
30+
*/
31+
public static function getResources(): array
32+
{
33+
return [DummyGetPostDeleteOperation::class];
34+
}
35+
36+
public function testAllowHeadersForSingleResourceWithGetDelete(): void
37+
{
38+
$client = static::createClient();
39+
$client->request('GET', '/dummy_get_post_delete_operations/1', [
40+
'headers' => [
41+
'Content-Type' => 'application/ld+json',
42+
],
43+
]);
44+
45+
$this->assertResponseHeaderSame('Allow', 'OPTIONS, HEAD, GET, DELETE');
46+
}
47+
48+
public function testAllowHeadersForResourceCollectionReflectsAllowedMethods(): void
49+
{
50+
$client = static::createClient();
51+
$client->request('GET', '/dummy_get_post_delete_operations', [
52+
'headers' => [
53+
'Content-Type' => 'application/ld+json',
54+
],
55+
]);
56+
57+
$this->assertResponseHeaderSame('allow', 'OPTIONS, HEAD, GET, POST');
58+
}
59+
60+
public function testAcceptPostHeaderForResourceWithPostReflectsAllowedTypes(): void
61+
{
62+
$client = static::createClient();
63+
$client->request('GET', '/dummy_get_post_delete_operations', [
64+
'headers' => [
65+
'Content-Type' => 'application/ld+json',
66+
],
67+
]);
68+
69+
$this->assertResponseHeaderSame('accept-post', 'application/ld+json, application/hal+json, application/vnd.api+json, application/xml, text/xml, application/json, text/html, application/graphql, multipart/form-data');
70+
}
71+
72+
public function testAcceptPostHeaderDoesNotExistResourceWithoutPost(): void
73+
{
74+
$client = static::createClient();
75+
$client->request('OPTIONS', '/dummy_get_post_delete_operations/1', [
76+
'headers' => [
77+
'Content-Type' => 'application/ld+json',
78+
],
79+
]);
80+
81+
$this->assertResponseNotHasHeader('accept-post');
82+
}
83+
84+
protected function setUp(): void
85+
{
86+
self::bootKernel();
87+
88+
$container = static::getContainer();
89+
$registry = $container->get('doctrine');
90+
$manager = $registry->getManager();
91+
if (!$manager instanceof EntityManagerInterface) {
92+
return;
93+
}
94+
95+
$classes = [$manager->getClassMetadata(DummyGetPostDeleteOperation::class)];
96+
97+
try {
98+
$schemaTool = new SchemaTool($manager);
99+
@$schemaTool->createSchema($classes);
100+
} catch (\Exception $e) {
101+
return;
102+
}
103+
104+
$dummy = new DummyGetPostDeleteOperation();
105+
$dummy->setName('Dummy');
106+
$manager->persist($dummy);
107+
$manager->flush();
108+
}
109+
110+
protected function tearDown(): void
111+
{
112+
$container = static::getContainer();
113+
$registry = $container->get('doctrine');
114+
$manager = $registry->getManager();
115+
if (!$manager instanceof EntityManagerInterface) {
116+
return;
117+
}
118+
119+
$classes = [$manager->getClassMetadata(DummyGetPostDeleteOperation::class)];
120+
121+
$schemaTool = new SchemaTool($manager);
122+
@$schemaTool->dropSchema($classes);
123+
parent::tearDown();
124+
}
125+
}

0 commit comments

Comments
 (0)