Added docs and test for log store service.

Author: colinmurphy

plugins/wpgraphql-logging/docs/how-to/logger_replace_log_store_service.md

@@ -0,0 +1,108 @@
+# How to Replace the Log Storage Service
+
+The WPGraphQL Logging plugin provides a robust database logging solution out of the box. However, for advanced use cases or integration with external logging systems, you can replace the default storage mechanism with your own custom implementation.
+
+This is made possible by the `wpgraphql_logging_log_store_service` filter.
+
+## Requirements
+
+Your custom log service class must implement the `\WPGraphQL\Logging\Logger\Api\LogServiceInterface`. This ensures that your custom service has all the methods the plugin expects to interact with.
+
+## Example: Logging to a File
+
+Here is an example of how you could replace the default database logger with a simple file-based logger.
+
+**1. Create your custom Log Service class**
+
+First, create a class that implements `LogServiceInterface`. This is a simplified example that would log to a file in the `wp-content/uploads` directory.
+
+```php
+<?php
+// In your theme's functions.php or a custom plugin
+
+use WPGraphQL\Logging\Logger\Api\LogServiceInterface;
+use WPGraphQL\Logging\Logger\Api\LogEntityInterface;
+
+class MyFileLogService implements LogServiceInterface {
+
+    /**
+     * @inheritDoc
+     */
+    public function create_log_entity( string $channel, int $level, string $level_name, string $message, array $context = [], array $extra = [] ): ?LogEntityInterface {
+        $log_file = WP_CONTENT_DIR . '/uploads/wpgraphql-logs.log';
+        $log_entry = sprintf(
+            "[%s] %s.%s: %s %s %s\n",
+            gmdate( 'Y-m-d H:i:s' ),
+            $channel,
+            $level_name,
+            $message,
+            wp_json_encode( $context ),
+            wp_json_encode( $extra )
+        );
+
+        file_put_contents( $log_file, $log_entry, FILE_APPEND );
+
+        // Return null as we are not creating a database entity.
+        return null;
+    }
+
+    public function find_entity_by_id(int $id): ?LogEntityInterface
+    {
+        return null;
+    }
+
+    public function find_entities_by_where(array $args = []): array
+    {
+        return [];
+    }
+
+    public function delete_entity_by_id(int $id): bool
+    {
+        return true;
+    }
+
+    public function delete_entities_older_than(DateTime $date): bool
+    {
+        return true;
+    }
+
+    public function delete_all_entities(): bool
+    {
+        return true;
+    }
+
+    public function count_entities_by_where(array $args = []): int
+    {
+        return 0;
+    }
+
+    public function activate(): void
+    {
+    }
+
+    public function deactivate(): void
+    {
+    }
+}
+```
+
+**2. Hook into the filter**
+
+Next, use the `wpgraphql_logging_log_store_service` filter to return an instance of your new class. It's best to do this early, for example on the `plugins_loaded` hook.
+
+```php
+<?php
+
+add_action( 'plugins_loaded', function() {
+    add_filter( 'wpgraphql_logging_log_store_service', function( $log_service ) {
+        // If another plugin hasn't already replaced the service,
+        // replace it with our custom file logger.
+        if ( null === $log_service ) {
+            $log_service = new MyFileLogService();
+        }
+        return $log_service;
+    } );
+}, 10, 0 );
+```
+
+With this in place, all logs from WPGraphQL Logging will be routed through your `MyFileLogService` and saved to a file instead of the database.

plugins/wpgraphql-logging/docs/index.md

@@ -181,6 +181,7 @@ define( 'WP_GRAPHQL_LOGGING_UNINSTALL_PLUGIN', true );
 ## How to Guides
 
 ### Admin
+- [How to replace the database log service](how-to/logger_replace_log_store_service.md)
 - [How to add a new Settings tab to WPGraphQL Logging](how-to/admin_add_new_tab.md)
 - [How to add a new field to an existing tab and query it](how-to/admin_add_fields.md)
 - [How to add a new column to the Logs admin grid](how-to/admin_add_view_column.md)

