feat: Introduce local ChromaDB server management for testing

Author: CodeWithKyrian

.github/workflows/test.yml

@@ -14,25 +14,15 @@ jobs:
 
     name: Tests on PHP ${{ matrix.php }} - ${{ matrix.dependency-version }}
 
-    services:
-      chroma-wo-auth:
-        image: chromadb/chroma:1.0.8
-        ports:
-          - 8000:8000
-
-      chroma-w-auth:
-        image: chromadb/chroma:1.0.8
-        ports:
-          - 8001:8000
-        env:
-          CHROMA_SERVER_AUTHN_CREDENTIALS: 'test-token'
-          CHROMA_SERVER_AUTHN_PROVIDER: 'chromadb.auth.token_authn.TokenAuthenticationServerProvider'
-          CHROMA_AUTH_TOKEN_TRANSPORT_HEADER: 'Authorization'
-
     steps:
       - name: Checkout
         uses: actions/checkout@v3
 
+      - name: Install Chroma CLI
+        run: |
+          curl -sSL https://raw.githubusercontent.com/chroma-core/chroma/main/rust/cli/install/install.sh | bash
+          echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+
       - name: Cache dependencies
         uses: actions/cache@v3
         with:

chroma.sqlite3

@@ -1,7 +1,17 @@
 {
   "name": "codewithkyrian/chromadb-php",
   "description": "A PHP client for the Chroma Open Source Embedding Database",
-  "keywords": ["chromadb", "php", "embedding", "database", "vectors", "semantic", "search", "chroma", "open-source"],
+  "keywords": [
+    "chromadb",
+    "php",
+    "embedding",
+    "database",
+    "vectors",
+    "semantic",
+    "search",
+    "chroma",
+    "open-source"
+  ],
   "type": "library",
   "license": "MIT",
   "require": {
@@ -11,13 +21,19 @@
   "require-dev": {
     "pestphp/pest": "^2.19",
     "symfony/var-dumper": "^6.3",
-    "mockery/mockery": "^1.6"
+    "mockery/mockery": "^1.6",
+    "symfony/process": "^7.4"
   },
   "autoload": {
     "psr-4": {
       "Codewithkyrian\\ChromaDB\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "Codewithkyrian\\ChromaDB\\Tests\\": "tests/"
+    }
+  },
   "authors": [
     {
       "name": "Kyrian Obikwelu",
@@ -33,4 +49,4 @@
     "test": "vendor/bin/pest",
     "test:coverage": "XDEBUG_MODE=coverage ./vendor/bin/pest --coverage"
   }
-}
+}

chroma/chroma.sqlite3

@@ -4,6 +4,7 @@
 
 namespace Codewithkyrian\ChromaDB;
 
+use Codewithkyrian\ChromaDB\Exceptions\ChromaAuthorizationException;
 use Codewithkyrian\ChromaDB\Exceptions\ChromaConnectionException;
 use Codewithkyrian\ChromaDB\Exceptions\ChromaException;
 use Codewithkyrian\ChromaDB\Models\Collection;
@@ -547,6 +548,13 @@ private function handleChromaApiException(\Exception|ClientExceptionInterface $e
         }
 
         if ($e instanceof RequestException) {
+            if ($e->hasResponse()) {
+                $statusCode = $e->getResponse()->getStatusCode();
+                if ($statusCode === 401 || $statusCode === 403) {
+                    throw new ChromaAuthorizationException($e->getMessage(), $statusCode);
+                }
+            }
+
             $errorString = $e->getResponse()->getBody()->getContents();
 
             if (preg_match('/(?<={"\"error\"\:\")([^"]*)/', $errorString, $matches)) {

composer.json

@@ -4,7 +4,6 @@
 
 use Codewithkyrian\ChromaDB\Client;
 use Codewithkyrian\ChromaDB\ChromaDB;
-use Codewithkyrian\ChromaDB\Exceptions\ChromaAuthorizationException;
 use Codewithkyrian\ChromaDB\Exceptions\ChromaConnectionException;
 
 it('can connect to a normal chroma server', function () {
@@ -22,33 +21,6 @@
     expect($client)->toBeInstanceOf(Client::class);
 });
 
-// test('can connect to an API token authenticated chroma server', function () {
-//     $client = ChromaDB::factory()
-//         ->withPort(8001)
-//         ->withAuthToken('test-token')
-//         ->connect();
-
-//     expect($client)->toBeInstanceOf(Client::class);
-// });
-
-/*
-NOTE: Currently token-based authentication is broken in the current ChromaDB versions
-
-it('cannot connect to an API token authenticated chroma server with wrong token', function () {
-    ChromaDB::factory()
-        ->withPort(8001)
-        ->withAuthToken('wrong-token')
-        ->connect();
-})->throws(ChromaAuthorizationException::class);
-
-it('throws exception when connecting to API token authenticated chroma server with no token', function () {
-    ChromaDB::factory()
-        ->withPort(8001)
-        ->connect();
-})->throws(ChromaAuthorizationException::class);
-
-*/
-
 it('throws a connection exception when connecting to a non-existent chroma server', function () {
     ChromaDB::factory()
         ->withHost('http://localhost')

src/Api.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Codewithkyrian\ChromaDB\Tests;
+
+use Symfony\Component\Process\Process;
+
+class ChromaServer
+{
+    private static ?Process $process = null;
+
+    public static function start(int $port = 8000): void
+    {
+        if (self::$process !== null && self::$process->isRunning()) {
+            return;
+        }
+
+        if (self::isPortInUse($port)) {
+            echo "Port $port is already in use. Assuming Chroma is running externally.\n";
+            return;
+        }
+
+        $command = ['chroma', 'run', '--port', (string)$port];
+        
+        self::$process = new Process($command, env: [
+            'IS_PERSISTENT' => false,
+            'ALLOW_RESET' => true
+        ]);
+
+        self::$process->start();
+
+        $retries = 20;
+        while ($retries > 0) {
+            if (self::isPortInUse($port)) {
+                return;
+            }
+            usleep(500000); // 0.5 seconds
+            $retries--;
+        }
+
+        throw new \RuntimeException("Failed to start Chroma server on port $port.");
+    }
+
+    public static function stop(): void
+    {
+        if (self::$process !== null && self::$process->isRunning()) {
+            self::$process->stop();
+            self::$process = null;
+        }
+    }
+
+    private static function isPortInUse(int $port): bool
+    {
+        $connection = @fsockopen('localhost', $port);
+
+        if (is_resource($connection)) {
+            fclose($connection);
+            return true;
+        }
+
+        return false;
+    }
+
+}

tests/ChromaDB.php

@@ -13,6 +13,8 @@
 use Codewithkyrian\ChromaDB\Models\Collection;
 
 beforeEach(function () {
+    // $this->chromaServer->start();
+
     $this->client = ChromaDB::factory()
         ->withDatabase('test_database')
         ->withTenant('test_tenant')

tests/ChromaServer.php

@@ -0,0 +1,15 @@
+<?php
+
+use Codewithkyrian\ChromaDB\ChromaDB;
+use Codewithkyrian\ChromaDB\Tests\ChromaServer;
+
+uses()
+    ->beforeAll(function () {
+        ChromaServer::start();
+        // ChromaDB::reset();
+    })
+    ->afterAll(function () {
+        // ChromaDB::reset();
+        ChromaServer::stop();
+    })
+    ->in(__DIR__);