release: dev → main (add campaign action endpoints, update bounce endpoints) (#168)

* Version: dev

* Copy message + patch status endpoints

* CampaignActionController

* Configure request object normalizer

* Datetime form at + test fix

* Fix: message format options

* Fix: manager configs

* Add: testSendMessage endpoint

* Client docs workflow

* Remove text_message from campaign request

* Remove html_formated from campaign request

* Add: validateNoClickTrackLinks

* Filter campaigns by subject
Fix: flush entity manager after updates

* Fix: double base64 encoding in TemplateImageNormalizer

* Add: update template endpoint

* Add: UniqueTemplateTitleValidator

* Add: Default templates endpoints

* Bounce controller

* Bounce controller: add status query parameter to get bounces

* Bounce controller: by campaign/subscriber endpoints

* BounceRegex controller: create/update rule

* Fix test

---------

Co-authored-by: Tatevik <tatevikg1@gmail.com>

Author: TatevikGr

.github/workflows/client-docs.yml

@@ -3,13 +3,24 @@ name: Update phplist-api-client OpenAPI
 on:
   push:
     branches:
-      - main
+      - '**'
   pull_request:
 
 jobs:
   generate-openapi:
     runs-on: ubuntu-22.04
+    outputs:
+      source_branch: ${{ steps.branch.outputs.source_branch }}
     steps:
+      - name: Determine source branch
+        id: branch
+        run: |
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            echo "source_branch=${{ github.head_ref }}" >> "$GITHUB_OUTPUT"
+          else
+            echo "source_branch=${{ github.ref_name }}" >> "$GITHUB_OUTPUT"
+          fi
+
       - name: Checkout Source Repository
         uses: actions/checkout@v3
 
@@ -42,6 +53,8 @@ jobs:
   update-phplist-api-client:
     runs-on: ubuntu-22.04
     needs: generate-openapi
+    env:
+      TARGET_BRANCH: ${{ needs.generate-openapi.outputs.source_branch }}
     steps:
       - name: Checkout phplist-api-client Repository
         uses: actions/checkout@v3
@@ -50,6 +63,17 @@ jobs:
           token: ${{ secrets.PUSH_API_CLIENT }}
           fetch-depth: 0
 
+      - name: Prepare target branch
+        run: |
+          git fetch origin
+
+          if git ls-remote --exit-code --heads origin "$TARGET_BRANCH" >/dev/null 2>&1; then
+            git checkout "$TARGET_BRANCH"
+            git pull --rebase origin "$TARGET_BRANCH"
+          else
+            git checkout -b "$TARGET_BRANCH"
+          fi
+
       - name: Download Generated OpenAPI JSON
         uses: actions/download-artifact@v4
         with:
@@ -63,24 +87,31 @@ jobs:
           if [ -f openapi.json ]; then
             diff openapi.json new-openapi/latest-restapi.json > openapi-diff.txt || true
             if [ -s openapi-diff.txt ]; then
-              echo "diff=true" >> $GITHUB_OUTPUT
+              echo "diff=true" >> "$GITHUB_OUTPUT"
             else
-              echo "diff=false" >> $GITHUB_OUTPUT
+              echo "diff=false" >> "$GITHUB_OUTPUT"
             fi
           else
             echo "No previous openapi.json, will add."
-            echo "diff=true" >> $GITHUB_OUTPUT
+            echo "diff=true" >> "$GITHUB_OUTPUT"
           fi
 
       - name: Update and Commit OpenAPI File
         if: steps.diff.outputs.diff == 'true'
         run: |
+          set -euo pipefail
           cp new-openapi/latest-restapi.json openapi.json
           git config user.name "github-actions"
           git config user.email "github-actions@phplist-api-client.workflow"
           git add openapi.json
-          git commit -m "Update openapi.json from REST API workflow `date`"
-          git push
+          if git diff --cached --quiet; then
+            echo "No changes to commit"
+            exit 0
+          fi
+          git commit -m "Update openapi.json from REST API workflow $(date -u +"%Y-%m-%dT%H:%M:%SZ")"
+          git fetch origin "$TARGET_BRANCH"
+          git rebase "origin/$TARGET_BRANCH"
+          git push origin HEAD:"$TARGET_BRANCH"
 
       - name: Skip Commit if No Changes
         if: steps.diff.outputs.diff == 'false'

config/services/managers.yml

@@ -8,7 +8,7 @@ services:
     autowire: true
     autoconfigure: true
 
-  PhpList\Core\Domain\Identity\Service\SessionManager:
+  PhpList\Core\Domain\Identity\Service\Manager\SessionManager:
     autowire: true
     autoconfigure: true
 
@@ -36,7 +36,7 @@ services:
     autowire: true
     autoconfigure: true
 
-  PhpList\Core\Domain\Identity\Service\AdministratorManager:
+  PhpList\Core\Domain\Identity\Service\Manager\AdministratorManager:
     autowire: true
     autoconfigure: true
 
@@ -56,6 +56,6 @@ services:
     autowire: true
     autoconfigure: true
 
-  PhpList\Core\Domain\Identity\Service\PasswordManager:
+  PhpList\Core\Domain\Identity\Service\Manager\PasswordManager:
     autowire: true
     autoconfigure: true

config/services/messenger_handlers.yml

@@ -1,5 +1,10 @@
 services:
-    PhpList\Core\Domain\Messaging\MessageHandler\CampaignProcessorMessageHandler:
+    PhpList\Core\Domain\Messaging\MessageHandler\CampaignProcessor\CampaignProcessorMessageHandler:
+        autowire: true
+        autoconfigure: true
+        public: false
+
+    PhpList\Core\Domain\Messaging\MessageHandler\CampaignProcessor\TestCampaignProcessorMessageHandler:
         autowire: true
         autoconfigure: true
         public: false

config/services/normalizers.yml

@@ -15,5 +15,11 @@ services:
       $classMetadataFactory: '@?serializer.mapping.class_metadata_factory'
       $nameConverter: '@Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter'
 
+  phplist.request_serializer:
+    class: Symfony\Component\Serializer\Serializer
+    arguments:
+      $normalizers:
+        - '@Symfony\Component\Serializer\Normalizer\ObjectNormalizer'
+
   PhpList\RestBundle\:
     resource: '../../src/*/Serializer/*'

config/services/validators.yml

@@ -1,7 +1,7 @@
 services:
   PhpList\RestBundle\Common\Validator\RequestValidator:
     arguments:
-      $serializer: '@Symfony\Component\Serializer\Normalizer\ObjectNormalizer'
+      $serializer: '@phplist.request_serializer'
       $validator: '@validator'
 
   PhpList\RestBundle\Identity\Validator\Constraint\UniqueEmailValidator:
@@ -27,6 +27,11 @@ services:
   PhpList\RestBundle\Messaging\Validator\Constraint\ContainsPlaceholderValidator:
     tags: ['validator.constraint_validator']
 
+  PhpList\RestBundle\Messaging\Validator\Constraint\UniqueTemplateTitleValidator:
+    autowire: true
+    autoconfigure: true
+    tags: [ 'validator.constraint_validator' ]
+
   PhpList\RestBundle\Identity\Validator\Constraint\UniqueLoginNameValidator:
     autowire: true
     autoconfigure: true
@@ -50,4 +55,3 @@ services:
     autowire: true
     autoconfigure: true
     tags: [ 'validator.constraint_validator' ]
-

src/Common/EventListener/ExceptionListener.php

@@ -15,7 +15,9 @@
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
+use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
+use Symfony\Component\Validator\Exception\ValidationFailedException;
 use Symfony\Component\Validator\Exception\ValidatorException;
 
 class ExceptionListener
@@ -24,7 +26,6 @@ class ExceptionListener
         SubscriptionCreationException::class => null,
         AttributeDefinitionCreationException::class => null,
         AdminAttributeCreationException::class => null,
-        ValidatorException::class => 400,
         AccessDeniedException::class => 403,
         AccessDeniedHttpException::class => 403,
         AttachmentFileNotFoundException::class => 404,
@@ -36,33 +37,85 @@ public function onKernelException(ExceptionEvent $event): void
     {
         $exception = $event->getThrowable();
 
+        if ($exception instanceof ValidationFailedException
+            || $exception instanceof ValidatorException
+            || $exception instanceof UnprocessableEntityHttpException
+        ) {
+            $event->setResponse(
+                new JsonResponse([
+                    'message' => 'Validation failed',
+                    'errors' => $this->parseFlatValidationMessage($exception->getMessage()),
+                    ], 422)
+            );
+
+            return;
+        }
+
         foreach (self::EXCEPTION_STATUS_MAP as $class => $statusCode) {
             if ($exception instanceof $class) {
-                $status = $statusCode ?? $exception->getStatusCode();
+                $status = $statusCode ?? (
+                method_exists($exception, 'getStatusCode')
+                    ? $exception->getStatusCode()
+                    : 400
+                );
+
                 $event->setResponse(
                     new JsonResponse([
-                        'message' => $exception->getMessage()
+                        'message' => $exception->getMessage(),
                     ], $status)
                 );
+
                 return;
             }
         }
 
         if ($exception instanceof HttpExceptionInterface) {
             $event->setResponse(
                 new JsonResponse([
-                    'message' => $exception->getMessage()
+                    'message' => $exception->getMessage(),
                 ], $exception->getStatusCode())
             );
+
             return;
         }
 
         if ($exception instanceof Exception) {
             $event->setResponse(
                 new JsonResponse([
-                    'message' => $exception->getMessage()
+                    'message' => $exception->getMessage(),
                 ], 500)
             );
         }
     }
+
+    /**
+     * @return array<string, array<int, string>>
+     */
+    private function parseFlatValidationMessage(string $message): array
+    {
+        $errors = [];
+        $lines = preg_split('/\r\n|\r|\n/', $message) ?: [];
+
+        foreach ($lines as $line) {
+            $line = trim($line);
+
+            if ($line === '') {
+                continue;
+            }
+
+            $parts = explode(':', $line, 2);
+
+            if (count($parts) !== 2) {
+                $errors['_global'][] = $line;
+                continue;
+            }
+
+            $field = trim($parts[0]);
+            $errorMessage = trim($parts[1]);
+
+            $errors[$field][] = $errorMessage;
+        }
+
+        return $errors;
+    }
 }