plugins/wpgraphql-logging/tests/wpunit/Logger/Store/CustomLogServiceStub.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WPGraphQL\Logging\Unit\Logger\Store;
+
+use WPGraphQL\Logging\Logger\Api\LogEntityInterface;
+use WPGraphQL\Logging\Logger\Api\LogServiceInterface;
+use DateTime;
+
+/**
+ * A stub implementation of LogServiceInterface for testing purposes.
+ */
+class CustomLogServiceStub implements LogServiceInterface
+{
+    public function create_log_entity(string $channel, int $level, string $level_name, string $message, array $context = [], array $extra = []): ?LogEntityInterface
+    {
+        return null;
+    }
+
+    public function find_entity_by_id(int $id): ?LogEntityInterface
+    {
+        return null;
+    }
+
+    public function find_entities_by_where(array $args = []): array
+    {
+        return [];
+    }
+
+    public function delete_entity_by_id(int $id): bool
+    {
+        return true;
+    }
+
+    public function delete_entities_older_than(DateTime $date): bool
+    {
+        return true;
+    }
+
+    public function delete_all_entities(): bool
+    {
+        return true;
+    }
+
+    public function count_entities_by_where(array $args = []): int
+    {
+        return 0;
+    }
+
+    public function activate(): void
+    {
+    }
+
+    public function deactivate(): void
+    {
+    }
+}

plugins/wpgraphql-logging/tests/wpunit/Logger/Store/LogStoreServiceTest.php

@@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WPGraphQL\Logging\Unit\Logger\Store;
+
+use WPGraphQL\Logging\Logger\Database\WordPressDatabaseLogService;
+use WPGraphQL\Logging\Logger\Store\LogStoreService;
+use lucatume\WPBrowser\TestCase\WPTestCase;
+
+require_once __DIR__ . '/CustomLogServiceStub.php';
+
+class LogStoreServiceTest extends WPTestCase
+{
+    /**
+     * Resets the singleton instance in LogStoreService using reflection.
+     */
+    protected function resetLogStoreService()
+    {
+        $reflection = new \ReflectionClass(LogStoreService::class);
+        $instanceProperty = $reflection->getProperty('instance');
+        $instanceProperty->setAccessible(true);
+        $instanceProperty->setValue(null, null);
+        $instanceProperty->setAccessible(false);
+    }
+
+    public function testGetLogServiceReturnsDefaultService()
+    {
+        $this->resetLogStoreService();
+        remove_all_filters('wpgraphql_logging_log_store_service');
+
+        $service = LogStoreService::get_log_service();
+        $this->assertInstanceOf(WordPressDatabaseLogService::class, $service);
+    }
+
+    public function testGetLogServiceCanBeReplacedByFilter()
+    {
+        $this->resetLogStoreService();
+        remove_all_filters('wpgraphql_logging_log_store_service');
+
+        $customService = new CustomLogServiceStub();
+
+        add_filter('wpgraphql_logging_log_store_service', function ($service) use ($customService) {
+            return $customService;
+        });
+
+        $service = LogStoreService::get_log_service();
+
+        $this->assertInstanceOf(CustomLogServiceStub::class, $service);
+        $this->assertSame($customService, $service);
+
+        // It should return the same instance on subsequent calls
+        $service2 = LogStoreService::get_log_service();
+        $this->assertSame($customService, $service2);
+
+        remove_all_filters('wpgraphql_logging_log_store_service');
+    }
+
+    public function testFilterReturningNullUsesDefaultService()
+    {
+        $this->resetLogStoreService();
+        remove_all_filters('wpgraphql_logging_log_store_service');
+
+        add_filter('wpgraphql_logging_log_store_service', function ($service) {
+            // A filter that does nothing or returns null
+            return null;
+        });
+
+        $service = LogStoreService::get_log_service();
+        $this->assertInstanceOf(WordPressDatabaseLogService::class, $service);
+
+        remove_all_filters('wpgraphql_logging_log_store_service');
+    }
+
+    public function testFilterReturningInvalidObjectUsesDefaultService()
+    {
+        $this->resetLogStoreService();
+        remove_all_filters('wpgraphql_logging_log_store_service');
+
+        add_filter('wpgraphql_logging_log_store_service', function ($service) {
+            // Return something that does not implement the interface
+            return new \stdClass();
+        });
+
+        $service = LogStoreService::get_log_service();
+        $this->assertInstanceOf(WordPressDatabaseLogService::class, $service);
+
+        remove_all_filters('wpgraphql_logging_log_store_service');
+    }
+}