bundles/VehicleIngestBundle/Controller/CampaignController.php line 56

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace VehicleIngestBundle\Controller;
  7. use Pimcore\Controller\FrontendController;
  8. use Symfony\Component\HttpFoundation\Request;
  9. use Symfony\Component\HttpFoundation\Response;
  10. use Symfony\Component\Messenger\MessageBusInterface;
  11. use Symfony\Component\Routing\Annotation\Route;
  12. use VehicleIngestBundle\Message\IngestCampaignMessage;
  13. use VehicleIngestBundle\Service\ErrorResponseFactory;
  15. /**
  16.  * Accept-and-enqueue only, mirroring LeasingController: this controller's only job is to accept
  17.  * automedia's campaign push and hand it off to Messenger; the actual persistence
  18.  * (campaignNames/campaignName + the `Kampagne` facet) happens asynchronously in
  19.  * IngestCampaignMessageHandler - kept off the request path for the same reason as
  20.  * leasing/images (a slow/delayed campaign push must never block the automedia exporter's ack).
  21.  *
  22.  * ## Path and namespace
  23.  *
  24.  * Confirmed against automedia's integration guide ("Delivering campaigns"):
  25.  *
  26.  *     PUT /campaign-api/sellers/{sellerId}/ads/{adId}/campaigns
  27.  *
  28.  * Campaigns are not part of the mobile.de Seller API - its OpenAPI schema
  29.  * (Resources/openapi/mobile-seller-api.json) has no `campaigns` sub-resource at all - so they get
  30.  * a namespace of their own, deliberately separate from `/leasing-api` "so you can route on the
  31.  * prefix and implement one extension without the other". Everything under `/seller-api` is what
  32.  * mobile.de specifies and nothing else.
  33.  *
  34.  * The path was previously inferred (under /seller-api, mirroring the leasing sub-resource) from a
  35.  * single sample payload. It was wrong, and every campaign push would have 404ed.
  36.  *
  37.  * PUT is the only method: the body is the complete list, so every state including "no campaigns"
  38.  * is expressible, and there is nothing for a DELETE to do. The body is a JSON array of
  39.  * {id,name,validFrom,validUntil} objects.
  40.  *
  41.  * The same campaigns also arrive inside the ad body as the `campaignIds` and `campaign`
  42.  * attributes ("All three always carry the same content"), which AdFactory already accepts - this
  43.  * endpoint is the sub-resource variant, not the only channel.
  44.  */
  45. class CampaignController extends FrontendController
  46. {
  47.     public function __construct(
  48.         private MessageBusInterface $bus,
  49.         private ErrorResponseFactory $errors,
  50.     ) {
  51.     }
  53.     /**
  54.      * @Route("/campaign-api/sellers/{sellerId}/ads/{adId}/campaigns", name="campaign_api_ad_campaigns_put", methods={"PUT"}, requirements={"adId"="\d+"})
  55.      */
  56.     public function putCampaignsAction(Request $request, string $adId): Response
  57.     {
  58.         $data = json_decode($request->getContent(), true);
  59.         // Must decode to a JSON array (a list), not an object/scalar - the real payload is
  60.         // `[{id,name,...}, ...]`, not `{...}`. array_is_list([]) is true, so an empty array still
  61.         // passes, which matters: it is the body that means "no campaigns, clear what you hold"
  62.         // (see IngestCampaignMessageHandler).
  63.         if (!is_array($data) || !array_is_list($data)) {
  64.             return $this->errors->keyed('body');
  65.         }
  67.         $this->bus->dispatch(new IngestCampaignMessage($adId, $data));
  69.         return new Response('', Response::HTTP_OK);
  70.     }
  71. }