Merge pull request #147 from rollbar/updated/types-and-comments

Improved missing typing and comments

Author: danielmorell

src/MonologHandler.php

@@ -2,39 +2,53 @@
 
 namespace Rollbar\Laravel;
 
+use Illuminate\Contracts\Foundation\Application;
 use Monolog\Handler\RollbarHandler;
 use Monolog\LogRecord;
 
 class MonologHandler extends RollbarHandler
 {
-    protected $app;
+    protected Application $app;
 
     /**
-     * @param $app
+     * Sets the Laravel application, so it can be used to get the current user and session data later.
+     *
+     * @param Application $app The Laravel application.
+     *
      * @return void
      */
-    public function setApp($app)
+    public function setApp(Application $app): void
     {
         $this->app = $app;
     }
 
     /**
-     * @param LogRecord $record
+     * Custom write method to add the Laravel context to the log record for Rollbar.
+     *
+     * @param LogRecord $record The Monolog log record.
+     *
      * @return void
      */
     protected function write(LogRecord $record): void
     {
-        parent::write(new LogRecord($record->datetime,
-            $record->channel,
-            $record->level,
-            $record->message,
-            $this->addContext($record->context),
-            $record->extra,
-            $record->formatted));
+        parent::write(
+            new LogRecord(
+                $record->datetime,
+                $record->channel,
+                $record->level,
+                $record->message,
+                $this->addContext($record->context),
+                $record->extra,
+                $record->formatted
+            )
+        );
     }
 
     /**
-     * @param array $context
+     * Adds the Laravel context to the log record for Rollbar. This includes person and session data.
+     *
+     * @param array $context The {@see LogRecord::context} array.
+     *
      * @return array
      */
     protected function addContext(array $context = []): array

src/RollbarServiceProvider.php

@@ -4,7 +4,7 @@
 use Rollbar\RollbarLogger;
 use Illuminate\Support\Arr;
 use InvalidArgumentException;
-use Rollbar\Laravel\MonologHandler;
+use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\ServiceProvider;
 
@@ -13,14 +13,14 @@ class RollbarServiceProvider extends ServiceProvider
     /**
      * Register the service provider.
      */
-    public function register()
+    public function register(): void
     {
         // Don't register rollbar if it is not configured.
         if ($this->stop() === true) {
             return;
         }
 
-        $this->app->singleton(RollbarLogger::class, function ($app) {
+        $this->app->singleton(RollbarLogger::class, function (Application $app) {
 
             $defaults = [
                 'environment'       => $app->environment(),
@@ -54,7 +54,7 @@ public function register()
             return Rollbar::logger();
         });
 
-        $this->app->singleton(MonologHandler::class, function ($app) {
+        $this->app->singleton(MonologHandler::class, function (Application $app) {
 
             $level = static::config('level', 'debug');
 
@@ -66,7 +66,7 @@ public function register()
     }
 
     /**
-     * Check if we should prevent the service from registering
+     * Check if we should prevent the service from registering.
      *
      * @return boolean
      */
@@ -82,15 +82,16 @@ public function stop() : bool
     }
 
     /**
-     * Return a rollbar logging config
+     * Return a rollbar logging config.
+     *
+     * @param string $key     The config key to lookup.
+     * @param mixed  $default The default value to return if the config is not found.
      *
-     * @param array|string $key
-     * @param mixed $default
      * @return mixed
      */
-    protected static function config($key = '', $default = null)
+    protected static function config(string $key = '', mixed $default = null): mixed
     {
-        $envKey = 'ROLLBAR_'.strtoupper($key);
+        $envKey = 'ROLLBAR_' . strtoupper($key);
 
         if ($envKey === 'ROLLBAR_ACCESS_TOKEN') {
             $envKey = 'ROLLBAR_TOKEN';

tests/RollbarTest.php

@@ -11,9 +11,10 @@
 
 class RollbarTest extends \Orchestra\Testbench\TestCase
 {
+    private string $access_token = 'B42nHP04s06ov18Dv8X7VI4nVUs6w04X';
+
     protected function setUp(): void
     {
-        $this->access_token = 'B42nHP04s06ov18Dv8X7VI4nVUs6w04X';
         putenv('ROLLBAR_TOKEN=' . $this->access_token);
 
         parent::setUp();