fix: adopt to lib changes and bring in pipeline (#15)

Author: chr-hertel

.github/workflows/pipeline.yml

@@ -0,0 +1,35 @@
+name: pipeline
+on: pull_request
+
+jobs:
+  pipeline:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: ['8.2', '8.3']
+        dependencies: ['lowest', 'highest']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+
+      - name: Install Composer
+        uses: "ramsey/composer-install@v3"
+        with:
+          dependency-versions: "${{ matrix.dependencies }}"
+
+      - name: Composer Validation
+        run: composer validate --strict
+
+      - name: Install PHP Dependencies
+        run: composer install --no-scripts
+
+      - name: Code Style PHP
+        run: vendor/bin/php-cs-fixer fix --dry-run
+
+      - name: PHPStan
+        run: vendor/bin/phpstan analyse

.gitignore

@@ -1,2 +1,3 @@
 vendor
 composer.lock
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,12 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@Symfony' => true,
+    ])
+    ->setFinder($finder)
+;

Makefile

@@ -0,0 +1,9 @@
+qa:
+	composer update --prefer-stable
+	vendor/bin/php-cs-fixer fix
+	vendor/bin/phpstan
+
+qa-lowest:
+	composer update --prefer-lowest
+	vendor/bin/php-cs-fixer fix
+	vendor/bin/phpstan

composer.json

@@ -22,5 +22,9 @@
         }
     },
     "minimum-stability": "dev",
-    "prefer-stable": true
+    "prefer-stable": true,
+    "require-dev": {
+        "php-cs-fixer/shim": "^3.64",
+        "phpstan/phpstan": "^1.12"
+    }
 }

phpstan.dist.neon

@@ -0,0 +1,7 @@
+parameters:
+    level: 6
+    paths:
+        - src/
+    excludePaths:
+        analyse:
+            - src/DependencyInjection/Configuration.php

src/DataCollector.php

@@ -4,11 +4,16 @@
 
 namespace PhpLlm\LlmChainBundle;
 
+use PhpLlm\LlmChain\ToolBox\Metadata;
 use Symfony\Bundle\FrameworkBundle\DataCollector\AbstractDataCollector;
 use Symfony\Component\DependencyInjection\Attribute\AutowireIterator;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
