Add support for logging HTTP requests and responses

Author: jeromegamez

CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG
 
 ## [Unreleased]
+### Added
+* It is now possible to log HTTP requests and responses to the Firebase APIs 
+  by specifying a logger's service ID. You can do so by setting 
+  `http_request_logger` and `http_request_debug_logger` with the service ID 
+  of an already configured logger, e.g. `monolog.logger`.
 
 ## [2.1.0] - 2020-06-23
 ### Added

README.md

@@ -112,7 +112,11 @@ kreait_firebase:
             default_dynamic_links_domain: 'https://my_project.page.link'
             # Optional: Used to cache Google's public keys. Must implement
             # \Psr\SimpleCache\CacheInterface (PSR-16)
-            verifier_cache: 'cache.app'
+            verifier_cache: null # Example: cache.app
+            # If set, logs simple HTTP request and response statuses
+            http_request_logger:  null # Example: monolog.logger.firebase
+            # If set, logs detailed HTTP request and response statuses
+            http_request_debug_logger: null # Example: monolog.logger.firebase_debug
 ```
 
 ## Documentation

src/DependencyInjection/Configuration.php

@@ -58,11 +58,21 @@ public function getConfigTreeBuilder(): TreeBuilder
                                 ->example('https://my-project.page.link')
                                 ->info('The default domain for dynamic links')
                             ->end()
-                                ->scalarNode('verifier_cache')
+                            ->scalarNode('verifier_cache')
                                 ->defaultNull()
                                 ->example('cache.app')
                                 ->info('Used to cache Google\'s public keys.')
                             ->end()
+                            ->scalarNode('http_request_logger')
+                                ->defaultNull()
+                                ->example('monolog.logger.firebase')
+                                ->info('If set, logs simple HTTP request and response statuses')
+                            ->end()
+                            ->scalarNode('http_request_debug_logger')
+                                ->defaultNull()
+                                ->example('monolog.logger.firebase_debug')
+                                ->info('If set, logs detailed HTTP request and response statuses')
+                            ->end()
                         ->end()
                     ->end()
                 ->end()

src/DependencyInjection/Factory/ProjectFactory.php

@@ -7,6 +7,7 @@
 use Kreait\Firebase;
 use Kreait\Firebase\Factory;
 use Psr\Cache\CacheItemPoolInterface;
+use Psr\Log\LoggerInterface;
 use Psr\SimpleCache\CacheInterface;
 use Symfony\Component\Cache\Psr16Cache;
 use Symfony\Component\Cache\Simple\Psr6Cache;
@@ -19,6 +20,12 @@ class ProjectFactory
     /** @var CacheInterface|null */
     private $verifierCache;
 
+    /** @var LoggerInterface|null */
+    private $httpRequestLogger;
+
+    /** @var LoggerInterface|null */
+    private $httpRequestDebugLogger;
+
     public function __construct(Factory $firebaseFactory)
     {
         $this->firebaseFactory = $firebaseFactory;
@@ -40,6 +47,16 @@ public function setVerifierCache($verifierCache = null): void
         $this->verifierCache = $verifierCache;
     }
 
+    public function setHttpRequestLogger(?LoggerInterface $logger = null): void
+    {
+        $this->httpRequestLogger = $logger;
+    }
+
+    public function setHttpRequestDebugLogger(?LoggerInterface $logger = null): void
+    {
+        $this->httpRequestDebugLogger = $logger;
+    }
+
     public function createFactory(array $config = []): Factory
     {
         $factory = clone $this->firebaseFactory; // Ensure a new instance
@@ -58,6 +75,14 @@ public function createFactory(array $config = []): Factory
             $factory = $factory->withVerifierCache($this->verifierCache);
         }
 
+        if ($this->httpRequestLogger) {
+            $factory = $factory->withHttpLogger($this->httpRequestLogger);
+        }
+
+        if ($this->httpRequestDebugLogger) {
+            $factory = $factory->withHttpDebugLogger($this->httpRequestDebugLogger);
+        }
+
         return $factory;
     }
 

src/DependencyInjection/FirebaseExtension.php

@@ -73,6 +73,14 @@ private function registerService(string $name, array $config, string $class, Con
             $factory->addMethodCall('setVerifierCache', [new Reference($config['verifier_cache'])]);
         }
 
+        if ($config['http_request_logger'] ?? null) {
+            $factory->addMethodCall('setHttpRequestLogger', [new Reference($config['http_request_logger'])]);
+        }
+
+        if ($config['http_request_debug_logger'] ?? null) {
+            $factory->addMethodCall('setHttpRequestDebugLogger', [new Reference($config['http_request_debug_logger'])]);
+        }
+
         $container->register($projectServiceId, $class)
             ->setFactory([$factory, $method])
             ->addArgument($config)

tests/DependencyInjection/FirebaseExtensionTest.php

@@ -7,6 +7,7 @@
 use Kreait\Firebase;
 use Kreait\Firebase\Symfony\Bundle\DependencyInjection\FirebaseExtension;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
 use Psr\SimpleCache\CacheInterface;
 use stdClass;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
@@ -84,6 +85,50 @@ public function a_verifier_cache_can_be_used(): void
         $this->addToAssertionCount(1);
     }
 
+    /**
+     * @test
+     */
+    public function a_request_logger_can_be_used(): void
+    {
+        $loggerServiceId = 'firebase_logger';
+
+        $container = $this->createContainer([
+            'projects' => [
+                'foo' => [
+                    'credentials' => __DIR__.'/../_fixtures/valid_credentials.json',
+                    'http_request_logger' => $loggerServiceId,
+                ],
+            ],
+        ]);
+        $logger = $this->createMock(LoggerInterface::class);
+        $container->set($loggerServiceId, $logger);
+
+        $container->get(Firebase\Auth::class);
+        $this->addToAssertionCount(1);
+    }
+
+    /**
+     * @test
+     */
+    public function a_request_debug_logger_can_be_used(): void
+    {
+        $loggerServiceId = 'firebase_debug_logger';
+
+        $container = $this->createContainer([
+            'projects' => [
+                'foo' => [
+                    'credentials' => __DIR__.'/../_fixtures/valid_credentials.json',
+                    'http_request_debug_logger' => $loggerServiceId,
+                ],
+            ],
+        ]);
+        $logger = $this->createMock(LoggerInterface::class);
+        $container->set($loggerServiceId, $logger);
+
+        $container->get(Firebase\Auth::class);
+        $this->addToAssertionCount(1);
+    }
+
     /**
      * @test
      */