Initialize Sentry Laravel Serverless package with core functionality, middleware customization, and basic package setup.

Author: datpmwork

.gitignore

@@ -0,0 +1,5 @@
+/vendor/
+.phpunit.result.cache
+composer.lock
+.idea/
+.vscode/

README.md

@@ -1 +1,21 @@
-# sentry-laravel-serverless
+# Sentry Laravel Serverless
+
+Laravel package for Sentry integration in serverless environments.
+
+## Installation
+
+You can install the package via composer:
+
+## Usage
+
+After installing the package, publish the configuration file:
+
+## Configuration
+
+Configure the package in your `.env` file:
+
+## Testing
+
+## License
+
+The MIT License (MIT).

composer.json

@@ -0,0 +1,30 @@
+{
+    "name": "datpmwork/sentry-laravel-serverless",
+    "description": "Sentry integration for Laravel in serverless (bref) environments",
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "DatPM\\Sentry\\Serverless\\": "src/"
+        }
+    },
+    "require": {
+        "php": "^7.4|^8.0",
+        "laravel/framework": "^8.0|^9.0|^10.0",
+        "sentry/sentry-laravel": "^3.0"
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "DatPM\\Sentry\\Serverless\\ServiceProvider"
+            ]
+        }
+    },
+    "minimum-stability": "stable",
+    "prefer-stable": true,
+    "config": {
+        "allow-plugins": {
+            "php-http/discovery": true
+        }
+    }
+}

src/Middlewares/ServerlessSentryMiddleware.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace DatPM\Sentry\Serverless\Middlewares;
+
+use Closure;
+use Sentry\State\Scope;
+use Illuminate\Http\Request;
+use Sentry\Laravel\Integration;
+use Sentry\Laravel\Tracing\Middleware;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Contracts\Auth\Authenticatable;
+use Illuminate\Contracts\Container\BindingResolutionException;
+
+class ServerlessSentryMiddleware extends Middleware
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param \Closure $next
+     *
+     * @return mixed
+     */
+    public function handle(Request $request, Closure $next)
+    {
+        $response = parent::handle($request, $next);
+
+        $this->setUserData(auth()->user());
+
+        return $response;
+    }
+
+    protected function setUserData($authUser)
+    {
+        if (!$authUser instanceof Model) {
+            return;
+        }
+
+        // If the user is a Laravel Eloquent model we try to extract some common fields from it
+        $userData = [
+            'id' => $authUser instanceof Authenticatable
+                ? $authUser->getAuthIdentifier()
+                : $authUser->getKey(),
+            'email' => $authUser->getAttribute('email') ?? $authUser->getAttribute('mail'),
+        ];
+
+        try {
+            /** @var \Illuminate\Http\Request $request */
+            $request = app()->make('request');
+
+            if ($request instanceof Request) {
+                $ipAddress = $request->ip();
+
+                if ($ipAddress !== null) {
+                    $userData['ip_address'] = $ipAddress;
+                }
+            }
+        } catch (BindingResolutionException $e) {
+            // If there is no request bound we cannot get the IP address from it
+        }
+
+        Integration::configureScope(static function (Scope $scope) use ($userData): void {
+            $scope->setUser(array_filter($userData));
+        });
+    }
+
+    public function terminate(Request $request, $response): void
+    {
+        # Do nothing when the application is terminating
+        return;
+    }
+
+    /**
+     * @param Request $request
+     * @param $response
+     * @return void
+     */
+    public function parentTerminate(Request $request, $response)
+    {
+        parent::terminate($request, $response);
+    }
+}
+

src/ServiceProvider.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace DatPM\Sentry\Serverless;
+
+use Sentry\Laravel\Tracing\Middleware;
+use Illuminate\Support\ServiceProvider as BaseServiceProvider;
+use DatPM\Sentry\Serverless\Middlewares\ServerlessSentryMiddleware;
+
+class ServiceProvider extends BaseServiceProvider
+{
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        # Overwrite default Middleware class of Sentry
+        # Default sentry will send APM in terminate step, after the FPM response was sent
+        # Our customization will send the APM when RequestHandled is triggered
+        # When this event is dispatched, we will call `parentTerminate` method of SentryTracingMiddleware to send
+        # The default `terminate` will be rewritten as empty
+        $this->app->bind(Middleware::class, ServerlessSentryMiddleware::class, true);
+    }
+}