Merge pull request #142 from danielmaier42/hotfix/executeActionsEmail

Fix executeActionsEmail via explicit ContentType declaration

Author: fschmtt

src/Http/Command.php

@@ -20,6 +20,7 @@ public function __construct(
         /** @var Representation|Collection|array<mixed>|null */
         private readonly Representation|Collection|array|null $payload = null,
         private readonly ?Criteria $criteria = null,
+        private readonly ContentType $contentType = ContentType::JSON,
     ) {}
 
     public function getMethod(): Method
@@ -61,4 +62,9 @@ public function getQuery(): string
 
         return '?' . http_build_query($this->criteria->jsonSerialize());
     }
+
+    public function getContentType(): ContentType
+    {
+        return $this->contentType;
+    }
 }

src/Http/CommandExecutor.php

@@ -20,29 +20,20 @@ public function __construct(
 
     public function executeCommand(Command $command): void
     {
-        $payload = $command->getPayload();
-
-        if (is_array($payload)) {
-            $this->client->request(
-                $command->getMethod()->value,
-                $command->getPath(),
-                [
-                    'form_params' => $payload,
+        $options = match ($command->getContentType()) {
+            ContentType::JSON => [
+                'body' => $this->serializer->serialize($command->getPayload()),
+                'headers' => [
+                    'Content-Type' => $command->getContentType()->value,
                 ],
-            );
-
-            return;
-        }
+            ],
+            ContentType::FORM_PARAMS => ['form_params' => $command->getPayload()],
+        };
 
         $this->client->request(
             $command->getMethod()->value,
             $command->getPath(),
-            [
-                'body' => $this->serializer->serialize($command->getPayload()),
-                'headers' => [
-                    'Content-Type' => 'application/json',
-                ],
-            ],
+            $options,
         );
     }
 }

src/Http/ContentType.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Fschmtt\Keycloak\Http;
+
+/**
+ * @internal
+ */
+enum ContentType: string
+{
+    case JSON = 'application/json';
+    case FORM_PARAMS = 'application/x-www-form-urlencoded';
+}

src/Resource/Organizations.php

@@ -6,6 +6,7 @@
 
 use Fschmtt\Keycloak\Collection\OrganizationCollection;
 use Fschmtt\Keycloak\Http\Command;
+use Fschmtt\Keycloak\Http\ContentType;
 use Fschmtt\Keycloak\Http\Criteria;
 use Fschmtt\Keycloak\Http\Method;
 use Fschmtt\Keycloak\Http\Query;
@@ -71,6 +72,7 @@ public function inviteUser(string $realm, string $id, string $email, string $fir
                     'firstName' => $firstName,
                     'lastName' => $lastName,
                 ],
+                contentType: ContentType::FORM_PARAMS,
             ),
         );
     }

src/Resource/Users.php

@@ -9,6 +9,7 @@
 use Fschmtt\Keycloak\Collection\RoleCollection;
 use Fschmtt\Keycloak\Collection\UserCollection;
 use Fschmtt\Keycloak\Http\Command;
+use Fschmtt\Keycloak\Http\ContentType;
 use Fschmtt\Keycloak\Http\Criteria;
 use Fschmtt\Keycloak\Http\Method;
 use Fschmtt\Keycloak\Http\Query;

tests/Integration/Resource/UsersTest.php

@@ -13,6 +13,7 @@
 use Fschmtt\Keycloak\Representation\Role;
 use Fschmtt\Keycloak\Representation\User;
 use Fschmtt\Keycloak\Test\Integration\IntegrationTestBehaviour;
+use GuzzleHttp\Exception\ServerException;
 use PHPUnit\Framework\TestCase;
 use Ramsey\Uuid\Uuid;
 
@@ -189,6 +190,33 @@ public function testGetUserCredentials(): void
         static::assertNull($user);
     }
 
