Add new test model and add orchestral testbench versions for older laravel versions

Author: CodeWithKyrian

composer.json

@@ -25,7 +25,7 @@
         "pestphp/pest": "^2.19",
         "symfony/var-dumper": "^6.3 |^7.0.1",
         "mockery/mockery": "^1.6",
-        "orchestra/testbench": "^8.20"
+        "orchestra/testbench": "^7.38 | ^8.20 | ^9.0"
     },
     "autoload": {
         "psr-4": {
@@ -70,7 +70,10 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Codewithkyrian\\ChromaDB\\Tests\\": "tests/"
+            "Codewithkyrian\\ChromaDB\\Tests\\": "tests/",
+            "Workbench\\App\\": "workbench/app/",
+            "Workbench\\Database\\Factories\\": "workbench/database/factories/",
+            "Workbench\\Database\\Seeders\\": "workbench/database/seeders/"
         }
     }
 }

config/chromadb.php

@@ -62,7 +62,7 @@
          | this is set to false, then the ChromaDB Sync feature will not be
          | enabled.
          */
-        'enabled' => env('CHROMA_SYNC_ENABLED', false),
+        'enabled' => env('CHROMA_SYNC_ENABLED', true),
 
         /*
          |--------------------------------------------------------------------------

phpunit.xml

@@ -16,6 +16,7 @@
     </source>
     <php>
         <env name="APP_ENV" value="testing"/>
+        <env name="DB_CONNECTION" value="testing"/>
         <env name="CHROMA_TENANT" value="test_tenant"/>
         <env name="CHROMA_DATABASE" value="test_database"/>
     </php>

src/Concerns/HasChromaCollection.php

@@ -4,36 +4,23 @@
 
 namespace Codewithkyrian\ChromaDB\Concerns;
 
+use Codewithkyrian\ChromaDB\Contracts\ChromaModel;
 use Codewithkyrian\ChromaDB\Embeddings\EmbeddingFunction;
 use Codewithkyrian\ChromaDB\Facades\ChromaDB;
 use Codewithkyrian\ChromaDB\Jobs\UpdateChromaCollectionJob;
 use Codewithkyrian\ChromaDB\Resources\CollectionResource;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Database\Eloquent\Builder;
 
-/**
- * @method mixed getKey()
- * @method string getTable()
- * @method mixed getAttribute(string $field)
- * @method array getChanges()
- * @method self saved(\Illuminate\Events\QueuedClosure|\Closure|string|array $callback)
- * @method self deleted(\Illuminate\Events\QueuedClosure|\Closure|string|array $callback)
- */
 trait HasChromaCollection
 {
     private static ?CollectionResource $chromaCollection;
 
     protected static function bootHasChromaCollection(): void
     {
-        $model = new static();
-
-        static::$chromaCollection = ChromaDB::getOrCreateCollection(
-            name: $model->collectionName(),
-            embeddingFunction: $model->embeddingFunction(),
-        );
-
         if (config('chromadb.sync.enabled')) {
-            static::saved(function (self $model) {
+            static::saved(function (Model&ChromaModel $model) {
                 $changedFields = array_keys($model->getChanges());
 
                 if (!config('chromadb.sync.queue', false)) {
@@ -43,14 +30,22 @@ protected static function bootHasChromaCollection(): void
                 }
             });
 
-            static::deleted(function (self $model) {
+            static::deleted(function (Model&ChromaModel $model) {
                 self::getChromaCollection()->delete([$model->getKey()]);
             });
         }
     }
 
     public static function getChromaCollection(): CollectionResource
     {
+        $model = new static();
+
+        static::$chromaCollection ??= ChromaDB::getOrCreateCollection(
+            name: $model->collectionName(),
+            embeddingFunction: $model->embeddingFunction(),
+        );
+
+
         return static::$chromaCollection;
     }
 
@@ -83,7 +78,7 @@ public function scopeQueryChromaCollection(Builder $query, string $queryText, in
      *
      * @return string[]
      */
-    protected function metadataFields(): array
+    public function metadataFields(): array
     {
         return ['id'];
     }
@@ -93,29 +88,29 @@ protected function metadataFields(): array
      *
      * @return string[]
      */
-    protected function documentFields(): array
+    public function documentFields(): array
     {
         return [];
     }
 
     /**
      * The embedding function to use for the collection.
      */
-    protected function embeddingFunction(): ?EmbeddingFunction
+    public function embeddingFunction(): ?EmbeddingFunction
     {
         return null;
     }
 
     /**
      * The collection name to use for the model.
      */
-    protected function collectionName(): string
+    public function collectionName(): string
     {
         return $this->getTable();
     }
 
 
-    private function generateMetadata(): array
+    public function generateMetadata(): array
     {
 
         return collect($this->metadataFields())
@@ -125,7 +120,7 @@ private function generateMetadata(): array
             ->toArray();
     }
 
-    protected function generateChromaDocument(): string
+    public function generateChromaDocument(): string
     {
         return collect($this->documentFields())
             ->map(function (string $field) {

src/Contracts/ChromaModel.php

@@ -4,22 +4,23 @@
 
 namespace Codewithkyrian\ChromaDB\Contracts;
 
+use Codewithkyrian\ChromaDB\Embeddings\EmbeddingFunction;
 use Codewithkyrian\ChromaDB\Resources\CollectionResource;
 
 interface ChromaModel
 {
 
     public function collectionName(): string;
 
-    public function embeddingFunction(): string;
+    public function embeddingFunction(): ?EmbeddingFunction;
 
     function metadataFields(): array;
 
     function documentFields(): array;
 
     public function generateMetadata(): array;
 
-    public function generateChromaDocument(): array;
+    public function generateChromaDocument(): string;
 
     public static function getChromaCollection(): CollectionResource;
 

tests/Concerns/HasChromaCollectionTest.php

@@ -3,21 +3,28 @@
 declare(strict_types=1);
 
 use Codewithkyrian\ChromaDB\Concerns\HasChromaCollection;
+use Codewithkyrian\ChromaDB\Jobs\UpdateChromaCollectionJob;
 use Codewithkyrian\ChromaDB\Resources\CollectionResource;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Facades\Queue;
+use Workbench\App\Models\TestModel;
 
 it('creates a chroma collection on boot', function () {
-    $model = new class extends Model {
-        use HasChromaCollection;
 
-        public function collectionName(): string
-        {
-            return 'test_collection';
-        }
-    };
-
-    $collection = $model->getChromaCollection();
+    $collection = TestModel::getChromaCollection();
     expect($collection)
         ->toBeInstanceOf(CollectionResource::class)
-        ->and($collection->name)->toBe('test_collection');
+        ->and($collection->name)->toBe('test_models');
+});
+
+it('dispatches a job to update the collection on save', function () {
+    Queue::fake();
+
+    $model = TestModel::create([
+        'title' => 'Test Model',
+        'document' => 'This is a test model'
+    ]);
+
+    Queue::assertPushed(UpdateChromaCollectionJob::class);
 });

tests/TestCase.php

@@ -5,7 +5,10 @@
 namespace Codewithkyrian\ChromaDB\Tests;
 
 use Codewithkyrian\ChromaDB\ChromaServiceProvider;
+use Orchestra\Testbench\Attributes\WithMigration;
+use function Orchestra\Testbench\workbench_path;
 
+#[WithMigration('laravel', 'job')]
 class TestCase extends \Orchestra\Testbench\TestCase
 {
     protected function getPackageProviders($app): array
@@ -14,4 +17,9 @@ protected function getPackageProviders($app): array
             ChromaServiceProvider::class
         ];
     }
+
+    protected function defineDatabaseMigrations(): void
+    {
+        $this->loadMigrationsFrom(workbench_path('database/migrations'));
+    }
 }

workbench/app/Models/TestModel.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Workbench\App\Models;
+
+use Codewithkyrian\ChromaDB\Concerns\HasChromaCollection;
+use Codewithkyrian\ChromaDB\Contracts\ChromaModel;
+use Illuminate\Database\Eloquent\Model;
+
+class TestModel extends Model implements ChromaModel
+{
+    use HasChromaCollection;
+
+    protected $fillable = [
+        'title',
+        'document',
+    ];
+
+    public function documentFields(): array
+    {
+        return [
+            'document',
+        ];
+    }
+}

workbench/database/migrations/2024_01_16_120226_create_test_models_table.php

@@ -0,0 +1,22 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    public function up(): void
+    {
+        Schema::create('test_models', function (Blueprint $table) {
+            $table->id();
+            $table->string('title');
+            $table->text('document');
+            $table->timestamps();
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropIfExists('test_models');
+    }
+};