Avoid collision if another package has bound 'sentry' (#467)

Co-authored-by: Alex Bouma <[email protected]>

Author: KarlCastle

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Avoid collision if another package has bound `sentry` in the Laravel container (#467)
+
 ## 2.4.1
 
 - Fix type hints incompatible with Laravel Lumen (#462)

src/Sentry/Laravel/Facade.php

@@ -2,6 +2,8 @@
 
 namespace Sentry\Laravel;
 
+use Sentry\State\HubInterface;
+
 /**
  * @method static bool addBreadcrumb(\Sentry\Breadcrumb $breadcrumb)
  * @method static string|null captureMessage(string $message, \Sentry\Severity $level = null, \Sentry\State\Scope $scope = null)
@@ -21,6 +23,6 @@ class Facade extends \Illuminate\Support\Facades\Facade
 {
     protected static function getFacadeAccessor()
     {
-        return 'sentry';
+        return HubInterface::class;
     }
 }

src/Sentry/Laravel/Http/SetRequestIpMiddleware.php

@@ -4,6 +4,7 @@
 
 use Closure;
 use Illuminate\Http\Request;
+use Sentry\State\HubInterface;
 use Sentry\State\Scope;
 
 class SetRequestIpMiddleware
@@ -18,14 +19,14 @@ class SetRequestIpMiddleware
      */
     public function handle(Request $request, Closure $next)
     {
-        if (app()->bound('sentry')) {
+        if (app()->bound(HubInterface::class)) {
             /** @var \Sentry\State\HubInterface $sentry */
-            $sentry = app('sentry');
+            $sentry = app(HubInterface::class);
 
             $client = $sentry->getClient();
 
             if ($client !== null && $client->getOptions()->shouldSendDefaultPii()) {
-                app('sentry')->configureScope(static function (Scope $scope) use ($request): void {
+                $sentry->configureScope(static function (Scope $scope) use ($request): void {
                     $scope->setUser([
                         'ip_address' => $request->ip(),
                     ]);

src/Sentry/Laravel/LogChannel.php

@@ -4,6 +4,7 @@
 
 use Monolog\Logger;
 use Illuminate\Log\LogManager;
+use Sentry\State\HubInterface;
 
 class LogChannel extends LogManager
 {
@@ -15,7 +16,7 @@ class LogChannel extends LogManager
     public function __invoke(array $config): Logger
     {
         $handler = new SentryHandler(
-            $this->app->make('sentry'),
+            $this->app->make(HubInterface::class),
             $config['level'] ?? Logger::DEBUG,
             $config['bubble'] ?? true
         );

src/Sentry/Laravel/ServiceProvider.php

@@ -37,7 +37,7 @@ class ServiceProvider extends BaseServiceProvider
      */
     public function boot(): void
     {
-        $this->app->make(static::$abstract);
+        $this->app->make(HubInterface::class);
 
         if ($this->hasDsnSet()) {
             $this->bindEvents($this->app);
@@ -71,7 +71,7 @@ public function boot(): void
     public function register(): void
     {
         if ($this->app instanceof Lumen) {
-            $this->app->configure('sentry');
+            $this->app->configure(static::$abstract);
         }
 
         $this->mergeConfigFrom(__DIR__ . '/../../../config/sentry.php', static::$abstract);
@@ -157,7 +157,7 @@ protected function configureAndRegisterClient(): void
             return $clientBuilder;
         });
 
-        $this->app->singleton(static::$abstract, function () {
+        $this->app->singleton(HubInterface::class, function () {
             /** @var \Sentry\ClientBuilderInterface $clientBuilder */
             $clientBuilder = $this->app->make(ClientBuilderInterface::class);
 
@@ -212,7 +212,7 @@ protected function configureAndRegisterClient(): void
             return $hub;
         });
 
-        $this->app->alias(static::$abstract, HubInterface::class);
+        $this->app->alias(HubInterface::class, static::$abstract);
     }
 
     /**

src/Sentry/Laravel/TestCommand.php

@@ -6,6 +6,7 @@
 use Illuminate\Console\Command;
 use Sentry\ClientBuilder;
 use Sentry\State\Hub;
+use Sentry\State\HubInterface;
 use Sentry\Tracing\SpanContext;
 use Sentry\Tracing\TransactionContext;
 
@@ -43,8 +44,8 @@ public function handle()
         $old_error_reporting = error_reporting(E_ALL | E_STRICT);
 
         try {
-            /** @var \Sentry\State\Hub $hub */
-            $hub = app('sentry');
+            /** @var \Sentry\State\HubInterface $hub */
+            $hub = app(HubInterface::class);
 
             if ($this->option('dsn')) {
                 $hub = new Hub(ClientBuilder::create(['dsn' => $this->option('dsn')])->getClient());

src/Sentry/Laravel/Tracing/Middleware.php

@@ -39,8 +39,8 @@ class Middleware
      */
     public function handle($request, Closure $next)
     {
-        if (app()->bound('sentry')) {
-            $this->startTransaction($request, app('sentry'));
+        if (app()->bound(HubInterface::class)) {
+            $this->startTransaction($request, app(HubInterface::class));
         }
 
         return $next($request);
@@ -56,7 +56,7 @@ public function handle($request, Closure $next)
      */
     public function terminate($request, $response): void
     {
-        if ($this->transaction !== null && app()->bound('sentry')) {
+        if ($this->transaction !== null && app()->bound(HubInterface::class)) {
             if ($this->appSpan !== null) {
                 $this->appSpan->finish();
             }