Add frontend and backend integrations

README.md

@@ -5,17 +5,6 @@
 [![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/astrogoat/sentry/Check%20&%20fix%20styling?label=code%20style)](https://github.com/astrogoat/sentry/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/astrogoat/sentry.svg?style=flat-square)](https://packagist.org/packages/astrogoat/sentry)
 
----
-This repo can be used to scaffold a Strata CMS App package. Follow these steps to get started:
-
-1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this sentry
-2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files
-3. Remove this block of text.
-4. Have fun creating your package.
----
-
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
 ## Installation
 
 You can install the package via composer:
@@ -24,13 +13,6 @@ You can install the package via composer:
 composer require astrogoat/sentry
 ```
 
-## Usage
-
-```php
-$sentry = new Astrogoat\Sentry();
-echo $sentry->echoPhrase('Hello, Astrogoat!');
-```
-
 ## Testing
 
 ```bash

config/sentry.php

@@ -1,15 +1,57 @@
 <?php
-// config for Astrogoat/Sentry
 
 return [
-    /*
-     * If you want to override the automatic injection of views
-     * into some areas of your application so you to include
-     * them yourself then you disable each in this array.
-     */
-    'include-frontend-views' => [
-        'head' => true,
-        'body' => true,
-        'end' => true,
-    ]
+
+    'dsn' => env('SENTRY_LARAVEL_DSN', env('SENTRY_DSN')),
+
+    // 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,
+
+        // Capture SQL queries in breadcrumbs
+        'sql_queries' => true,
+
+        // Capture bindings on SQL queries logged in breadcrumbs
+        'sql_bindings' => true,
+
+        // Capture queue job information in breadcrumbs
+        'queue_info' => true,
+
+        // Capture command information in breadcrumbs
+        'command_info' => true,
+    ],
+
+    'tracing' => [
+        // Trace queue jobs as their own transactions
+        'queue_job_transactions' => env('SENTRY_TRACE_QUEUE_ENABLED', false),
+
+        // Capture queue jobs as spans when executed on the sync driver
+        'queue_jobs' => true,
+
+        // Capture SQL queries as spans
+        'sql_queries' => true,
+
+        // Try to find out where the SQL query originated from and add it to the query spans
+        'sql_origin' => true,
+
+        // Capture views as spans
+        'views' => true,
+
+        // Indicates if the tracing integrations supplied by Sentry should be loaded
+        'default_integrations' => true,
+    ],
+
+    // @see: https://docs.sentry.io/platforms/php/configuration/options/#send-default-pii
+    'send_default_pii' => env('SENTRY_SEND_DEFAULT_PII', false),
+
+    'traces_sample_rate' => (float) (env('SENTRY_TRACES_SAMPLE_RATE', 0.0)),
+
+    'controllers_base_namespace' => env('SENTRY_CONTROLLERS_BASE_NAMESPACE', 'App\\Http\\Controllers'),
+
 ];

mix-manifest.json

@@ -1,4 +1,3 @@
 {
-    "/public/js/sentry.js": "/public/js/sentry.js",
-    "/public/css/sentry.css": "/public/css/sentry.css"
+    "/public/js/sentry.js": "/public/js/sentry.js"
 }

package.json

@@ -36,5 +36,8 @@
     "devDependencies": {
         "laravel-mix": "^6.0.49",
         "tailwindcss": "^3.4.1"
+    },
+    "dependencies": {
+        "@sentry/browser": "^7.108.0"
     }
 }

resources/js/sentry.js

@@ -1 +1,3 @@
-// Javascript file for sentry
+import * as Sentry from "@sentry/browser";
+
+window.Sentry = Sentry;

resources/views/backend.blade.php

@@ -0,0 +1,42 @@
+@if(app()->bound('sentry') && Astrogoat\Sentry\Settings\SentrySettings::isEnabled())
+    @php $user = auth()->user(); @endphp
+    <script src="{{ asset('vendor/sentry/js/sentry.js') }}" defer></script>
+    <script>
+        document.addEventListener('DOMContentLoaded', () => {
+            Sentry.setUser({
+                email: "{{ $user->email }}",
+                fullName: "{{ $user->name }}",
+            });
+
+            Sentry.init({
+                dsn: "{{ config('sentry.dsn') }}",
+                environment: "{{ app()->environment() }}",
+
+                beforeSend(event, hint) {
+                    // Check if it is an exception, and if so, show the report dialog
+                    if (event.exception && event.event_id) {
+                        Sentry.showReportDialog({ eventId: event.event_id });
+                    }
+
+                    return event;
+                },
+                integrations: [
+                    Sentry.feedbackIntegration({
+                        // Additional SDK configuration goes in here, for example:
+                        colorScheme: "system",
+                        showName: false,
+                        showEmail: false,
+                        useSentryUser: {
+                            email: "email",
+                            name: "fullName",
+                        },
+                    }),
+
+                    Sentry.browserTracingIntegration(),
+                ],
+
+                tracesSampleRate: {{ config('sentry.traces_sample_rate', 0.0) }},
+            });
+        });
+    </script>
+@endif

