Merge pull request #76 from honeybadger-io/user-informer

Implement user informer and feedback form Blade directives

Author: shalvah

resources/lang/en/feedback.php

@@ -0,0 +1,14 @@
+<?php
+
+return [
+    'thanks' => 'Thanks for the feedback!',
+    'heading' => 'Care to help us fix this?',
+    'explanation' => 'Any information you can provide will help our technical team get to the bottom of this issue.',
+    'labels' => [
+        'name' => 'Your name',
+        'phone' => 'Your phone number',
+        'email' => 'Your email address',
+        'comment' => 'Comment (required)',
+    ],
+    'submit' => 'Send',
+];

resources/views/feedback.blade.php

@@ -0,0 +1,88 @@
+@if(auth()->user() && session('honeybadger_last_error'))
+    <style>
+        #honeybadger_feedback { padding-left: 2em; padding-right: 2em; min-width: 80%;  color: #9CA3AF; }
+        #honeybadger_feedback_form h2 { line-height: 1.5em; }
+        #honeybadger_feedback_name, #honeybadger_feedback_email, #honeybadger_feedback_comment { width: 100%; padding: 0.5em; }
+        #honeybadger_feedback_comment { height: 10em; }
+        #honeybadger_feedback_submit { color: initial; padding: 0.5em 1em; }
+        #honeybadger_feedback_form .honeybadger-feedback-phone { display: none; }
+        #honeybadger_feedback_link { text-decoration: underline; }
+    </style>
+
+    <script>
+        function honeybadgerFeedbackResponse(data) {
+            if (data['result'] == 'OK') {
+                var form = document.getElementById('honeybadger_feedback_form');
+                var success = document.getElementById('honeybadger_feedback_success');
+
+                form.style.display = 'none';
+                success.style.display = 'block';
+            } else {
+                var message;
+
+                if (data['error']) {
+                    message = data['error'];
+                } else {
+                    message = 'An unknown error occurred. Please try again.';
+                }
+
+                alert(message);
+            }
+        }
+
+        function sendHoneybadgerFeedback() {
+            try {
+                var script = document.createElement('script');
+                var form = document.getElementById('honeybadger_feedback_form');
+                script.src = '{{ $action }}?format=js&token={{ session('honeybadger_last_error') }}&name=' + encodeURIComponent(form.name.value) + '&email=' + encodeURIComponent(form.email.value) + '&comment=' + encodeURIComponent(form.comment.value);
+                form.appendChild(script);
+                return false;
+            } catch(e) {
+                if (window.console) {
+                    console.log('Error caught while processing Honeybadger feedback form: ' + e);
+                    console.log('Submitting form normally...');
+                }
+                return true;
+            }
+        }
+    </script>
+
+    <div id="honeybadger_feedback">
+    <div id="honeybadger_feedback_success" style="display:none;">
+        <p><strong>{{ __('honeybadger::feedback.thanks') }}</strong></p>
+    </div>
+
+    <form action="{{ $action }}" method="POST" id="honeybadger_feedback_form" onsubmit="return sendHoneybadgerFeedback();">
+        <input type="hidden" name="token" id="honeybadger_feedback_token" value="{{ session('honeybadger_last_error') }}">
+
+        <h2>{{ __('honeybadger::feedback.heading') }}</h2>
+        <p>{{ __('honeybadger::feedback.explanation') }}</p>
+
+        <p class="honeybadger-feedback-name">
+            <label for="honeybadger_feedback_name">{{ __('honeybadger::feedback.labels.name') }}</label><br>
+            <input type="text" name="name" id="honeybadger_feedback_name" size="60">
+        </p>
+
+        <p class="honeybadger-feedback-phone">
+            <label for="honeybadger_feedback_phone">{{ __('honeybadger::feedback.labels.phone') }}</label><br>
+            <input type="text" name="phone" id="honeybadger_feedback_phone" size="60">
+        </p>
+
+        <p class="honeybadger-feedback-email">
+            <label for="honeybadger_feedback_email">{{ __('honeybadger::feedback.labels.email') }}</label><br>
+            <input type="email" name="email" id="honeybadger_feedback_email" value="{{ auth()->user()->email ?? '' }}">
+        </p>
+
+        <p class="honeybadger-feedback-comment">
+            <label for="honeybadger_feedback_comment">{{ __('honeybadger::feedback.labels.comment') }}</label><br>
+            <textarea name="comment" id="honeybadger_feedback_comment" cols="50" rows="6" required></textarea>
+        </p>
+
+        <p class="honeybadger-feedback-submit">
+            <input type="submit" id="honeybadger_feedback_submit" value="{{ __('honeybadger::feedback.submit') }}">
+        </p>
+    </form>
+
+    <p><a id="honeybadger_feedback_link" href="https://www.honeybadger.io/" target="_blank" title="Exception, uptime, and performance monitoring for PHP.">Powered by Honeybadger</a></p>
+    </div>
+@endif

