Skip to content
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.

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

fix(symfony): no read should throw on wrong uri variables #6357

Merged
merged 1 commit into from
May 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions features/main/patch.feature
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,14 @@ Feature: Sending PATCH requets
"alpha": "/alphas/2"
}
"""

Scenario: Patch a non-readable resource
When I add "Content-Type" header equal to "application/merge-patch+json"
And I send a "PATCH" request to "/order_products/1/count" with body:
"""
{
"id": 1,
"count": 10
}
"""
Then print last JSON response
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how is this testing anything?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forgot to change this, #6355 confirmed it worked but I wasn't sure what the behavior should be inside the controller, did a fix at #6368

4 changes: 3 additions & 1 deletion src/Symfony/EventListener/ReadListener.php
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@ public function onKernelRequest(RequestEvent $event): void
try {
$uriVariables = $this->getOperationUriVariables($operation, $request->attributes->all(), $operation->getClass());
} catch (InvalidIdentifierException|InvalidUriVariableException $e) {
throw new NotFoundHttpException('Invalid identifier value or configuration.', $e);
if ($operation->canRead()) {
throw new NotFoundHttpException('Invalid identifier value or configuration.', $e);
}
}
}

Expand Down
26 changes: 26 additions & 0 deletions tests/Fixtures/TestBundle/ApiResource/Issue6355/OrderDto.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?php

/*
* This file is part of the API Platform project.
*
* (c) Kévin Dunglas <dunglas@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue6355;

use ApiPlatform\Metadata\ApiProperty;
use Symfony\Component\Uid\Uuid;

class OrderDto
{
#[ApiProperty(identifier: false)]
public ?int $id = null;

#[ApiProperty(identifier: true)]
public ?Uuid $uuid = null;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?php

/*
* This file is part of the API Platform project.
*
* (c) Kévin Dunglas <dunglas@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue6355;

use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\NotExposed;
use ApiPlatform\Metadata\Patch;
use ApiPlatform\Tests\Fixtures\TestBundle\Controller\Issue6355\UpdateOrderProductCountController;

#[ApiResource(
shortName: 'OrderProduct',
operations: [
new NotExposed(),
new Patch(
uriTemplate: '/order_products/{id}/count',
controller: UpdateOrderProductCountController::class,
class: OrderDto::class,
input: OrderProductCount::class,
output: OrderDto::class,
read: false,
write: false,
name: 'order_product_update_count',
),
],
order: ['position' => 'ASC'],
)]
class OrderProductCount
{
#[ApiProperty(writable: false, identifier: true)]
public ?int $id = null;
public ?int $count = null;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?php

/*
* This file is part of the API Platform project.
*
* (c) Kévin Dunglas <dunglas@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

declare(strict_types=1);

namespace ApiPlatform\Tests\Fixtures\TestBundle\Controller\Issue6355;

use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue6355\OrderDto;
use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue6355\OrderProductCount;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Attribute\AsController;

#[AsController]
class UpdateOrderProductCountController extends AbstractController
{
public function __invoke(OrderProductCount $data, Request $request): OrderDto
{
$dto = new OrderDto();
$dto->id = 1;

return $dto;
}
}
Loading