Test errors from the browser console (#6)

README.md

@@ -38,6 +38,20 @@ SENTRY_VUE_INTEGRATION_REPLAY=true
 
 Check out the [sentry/sentry-laravel readme](https://github.com/getsentry/sentry-laravel) for configuration of the laravel package.
 
+## Testing
+
+Errors thrown directly from the browser console don't get caught by Sentry, so you can test whether or not the frontend error reporting works by sending a test error in the browser console with:
+
+```js
+document.dispatchEvent(new Event('sentry-test-error'))
+```
+
+This functionality can be disabled in your `.env`:
+
+```
+SENTRY_VUE_ALLOW_TEST_ERRORS=false
+```
+
 ## License
 
 GNU General Public License v3. Please see [License File](LICENSE) for more information.

config/rapidez/sentry-vue.php

@@ -4,6 +4,7 @@
     // Configuration as defined in the docs: https://docs.sentry.io/platforms/javascript/guides/vue/configuration/
     'configuration' => [
         'enabled' => env('SENTRY_VUE_ENABLED', true),
+        'allow_test_errors' => env('SENTRY_VUE_ALLOW_TEST_ERRORS', true),
 
         // Amount of errors to be logged to sentry (1.00 = 100%)
         'sampleRate' => env('SENTRY_VUE_SAMPLE_RATE', 100) / 100,

resources/js/sentry.js

@@ -48,3 +48,10 @@ document.addEventListener('turbo:load', async () => {
     window.app.$on(['logged-in', 'logout'], () => setUser(window.app.user))
     setUser(window.app.user)
 })
+
+// Allow test errors to be sent from the browser console with `document.dispatchEvent(new Event('sentry-test-error'))`
+if(window.config.sentry.configuration.allow_test_errors) {
+    document.addEventListener('sentry-test-error', () => {
+        throw new Error('Sentry test error')
+    })
+}