+    public function testExecuteActionsEmail(): void
+    {
+        $users = $this->getKeycloak()->users();
+        $username = Uuid::uuid4()->toString();
+
+        $users->create('master', new User(
+            email: '[email protected]',
+            enabled: true,
+            username: $username,
+        ));
+
+        $user = $this->searchUserByUsername($username);
+        static::assertInstanceOf(User::class, $user);
+
+        try {
+            $users->executeActionsEmail('master', $user->getId(), ['UPDATE_PASSWORD']);
+        } catch (ServerException $e) {
+            static::assertSame(500, $e->getResponse()->getStatusCode());
+            static::assertStringContainsString('Failed to send execute actions email', $e->getResponse()->getBody()->getContents());
+        }
+
+        $users->delete('master', $user->getId());
+
+        $user = $this->searchUserByUsername($username);
+        static::assertNull($user);
+    }
+
     private function searchUserByUsername(string $username, string $realm = 'master'): ?User
     {
         /** @var User|null $user */

tests/Unit/Http/CommandExecutorTest.php

@@ -7,6 +7,7 @@
 use Fschmtt\Keycloak\Http\Client;
 use Fschmtt\Keycloak\Http\Command;
 use Fschmtt\Keycloak\Http\CommandExecutor;
+use Fschmtt\Keycloak\Http\ContentType;
 use Fschmtt\Keycloak\Http\Method;
 use Fschmtt\Keycloak\Json\JsonEncoder;
 use Fschmtt\Keycloak\Serializer\Serializer;
@@ -43,7 +44,7 @@ public function testCallsClientWithoutBodyIfCommandHasNoRepresentation(): void
         );
     }
 
-    public function testCallsClientWithBodyIfCommandHasRepresentation(): void
+    public function testCallsClientWithJsonIfCommandHasRepresentation(): void
     {
         $command = new Command(
             '/path/to/resource',
@@ -101,13 +102,14 @@ public function testCallsClientWithBodyIfCommandHasCollection(): void
         $executor->executeCommand($command);
     }
 
-    public function testCallsClientWithFormParamsIfCommandHasArrayPayload(): void
+    public function testCallsClientWithFormParamsIfCommandFormParamContentType(): void
     {
         $command = new Command(
             '/path/to/resource',
             Method::PUT,
             [],
             $payload = ['UPDATE_PASSWORD', 'VERIFY_EMAIL'],
+            contentType: ContentType::FORM_PARAMS,
         );
 
         $client = $this->createMock(Client::class);

tests/Unit/Http/CommandTest.php

@@ -5,6 +5,7 @@
 namespace Fschmtt\Keycloak\Test\Unit\Http;
 
 use Fschmtt\Keycloak\Http\Command;
+use Fschmtt\Keycloak\Http\ContentType;
 use Fschmtt\Keycloak\Http\Criteria;
 use Fschmtt\Keycloak\Http\Method;
 use Fschmtt\Keycloak\Test\Unit\Stub\Collection;
@@ -84,4 +85,18 @@ public function testBuildsPathWithQueryIfCriteriaIsProvided(): void
             ))->getPath(),
         );
     }
+
+    public function testContentTypeDefaultsToJson(): void
+    {
+        $command = new Command('/path', Method::GET);
+
+        static::assertSame(ContentType::JSON, $command->getContentType());
+    }
+
+    public function testContentTypeCanBeSetToFormParams(): void
+    {
+        $command = new Command('/path', Method::GET, contentType: ContentType::FORM_PARAMS);
+
+        static::assertSame(ContentType::FORM_PARAMS, $command->getContentType());
+    }
 }

tests/Unit/Resource/OrganizationsTest.php

@@ -7,6 +7,7 @@
 use Fschmtt\Keycloak\Collection\OrganizationCollection;
 use Fschmtt\Keycloak\Http\Command;
 use Fschmtt\Keycloak\Http\CommandExecutor;
+use Fschmtt\Keycloak\Http\ContentType;
 use Fschmtt\Keycloak\Http\Method;
 use Fschmtt\Keycloak\Http\Query;
 use Fschmtt\Keycloak\Http\QueryExecutor;
@@ -148,6 +149,7 @@ public function testInviteUser(): void
                 'firstName' => 'first name',
                 'lastName' => 'last name',
             ],
+            contentType: ContentType::FORM_PARAMS,
         );
 
         $commandExecutor = $this->createMock(CommandExecutor::class);

tests/Unit/Resource/UsersTest.php

@@ -10,6 +10,7 @@
 use Fschmtt\Keycloak\Collection\UserCollection;
 use Fschmtt\Keycloak\Http\Command;
 use Fschmtt\Keycloak\Http\CommandExecutor;
+use Fschmtt\Keycloak\Http\ContentType;
 use Fschmtt\Keycloak\Http\Criteria;
 use Fschmtt\Keycloak\Http\Method;
 use Fschmtt\Keycloak\Http\Query;