Merge pull request #86 from honeybadger-io/report-data

Warn of `report_data` when running a test

Author: shalvah

src/Commands/HoneybadgerInstallCommand.php

@@ -113,6 +113,10 @@ private function addTestExceptionTask(): void
         $this->tasks->addTask(
             'Send test exception to Honeybadger',
             function () {
+                if (! config('honeybadger.report_data')) {
+                    $this->info("You have `report_data` set to false in your config. Errors won't be reported in this environment.");
+                    $this->info("We've switched it to true for this test, but you should check that it's enabled for your production environments.");
+                }
                 $result = $this->installer->sendTestException();
 
                 return empty($result) ? false : $result;

src/Commands/HoneybadgerTestCommand.php

@@ -6,7 +6,6 @@
 use Honeybadger\Contracts\Reporter;
 use Honeybadger\HoneybadgerLaravel\Exceptions\TestException;
 use Illuminate\Console\Command;
-use Illuminate\Support\Arr;
 
 class HoneybadgerTestCommand extends Command
 {
@@ -30,13 +29,18 @@ public function handle()
         $honeybadger = app('honeybadger.loud');
 
         try {
+            if (! config('honeybadger.report_data')) {
+                $this->info("You have `report_data` set to false in your config. Errors won't be reported in this environment.");
+                $this->info("We've switched it to true for this test, but you should check that it's enabled for your production environments.");
+            }
             $result = $honeybadger->notify(new TestException);
-            $this->info('A test exception was sent to Honeybadger');
-            if (is_null(Arr::get($result, 'id'))) {
+            $id = $result['id'] ?? null;
+            if (is_null($id)) {
                 throw new Exception('There was an error sending the exception to Honeybadger');
             }
 
-            $this->line(sprintf('https://app.honeybadger.io/notice/', Arr::get($result, 'id')));
+            $noticeUrl = "https://app.honeybadger.io/notice/$id";
+            $this->info("Successfully sent a test exception to Honeybadger: $noticeUrl");
         } catch (Exception $e) {
             $this->error($e->getMessage());
         }

src/HoneybadgerLaravel.php

@@ -5,6 +5,7 @@
 use Honeybadger\Contracts\Reporter;
 use Honeybadger\Exceptions\ServiceException;
 use Honeybadger\Honeybadger;
+use Honeybadger\HoneybadgerLaravel\Exceptions\TestException;
 use Illuminate\Support\Facades\Log;
 use Symfony\Component\HttpFoundation\Request;
 use Throwable;
@@ -62,6 +63,18 @@ public function notify(Throwable $throwable, Request $request = null, array $add
         return $result;
     }
 
+    protected function shouldReport(Throwable $throwable): bool
+    {
+        // Always report if the user is running a test.
+        if ($throwable instanceof TestException) {
+            return true;
+        }
+
+        return ! $this->excludedException($throwable)
+            && ! empty($this->config['api_key'])
+            && $this->config['report_data'];
+    }
+
     protected function setRouteActionAndUserContext(Request $request): void
     {
         // For backwards compatibility, check if context has already been set by the middleware

tests/Commands/HoneybadgerTestCommandTest.php

@@ -29,7 +29,7 @@ public function it_outputs_success()
     {
         $mock = $this->createMock(Reporter::class);
         $mock->method('notify')
-            ->willReturn([]);
+            ->willReturn(['id' => 8633]);
 
         $this->app->instance('honeybadger.loud', $mock);
 
@@ -40,7 +40,7 @@ public function it_outputs_success()
 
         $command->expects($this->once())
             ->method('info')
-            ->with('A test exception was sent to Honeybadger');
+            ->with('Successfully sent a test exception to Honeybadger: https://app.honeybadger.io/notice/8633');
 
         $this->app[Kernel::class]->registerCommand($command);