resources/views/informer.blade.php

@@ -0,0 +1,5 @@
+@if(session('honeybadger_last_error'))
+    <div class="{{ $class }}">
+        {{ $text }} {{ session('honeybadger_last_error') }}
+    </div>
+@endif

src/HoneybadgerLaravel.php

@@ -6,21 +6,16 @@
 use Honeybadger\Exceptions\ServiceException;
 use Honeybadger\Honeybadger;
 use Illuminate\Support\Facades\Log;
+use Symfony\Component\HttpFoundation\Request;
+use Throwable;
 
-class HoneybadgerLaravel
+class HoneybadgerLaravel extends Honeybadger
 {
     const VERSION = '3.6.0';
 
-    /**
-     * Honeybadger factory.
-     *
-     * @param array $config
-     *
-     * @return \Honeybadger\Contracts\Reporter
-     */
-    public function make(array $config): Reporter
+    public static function make(array $config): Reporter
     {
-        return Honeybadger::new(array_merge([
+        return static::new(array_merge([
             'notifier' => [
                 'name' => 'Honeybadger Laravel',
                 'url' => 'https://github.com/honeybadger-io/honeybadger-laravel',
@@ -31,4 +26,17 @@ public function make(array $config): Reporter
             },
         ], $config));
     }
+
+    public function notify(Throwable $throwable, Request $request = null, array $additionalParams = []): array
+    {
+        $result = parent::notify($throwable, $request, $additionalParams);
+
+        // Persist the most recent error for the rest of the request, so we can display on error page.
+        if (app()->bound('session')) {
+            // Lumen doesn't come with sessions.
+            session()->now('honeybadger_last_error', $result['id'] ?? null);
+        }
+
+        return $result;
+    }
 }

src/HoneybadgerServiceProvider.php

@@ -12,6 +12,7 @@
 use Honeybadger\HoneybadgerLaravel\Commands\HoneybadgerTestCommand;
 use Honeybadger\HoneybadgerLaravel\Contracts\Installer as InstallerContract;
 use Illuminate\Console\Scheduling\Event;
+use Illuminate\Support\Facades\Blade;
 use Illuminate\Support\ServiceProvider;
 
 class HoneybadgerServiceProvider extends ServiceProvider
@@ -28,10 +29,19 @@ public function boot()
 
             $this->publishes([
                 __DIR__.'/../config/honeybadger.php' => base_path('config/honeybadger.php'),
-            ], 'config');
+            ], 'honeybadger-config');
+            $this->publishes([
+                __DIR__.'/../resources/views' => resource_path('views/vendor/honeybadger'),
+            ], 'honeybadger-views');
+            $this->publishes([
+                __DIR__.'/../resources/lang' => resource_path('lang/vendor/honeybadger'),
+            ], 'honeybadger-translations');
         }
 
