feat!: replace plugin with LoggerInterface implementation

BREAKING CHANGE: We no longer plugin around the query processor (which is a good thing). However, Magento's out-of-box log data doesn't give the exact query sent. This is likely due to the fact that it is possible for mutation data like user passwords to appear in the log if developers fail to use variables appropriately. However, I'm not going to compensate for naive developers. To keep existing functionality, we've added the full query (not variables) to the log data when this package is enabled. I would avoid using this in production environments if at all possible if you're concerned about the quality of your development team.

Author: damienwebdev

Plugin/LoggerPlugin.php renamed to Logger/Logger.php

@@ -1,49 +1,47 @@
 <?php
 
-namespace Graycore\GraphQlLogger\Plugin;
+namespace Graycore\GraphQlLogger\Logger;
+
+use Graycore\GraphQlLogger\Model\Config;
+use Magento\GraphQl\Model\Query\Logger\LoggerInterface;
 
 use Graycore\GraphQlLogger\Api\LogRepositoryInterface;
 use Graycore\GraphQlLogger\Api\Data\LogInterfaceFactory as LogFactory;
-use Graycore\GraphQlLogger\Model\Config;
-use Magento\Framework\App\RequestInterface;
 use Magento\Framework\Exception\NoSuchEntityException;
-use Magento\Framework\GraphQl\Query\QueryProcessor;
-use Magento\Framework\GraphQl\Schema;
 use Magento\Framework\Stdlib\DateTime\TimezoneInterface;
 
-class LoggerPlugin
+class Logger implements LoggerInterface
 {
     private LogRepositoryInterface $logRepository;
     private LogFactory $logFactory;
-    private RequestInterface $request;
     private TimezoneInterface $date;
     private Config $config;
 
+    /**
+     * @param Config $config
+     */
     public function __construct(
-        RequestInterface $request,
         LogRepositoryInterface $logRepository,
         LogFactory $logFactory,
         TimezoneInterface $date,
         Config $config
     ) {
-        $this->request = $request;
         $this->logRepository = $logRepository;
         $this->logFactory = $logFactory;
         $this->date = $date;
         $this->config = $config;
     }
 
-    public function afterProcess(
-        QueryProcessor $queryProcessor,
-        array $value,
-        Schema $schema,
-        string $source
-    ): array {
+    /**
+     * @inheritdoc
+     */
+    public function execute(array $queryDetails)
+    {
         if (!$this->config->isEnabled()) {
-            return $value;
+            return;
         }
 
-        $hash = hash('sha256', $source);
+        $hash = hash('sha256', $queryDetails['query']);
 
         try {
             $log = $this->logRepository->getByHash($hash);
@@ -52,11 +50,9 @@ public function afterProcess(
         }
 
         $log->setHash($hash)
-            ->setMethod($this->request->getMethod())
-            ->setQuery($source)
+            ->setMethod($queryDetails[LoggerInterface::HTTP_METHOD])
+            ->setQuery($queryDetails['query'])
             ->setUpdated($this->date->date()->format('Y-m-d H:i:s'));
         $this->logRepository->save($log);
-
-        return $value;
     }
 }

Plugin/LogDataPlugin.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Graycore\GraphQlLogger\Plugin;
+
+use Graycore\GraphQlLogger\Model\Config;
+use Magento\Framework\App\RequestInterface;
+use Magento\GraphQl\Helper\Query\Logger\LogData;
+
+class LogDataPlugin
+{
+    private Config $config;
+
+    /**
+     * @param Config $config
+     */
+    public function __construct(
+        Config $config
+    ) {
+        $this->config = $config;
+    }
+
+    public function afterGetLogData(
+        LogData $logdata,
+        array $result,
+        RequestInterface $request,
+        array $data
+    ): array {
+        if (!$this->config->isEnabled()) {
+            return $result;
+        }
+
+        /**
+         * Add the query to the data.
+         */
+        $result['query'] = $data['query'];
+        return $result;
+    }
+}

etc/di.xml

@@ -3,4 +3,14 @@
         xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
     <preference for="Graycore\GraphQlLogger\Api\LogRepositoryInterface" type="Graycore\GraphQlLogger\Model\LogRepository"/>
     <preference for="Graycore\GraphQlLogger\Api\Data\LogInterface" type="Graycore\GraphQlLogger\Model\Log"/>
+    <type name="Magento\GraphQl\Model\Query\Logger\LoggerPool">
+        <arguments>
+            <argument name="loggers" xsi:type="array">
+                <item name="graycoreGraphqlLogger" xsi:type="object">Graycore\GraphQlLogger\Logger\Logger</item>
+            </argument>
+        </arguments>
+    </type>
+    <type name="Magento\GraphQl\Helper\Query\Logger\LogData">
+        <plugin name="Graycore_GraphQlLogger::additionalLogData" type="Graycore\GraphQlLogger\Plugin\LogDataPlugin"/>
+    </type>
 </config>