fix(OpenAI): prevent registration of headers on all requests (#688)

* fix(OpenAI): prevent registration of headers on all requests

* chore: add test for addHeader

Author: iBotPeaches

src/Contracts/TransporterContract.php

@@ -17,6 +17,11 @@
  */
 interface TransporterContract
 {
+    /**
+     * Adds a custom header that will be included in all subsequent requests.
+     */
+    public function addHeader(string $name, string $value): self;
+
     /**
      * Sends a request to a server expecting an object back.
      *

src/OpenAI.php

@@ -16,7 +16,6 @@ public static function client(string $apiKey, ?string $organization = null, ?str
             ->withApiKey($apiKey)
             ->withOrganization($organization)
             ->withProject($project)
-            ->withHttpHeader('OpenAI-Beta', 'assistants=v2')
             ->make();
     }
 

src/Resources/Assistants.php

@@ -27,7 +27,9 @@ public function create(array $parameters): AssistantResponse
         $payload = Payload::create('assistants', $parameters);
 
         /** @var Response<array{id: string, object: string, created_at: int, name: ?string, reasoning_effort?: ?string, description: ?string, model: string, instructions: ?string, tools: array<int, array{type: 'code_interpreter'}|array{type: 'file_search'}|array{type: 'function', function: array{description: string, name: string, parameters: array<string, mixed>}}>, tool_resources: array{code_interpreter?: array{file_ids: array<int,string>}, file_search?: array{vector_store_ids: array<int,string>}}, metadata: array<string, string>, temperature: ?float, top_p: ?float, response_format: string|array{type: 'text'|'json_object'}}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return AssistantResponse::from($response->data(), $response->meta());
     }
@@ -42,7 +44,9 @@ public function retrieve(string $id): AssistantResponse
         $payload = Payload::retrieve('assistants', $id);
 
         /** @var Response<array{id: string, object: string, created_at: int, name: ?string, reasoning_effort?: ?string, description: ?string, model: string, instructions: ?string, tools: array<int, array{type: 'code_interpreter'}|array{type: 'file_search'}|array{type: 'function', function: array{description: string, name: string, parameters: array<string, mixed>}}>, tool_resources: array{code_interpreter?: array{file_ids: array<int,string>}, file_search?: array{vector_store_ids: array<int,string>}}, metadata: array<string, string>, temperature: ?float, top_p: ?float, response_format: string|array{type: 'text'|'json_object'}}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return AssistantResponse::from($response->data(), $response->meta());
     }
@@ -59,7 +63,9 @@ public function modify(string $id, array $parameters): AssistantResponse
         $payload = Payload::modify('assistants', $id, $parameters);
 
         /** @var Response<array{id: string, object: string, created_at: int, name: ?string, reasoning_effort?: ?string, description: ?string, model: string, instructions: ?string, tools: array<int, array{type: 'code_interpreter'}|array{type: 'file_search'}|array{type: 'function', function: array{description: string, name: string, parameters: array<string, mixed>}}>, tool_resources: array{code_interpreter?: array{file_ids: array<int,string>}, file_search?: array{vector_store_ids: array<int,string>}}, metadata: array<string, string>, temperature: ?float, top_p: ?float, response_format: string|array{type: 'text'|'json_object'}}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return AssistantResponse::from($response->data(), $response->meta());
     }
@@ -74,7 +80,9 @@ public function delete(string $id): AssistantDeleteResponse
         $payload = Payload::delete('assistants', $id);
 
         /** @var Response<array{id: string, object: string, deleted: bool}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return AssistantDeleteResponse::from($response->data(), $response->meta());
     }
@@ -91,7 +99,9 @@ public function list(array $parameters = []): AssistantListResponse
         $payload = Payload::list('assistants', $parameters);
 
         /** @var Response<array{object: string, data: array<int, array{id: string, object: string, created_at: int, name: ?string, reasoning_effort?: ?string, description: ?string, model: string, instructions: ?string, tools: array<int, array{type: 'code_interpreter'}|array{type: 'file_search'}|array{type: 'function', function: array{description: string, name: string, parameters: array<string, mixed>}}>, tool_resources: array{code_interpreter?: array{file_ids: array<int,string>}, file_search?: array{vector_store_ids: array<int,string>}}, metadata: array<string, string>, temperature: ?float, top_p: ?float, response_format: string|array{type: 'text'|'json_object'}}>, first_id: ?string, last_id: ?string, has_more: bool}> $response */
-        $response = $this->transporter->requestObject($payload);
+        $response = $this->transporter
+            ->addHeader('OpenAI-Beta', 'assistants=v2')
+            ->requestObject($payload);
 
         return AssistantListResponse::from($response->data(), $response->meta());
     }

src/Transporters/HttpTransporter.php

@@ -34,13 +34,23 @@ final class HttpTransporter implements TransporterContract
     public function __construct(
         private readonly ClientInterface $client,
         private readonly BaseUri $baseUri,
-        private readonly Headers $headers,
+        private Headers $headers,
         private readonly QueryParams $queryParams,
         private readonly Closure $streamHandler,
     ) {
         // ..
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function addHeader(string $name, string $value): self
+    {
+        $this->headers = $this->headers->withCustomHeader($name, $value);
+
+        return $this;
+    }
+
     /**
      * {@inheritDoc}
      */

tests/Pest.php

@@ -15,6 +15,11 @@ function mockClient(string $method, string $resource, array $params, Response|Ad
 {
     $transporter = Mockery::mock(TransporterContract::class);
 
+    $transporter
+        ->shouldReceive('addHeader')
+        ->zeroOrMoreTimes()
+        ->andReturnSelf();
+
     $transporter
         ->shouldReceive($methodName)
         ->once()

tests/Transporters/HttpTransporter.php

@@ -602,3 +602,25 @@
                 ->and($e->getErrorType())->toBe('invalid_request_error');
         });
 });
+
+test('addHeader does not blow out headers when adding one', function () {
+    $payload = Payload::list('models');
+
+    $this->http->addHeader('X-Test', '1');
+
+    $response = new Response(200, ['Content-Type' => 'application/json; charset=utf-8', ...metaHeaders()], json_encode(['ok' => true]));
+
+    $this->client
+        ->shouldReceive('sendRequest')
+        ->once()
+        ->withArgs(function (Psr7Request $request) {
+            expect($request->getHeaderLine('Authorization'))->toBe('Bearer foo')
+                ->and($request->getHeaderLine('Content-Type'))->toBe('application/json')
+                ->and($request->getHeaderLine('X-Test'))->toBe('1');
+
+            return true;
+        })
+        ->andReturn($response);
+
+    $this->http->requestObject($payload);
+});