resources/views/frontend.blade.php

@@ -0,0 +1,17 @@
+@if(app()->bound('sentry') && Astrogoat\Sentry\Settings\SentrySettings::isEnabled())
+    <script src="{{ asset('vendor/sentry/js/sentry.js') }}" defer></script>
+    <script>
+        document.addEventListener('DOMContentLoaded', () => {
+            Sentry.init({
+                dsn: "{{ config('sentry.dsn') }}",
+                environment: "{{ app()->environment() }}",
+
+                integrations: [
+                    Sentry.browserTracingIntegration(),
+                ],
+
+                tracesSampleRate: {{ config('sentry.traces_sample_rate', 0.0) }},
+            });
+        });
+    </script>
+@endif

src/Middleware/AddAdditionalSentryInfo.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Astrogoat\Sentry\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+use Astrogoat\Sentry\Settings\SentrySettings;
+use Symfony\Component\HttpFoundation\Response;
+
+class AddAdditionalSentryInfo
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Closure(\Illuminate\Http\Request): (\Illuminate\Http\Response|\Illuminate\Http\RedirectResponse)  $next
+     */
+    public function handle(Request $request, Closure $next): Response
+    {
+        if (app()->bound('sentry') && SentrySettings::isEnabled()) {
+            \Sentry\configureScope(function (\Sentry\State\Scope $scope): void {
+                $scope->setTag('tenant.name', tenant()->name ?? 'Central');
+                $scope->setTag('tenant.id', tenant()->id ?? 'central');
+
+                if (auth()->check()) {
+                    $user = auth()->user();
+
+                    $scope->setUser([
+                        'id' => $user->id,
+                        'username' => $user->name,
+                        'email' => $user->email,
+                        'strata_user_id' => strata_user_id(),
+                    ]);
+                } else {
+                    $scope->setUser([
+                        'id' => strata_user_id(),
+                    ]);
+                }
+            });
+        }
+
+        return $next($request);
+    }
+}

src/SentryServiceProvider.php

@@ -2,11 +2,17 @@
 
 namespace Astrogoat\Sentry;
 
+use Exception;
 use Helix\Lego\Apps\App;
 use Helix\Lego\LegoManager;
+use Illuminate\Routing\Router;
 use Spatie\LaravelPackageTools\Package;
+use Helix\Lego\Providers\RouteServiceProvider;
+use Helix\Lego\Apps\Services\IncludeBackendViews;
+use Helix\Lego\Apps\Services\IncludeFrontendViews;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 use Astrogoat\Sentry\Settings\SentrySettings;
+use Astrogoat\Sentry\Middleware\AddAdditionalSentryInfo;
 
 class SentryServiceProvider extends PackageServiceProvider
 {
@@ -19,6 +25,12 @@ public function registerApp(App $app)
                 __DIR__ . '/../database/migrations',
                 __DIR__ . '/../database/migrations/settings',
             ])
+            ->includeFrontendViews(function (IncludeFrontendViews $frontendViews) {
+                return $frontendViews->addToHead('sentry::frontend');
+            })
+            ->includeBackendViews(function (IncludeBackendViews $backendViews) {
+                return $backendViews->addToHead('sentry::backend');
+            })
             ->backendRoutes(__DIR__.'/../routes/backend.php')
             ->frontendRoutes(__DIR__.'/../routes/frontend.php');
     }
@@ -30,6 +42,17 @@ public function registeringPackage()
         });
     }
 
+    public function bootingPackage()
+    {
+        resolve(Router::class)->pushMiddlewareToGroup(RouteServiceProvider::MIDDLEWARE_GROUP_FRONTEND, AddAdditionalSentryInfo::class);
+
+        if ($this->app->runningInConsole()) {
+            $this->publishes([
+                __DIR__.'/../public' => public_path('vendor/sentry/'),
+            ], 'sentry-assets');
+        }
+    }
+
     public function configurePackage(Package $package): void
     {
         $package->name('sentry')->hasConfigFile()->hasViews();