Skip to content

fix: use PATCH instead of PUT #589

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
vincentchalamon merged 1 commit into from
Feb 5, 2026
Merged

fix: use PATCH instead of PUT #589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 2 additions & 3 deletions api/src/Entity/Book.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
use ApiPlatform\Metadata\Delete;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Patch;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;
use ApiPlatform\Metadata\UrlGeneratorInterface;
use App\Enum\BookCondition;
use App\Repository\BookRepository;
Expand Down Expand Up @@ -54,8 +54,7 @@
new Get(
uriTemplate: '/admin/books/{id}{._format}'
),
// https://github.com/api-platform/admin/issues/370
new Put(
new Patch(
uriTemplate: '/admin/books/{id}{._format}',
processor: BookPersistProcessor::class
),
Expand Down
6 changes: 3 additions & 3 deletions api/src/Entity/Review.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
use ApiPlatform\Metadata\NotExposed;
use ApiPlatform\Metadata\Patch;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;
use ApiPlatform\Metadata\UrlGeneratorInterface;
use ApiPlatform\State\CreateProvider;
use ApiPlatform\State\SerializerContextBuilderInterface;
use App\Repository\ReviewRepository;
use App\Security\Voter\OidcTokenPermissionVoter;
use App\Serializer\IriTransformerNormalizer;
Expand Down Expand Up @@ -54,8 +54,7 @@
new Get(
uriTemplate: '/admin/reviews/{id}{._format}'
),
// https://github.com/api-platform/admin/issues/370
new Put(
new Patch(
uriTemplate: '/admin/reviews/{id}{._format}',
processor: ReviewPersistProcessor::class
),
Expand All @@ -74,6 +73,7 @@
],
denormalizationContext: [
AbstractNormalizer::GROUPS => ['Review:write', 'Review:write:admin'],
SerializerContextBuilderInterface::ASSIGN_OBJECT_TO_POPULATE => true,
],
collectDenormalizationErrors: true,
security: 'is_granted("OIDC_ADMIN")',
Expand Down
8 changes: 0 additions & 8 deletions api/src/State/Processor/ReviewPersistProcessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
use ApiPlatform\Doctrine\Common\State\PersistProcessor;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Put;
use ApiPlatform\State\ProcessorInterface;
use App\Entity\Review;
use App\Security\Http\Protection\ResourceHandlerInterface;
Expand Down Expand Up @@ -44,13 +43,6 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
$data->publishedAt = $this->clock->now();
}

// standard PUT
// todo find why $data lost properties unauthorized from deserialization
if ($operation instanceof Put && isset($context['previous_data'])) {
$data->user = $context['previous_data']->user;
$data->publishedAt = $context['previous_data']->publishedAt;
}

// save entity
$data = $this->persistProcessor->process($data, $operation, $uriVariables, $context);

Expand Down
31 changes: 15 additions & 16 deletions api/tests/Api/Admin/BookTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use App\Tests\Api\Security\TokenGenerator;
use App\Tests\Api\Trait\SerializerTrait;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\Test;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Mercure\Update;
Expand Down Expand Up @@ -363,8 +364,8 @@ public static function getInvalidData(): iterable
}

