Replaced torann/geoip by stevebauman/location for optional GeoIP support

Improved username detection in `Formatter` headers

Author: onlime

CHANGELOG.md

@@ -9,6 +9,8 @@
 - Drop Laravel 9 support, require Laravel v10.15 or higher for the new `DB::getRawQueryLog()` support.
 - PHP code style fixes by `laravel/pint` v1.10, now using more strict style rules (`laravel` preset).
 - Refactored whole codebase from `DB::getQueryLog()` to use the new `DB::getRawQueryLog()` method, so `ReplacesBindings` is no longer needed.
+- Replaced [torann/geoip](https://github.com/Torann/laravel-geoip) by [stevebauman/location](https://github.com/stevebauman/location) for optional GeoIP support.
+- Improved username detection in `Formatter` headers, so that it works both with default `email` field or custom `username()` method on `User` model.
 
 ## [1.0.1 (2023-02-26)](https://github.com/onlime/laravel-sql-reporter/compare/v1.0.0...v1.0.1)
 

README.md

@@ -68,14 +68,14 @@ It reports a lot of metadata like total query count, total execution time, origi
 
 ## Optional
 
-For optional GeoIP support (adding country information to client IP in log headers), you may install [torann/geoip](https://github.com/Torann/laravel-geoip) in your project:
+For optional GeoIP support (adding country information to client IP in log headers), you may install [stevebauman/location](https://github.com/stevebauman/location) in your project:
 
 ```bash
-$ composer require torann/geoip
-$ php artisan vendor:publish --provider="Torann\GeoIP\GeoIPServiceProvider"
+$ composer require stevebauman/location
+$ php artisan vendor:publish --provider="Stevebauman\Location\LocationServiceProvider"
 ```
 
-It will be auto-detected, no configuration needed for this.
+It will be auto-detected, no configuration needed for this. If you wish to use a different driver than the default [IpApi](https://ip-api.com/), e.g. `MaxMind` make sure you correctly configure it according to the docs: [Available Drivers](https://github.com/stevebauman/location#available-drivers)
 
 ## Development
 

composer.json

@@ -47,7 +47,7 @@
             "url": "https://github.com/mnabialek/laravel-version"
         },
         "suggest": {
-            "torann/geoip": "GeoIP country detection for log headers information",
+            "stevebaumann/location": "GeoIP country detection for log headers information",
             "symfony/thanks": "Star packages you use running 'composer thanks' command"
         }
     }

src/Formatter.php

@@ -44,6 +44,12 @@ public function getHeader(): string
             return '';
         }
 
+        // Try to resolve username, which is stored in 'email' field by default, but could be mapped by username() method
+        // by some custom trait.
+        $username = ($user = Auth::user())
+            ? (method_exists($user, 'username') ? $user->username() : $user->email)
+            : '';
+
         $queryLog  = DB::getRawQueryLog();
         $times     = Arr::pluck($queryLog, 'time');
         $totalTime = $this->time(array_sum($times));
@@ -54,7 +60,7 @@ public function getHeader(): string
             'datetime' => Carbon::now()->toDateTimeString(),
             'origin'   => $this->originLine(),
             'status'   => sprintf('Executed %s queries in %s', count($queryLog), $totalTime),
-            'user'     => Auth::user()?->username(),
+            'user'     => $username,
             'env'      => $this->app->environment(),
             'agent'    => Request::userAgent() ?? PHP_SAPI,
             'ip'       => $ip,
@@ -63,10 +69,10 @@ public function getHeader(): string
         ];
         $headers = Arr::only($data, $headerFields);
 
-        // (optional) GeoIP lookup if torann/geoip is installed, appending country information to IP
-        if (in_array('ip', $headerFields) && $ip !== '127.0.0.1' && function_exists('geoip')) {
-            $geoip = geoip($ip);
-            $headers['ip'] .= sprintf(' (%s / %s)', $geoip->iso_code, $geoip->country);
+        // (optional) GeoIP lookup if stevebaumann/location is installed, appending country information to IP
+        if (in_array('ip', $headerFields) && $ip !== '127.0.0.1' && class_exists('Stevebauman\Location\Facades\Location')) {
+            $position = \Stevebauman\Location\Facades\Location::get();
+            $headers['ip'] .= sprintf(' (%s / %s)', $position->isoCode, $position->countryName);
         }
 
         // get formatted header lines with padded keys