WIP: add events

Author: gehrisandro

composer.json

@@ -19,7 +19,8 @@
         "psr/http-client": "^1.0.3",
         "psr/http-client-implementation": "^1.0.1",
         "psr/http-factory-implementation": "*",
-        "psr/http-message": "^1.1.0|^2.0.0"
+        "psr/http-message": "^1.1.0|^2.0.0",
+        "psr/event-dispatcher": "^1.0.0"
     },
     "require-dev": {
         "guzzlehttp/guzzle": "^7.8.0",

src/Client.php

@@ -5,8 +5,10 @@
 namespace OpenAI;
 
 use OpenAI\Contracts\ClientContract;
+use OpenAI\Contracts\DispatcherContract;
 use OpenAI\Contracts\Resources\ThreadsContract;
 use OpenAI\Contracts\TransporterContract;
+use OpenAI\Events\Dispatcher;
 use OpenAI\Resources\Assistants;
 use OpenAI\Resources\Audio;
 use OpenAI\Resources\Chat;
@@ -26,7 +28,10 @@ final class Client implements ClientContract
     /**
      * Creates a Client instance with the given API token.
      */
-    public function __construct(private readonly TransporterContract $transporter)
+    public function __construct(
+        private readonly TransporterContract $transporter,
+        private readonly DispatcherContract $events,
+    )
     {
         // ..
     }
@@ -151,7 +156,7 @@ public function images(): Images
      */
     public function assistants(): Assistants
     {
-        return new Assistants($this->transporter);
+        return new Assistants($this->transporter, $this->events);
     }
 
     /**

src/Contracts/DispatcherContract.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenAI\Contracts;
+
+use OpenAI\Exceptions\ErrorException;
+use OpenAI\Exceptions\TransporterException;
+use OpenAI\Exceptions\UnserializableResponse;
+use OpenAI\ValueObjects\Transporter\Payload;
+use OpenAI\ValueObjects\Transporter\Response;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * @internal
+ */
+interface DispatcherContract
+{
+    /**
+     * Dispatch an event.
+     */
+    public function dispatch(object $event): void;
+}

src/Events/Dispatcher.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace OpenAI\Events;
+
+use Illuminate\Contracts\Events\Dispatcher as LaravelDispatcher;
+use OpenAI\Contracts\DispatcherContract;
+use Psr\EventDispatcher\EventDispatcherInterface;
+
+class Dispatcher implements DispatcherContract
+{
+    public function __construct(
+        private readonly LaravelDispatcher|EventDispatcherInterface|null $events
+    )
+    {
+    }
+
+    public function dispatch(object $event): void
+    {
+        $this->events?->dispatch($event);
+    }
+}

src/Events/RequestHandled.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace OpenAI\Events;
+
+use OpenAI\Contracts\ResponseContract;
+use OpenAI\Contracts\ResponseStreamContract;
+use OpenAI\ValueObjects\Transporter\Payload;
+
+class RequestHandled
+{
+    public function __construct(
+        public readonly Payload $payload,
+        public readonly ResponseContract|ResponseStreamContract|string $response,
+    )
+    {
+    }
+}

src/Factory.php

@@ -6,11 +6,14 @@
 use Exception;
 use GuzzleHttp\Client as GuzzleClient;
 use Http\Discovery\Psr18ClientDiscovery;
+use Illuminate\Contracts\Events\Dispatcher as LaravelDispatcher;
+use OpenAI\Events\Dispatcher;
 use OpenAI\Transporters\HttpTransporter;
 use OpenAI\ValueObjects\ApiKey;
 use OpenAI\ValueObjects\Transporter\BaseUri;
 use OpenAI\ValueObjects\Transporter\Headers;
 use OpenAI\ValueObjects\Transporter\QueryParams;
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -54,6 +57,8 @@ final class Factory
 
     private ?Closure $streamHandler = null;
 
+    private Dispatcher|EventDispatcherInterface|null $events = null;
+
     /**
      * Sets the API key for the requests.
      */
@@ -126,6 +131,18 @@ public function withQueryParam(string $name, string $value): self
         return $this;
     }
 
+    /**
+     * Set the event dispatcher instance.
+     *
+     * @param LaravelDispatcher|EventDispatcherInterface $events
+     */
+    public function withEventDispatcher(LaravelDispatcher|EventDispatcherInterface $events): self
+    {
+        $this->events = $events;
+
+        return $this;
+    }
+
     /**
      * Creates a new Open AI Client.
      */
@@ -158,7 +175,9 @@ public function make(): Client
 
         $transporter = new HttpTransporter($client, $baseUri, $headers, $queryParams, $sendAsync);
 
-        return new Client($transporter);
+        $dispatcher = new Dispatcher($this->events);
+
+        return new Client($transporter, $dispatcher);
     }
 
     /**

src/Resources/Assistants.php

@@ -6,6 +6,7 @@
 
 use OpenAI\Contracts\Resources\AssistantsContract;
 use OpenAI\Contracts\Resources\AssistantsFilesContract;
+use OpenAI\Events\RequestHandled;
 use OpenAI\Responses\Assistants\AssistantDeleteResponse;
 use OpenAI\Responses\Assistants\AssistantListResponse;
 use OpenAI\Responses\Assistants\AssistantResponse;
@@ -30,7 +31,11 @@ public function create(array $parameters): AssistantResponse
         /** @var Response<array{id: string, object: string, created_at: int, name: ?string, description: ?string, model: string, instructions: ?string, tools: array<int, array{type: 'code_interpreter'}|array{type: 'retrieval'}|array{type: 'function', function: array{description: string, name: string, parameters: array<string, mixed>}}>, file_ids: array<int, string>, metadata: array<string, string>}> $response */
         $response = $this->transporter->requestObject($payload);
 
-        return AssistantResponse::from($response->data(), $response->meta());
+        $response = AssistantResponse::from($response->data(), $response->meta());
+
+        $this->event(new RequestHandled($payload, $response));
+
+        return $response;
     }
 
     /**

src/Resources/Concerns/Transportable.php

@@ -4,15 +4,24 @@
 
 namespace OpenAI\Resources\Concerns;
 
+use OpenAI\Contracts\DispatcherContract;
 use OpenAI\Contracts\TransporterContract;
 
 trait Transportable
 {
     /**
      * Creates a Client instance with the given API token.
      */
-    public function __construct(private readonly TransporterContract $transporter)
+    public function __construct(
+        private readonly TransporterContract $transporter,
+        private readonly DispatcherContract $events,
+    )
     {
         // ..
     }
+
+    public function event(object $event): void
+    {
+        $this->events->dispatch($event);
+    }
 }

src/ValueObjects/Transporter/Payload.php

@@ -24,10 +24,10 @@ final class Payload
      * @param  array<string, mixed>  $parameters
      */
     private function __construct(
-        private readonly ContentType $contentType,
-        private readonly Method $method,
-        private readonly ResourceUri $uri,
-        private readonly array $parameters = [],
+        public readonly ContentType $contentType,
+        public readonly Method $method,
+        public readonly ResourceUri $uri,
+        public readonly array $parameters = [],
     ) {
         // ..
     }