PWA-1311: New Relic is not being given useful transaction names for graphql requests

 - refactor to reduce complexity and improve naming

Author: cspruiell

app/code/Magento/GraphQl/Controller/GraphQl.php

@@ -192,7 +192,7 @@ public function dispatch(RequestInterface $request): ResponseInterface
 
         // log information about the query, unless it is an introspection query
         if (strpos($data['query'], 'IntrospectionQuery') === false) {
-            $queryInformation = $this->logDataHelper->getRequestInformation($request, $data, $schema, $this->httpResponse);
+            $queryInformation = $this->logDataHelper->getLogData($request, $data, $schema, $this->httpResponse);
             $this->loggerPool->execute($queryInformation);
         }
 

app/code/Magento/GraphQl/Helper/Query/Logger/LogData.php

@@ -32,42 +32,75 @@ class LogData
      * @param HttpResponse|null $response
      * @return array
      */
-    public function getRequestInformation(
+    public function getLogData(
         RequestInterface $request,
         array $data,
-        Schema $schema = null,
-        HttpResponse $response = null
+        ?Schema $schema,
+        ?HttpResponse $response
     ) : array {
-        $requestInformation = [];
+        $logData = [];
+        $logData = array_merge($logData, $this->gatherRequestInformation($request));
+        if ($schema) {
+            $logData = array_merge($logData, $this->gatherQueryInformation($schema));
+        }
+        $logData[LoggerInterface::COMPLEXITY] = $this->getFieldCount($data['query'] ?? '');
+        if ($response) {
+            $logData = array_merge($logData, $this->gatherResponseInformation($response));
+        }
+
+        return $logData;
+    }
+
+    /**
+     * Gets the information needed from the request
+     *
+     * @param RequestInterface $request
+     * @return array
+     */
+    private function gatherRequestInformation(RequestInterface $request) : array
+    {
         $requestInformation[LoggerInterface::HTTP_METHOD] = $request->getMethod();
         $requestInformation[LoggerInterface::STORE_HEADER] = $request->getHeader('Store') ?: '';
         $requestInformation[LoggerInterface::CURRENCY_HEADER] = $request->getHeader('Currency') ?: '';
         $requestInformation[LoggerInterface::HAS_AUTH_HEADER] = $request->getHeader('Authorization') ? 'true' : 'false';
-        $requestInformation[LoggerInterface::IS_CACHEABLE] =
-            ($response->getHeader('X-Magento-Tags') && $response->getHeader('X-Magento-Tags') !== '')
-                ? 'true'
-                : 'false';
         $requestInformation[LoggerInterface::REQUEST_LENGTH] = $request->getHeader('Content-Length') ?: '';
+        return $requestInformation;
+    }
 
-        if ($schema) {
-            $schemaConfig = $schema->getConfig();
-            $mutationOperations = $schemaConfig->getMutation()->getFields();
-            $queryOperations = $schemaConfig->getQuery()->getFields();
-            $requestInformation[LoggerInterface::HAS_MUTATION] = count($mutationOperations) > 0 ? 'true' : 'false';
-            $requestInformation[LoggerInterface::NUMBER_OF_OPERATIONS] =
-                count($mutationOperations) + count($queryOperations);
-            $operationNames = array_merge(array_keys($mutationOperations), array_keys($queryOperations));
-            $requestInformation[LoggerInterface::OPERATION_NAMES] =
-                count($operationNames) > 0 ? implode(",", $operationNames) : 'operationNameNotFound';
-        }
-
-        $requestInformation[LoggerInterface::COMPLEXITY] = $this->getFieldCount($data['query'] ?? '');
-
-        if ($response) {
-            $requestInformation[LoggerInterface::HTTP_RESPONSE_CODE] = $response->getHttpResponseCode();
-        }
+    /**
+     * Gets the information needed from the schema
+     *
+     * @param Schema $schema
+     * @return array
+     */
+    private function gatherQueryInformation(Schema $schema) : array
+    {
+        $schemaConfig = $schema->getConfig();
+        $mutationOperations = $schemaConfig->getMutation()->getFields();
+        $queryOperations = $schemaConfig->getQuery()->getFields();
+        $queryInformation[LoggerInterface::HAS_MUTATION] = count($mutationOperations) > 0 ? 'true' : 'false';
+        $queryInformation[LoggerInterface::NUMBER_OF_OPERATIONS] =
+            count($mutationOperations) + count($queryOperations);
+        $operationNames = array_merge(array_keys($mutationOperations), array_keys($queryOperations));
+        $queryInformation[LoggerInterface::OPERATION_NAMES] =
+            count($operationNames) > 0 ? implode(",", $operationNames) : 'operationNameNotFound';
+        return $queryInformation;
+    }
 
-        return $requestInformation;
+    /**
+     * Gets the information needed from the response
+     *
+     * @param HttpResponse $response
+     * @return array
+     */
+    private function gatherResponseInformation(HttpResponse $response) : array
+    {
+        $responseInformation[LoggerInterface::IS_CACHEABLE] =
+            ($response->getHeader('X-Magento-Tags') && $response->getHeader('X-Magento-Tags') !== '')
+                ? 'true'
+                : 'false';
+        $responseInformation[LoggerInterface::HTTP_RESPONSE_CODE] = $response->getHttpResponseCode();
+        return $responseInformation;
     }
 
     /**

dev/tests/integration/testsuite/Magento/GraphQl/Helper/Query/Logger/LogDataTest.php

@@ -82,7 +82,7 @@ public function testGetQueryInformation(string $query, array $headers, array $ex
         $queryFields = $this->objectManager->get(Fields::class);
         $queryFields->setQuery($query);
 
-        $queryInformation = $this->logData->getRequestInformation(
+        $queryInformation = $this->logData->getLogData(
             $this->request,
             $postData,
             $this->schemaGenerator->generate(),