Add new request logger

Classes/Controller/GraphQLController.php

@@ -9,6 +9,7 @@
 use Neos\Flow\Mvc\Controller\ActionController;
 use t3n\GraphQL\Context;
 use t3n\GraphQL\Exception\InvalidContextException;
+use t3n\GraphQL\Log\RequestLoggerInterface;
 use t3n\GraphQL\Service\DefaultFieldResolver;
 use t3n\GraphQL\Service\SchemaService;
 use t3n\GraphQL\Service\ValidationRuleService;
@@ -43,6 +44,13 @@ class GraphQLController extends ActionController
      */
     protected $endpointConfigurations;
 
+    /**
+     * @Flow\Inject
+     *
+     * @var RequestLoggerInterface
+     */
+    protected $requestLogger;
+
     /**
      * phpcs:disable SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableParameterTypeHintSpecification
      *
@@ -62,8 +70,10 @@ public function queryAction(string $endpoint, string $query, ?array $variables =
         $schema = $this->schemaService->getSchemaForEndpoint($endpoint);
         $validationRules = $this->validationRuleService->getValidationRulesForEndpoint($endpoint);
 
-        if (isset($this->endpointConfigurations[$endpoint]['context'])) {
-            $contextClassname = $this->endpointConfigurations[$endpoint]['context'];
+        $endpointConfiguration = $this->endpointConfigurations[$endpoint] ?? [];
+
+        if (isset($endpointConfiguration['context'])) {
+            $contextClassname = $endpointConfiguration['context'];
         } else {
             $contextClassname = $this->contextClassName;
         }
@@ -73,6 +83,10 @@ public function queryAction(string $endpoint, string $query, ?array $variables =
             throw new InvalidContextException('The configured Context must extend \t3n\GraphQL\Context', 1545945332);
         }
 
+        if (isset($endpointConfiguration['logRequests']) && $endpointConfiguration['logRequests'] === true) {
+            $this->requestLogger->info('Incoming graphql request', ['endpoint' => $endpoint, 'query' => json_encode($query), 'variables' => empty($variables) ? 'none' : $variables]);
+        }
+
         GraphQL::setDefaultFieldResolver([DefaultFieldResolver::class, 'resolve']);
 
         $result  = GraphQL::executeQuery(

Classes/Log/RequestLoggerInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace t3n\GraphQL\Log;
+
+use Psr\Log\LoggerInterface;
+
+interface RequestLoggerInterface extends LoggerInterface
+{
+}

Classes/Service/SchemaService.php

@@ -74,6 +74,14 @@ public function getSchemaForEndpoint(string $endpoint): Schema
         return $schema;
     }
 
+    /**
+     * @return mixed[]
+     */
+    public function getEndpointConfiguration(string $endpoint): ?array
+    {
+        return $this->endpoints[$endpoint] ?? null;
+    }
+
     protected function getSchemaFromEnvelope(string $envelopeClassName): Schema
     {
         $envelope = $this->objectManager->get($envelopeClassName);

Configuration/Objects.yaml

@@ -14,3 +14,11 @@ t3n\GraphQL\Service\SchemaService:
         arguments:
           1:
             value: t3n_GraphQL_Schema
+
+t3n\GraphQL\Log\RequestLoggerInterface:
+  scope: singleton
+  factoryObjectName: Neos\Flow\Log\PsrLoggerFactoryInterface
+  factoryMethodName: get
+  arguments:
+    1:
+      value: graphQLRequestLogger

Configuration/Settings.yaml

@@ -7,12 +7,24 @@ Neos:
             'graphQLOptions':
               position: 'before routing'
               component: 't3n\GraphQL\Http\HttpOptionsComponent'
+    log:
+      graphQLRequestLogger:
+        logger: Neos\Flow\Log\Logger
+        backend: Neos\Flow\Log\Backend\FileBackend
+        backendOptions:
+          logFileURL: '%FLOW_PATH_DATA%Logs/GraphQLRequests.log'
+          createParentDirectories: true
+          severityThreshold: '%LOG_INFO%'
+          maximumLogFileSize: 10485760
+          logFilesToKeep: 1
+          logMessageOrigin: false
 
 t3n:
   GraphQL:
     context: 't3n\GraphQL\Context'
     includeExceptionMessageInOutput: true
     endpoints: []
 #      'some-endpoint':
+#        'logRequests': true  # if enabled all requests are logged
 #        'context:' 'Foo\Vendor\GraphQL\Context  # optional context that overrides the global context
 #        'schemaEnvelope': 'Some\Fully\Qualified\Namespace'

Readme.md

@@ -362,6 +362,21 @@ class MutationResolver implements ResolverInterface
 }
 ```
 
+### Log incoming requests
+
+You can enable logging of incoming requests per endpoint:
+
+```yaml
+t3n:
+  GraphQL:
+    endpoints:
+      'your-endpoint':
+        logRequests: true
+```
+
+Once activated all incoming requests will be logged to `Data/Logs/GraphQLRequests.log`. Each log entry
+will contain the endpoint, query and variables.
+
 ### Secure your endpoint
 
 To secure your api endpoints you have several options. The easiest way is to just configure