-        $this->registerMacros();
+        $this->registerEventHooks();
+        $this->loadViewsFrom(__DIR__.'/../resources/views', 'honeybadger');
+        $this->loadTranslationsFrom(__DIR__.'/../resources/lang', 'honeybadger');
+        $this->registerBladeDirectives();
     }
 
     /**
@@ -42,7 +52,7 @@ public function register()
         $this->mergeConfigFrom(__DIR__.'/../config/honeybadger.php', 'honeybadger');
 
         $this->app->singleton(Reporter::class, function ($app) {
-            return (new HoneybadgerLaravel)->make($app['config']['honeybadger']);
+            return HoneybadgerLaravel::make($app['config']['honeybadger']);
         });
 
         $this->app->alias(Reporter::class, Honeybadger::class);
@@ -57,7 +67,7 @@ public function register()
                 throw $e;
             };
 
-            return (new HoneybadgerLaravel)->make($config);
+            return HoneybadgerLaravel::make($config);
         });
 
         $this->app->singleton('honeybadger.isLumen', function () {
@@ -115,9 +125,9 @@ private function bindCommands()
     /**
      * @return void
      */
-    private function registerMacros()
+    private function registerEventHooks()
     {
-        /** @param  string|array|null  $environments */
+        /** @param string|array|null $environments */
         Event::macro('thenPingHoneybadger', function (string $id, $environments = null) {
             return $this->then(function () use ($id, $environments) {
                 if ($environments === null || app()->environment($environments)) {
@@ -126,7 +136,7 @@ private function registerMacros()
             });
         });
 
-        /** @param  string|array|null  $environments */
+        /** @param string|array|null $environments */
         Event::macro('pingHoneybadgerOnSuccess', function (string $id, $environments = null) {
             return $this->onSuccess(function () use ($id, $environments) {
                 if ($environments === null || app()->environment($environments)) {
@@ -135,4 +145,26 @@ private function registerMacros()
             });
         });
     }
+
+    private function registerBladeDirectives()
+    {
+        // Views are not enabled on Lumen by default
+        if (app()->bound('blade.compiler')) {
+            Blade::directive('honeybadgerError', function ($options) {
+                if ($options === '') {
+                    $options = '[]';
+                }
+
+                $defaults = "['class' => 'text-gray-500 text-sm', 'text' => 'Error ID:']";
+
+                return "<?php echo \$__env->make('honeybadger::informer', $options, $defaults)->render(); ?>";
+            });
+
+            Blade::directive('honeybadgerFeedback', function () {
+                $action = rtrim(Honeybadger::API_URL, '/').'/feedback';
+
+                return "<?php echo \$__env->make('honeybadger::feedback', ['action' => '$action'])->render(); ?>";
+            });
+        }
+    }
 }

src/Installer.php

@@ -43,7 +43,7 @@ public function sendTestException(): array
     public function publishLaravelConfig(): bool
     {
         return Artisan::call('vendor:publish', [
-            '--provider' => HoneybadgerServiceProvider::class,
+            '--tag' => 'honeybadger-config',
         ]) === 0;
     }
 

tests/Commands/InstallerTest.php

@@ -4,7 +4,6 @@
 
 use Honeybadger\Contracts\Reporter;
 use Honeybadger\HoneybadgerLaravel\Exceptions\TestException;
-use Honeybadger\HoneybadgerLaravel\HoneybadgerServiceProvider;
 use Honeybadger\HoneybadgerLaravel\Installer;
 use Honeybadger\Tests\TestCase;
 use Illuminate\Support\Facades\Artisan;
@@ -93,17 +92,15 @@ public function publishes_config_for_laravel()
 
         Artisan::shouldReceive('call')
             ->once()
-            ->with('vendor:publish', [
-                '--provider' => HoneybadgerServiceProvider::class,
-            ])->andReturn(0);
+            ->with('vendor:publish', ['--tag' => 'honeybadger-config'])->andReturn(0);
 
         $installer = new Installer($honeybadger);
 
         $this->assertTrue($installer->publishLaravelConfig());
     }
 
     /** @test */
-    public function publish_should_be_configed()
+    public function config_should_be_published()
     {
         $honeybadger = $this->createMock(Reporter::class);