wip

Author: StanBarrows

.phpunit.cache/test-results

@@ -1,9 +1,12 @@
 # Laravel Azure Event Hub
 
-[![PHPStan](https://github.com/codebar-ag/laravel-azure-event-hub/workflows/PHPStan%20Static%20Analysis/badge.svg)](https://github.com/codebar-ag/laravel-azure-event-hub/actions/workflows/phpstan.yml)
-[![PHP Version](https://img.shields.io/badge/PHP-8.4%2B-blue.svg)](https://php.net/)
+[![Packagist Version](https://img.shields.io/packagist/v/codebar-ag/laravel-azure-event-hub.svg)](https://packagist.org/packages/codebar-ag/laravel-azure-event-hub)
+[![Downloads](https://img.shields.io/packagist/dt/codebar-ag/laravel-azure-event-hub.svg)](https://packagist.org/packages/codebar-ag/laravel-azure-event-hub/stats)
+[![License](https://img.shields.io/packagist/l/codebar-ag/laravel-azure-event-hub.svg)](https://github.com/codebar-ag/laravel-azure-event-hub/blob/main/LICENSE)
+[![PHP Version](https://img.shields.io/badge/PHP-8.4%2B-blue.svg)](https://www.php.net/)
 [![Laravel Version](https://img.shields.io/badge/Laravel-12.0%2B-red.svg)](https://laravel.com/)
 [![Pest Tests](https://github.com/codebar-ag/laravel-azure-event-hub/workflows/Pest%20Tests/badge.svg)](https://github.com/codebar-ag/laravel-azure-event-hub/actions/workflows/pest.yml)
+[![PHPStan](https://github.com/codebar-ag/laravel-azure-event-hub/workflows/PHPStan%20Static%20Analysis/badge.svg)](https://github.com/codebar-ag/laravel-azure-event-hub/actions/workflows/phpstan.yml)
 
 This package primarily provides an event_log functionality for logging HTTP requests and model events. It also provides a connector to send those events to Azure Event Hub, but you need to process them by yourself in the packages.
 
@@ -37,7 +40,7 @@ composer require codebar-ag/laravel-azure-event-hub
 php artisan vendor:publish --provider="CodebarAg\LaravelAzureEventHub\LaravelAzureEventHubServiceProvider"
 ```
 
-This will publish the configuration file to `config/azure-event-hub.php` where you can customize the package settings.
+This will publish the configuration file to `config/laravel-azure-event-hub.php` where you can customize the package settings.
 
 ## Usage
 
@@ -48,7 +51,7 @@ The `EventLogMiddleware` automatically logs all HTTP requests. Add it to your La
 #### Configuration
 
 ```php
-// config/azure-event-hub.php
+// config/laravel-azure-event-hub.php
 return [
     'exclude_routes' => [
         'livewire.update',
@@ -125,12 +128,12 @@ The package provides an action to send event logs to Azure Event Hub. You can pr
 Add your Azure Event Hub credentials to the published config file:
 
 ```php
-// config/azure-event-hub.php
+// config/laravel-azure-event-hub.php
 return [
-    'enabled' => env('AZURE_EVENT_HUB_ENABLED', true),
+    'enabled' => env('AZURE_EVENT_HUB_ENABLED', false),
     'endpoint' => env('AZURE_EVENT_HUB_ENDPOINT'),
     'path' => env('AZURE_EVENT_HUB_PATH'),
-    'policy_name' => env('AZURE_EVENT_HUB_POLICY_NAME'),
+    'policy_name' => env('AZURE_EVENT_HUB_POLICY'),
     'primary_key' => env('AZURE_EVENT_HUB_PRIMARY_KEY'),
     // ... other config options
 ];
@@ -142,10 +145,24 @@ return [
 AZURE_EVENT_HUB_ENABLED=true
 AZURE_EVENT_HUB_ENDPOINT=https://your-namespace.servicebus.windows.net
 AZURE_EVENT_HUB_PATH=your-event-hub-name
-AZURE_EVENT_HUB_POLICY_NAME=RootManageSharedAccessKey
+AZURE_EVENT_HUB_POLICY=RootManageSharedAccessKey
 AZURE_EVENT_HUB_PRIMARY_KEY=your-primary-key
 ```
 
+#### Available Methods
+
+- **`(new AzureEventHubAction())->send(EventLog $eventLog): void`**: Sends a single `CodebarAg\LaravelAzureEventHub\Models\EventLog` to Azure Event Hub using the REST API. The payload is the model's `toArray()` encoded as JSON and sent to `.../messages?api-version=2014-01` with a SAS token in the `Authorization` header. Returns `void`. Recommended to guard calls with `config('laravel-azure-event-hub.enabled')` and to handle idempotency (e.g., `synced_at`) in your job.
+
+Minimal usage example:
+
+```php
+use CodebarAg\LaravelAzureEventHub\Actions\AzureEventHubAction;
+use CodebarAg\LaravelAzureEventHub\Models\EventLog;
+
+// Send one event (instance API)
+(new AzureEventHubAction())->sendEvent($eventLog); // $eventLog is an instance of EventLog
+```
+
 #### Example Implementation
 
 Create a job to process and send event logs to Azure Event Hub:
@@ -170,7 +187,7 @@ class ProcessAzureEventJob implements ShouldQueue
 
     public function handle(): void
     {
-        $enabled = config('azure-event-hub.enabled');
+        $enabled = config('laravel-azure-event-hub.enabled');
 
         if (!$enabled) {
             return;
@@ -180,8 +197,8 @@ class ProcessAzureEventJob implements ShouldQueue
             return;
         }
 
-        // Send to Azure Event Hub using the DTO
-        AzureEventHubAction::send(eventLog: $this->eventLog);
+        // Send to Azure Event Hub
+        (new AzureEventHubAction())->sendEvent(eventLog: $this->eventLog);
 
         // Mark as synced
         $this->eventLog->update([

README.md

@@ -2,14 +2,8 @@ parameters:
     level: 9
     paths:
         - src
-    excludePaths:
-        - tests
     treatPhpDocTypesAsCertain: false
     ignoreErrors:
-        - '#Class.*uses generic trait Illuminate\\Database\\Eloquent\\Factories\\HasFactory but does not specify its types#'
-        - '#Function config not found#'
-        - '#Function config_path not found#'
-        - '#Call to method getName\(\) on an unknown class Illuminate\\Routing\\Route#'
-        - '#Call to an undefined static method CodebarAg\\LaravelAzureEventHub\\Models\\EventLog::create\(\)#'
-        - '#Access to an undefined property Illuminate\\Contracts\\Auth\\Authenticatable::\$id#'
-        - '#Trait CodebarAg\\LaravelAzureEventHub\\Traits\\HasEventLogTrait is used zero times#'
+        -
+            identifier: trait.unused
+            path: src/Traits/HasEventLogTrait.php

phpstan.neon

@@ -7,43 +7,25 @@
 
 class AzureEventHubAction
 {
-    /**
-     * Send one event to Azure Event Hubs via REST.
-     *
-     * @param  EventLog  $event
-     */
-    public static function send(EventLog $eventLog): void
-    {
-        $endpoint = rtrim((string) config('laravel-azure-event-hub.endpoint'), '/');
-        $hub = trim((string) config('laravel-azure-event-hub.path'), '/');
+    private string $endpoint;
 
-        $resource = self::resource($endpoint, $hub);
-        $postUrl = "{$resource}/messages?api-version=2014-01";
+    private string $hub;
 
-        $token = self::token($resource);
+    private string $policy;
 
-        Http::retry(3, 500)
-            ->withHeaders([
-                'Authorization' => $token,
-                'Content-Type' => 'application/json',
-            ])
-            ->withBody(json_encode($eventLog->toArray(), JSON_UNESCAPED_SLASHES) ?: '{}', 'application/json')
-            ->post($postUrl);
-    }
+    private string $primaryKey;
 
-    /**
-     * Build (cached) SAS token for the given Event Hub resource.
-     */
-    public static function token(string $resource): string
+    public function __construct()
     {
-        $policy = (string) config('laravel-azure-event-hub.policy_name');
-        $key = (string) config('laravel-azure-event-hub.primary_key');
-        $encodedResource = rawurlencode($resource);
-        $expiry = time() + 7200; // 1 hour
-        $stringToSign = $encodedResource."\n".$expiry;
-        $signature = rawurlencode(base64_encode(hash_hmac('sha256', $stringToSign, $key, true)));
+        $endpointConfig = config('laravel-azure-event-hub.endpoint');
+        $hubConfig = config('laravel-azure-event-hub.path');
+        $policyConfig = config('laravel-azure-event-hub.policy_name');
+        $keyConfig = config('laravel-azure-event-hub.primary_key');
 
-        return "SharedAccessSignature sr={$encodedResource}&sig={$signature}&se={$expiry}&skn={$policy}";
+        $this->endpoint = is_string($endpointConfig) ? rtrim($endpointConfig, '/') : '';
+        $this->hub = is_string($hubConfig) ? trim($hubConfig, '/') : '';
+        $this->policy = is_string($policyConfig) ? $policyConfig : '';
+        $this->primaryKey = is_string($keyConfig) ? $keyConfig : '';
     }
 
     private static function resource(string $endpoint, string $hub): string
@@ -55,4 +37,34 @@ private static function resource(string $endpoint, string $hub): string
 
         return "{$scheme}://{$host}/{$hub}";
     }
+
+    public function resourceUrl(): string
+    {
+        return self::resource($this->endpoint, $this->hub);
+    }
+
+    public function buildToken(): string
+    {
+        $resource = $this->resourceUrl();
+        $encodedResource = rawurlencode($resource);
+        $expiry = time() + 7200; // 1 hour
+        $stringToSign = $encodedResource."\n".$expiry;
+        $signature = rawurlencode(base64_encode(hash_hmac('sha256', $stringToSign, $this->primaryKey, true)));
+
+        return "SharedAccessSignature sr={$encodedResource}&sig={$signature}&se={$expiry}&skn={$this->policy}";
+    }
+
+    public function send(EventLog $eventLog): void
+    {
+        $resource = $this->resourceUrl();
+        $postUrl = "{$resource}/messages?api-version=2014-01";
+
+        Http::retry(3, 500)
+            ->withHeaders([
+                'Authorization' => $this->buildToken(),
+                'Content-Type' => 'application/json',
+            ])
+            ->withBody(json_encode($eventLog->toArray(), JSON_UNESCAPED_SLASHES) ?: '{}', 'application/json')
+            ->post($postUrl);
+    }
 }

src/Actions/AzureEventHubAction.php

@@ -49,7 +49,7 @@ public static function fromEventLog(EventLog $eventLog): self
             event: $eventLog->event instanceof EventLogEventEnum ? $eventLog->event : null,
             event_data: $eventLog->event_data,
             context: $eventLog->context,
-            created_at: $eventLog->created_at ? $eventLog->created_at->toDateTimeString() : null,
+            created_at: $eventLog->created_at->toDateTimeString(),
         );
     }
 

src/DTO/AzureEventHubDTO.php

@@ -23,21 +23,34 @@ public function handle(Request $request, Closure $next): Response
         $user = Auth::user();
 
         // Allow disabling via config; default true in package tests
-        $enabled = config('laravel-azure-event-hub.enabled', true);
+        $enabled = (bool) config('laravel-azure-event-hub.enabled', true);
         if (! $enabled) {
             return $next($request);
         }
 
-        $excludeRoutes = config('laravel-azure-event-hub.exclude_routes', []);
+        $excludeRoutesConfig = config('laravel-azure-event-hub.exclude_routes', []);
+        $excludeRoutes = is_array($excludeRoutesConfig)
+            ? array_values(array_filter($excludeRoutesConfig, static fn ($v): bool => is_string($v)))
+            : [];
         $route = $request->route();
-        $currentRouteName = $route ? $route->getName() : null;
+        $currentRouteNameRaw = $route ? $route->getName() : null;
+        $currentRouteName = is_string($currentRouteNameRaw) ? $currentRouteNameRaw : null;
 
-        if ($currentRouteName && in_array($currentRouteName, $excludeRoutes)) {
+        if ($currentRouteName !== null && in_array($currentRouteName, $excludeRoutes, true)) {
             return $next($request);
         }
 
-        $requestHeadersToRemove = config('laravel-azure-event-hub.sanitize.request_headers_exclude', []);
-        $requestDataToRemove = config('laravel-azure-event-hub.sanitize.request_data_exclude', []);
+        $headersExcludeConfig = config('laravel-azure-event-hub.sanitize.request_headers_exclude', []);
+        $dataExcludeConfig = config('laravel-azure-event-hub.sanitize.request_data_exclude', []);
+
+        /** @var array<int, string> $requestHeadersToRemove */
+        $requestHeadersToRemove = is_array($headersExcludeConfig)
+            ? array_values(array_filter($headersExcludeConfig, static fn ($v): bool => is_string($v)))
+            : [];
+        /** @var array<int, string> $requestDataToRemove */
+        $requestDataToRemove = is_array($dataExcludeConfig)
+            ? array_values(array_filter($dataExcludeConfig, static fn ($v): bool => is_string($v)))
+            : [];
 
         EventLog::create([
             'type' => EventLogTypeEnum::HTTP,

src/Middleware/EventLogMiddleware.php

@@ -13,7 +13,7 @@
 /**
  * @property int $id
  * @property string $uuid
- * @property EventLogTypeEnum $type
+ * @property EventLogTypeEnum|null $type
  * @property string|null $subject_type
  * @property int|null $subject_id
  * @property string|null $user_type
@@ -30,9 +30,14 @@
  * @property \Carbon\Carbon|null $synced_at
  * @property \Carbon\Carbon $created_at
  * @property \Carbon\Carbon $updated_at
+ *
+ * @use HasFactory<EventLogFactory>
  */
 class EventLog extends Model
 {
+    /**
+     * @use HasFactory<EventLogFactory>
+     */
     use HasFactory;
 
     protected $fillable = [
@@ -54,7 +59,7 @@ class EventLog extends Model
         'synced_at',
     ];
 
-    /** @var array<string, mixed> */
+    /** @var array<string, string> */
     protected $casts = [
         'request_headers' => 'array',
         'request_data' => 'array',
@@ -83,7 +88,7 @@ public function toArray(): array
     /**
      * Create a new factory instance for the model.
      */
-    protected static function newFactory()
+    protected static function newFactory(): EventLogFactory
     {
         return EventLogFactory::new();
     }

src/Models/EventLog.php

@@ -7,8 +7,7 @@
 use Illuminate\Support\Facades\Http;
 
 test('azure event hub action can generate token', function () {
-    $resource = 'https://test-namespace.servicebus.windows.net/test-event-hub';
-    $token = AzureEventHubAction::token($resource);
+    $token = (new AzureEventHubAction)->buildToken();
 
     expect($token)->toContain('SharedAccessSignature');
     expect($token)->toContain('sr=');
@@ -33,7 +32,7 @@
     ]);
 
     // This should not throw an exception
-    expect(fn () => AzureEventHubAction::send($eventLog))->not->toThrow(\Throwable::class);
+    expect(fn () => (new AzureEventHubAction)->send($eventLog))->not->toThrow(\Throwable::class);
 });
 
 test('azure event hub action handles malformed data gracefully', function () {
@@ -42,10 +41,12 @@
         'https://test-namespace.servicebus.windows.net/test-event-hub/messages*' => Http::response('OK', 200),
     ]);
 
+    /** @var mixed $malformedData */
     $malformedData = null;
 
     // Should handle null data gracefully
-    expect(fn () => AzureEventHubAction::send($malformedData))->toThrow(\TypeError::class);
+    expect(fn () => (new AzureEventHubAction)->send($malformedData)) // @phpstan-ignore-line
+        ->toThrow(\TypeError::class);
 });
 
 test('azure event hub configuration is properly loaded', function () {