Support for SENTRY_ENVIRONMENT environment variable (#354)

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

Author: NiclasvanEyk

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Respect the `SENTRY_ENVIRONMENT` environment variable to override the Laravel environment (#354)
+
 ## 1.8.0
 
 - Add `send_default_pii` option by default to published config file (#340)

config/sentry.php

@@ -7,6 +7,9 @@
     // capture release as git sha
     // 'release' => trim(exec('git --git-dir ' . base_path('.git') . ' log --pretty="%h" -n1 HEAD')),
 
+    // When left empty or `null` the Laravel environment will be used
+    'environment' => env('SENTRY_ENVIRONMENT'),
+
     'breadcrumbs' => [
         // Capture Laravel logs in breadcrumbs
         'logs' => true,

src/Sentry/Laravel/ServiceProvider.php

@@ -114,13 +114,17 @@ protected function configureAndRegisterClient(): void
 
             $options = \array_merge(
                 [
-                    'environment' => $this->app->environment(),
                     'prefixes' => [$basePath],
                     'in_app_exclude' => ["{$basePath}/vendor"],
                 ],
                 $userConfig
             );
 
+            // When we get no environment from the (user) configuration we default to the Laravel environment
+            if (empty($options['environment'])) {
+                $options['environment'] = $this->app->environment();
+            }
+
             $clientBuilder = ClientBuilder::create($options);
 
             // Set the Laravel SDK identifier and version

test/Sentry/ServiceProviderWithEnvironmentFromConfigTest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Sentry;
+
+use Sentry\Laravel\Tests\SentryLaravelTestCase;
+
+class ServiceProviderWithEnvironmentFromConfigTest extends SentryLaravelTestCase
+{
+    public function testSentryEnvironmentDefaultsToLaravelEnvironment()
+    {
+        $this->assertEquals('testing', app()->environment());
+    }
+
+    public function testEmptySentryEnvironmentDefaultsToLaravelEnvironment()
+    {
+        $this->resetApplicationWithConfig([
+            'sentry.environment' => '',
+        ]);
+
+        $this->assertEquals('testing', $this->getHubFromContainer()->getClient()->getOptions()->getEnvironment());
+
+        $this->resetApplicationWithConfig([
+            'sentry.environment' => null,
+        ]);
+
+        $this->assertEquals('testing', $this->getHubFromContainer()->getClient()->getOptions()->getEnvironment());
+    }
+
+    public function testSentryEnvironmentDefaultGetsOverriddenByConfig()
+    {
+        $this->resetApplicationWithConfig([
+            'sentry.environment' => 'not_testing',
+        ]);
+
+        $this->assertEquals('not_testing', $this->getHubFromContainer()->getClient()->getOptions()->getEnvironment());
+    }
+}