Add support for logging HTTP requests and responses

Author: jeromegamez

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+### Added
+* It is now possible to log HTTP requests and responses to the Firebase APIs to existing log channels. 
+  See the "logging" section in [`config/firebase.php`](config/firebase.php) for the configuration 
+  options and the [SDK Logging Documentation](https://firebase-php.readthedocs.io/en/5.5.0/setup.html#logging) 
+  for more information.
+### Changed
 * The default branch of the GitHub repository has been renamed from `master` to `main` - 
   if you're using `dev-master` as a version constraint in your `composer.json`, please 
   update it to `dev-main`.

README.md

@@ -73,7 +73,7 @@ FIREBASE_CREDENTIALS=relative/path/to/firebase_credentials.json
 ```
 
 For further configuration, please see [config/firebase.php](config/firebase.php). You can modify the configuration
-by copying it to your local `config` directory:
+by copying it to your local `config` directory or by defining the environment variables used in the config file:
 
 ```bash
 # Laravel

config/firebase.php

@@ -113,7 +113,28 @@
 
     /**
      * ------------------------------------------------------------------------
-     * Debug
+     * Logging
+     * ------------------------------------------------------------------------
+     *
+     * Enable logging of HTTP interaction for insights and/or debugging.
+     *
+     * Log channels are defined in config/logging.php
+     *
+     * Successful HTTP messages are logged with the log level 'info'.
+     * Failed HTTP messages are logged with the the log level 'notice'.
+     *
+     * Note: Using the same channel for simple and debug logs will result in
+     * two entries per request and response.
+     */
+
+    'logging' => [
+        'http_log_channel' => env('FIREBASE_HTTP_LOG_CHANNEL', null),
+        'http_debug_log_channel' => env('FIREBASE_HTTP_DEBUG_LOG_CHANNEL', null),
+    ],
+
+    /**
+     * ------------------------------------------------------------------------
+     * Debug (deprecated)
      * ------------------------------------------------------------------------
      *
      * Enable debugging of HTTP requests made directly from the SDK.

src/ServiceProvider.php

@@ -117,6 +117,18 @@ private function registerFactory(): void
                 );
             }
 
+            if ($logChannel = $config['logging']['http_log_channel'] ?? null) {
+                $factory = $factory->withHttpLogger(
+                    $app->make('log')->channel($logChannel)
+                );
+            }
+
+            if ($logChannel = $config['logging']['http_debug_log_channel'] ?? null) {
+                $factory = $factory->withHttpDebugLogger(
+                    $app->make('log')->channel($logChannel)
+                );
+            }
+
             return $factory;
         });
     }

tests/ServiceProviderTest.php

@@ -117,6 +117,32 @@ public function the_storage_default_bucket_can_be_configured(): void
         $this->assertSame($name, $property->getValue($storage));
     }
 
+    /** @test */
+    public function logging_can_be_configured(): void
+    {
+        $this->app->config->set('firebase.logging.http_log_channel', 'stack');
+
+        $factory = $this->app->make(Firebase\Factory::class);
+
+        $property = ReflectionObject::createFromInstance($factory)->getProperty('httpLogMiddleware');
+        $property->setVisibility(\ReflectionProperty::IS_PUBLIC);
+
+        $this->assertNotNull($property->getValue($factory));
+    }
+
+    /** @test */
+    public function debug_logging_can_be_configured(): void
+    {
+        $this->app->config->set('firebase.logging.http_debug_log_channel', 'stack');
+
+        $factory = $this->app->make(Firebase\Factory::class);
+
+        $property = ReflectionObject::createFromInstance($factory)->getProperty('httpDebugLogMiddleware');
+        $property->setVisibility(\ReflectionProperty::IS_PUBLIC);
+
+        $this->assertNotNull($property->getValue($factory));
+    }
+
     /** @test */
     public function it_uses_the_laravel_cache(): void
     {