src/Common/SwaggerSchemasResponse.php

@@ -6,8 +6,22 @@
 
 use OpenApi\Attributes as OA;
 
+#[OA\Schema(
+    schema: 'ErrorDetails',
+    type: 'object',
+    example: [
+        'format.formatOptions[0]' => ['The value you selected is not a valid choice.'],
+        'schedule.repeatUntil' => ['This value is not a valid datetime.'],
+        'schedule.requeueUntil' => ['This value is not a valid datetime.'],
+    ],
+    additionalProperties: new OA\AdditionalProperties(
+        type: 'array',
+        items: new OA\Items(type: 'string')
+    )
+)]
 #[OA\Schema(
     schema: 'UnauthorizedResponse',
+    required: ['message'],
     properties: [
         new OA\Property(
             property: 'message',
@@ -19,17 +33,23 @@
 )]
 #[OA\Schema(
     schema: 'ValidationErrorResponse',
+    required: ['message', 'errors'],
     properties: [
         new OA\Property(
             property: 'message',
             type: 'string',
-            example: 'Some fields are invalid'
+            example: 'Validation failed'
+        ),
+        new OA\Property(
+            property: 'errors',
+            ref: '#/components/schemas/ErrorDetails'
         )
     ],
     type: 'object'
 )]
 #[OA\Schema(
     schema: 'BadRequestResponse',
