mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-16 22:05:20 +00:00
Foundation for the AI chatbot + text generation feature. Phase 1 is infrastructure only: driver plumbing, configuration storage with encrypted API keys, global vs per-company resolution, admin + company UI pages, and an optional installer wizard step. The chat assistant and text-generation WYSIWYG integration come in later phases.
**Driver plumbing (app/Support/Ai/)** — AiDriver abstract, AiDriverFactory, AiException, AiChatResponse DTO, OpenRouterDriver concrete implementation. OpenRouter is the OpenAI-compatible aggregator that unlocks hundreds of models behind one API key and one request shape — ideal as the default v1 driver. Drivers are extensible the same way exchange rate drivers are: the module Registry's generic registerDriver('ai', ...) machinery plus a typed Registry::registerAiDriver() convenience wrapper (shipped in the upstream invoiceshelf/modules package in a paired commit).
**AiConfigurationService** — mirrors MailConfigurationService shape but with one deliberate deviation: API keys are encrypted at the service layer via Crypt::encryptString before persistence. OpenRouter bearer tokens have much bigger blast radius than SMTP passwords. Same settings / company_settings tables, same global-vs-per-company pattern, same use_custom_ai_config override toggle. Resolution order: global ai_enabled must be YES, then the company either overrides via use_custom_ai_config=YES (and can opt out with ai_enabled=NO inside the override) or inherits the global config.
**Controllers** — Admin/Settings/AiConfigurationController (global CRUD + driver list + test connection), Company/Settings/CompanyAiConfigurationController (per-company override + test), Setup/AiConfigurationController (installer wizard step, skippable with explicit ai_enabled=NO). API key is always masked as '********' in GET responses — the frontend submits the placeholder back on save and the backend preserves the stored value.
**Installer wizard** — new optional step 7 'AI' between Mail and Account. Default OFF with a Skip button. MailView.vue now routes to installation.ai instead of installation.account; installation.ai then routes to installation.account. Step order comment updated in routes.ts.
**Admin + Company settings pages** — AdminAiConfigView (no toggle, always global) and AiConfigView (with use_custom_ai_config BaseSwitchSection that auto-saves OFF). Both share AiConfigurationForm which renders the driver selector, API key input with show/hide, driver-specific config_fields (base_url for OpenRouter), and per-role enable toggles with free-text model inputs backed by a datalist of suggested models from driver metadata.
**Bootstrap endpoint** — adds an ai block to the response: { enabled, chat_enabled, text_generation_enabled }. All three are booleans resolved through AiConfigurationService::resolveForCompany(). Never leaks the API key. Frontend feature flags read from bootstrapData.ai to decide whether to show Phase 2/3 UI.
**Bouncer ability** 'manage ai config' added to SettingsPolicy, gated on isSuperAdmin() (same pattern as manage email config, manage pdf config).
**Tests** (22 new) — Unit: AiDriverFactory resolves built-in + Registry-contributed drivers, rejects unknown, merges availableDrivers. AiConfigurationService: encryption round-trip, resolution order (3 cases: global off, inherit global, override with company key, override with opt-out), makeDriver null/instance cases, listDrivers metadata. Feature: admin save + read with api key masking, preserve-on-placeholder behavior, company toggle ON/OFF semantics, bootstrap ai flags reflect resolution, company opt-out path.
372 tests pass (was 350, +22). Pint clean. npm run build clean. Phase 2 (chat assistant + tool calling) and Phase 3 (WYSIWYG text generation popup) are separate follow-up commits — this one is the foundation only.
184 lines
6.4 KiB
PHP
184 lines
6.4 KiB
PHP
<?php
|
|
|
|
use App\Models\CompanySetting;
|
|
use App\Models\Setting;
|
|
use App\Models\User;
|
|
use App\Services\AiConfigurationService;
|
|
use App\Support\Ai\OpenRouterDriver;
|
|
use Illuminate\Support\Facades\Artisan;
|
|
use Illuminate\Support\Facades\Crypt;
|
|
|
|
beforeEach(function () {
|
|
Artisan::call('db:seed', ['--class' => 'DatabaseSeeder', '--force' => true]);
|
|
Artisan::call('db:seed', ['--class' => 'DemoSeeder', '--force' => true]);
|
|
|
|
$this->service = new AiConfigurationService;
|
|
$this->user = User::find(1);
|
|
$this->companyId = $this->user->companies()->first()->id;
|
|
});
|
|
|
|
test('saving global config encrypts the api key at rest', function () {
|
|
$this->service->saveGlobalConfig([
|
|
'ai_enabled' => 'YES',
|
|
'ai_driver' => 'openrouter',
|
|
'ai_api_key' => 'sk-or-secret-key',
|
|
'ai_base_url' => 'https://openrouter.ai/api/v1',
|
|
'ai_chat_enabled' => 'YES',
|
|
'ai_chat_model' => 'openai/gpt-4o',
|
|
'ai_text_generation_enabled' => 'NO',
|
|
'ai_text_generation_model' => '',
|
|
]);
|
|
|
|
$storedCiphertext = Setting::getSetting('ai_api_key');
|
|
expect($storedCiphertext)->not->toBe('sk-or-secret-key');
|
|
expect(Crypt::decryptString($storedCiphertext))->toBe('sk-or-secret-key');
|
|
});
|
|
|
|
test('reading global config decrypts the api key', function () {
|
|
$this->service->saveGlobalConfig([
|
|
'ai_enabled' => 'YES',
|
|
'ai_driver' => 'openrouter',
|
|
'ai_api_key' => 'sk-or-secret-key',
|
|
'ai_chat_enabled' => 'YES',
|
|
'ai_chat_model' => 'openai/gpt-4o',
|
|
]);
|
|
|
|
$config = $this->service->getGlobalConfig();
|
|
|
|
expect($config['ai_api_key'])->toBe('sk-or-secret-key');
|
|
expect($config['ai_enabled'])->toBe('YES');
|
|
expect($config['ai_chat_model'])->toBe('openai/gpt-4o');
|
|
});
|
|
|
|
test('company save with toggle OFF only persists the toggle and discards driver fields', function () {
|
|
$this->service->saveCompanyConfig($this->companyId, [
|
|
'use_custom_ai_config' => 'NO',
|
|
'ai_api_key' => 'this-should-not-be-stored',
|
|
'ai_driver' => 'openrouter',
|
|
]);
|
|
|
|
$raw = CompanySetting::getSettings(['use_custom_ai_config', 'company_ai_api_key'], $this->companyId)->all();
|
|
|
|
expect($raw['use_custom_ai_config'] ?? null)->toBe('NO');
|
|
expect($raw['company_ai_api_key'] ?? null)->toBeNull();
|
|
});
|
|
|
|
test('company save with toggle ON encrypts and persists driver fields', function () {
|
|
$this->service->saveCompanyConfig($this->companyId, [
|
|
'use_custom_ai_config' => 'YES',
|
|
'ai_driver' => 'openrouter',
|
|
'ai_api_key' => 'company-specific-key',
|
|
'ai_chat_enabled' => 'YES',
|
|
'ai_chat_model' => 'anthropic/claude-3.5-sonnet',
|
|
]);
|
|
|
|
$config = $this->service->getCompanyConfig($this->companyId);
|
|
|
|
expect($config['use_custom_ai_config'])->toBe('YES');
|
|
expect($config['ai_api_key'])->toBe('company-specific-key');
|
|
expect($config['ai_chat_model'])->toBe('anthropic/claude-3.5-sonnet');
|
|
});
|
|
|
|
test('resolveForCompany returns null when global ai_enabled is NO', function () {
|
|
$this->service->saveGlobalConfig([
|
|
'ai_enabled' => 'NO',
|
|
'ai_driver' => 'openrouter',
|
|
'ai_api_key' => 'key',
|
|
]);
|
|
|
|
expect($this->service->resolveForCompany($this->companyId))->toBeNull();
|
|
});
|
|
|
|
test('resolveForCompany returns null when company opts out via override', function () {
|
|
$this->service->saveGlobalConfig([
|
|
'ai_enabled' => 'YES',
|
|
'ai_driver' => 'openrouter',
|
|
'ai_api_key' => 'global-key',
|
|
'ai_chat_enabled' => 'YES',
|
|
'ai_chat_model' => 'openai/gpt-4o',
|
|
]);
|
|
|
|
// Company uses custom config but explicitly disables AI
|
|
$this->service->saveCompanyConfig($this->companyId, [
|
|
'use_custom_ai_config' => 'YES',
|
|
'ai_enabled' => 'NO',
|
|
'ai_driver' => 'openrouter',
|
|
'ai_api_key' => 'unused',
|
|
]);
|
|
|
|
expect($this->service->resolveForCompany($this->companyId))->toBeNull();
|
|
});
|
|
|
|
test('resolveForCompany returns global config when company has no custom override', function () {
|
|
$this->service->saveGlobalConfig([
|
|
'ai_enabled' => 'YES',
|
|
'ai_driver' => 'openrouter',
|
|
'ai_api_key' => 'global-key',
|
|
'ai_base_url' => 'https://global.example.com/v1',
|
|
'ai_chat_enabled' => 'YES',
|
|
'ai_chat_model' => 'openai/gpt-4o',
|
|
]);
|
|
|
|
$resolved = $this->service->resolveForCompany($this->companyId);
|
|
|
|
expect($resolved)->not->toBeNull();
|
|
expect($resolved['ai_api_key'])->toBe('global-key');
|
|
expect($resolved['ai_base_url'])->toBe('https://global.example.com/v1');
|
|
expect($resolved['chat_enabled'])->toBeTrue();
|
|
});
|
|
|
|
test('resolveForCompany returns company config when use_custom_ai_config is YES', function () {
|
|
$this->service->saveGlobalConfig([
|
|
'ai_enabled' => 'YES',
|
|
'ai_driver' => 'openrouter',
|
|
'ai_api_key' => 'global-key',
|
|
'ai_chat_enabled' => 'YES',
|
|
'ai_chat_model' => 'openai/gpt-4o',
|
|
]);
|
|
|
|
$this->service->saveCompanyConfig($this->companyId, [
|
|
'use_custom_ai_config' => 'YES',
|
|
'ai_enabled' => 'YES',
|
|
'ai_driver' => 'openrouter',
|
|
'ai_api_key' => 'company-key',
|
|
'ai_chat_enabled' => 'YES',
|
|
'ai_chat_model' => 'anthropic/claude-3.5-sonnet',
|
|
]);
|
|
|
|
$resolved = $this->service->resolveForCompany($this->companyId);
|
|
|
|
expect($resolved)->not->toBeNull();
|
|
expect($resolved['ai_api_key'])->toBe('company-key');
|
|
expect($resolved['ai_chat_model'])->toBe('anthropic/claude-3.5-sonnet');
|
|
expect($resolved['chat_enabled'])->toBeTrue();
|
|
});
|
|
|
|
test('makeDriver returns null when ai is disabled', function () {
|
|
$this->service->saveGlobalConfig(['ai_enabled' => 'NO']);
|
|
|
|
expect($this->service->makeDriver($this->companyId))->toBeNull();
|
|
});
|
|
|
|
test('makeDriver instantiates a driver from the resolved config', function () {
|
|
$this->service->saveGlobalConfig([
|
|
'ai_enabled' => 'YES',
|
|
'ai_driver' => 'openrouter',
|
|
'ai_api_key' => 'test-key',
|
|
]);
|
|
|
|
$driver = $this->service->makeDriver($this->companyId);
|
|
|
|
expect($driver)->toBeInstanceOf(OpenRouterDriver::class);
|
|
});
|
|
|
|
test('listDrivers returns driver metadata from the Registry', function () {
|
|
$drivers = $this->service->listDrivers();
|
|
|
|
expect($drivers)->not->toBeEmpty();
|
|
|
|
$openrouter = collect($drivers)->firstWhere('value', 'openrouter');
|
|
expect($openrouter)->not->toBeNull();
|
|
expect($openrouter['label'])->toBe('settings.ai.openrouter');
|
|
expect($openrouter['supported_roles'])->toContain('chat')->toContain('text_generation');
|
|
});
|