Implement Context system (#4064)

Author: henzigo

src/Component/Context/FrontendApiContext.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrontendApiBundle\Component\Context;
+
+use Override;
+use Shopsys\FrameworkBundle\Component\Context\AbstractContext;
+use Symfony\Component\HttpFoundation\RequestStack;
+
+final class FrontendApiContext extends AbstractContext
+{
+    /**
+     * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
+     */
+    public function __construct(
+        private readonly RequestStack $requestStack,
+    ) {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    #[Override]
+    public function getDescription(): string
+    {
+        return 'Matches requests to Frontend API endpoints (GraphQL)';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    #[Override]
+    public function matches(): bool
+    {
+        $request = $this->requestStack->getMainRequest();
+
+        if ($request === null) {
+            return false;
+        }
+
+        return in_array($request->attributes->get('_route'), ['overblog_graphql_endpoint', 'overblog_graphql_batch_endpoint'], true);
+    }
+}

src/Component/HttpFoundation/TransactionalMasterRequestConditionProvider.php

@@ -8,15 +8,24 @@
 use GraphQL\Language\AST\OperationDefinitionNode;
 use GraphQL\Language\Parser;
 use Override;
+use Shopsys\FrameworkBundle\Component\Context\ContextResolverInterface;
 use Shopsys\FrameworkBundle\Component\HttpFoundation\TransactionalMasterRequestConditionProviderInterface;
+use Shopsys\FrontendApiBundle\Component\Context\FrontendApiContext;
 use Shopsys\FrontendApiBundle\Model\Error\InvalidArgumentUserError;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 
 class TransactionalMasterRequestConditionProvider implements TransactionalMasterRequestConditionProviderInterface
 {
-    protected const GRAPHQL_ENDPOINT_ROUTE = 'overblog_graphql_endpoint';
     protected const QUERY_TYPE = 'query';
 
+    /**
+     * @param \Shopsys\FrameworkBundle\Component\Context\ContextResolverInterface $contextResolver
+     */
+    public function __construct(
+        protected readonly ContextResolverInterface $contextResolver,
+    ) {
+    }
+
     /**
      * @param \Symfony\Component\HttpKernel\Event\RequestEvent $event
      * @return bool
@@ -33,7 +42,7 @@ public function shouldBeginTransaction(RequestEvent $event): bool
      */
     protected function isRequestGraphQlQuery(RequestEvent $requestEvent): bool
     {
-        if ($requestEvent->getRequest()->attributes->get('_route') !== static::GRAPHQL_ENDPOINT_ROUTE) {
+        if (!$this->contextResolver->isCurrentContext(FrontendApiContext::class)) {
             return false;
         }
 

src/Model/Error/ErrorHandlerListener.php

@@ -4,21 +4,30 @@
 
 namespace Shopsys\FrontendApiBundle\Model\Error;
 
+use Shopsys\FrameworkBundle\Component\Context\ContextResolverInterface;
+use Shopsys\FrontendApiBundle\Component\Context\FrontendApiContext;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 
 class ErrorHandlerListener
 {
+    /**
+     * @param \Shopsys\FrameworkBundle\Component\Context\ContextResolverInterface $contextResolver
+     */
+    public function __construct(
+        protected readonly ContextResolverInterface $contextResolver,
+    ) {
+    }
+
     /**
      * @param \Symfony\Component\HttpKernel\Event\ExceptionEvent $event
      */
     public function onKernelException(ExceptionEvent $event): void
     {
         $throwable = $event->getThrowable();
-        $routeParam = $event->getRequest()->attributes->get('_route');
 
-        if (!($throwable instanceof BadRequestHttpException) || !$this->isGraphQlRoute($routeParam)) {
+        if (!($throwable instanceof BadRequestHttpException) || !$this->contextResolver->isCurrentContext(FrontendApiContext::class)) {
             return;
         }
 
@@ -30,13 +39,4 @@ public function onKernelException(ExceptionEvent $event): void
 
         $event->setResponse(new JsonResponse($errors));
     }
-
-    /**
-     * @param string $routeParam
-     * @return bool
-     */
-    protected function isGraphQlRoute(string $routeParam): bool
-    {
-        return in_array($routeParam, ['overblog_graphql_endpoint', 'overblog_graphql_batch_endpoint'], true);
-    }
 }

src/Resources/config/services.yaml

@@ -5,7 +5,7 @@ services:
         public: false
 
     Shopsys\FrontendApiBundle\:
-        resource: '../../**/*{Facade,Factory,Helper,Listener,Loader,Mapper,Mutation,Provider,Query,Repository,Subscriber,Transformer,Validator}.php'
+        resource: '../../**/*{Context,Facade,Factory,Helper,Listener,Loader,Mapper,Mutation,Provider,Query,Repository,Subscriber,Transformer,Validator}.php'
 
     resolverMaps:
         namespace: Shopsys\FrontendApiBundle\