+/**
+ * @phpstan-import-type LlmCallData from TraceableLanguageModel
+ * @phpstan-import-type ToolCallData from TraceableToolBox
+ */
 final class DataCollector extends AbstractDataCollector
 {
     /**
@@ -22,7 +27,7 @@ final class DataCollector extends AbstractDataCollector
     public function __construct(
         #[AutowireIterator('llm_chain.traceable_llm')]
         iterable $llms,
-        private TraceableToolRegistry $toolRegistry,
+        private TraceableToolBox $toolBox,
     ) {
         $this->llms = $llms instanceof \Traversable ? iterator_to_array($llms) : $llms;
     }
@@ -35,9 +40,9 @@ public function collect(Request $request, Response $response, ?\Throwable $excep
         }
 
         $this->data = [
-            'tools' => $this->toolRegistry->getMap(),
+            'tools' => $this->toolBox->getMap(),
             'llm_calls' => $llmCalls,
-            'tool_calls' => $this->toolRegistry->calls,
+            'tool_calls' => $this->toolBox->calls,
         ];
     }
 
@@ -46,7 +51,9 @@ public static function getTemplate(): string
         return '@LlmChain/data_collector.html.twig';
     }
 
-
+    /**
+     * @return list<LlmCallData>
+     */
     public function getLlmCalls(): array
     {
         return $this->data['llm_calls'] ?? [];
@@ -57,11 +64,17 @@ public function getLlmCallCount(): int
         return array_sum(array_map('count', $this->data['llm_calls'] ?? []));
     }
 
+    /**
+     * @return Metadata[]
+     */
     public function getTools(): array
     {
         return $this->data['tools'] ?? [];
     }
 
+    /**
+     * @return list<ToolCallData>
+     */
     public function getToolCalls(): array
     {
         return $this->data['tool_calls'] ?? [];

src/DependencyInjection/LlmChainExtension.php

@@ -18,7 +18,7 @@
 use PhpLlm\LlmChain\ToolBox\AsTool;
 use PhpLlm\LlmChainBundle\DataCollector;
 use PhpLlm\LlmChainBundle\TraceableLanguageModel;
-use PhpLlm\LlmChainBundle\TraceableToolRegistry;
+use PhpLlm\LlmChainBundle\TraceableToolBox;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -37,33 +37,33 @@ public function load(array $configs, ContainerBuilder $container): void
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);
 
-        foreach ($config['runtimes'] as $name => $runtime) {
-            $this->processRuntimeConfig($name, $runtime, $container);
+        foreach ($config['runtimes'] as $runtimeName => $runtime) {
+            $this->processRuntimeConfig($runtimeName, $runtime, $container);
         }
-        if (1 === count($config['runtimes'])) {
-            $container->setAlias(Runtime::class, 'llm_chain.runtime.'.$name);
+        if (1 === count($config['runtimes']) && isset($runtimeName)) {
+            $container->setAlias(Runtime::class, 'llm_chain.runtime.'.$runtimeName);
         }
 
-        foreach ($config['llms'] as $name => $llm) {
-            $this->processLlmConfig($name, $llm, $container);
+        foreach ($config['llms'] as $llmName => $llm) {
+            $this->processLlmConfig($llmName, $llm, $container);
         }
-        if (1 === count($config['llms'])) {
-            $container->setAlias(LanguageModel::class, 'llm_chain.llm.'.$name);
+        if (1 === count($config['llms']) && isset($llmName)) {
+            $container->setAlias(LanguageModel::class, 'llm_chain.llm.'.$llmName);
         }
 
-        foreach ($config['embeddings'] as $name => $embeddings) {
-            $this->processEmbeddingsConfig($name, $embeddings, $container);
+        foreach ($config['embeddings'] as $embeddingsName => $embeddings) {
+            $this->processEmbeddingsConfig($embeddingsName, $embeddings, $container);
         }
-        if (1 === count($config['embeddings'])) {
-            $container->setAlias(EmbeddingModel::class, 'llm_chain.embeddings.'.$name);
+        if (1 === count($config['embeddings']) && isset($embeddingsName)) {
+            $container->setAlias(EmbeddingModel::class, 'llm_chain.embeddings.'.$embeddingsName);
         }
 
-        foreach ($config['stores'] as $name => $store) {
-            $this->processStoreConfig($name, $store, $container);
+        foreach ($config['stores'] as $storeName => $store) {
+            $this->processStoreConfig($storeName, $store, $container);
         }
-        if (1 === count($config['stores'])) {
-            $container->setAlias(VectorStoreInterface::class, 'llm_chain.store.'.$name);
-            $container->setAlias(StoreInterface::class, 'llm_chain.store.'.$name);
+        if (1 === count($config['stores']) && isset($storeName)) {
+            $container->setAlias(VectorStoreInterface::class, 'llm_chain.store.'.$storeName);
+            $container->setAlias(StoreInterface::class, 'llm_chain.store.'.$storeName);
         }
 
         $container->registerAttributeForAutoconfiguration(AsTool::class, static function (ChildDefinition $definition, AsTool $attribute): void {
@@ -76,10 +76,13 @@ public function load(array $configs, ContainerBuilder $container): void
 
         if (false === $container->getParameter('kernel.debug')) {
             $container->removeDefinition(DataCollector::class);
-            $container->removeDefinition(TraceableToolRegistry::class);
+            $container->removeDefinition(TraceableToolBox::class);
         }
     }
 
+    /**
+     * @param array<string, mixed> $runtime
+     */
     private function processRuntimeConfig(string $name, array $runtime, ContainerBuilder $container): void
     {
         if ('openai' === $runtime['type']) {
@@ -104,6 +107,9 @@ private function processRuntimeConfig(string $name, array $runtime, ContainerBui
         }
     }
 
+    /**
+     * @param array<string, mixed> $llm
+     */
     private function processLlmConfig(string $name, array $llm, ContainerBuilder $container): void
     {
         $runtime = isset($llm['runtime']) ? 'llm_chain.runtime.'.$llm['runtime'] : Runtime::class;
@@ -123,7 +129,10 @@ private function processLlmConfig(string $name, array $llm, ContainerBuilder $co
         }
     }
 
-    private function processEmbeddingsConfig(string $name, mixed $embeddings, ContainerBuilder $container): void
+    /**
+     * @param array<string, mixed> $embeddings
+     */
+    private function processEmbeddingsConfig(string $name, array $embeddings, ContainerBuilder $container): void
     {
         $runtime = isset($embeddings['runtime']) ? 'llm_chain.runtime.'.$embeddings['runtime'] : Runtime::class;
 
@@ -133,7 +142,10 @@ private function processEmbeddingsConfig(string $name, mixed $embeddings, Contai
         $container->setDefinition('llm_chain.embeddings.'.$name, $definition);
     }
 
-    private function processStoreConfig(string $name, mixed $stores, ContainerBuilder $container): void
+    /**
+     * @param array<string, mixed> $stores
+     */
+    private function processStoreConfig(string $name, array $stores, ContainerBuilder $container): void
     {
         if ('chroma-db' === $stores['engine']) {
             $definition = new ChildDefinition(ChromaDbStore::class);

src/Resources/config/services.php

@@ -11,14 +11,14 @@
 use PhpLlm\LlmChain\OpenAI\Runtime;
 use PhpLlm\LlmChain\OpenAI\Runtime\Azure as AzureRuntime;
 use PhpLlm\LlmChain\OpenAI\Runtime\OpenAI as OpenAIRuntime;
-use PhpLlm\LlmChain\ToolBox\ParameterAnalyzer;
-use PhpLlm\LlmChain\ToolBox\Registry;
-use PhpLlm\LlmChain\ToolBox\RegistryInterface;
-use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
 use PhpLlm\LlmChain\Store\Azure\SearchStore as AzureSearchStore;
 use PhpLlm\LlmChain\Store\ChromaDb\Store as ChromaDbStore;
+use PhpLlm\LlmChain\ToolBox\ParameterAnalyzer;
+use PhpLlm\LlmChain\ToolBox\ToolAnalyzer;
+use PhpLlm\LlmChain\ToolBox\ToolBox;
+use PhpLlm\LlmChain\ToolBox\ToolBoxInterface;
 use PhpLlm\LlmChainBundle\DataCollector;
-use PhpLlm\LlmChainBundle\TraceableToolRegistry;
+use PhpLlm\LlmChainBundle\TraceableToolBox;
 
 return static function (ContainerConfigurator $container) {
     $container->services()
@@ -73,17 +73,17 @@
             ])
 
         // tools
-        ->set(Registry::class)
+        ->set(ToolBox::class)
             ->args([
                 '$tools' => tagged_iterator('llm_chain.tool'),
             ])
-            ->alias(RegistryInterface::class, Registry::class)
+            ->alias(ToolBoxInterface::class, ToolBox::class)
         ->set(ToolAnalyzer::class)
         ->set(ParameterAnalyzer::class)
 
         // profiler
         ->set(DataCollector::class)
-        ->set(TraceableToolRegistry::class)
-            ->decorate(Registry::class)
+        ->set(TraceableToolBox::class)
+            ->decorate(ToolBox::class)
     ;
 };

src/TraceableLanguageModel.php

@@ -8,8 +8,18 @@
 use PhpLlm\LlmChain\Message\MessageBag;
 use PhpLlm\LlmChain\Response\Response;
 
+/**
+ * @phpstan-type LlmCallData array{
+ *     messages: MessageBag,
+ *     options: array<string, mixed>,
+ *     response: Response,
+ * }
+ */
 final class TraceableLanguageModel implements LanguageModel
 {
+    /**
+     * @var list<LlmCallData>
+     */
     public array $calls = [];
 
     public function __construct(
@@ -31,14 +41,14 @@ public function call(MessageBag $messages, array $options = []): Response
         return $response;
     }
 
-    public function hasToolSupport(): bool
+    public function supportsToolCalling(): bool
     {
-        return $this->llm->hasToolSupport();
+        return $this->llm->supportsToolCalling();
     }
 
-    public function hasStructuredOutputSupport(): bool
+    public function supportsStructuredOutput(): bool
     {
-        return $this->llm->hasStructuredOutputSupport();
+        return $this->llm->supportsStructuredOutput();
     }
 
     public function getName(): string