initial commit

Author: danslo

.github/workflows/integration.yml

@@ -0,0 +1,35 @@
+name: Integration Test
+
+on:
+  push:
+    branches:
+    - main
+    paths-ignore:
+    - "docs/**"
+    - "*.md"
+  pull_request:
+    branches:
+    - main
+    paths-ignore:
+    - "docs/**"
+    - "*.md"
+
+jobs:
+  compute_matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.supported-version.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: graycoreio/github-actions-magento2/supported-version@main
+        id: supported-version
+      - run: echo ${{ steps.supported-version.outputs.matrix }}
+  integration-workflow:
+    needs: compute_matrix
+    uses: graycoreio/github-actions-magento2/.github/workflows/integration.yaml@main
+    with:
+      package_name: graycore/magento2-graphql-logger
+      matrix: ${{ needs.compute_matrix.outputs.matrix }}
+      test_command: ../../../vendor/bin/phpunit ../../../vendor/graycore/magento2-graphql-logger/Test/Integration
+    secrets:
+      composer_auth: ${{ secrets.COMPOSER_AUTH }}

.gitignore

@@ -0,0 +1,4 @@
+/vendor
+/composer.lock
+
+/node_modules

Api/Data/LogInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Graycore\GraphQlLogger\Api\Data;
+
+interface LogInterface
+{
+    public const LOG_ID  = 'log_id';
+    public const HASH    = 'hash';
+    public const METHOD  = 'method';
+    public const QUERY   = 'query';
+    public const UPDATED = 'updated';
+
+    public function setLogId(int $logId): self;
+    public function getLogId(): ?int;
+    public function setHash(string $hash): self;
+    public function getHash(): string;
+    public function setMethod(string $method): self;
+    public function getMethod(): string;
+    public function setQuery(string $query): self;
+    public function getQuery(): string;
+    public function setUpdated(string $updated): self;
+    public function getUpdated(): string;
+}

Api/LogRepositoryInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Graycore\GraphQlLogger\Api;
+
+use Graycore\GraphQlLogger\Api\Data\LogInterface;
+
+interface LogRepositoryInterface
+{
+    public function save(LogInterface $log): LogInterface;
+    public function getByHash(string $hash): LogInterface;
+}

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Graycore, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Model/Config.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Graycore\GraphQlLogger\Model;
+
+use Magento\Framework\App\Config\ScopeConfigInterface;
+
+class Config
+{
+    private const CONFIG_PATH_GRAPHQL_LOGGER_ENABLED = 'graphql/logger/enabled';
+
+    private ScopeConfigInterface $scopeConfig;
+
+    public function __construct(ScopeConfigInterface $scopeConfig)
+    {
+        $this->scopeConfig = $scopeConfig;
+    }
+
+    public function isEnabled(): bool
+    {
+        return (bool) $this->scopeConfig->getValue(self::CONFIG_PATH_GRAPHQL_LOGGER_ENABLED);
+    }
+}

Model/Log.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Graycore\GraphQlLogger\Model;
+
+
+use Graycore\GraphQlLogger\Api\Data\LogInterface;
+use Graycore\GraphQlLogger\Model\ResourceModel\Log as LogResource;
+use Magento\Framework\Model\AbstractModel;
+
+class Log extends AbstractModel implements LogInterface
+{
+    protected function _construct()
+    {
+        $this->_init(LogResource::class);
+    }
+
+    public function setLogId(int $logId): LogInterface
+    {
+        $this->setData(self::LOG_ID, $logId);
+        return $this;
+    }
+
+    public function getLogId(): ?int
+    {
+        $logId = $this->getData(self::LOG_ID);
+        return $logId !== null ? (int) $logId : null;
+    }
+
+    public function setHash(string $hash): LogInterface
+    {
+        $this->setData(self::HASH, $hash);
+        return $this;
+    }
+
+    public function getHash(): string
+    {
+        return $this->getData(self::HASH);
+    }
+
+    public function setMethod(string $method): LogInterface
+    {
+        $this->setData(self::METHOD, $method);
+        return $this;
+    }
+
+    public function getMethod(): string
+    {
+        return $this->getData(self::METHOD);
+    }
+
+    public function setQuery(string $query): LogInterface
+    {
+        $this->setData(self::QUERY, $query);
+        return $this;
+    }
+
+    public function getQuery(): string
+    {
+        return $this->getData(self::QUERY);
+    }
+
+    public function setUpdated(string $updated): LogInterface
+    {
+        $this->setData(self::UPDATED, $updated);
+        return $this;
+    }
+
+    public function getUpdated(): string
+    {
+        return $this->getData(self::UPDATED);
+    }
+}

Model/LogRepository.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Graycore\GraphQlLogger\Model;
+
+use Graycore\GraphQlLogger\Api\Data\LogInterface;
+use Graycore\GraphQlLogger\Api\Data\LogInterfaceFactory as LogFactory;
+use Graycore\GraphQlLogger\Api\LogRepositoryInterface;
+use Graycore\GraphQlLogger\Model\ResourceModel\Log as LogResource;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Psr\Log\LoggerInterface;
+
+class LogRepository implements LogRepositoryInterface
+{
+    private LogFactory $logFactory;
+    private LogResource $logResource;
+    private LoggerInterface $logger;
+
+    public function __construct(LogFactory $logFactory, LogResource $logResource, LoggerInterface $logger)
+    {
+        $this->logFactory = $logFactory;
+        $this->logResource = $logResource;
+        $this->logger = $logger;
+    }
+
+    public function save(LogInterface $log): LogInterface
+    {
+        try {
+            $this->logResource->save($log);
+        } catch (\Exception $e) {
+            $this->logger->warning('Unable to log query.', ['message' => $e->getMessage()]);
+        }
+        return $log;
+    }
+
+    public function getByHash(string $hash): LogInterface
+    {
+        /** @var LogInterface $log */
+        $log = $this->logFactory->create();
+        $this->logResource->load($log, $hash, LogInterface::HASH);
+        if ($log->getLogId() === null) {
+            throw new NoSuchEntityException(__('No log exists for specified hash.'));
+        }
+        return $log;
+    }
+}

Model/ResourceModel/Log.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Graycore\GraphQlLogger\Model\ResourceModel;
+
+use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
+
+class Log extends AbstractDb
+{
+    protected function _construct()
+    {
+        $this->_init('graycore_graphql_log', 'log_id');
+    }
+}

Plugin/LoggerPlugin.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Graycore\GraphQlLogger\Plugin;
+
+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
+{
+    private LogRepositoryInterface $logRepository;
+    private LogFactory $logFactory;
+    private RequestInterface $request;
+    private TimezoneInterface $date;
+    private 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 {
+        if (!$this->config->isEnabled()) {
+            return $value;
+        }
+
+        $hash = hash('sha256', $source);
+
+        try {
+            $log = $this->logRepository->getByHash($hash);
+        } catch (NoSuchEntityException $e) {
+            $log = $this->logFactory->create();
+        }
+
+        $log->setHash($hash)
+            ->setMethod($this->request->getMethod())
+            ->setQuery($source)
+            ->setUpdated($this->date->date()->format('Y-m-d H:i:s'));
+        $this->logRepository->save($log);
+
+        return $value;
+    }
+}