+    required: ['message'],
     properties: [
         new OA\Property(
             property: 'message',
@@ -41,6 +61,7 @@
 )]
 #[OA\Schema(
     schema: 'AlreadyExistsResponse',
+    required: ['message'],
     properties: [
         new OA\Property(
             property: 'message',
@@ -62,7 +83,18 @@
     ],
     type: 'object'
 )]
-
+#[OA\Schema(
+    schema: 'GenericErrorResponse',
+    required: ['message'],
+    properties: [
+        new OA\Property(
+            property: 'message',
+            type: 'string',
+            example: 'An unexpected error occurred.'
+        )
+    ],
+    type: 'object'
+)]
 #[OA\Schema(
     schema: 'CursorPagination',
     properties: [

src/Common/Validator/RequestValidator.php

@@ -33,6 +33,9 @@ public function validate(Request $request, string $dtoClass): RequestInterface
         if (isset($routeParams['listId'])) {
             $routeParams['listId'] = (int) $routeParams['listId'];
         }
+        if (isset($routeParams['templateId'])) {
+            $routeParams['templateId'] = (int) $routeParams['templateId'];
+        }
 
         $data = array_merge($routeParams, $request->query->all(), $body ?? []);
 

src/Identity/Serializer/AdministratorTokenNormalizer.php

@@ -4,6 +4,7 @@
 
 namespace PhpList\RestBundle\Identity\Serializer;
 
+use DateTimeInterface;
 use PhpList\Core\Domain\Identity\Model\AdministratorToken;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
@@ -21,7 +22,7 @@ public function normalize($object, string $format = null, array $context = []):
         return [
             'id' => $object->getId(),
             'key' => $object->getKey(),
-            'expiry_date' => $object->getExpiry()->format('Y-m-d\TH:i:sP'),
+            'expiry_date' => $object->getExpiry()->format(DateTimeInterface::ATOM),
         ];
     }