#[Test]
#[\PHPUnit\Framework\Attributes\Group('apiCall')]
#[\PHPUnit\Framework\Attributes\Group('mercure')]
#[Group('apiCall')]
#[Group('mercure')]
public function asAdminUserICanCreateABook(): void
{
$token = self::getContainer()->get(TokenGenerator::class)->generateToken([
Expand Down Expand Up @@ -424,13 +425,13 @@ public function asNonAdminUserICannotUpdateBook(int $expectedCode, string $hydra
$options['auth_bearer'] = $token;
}

$this->client->request('PUT', '/admin/books/' . $book->getId(), $options + [
$this->client->request('PATCH', '/admin/books/' . $book->getId(), $options + [
'json' => [
'book' => 'https://gutendex.com/books/31547.json',
'condition' => BookCondition::NewCondition->value,
],
'headers' => [
'Content-Type' => 'application/ld+json',
'Content-Type' => 'application/merge-patch+json',
'Accept' => 'application/ld+json',
],
]);
Expand All @@ -454,13 +455,13 @@ public function asAdminUserICannotUpdateAnInvalidBook(): void
'email' => UserFactory::createOneAdmin()->email,
]);

$this->client->request('PUT', '/admin/books/invalid', [
$this->client->request('PATCH', '/admin/books/invalid', [
'auth_bearer' => $token,
'json' => [
'condition' => BookCondition::DamagedCondition->value,
],
'headers' => [
'Content-Type' => 'application/ld+json',
'Content-Type' => 'application/merge-patch+json',
'Accept' => 'application/ld+json',
],
]);
Expand All @@ -478,11 +479,11 @@ public function asAdminUserICannotUpdateABookWithInvalidData(array $data, int $s
'email' => UserFactory::createOneAdmin()->email,
]);

$this->client->request('PUT', '/admin/books/' . $book->getId(), [
$this->client->request('PATCH', '/admin/books/' . $book->getId(), [
'auth_bearer' => $token,
'json' => $data,
'headers' => [
'Content-Type' => 'application/ld+json',
'Content-Type' => 'application/merge-patch+json',
'Accept' => 'application/ld+json',
],
]);
Expand All @@ -494,29 +495,27 @@ public function asAdminUserICannotUpdateABookWithInvalidData(array $data, int $s
}

#[Test]
#[\PHPUnit\Framework\Attributes\Group('apiCall')]
#[\PHPUnit\Framework\Attributes\Group('mercure')]
#[Group('apiCall')]
#[Group('mercure')]
public function asAdminUserICanUpdateABook(): void
{
$book = BookFactory::createOne([
'book' => 'https://gutendex.com/books/31547.json',
'condition' => BookCondition::UsedCondition,
]);
self::getMercureHub()->reset();

$token = self::getContainer()->get(TokenGenerator::class)->generateToken([
'email' => UserFactory::createOneAdmin()->email,
]);

$response = $this->client->request('PUT', '/admin/books/' . $book->getId(), [
$response = $this->client->request('PATCH', '/admin/books/' . $book->getId(), [
'auth_bearer' => $token,
'json' => [
'@id' => '/books/' . $book->getId(),
// Must set all data because of standard PUT
'book' => 'https://gutendex.com/books/31547.json',
'condition' => BookCondition::DamagedCondition->value,
],
'headers' => [
'Content-Type' => 'application/ld+json',
'Content-Type' => 'application/merge-patch+json',
'Accept' => 'application/ld+json',
],
]);
Expand Down Expand Up @@ -586,7 +585,7 @@ public function asAdminUserICannotDeleteAnInvalidBook(): void
}

#[Test]
#[\PHPUnit\Framework\Attributes\Group('mercure')]
#[Group('mercure')]
public function asAdminUserICanDeleteABook(): void
{
$book = BookFactory::createOne(['title' => 'Hyperion']);
Expand Down
22 changes: 12 additions & 10 deletions api/tests/Api/Admin/ReviewTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use App\Tests\Api\Security\TokenGenerator;
use App\Tests\Api\Trait\SerializerTrait;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\Test;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Mercure\Update;
Expand Down Expand Up @@ -240,14 +241,14 @@ public function asAdminUserICannotUpdateAnInvalidReview(): void
'email' => UserFactory::createOneAdmin()->email,
]);

$this->client->request('PUT', '/admin/reviews/invalid', [
$this->client->request('PATCH', '/admin/reviews/invalid', [
'auth_bearer' => $token,
'json' => [
'body' => 'Very good book!',
'rating' => 5,
],
'headers' => [
'Content-Type' => 'application/ld+json',
'Content-Type' => 'application/merge-patch+json',
'Accept' => 'application/ld+json',
],
]);
Expand All @@ -256,29 +257,30 @@ public function asAdminUserICannotUpdateAnInvalidReview(): void
}

#[Test]
#[\PHPUnit\Framework\Attributes\Group('mercure')]
#[Group('mercure')]
public function asAdminUserICanUpdateAReview(): void
{
$book = BookFactory::createOne();
$review = ReviewFactory::createOne(['book' => $book]);
$review = ReviewFactory::createOne([
'book' => $book,
'body' => "Yeah, it's ok...",
'rating' => 3,
]);
$user = UserFactory::createOneAdmin();
self::getMercureHub()->reset();

$token = self::getContainer()->get(TokenGenerator::class)->generateToken([
'email' => $user->email,
]);

$response = $this->client->request('PUT', '/admin/reviews/' . $review->getId(), [
$response = $this->client->request('PATCH', '/admin/reviews/' . $review->getId(), [
'auth_bearer' => $token,
'json' => [
// Must set all data because of standard PUT
'book' => '/admin/books/' . $book->getId(),
'letter' => null,
'body' => 'Very good book!',
'rating' => 5,
],
'headers' => [
'Content-Type' => 'application/ld+json',
'Content-Type' => 'application/merge-patch+json',
'Accept' => 'application/ld+json',
],
]);
Expand Down Expand Up @@ -351,7 +353,7 @@ public function asAdminUserICannotDeleteAnInvalidReview(): void
}

#[Test]
#[\PHPUnit\Framework\Attributes\Group('mercure')]
#[Group('mercure')]
public function asAdminUserICanDeleteAReview(): void
{
$review = ReviewFactory::createOne(['body' => 'Best book ever!']);
Expand Down
5 changes: 3 additions & 2 deletions api/tests/Api/BookmarkTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use App\Repository\BookmarkRepository;
use App\Tests\Api\Security\TokenGenerator;
use App\Tests\Api\Trait\SerializerTrait;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\Test;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Mercure\Update;
Expand Down Expand Up @@ -140,7 +141,7 @@ public function asAUserICannotCreateABookmarkWithInvalidData(): void
}

#[Test]
#[\PHPUnit\Framework\Attributes\Group('mercure')]
#[Group('mercure')]
public function asAUserICanCreateABookmark(): void
{
$book = BookFactory::createOne(['book' => 'https://openlibrary.org/books/OL2055137M.json']);
Expand Down Expand Up @@ -277,7 +278,7 @@ public function asAUserICannotDeleteAnInvalidBookmark(): void
}

#[Test]
#[\PHPUnit\Framework\Attributes\Group('mercure')]
#[Group('mercure')]
public function asAUserICanDeleteMyBookmark(): void
{
$book = BookFactory::createOne(['title' => 'Hyperion']);
Expand Down
7 changes: 4 additions & 3 deletions api/tests/Api/ReviewTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use App\Tests\Api\Security\TokenGenerator;
use App\Tests\Api\Trait\SerializerTrait;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\Test;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Mercure\Update;
Expand Down Expand Up @@ -238,7 +239,7 @@ public function asAUserICannotAddAReviewWithValidDataOnAnInvalidBook(): void
}

#[Test]
#[\PHPUnit\Framework\Attributes\Group('mercure')]
#[Group('mercure')]
public function asAUserICanAddAReviewOnABook(): void
{
$book = BookFactory::createOne();
Expand Down Expand Up @@ -443,7 +444,7 @@ public function asAUserICannotUpdateAnInvalidBookReview(): void
}

#[Test]
#[\PHPUnit\Framework\Attributes\Group('mercure')]
#[Group('mercure')]
public function asAUserICanUpdateMyBookReview(): void
{
$review = ReviewFactory::createOne();
Expand Down Expand Up @@ -544,7 +545,7 @@ public function asAUserICannotDeleteAnInvalidBookReview(): void
}

#[Test]
#[\PHPUnit\Framework\Attributes\Group('mercure')]
#[Group('mercure')]
public function asAUserICanDeleteMyBookReview(): void
{
$review = ReviewFactory::createOne(['body' => 'Best book ever!']);
Expand Down
8 changes: 4 additions & 4 deletions compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ services:
image: ${IMAGES_PREFIX:-}app-php
depends_on:
database:
condition: service_healthy
condition: service_started
pwa:
condition: service_healthy
condition: service_started
keycloak:
condition: service_healthy
condition: service_started
restart: unless-stopped
environment:
PWA_UPSTREAM: pwa:3000
Expand Down Expand Up @@ -124,7 +124,7 @@ services:
retries: 15
depends_on:
keycloak-database:
condition: service_healthy
condition: service_started
ports:
- target: 8080
published: 8080
Expand Down
1 change: 1 addition & 0 deletions pwa/components/admin/Admin.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ const AdminAdapter = ({
fetchHydra(url, {
...options,
headers: {
...options.headers,
Authorization: `Bearer ${session?.accessToken}`,
},
}),
Expand Down