mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-16 22:05:20 +00:00
feat(ai): Phase 1 — provider configuration, installer step, admin + company settings
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.
This commit is contained in:
Darko Gjorgjijoski
146
tests/Feature/Ai/AiConfigurationTest.php
Normal file
146
tests/Feature/Ai/AiConfigurationTest.php
Normal file
@@ -0,0 +1,146 @@
|
||||
<?php
|
||||
|
||||
use App\Models\CompanySetting;
|
||||
use App\Models\User;
|
||||
use App\Services\AiConfigurationService;
|
||||
use Illuminate\Support\Facades\Artisan;
|
||||
use Laravel\Sanctum\Sanctum;
|
||||
|
||||
use function Pest\Laravel\getJson;
|
||||
use function Pest\Laravel\postJson;
|
||||
|
||||
beforeEach(function () {
|
||||
Artisan::call('db:seed', ['--class' => 'DatabaseSeeder', '--force' => true]);
|
||||
Artisan::call('db:seed', ['--class' => 'DemoSeeder', '--force' => true]);
|
||||
|
||||
$this->user = User::find(1);
|
||||
$this->companyId = $this->user->companies()->first()->id;
|
||||
|
||||
$this->withHeaders(['company' => $this->companyId]);
|
||||
Sanctum::actingAs($this->user, ['*']);
|
||||
});
|
||||
|
||||
test('admin can fetch AI driver list with metadata', function () {
|
||||
$response = getJson('/api/v1/ai/drivers')->assertOk();
|
||||
|
||||
$drivers = collect($response->json('ai_drivers'));
|
||||
$openrouter = $drivers->firstWhere('value', 'openrouter');
|
||||
|
||||
expect($openrouter)->not->toBeNull()
|
||||
->and($openrouter['label'])->toBe('settings.ai.openrouter')
|
||||
->and($openrouter['supported_roles'])->toContain('chat')
|
||||
->and($openrouter['suggested_models'])->not->toBeEmpty();
|
||||
});
|
||||
|
||||
test('admin can save and retrieve global AI config with api key masked in response', function () {
|
||||
postJson('/api/v1/ai/config', [
|
||||
'ai_enabled' => 'YES',
|
||||
'ai_driver' => 'openrouter',
|
||||
'ai_api_key' => 'sk-or-super-secret',
|
||||
'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' => '',
|
||||
])->assertOk();
|
||||
|
||||
$response = getJson('/api/v1/ai/config')->assertOk();
|
||||
|
||||
// API key is masked in responses — never returned in plaintext
|
||||
expect($response->json('ai_api_key'))->toBe('********');
|
||||
expect($response->json('ai_enabled'))->toBe('YES');
|
||||
expect($response->json('ai_chat_model'))->toBe('openai/gpt-4o');
|
||||
});
|
||||
|
||||
test('admin save preserves existing api key when masked placeholder is submitted', function () {
|
||||
// Initial save
|
||||
postJson('/api/v1/ai/config', [
|
||||
'ai_enabled' => 'YES',
|
||||
'ai_driver' => 'openrouter',
|
||||
'ai_api_key' => 'original-key',
|
||||
])->assertOk();
|
||||
|
||||
// Second save submits the masked placeholder — key should be preserved
|
||||
postJson('/api/v1/ai/config', [
|
||||
'ai_enabled' => 'YES',
|
||||
'ai_driver' => 'openrouter',
|
||||
'ai_api_key' => '********',
|
||||
'ai_chat_model' => 'openai/gpt-4o-mini',
|
||||
])->assertOk();
|
||||
|
||||
$service = app(AiConfigurationService::class);
|
||||
$config = $service->getGlobalConfig();
|
||||
|
||||
expect($config['ai_api_key'])->toBe('original-key')
|
||||
->and($config['ai_chat_model'])->toBe('openai/gpt-4o-mini');
|
||||
});
|
||||
|
||||
test('company save respects use_custom_ai_config toggle OFF', function () {
|
||||
postJson('/api/v1/company/ai/config', [
|
||||
'use_custom_ai_config' => 'NO',
|
||||
'ai_api_key' => 'should-not-be-saved',
|
||||
])->assertOk();
|
||||
|
||||
$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 persists company-specific driver fields', function () {
|
||||
postJson('/api/v1/company/ai/config', [
|
||||
'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',
|
||||
])->assertOk();
|
||||
|
||||
$response = getJson('/api/v1/company/ai/config')->assertOk();
|
||||
|
||||
expect($response->json('use_custom_ai_config'))->toBe('YES')
|
||||
->and($response->json('ai_chat_model'))->toBe('anthropic/claude-3.5-sonnet')
|
||||
->and($response->json('ai_api_key'))->toBe('********'); // masked
|
||||
});
|
||||
|
||||
test('bootstrap response surfaces ai flags based on resolution', function () {
|
||||
// No config — AI should be disabled
|
||||
$response = getJson('/api/v1/bootstrap')->assertOk();
|
||||
expect($response->json('ai.enabled'))->toBeFalse();
|
||||
|
||||
// Enable globally with chat enabled
|
||||
app(AiConfigurationService::class)->saveGlobalConfig([
|
||||
'ai_enabled' => 'YES',
|
||||
'ai_driver' => 'openrouter',
|
||||
'ai_api_key' => 'key',
|
||||
'ai_chat_enabled' => 'YES',
|
||||
'ai_chat_model' => 'openai/gpt-4o',
|
||||
'ai_text_generation_enabled' => 'NO',
|
||||
]);
|
||||
|
||||
$response = getJson('/api/v1/bootstrap')->assertOk();
|
||||
expect($response->json('ai.enabled'))->toBeTrue()
|
||||
->and($response->json('ai.chat_enabled'))->toBeTrue()
|
||||
->and($response->json('ai.text_generation_enabled'))->toBeFalse();
|
||||
});
|
||||
|
||||
test('bootstrap response hides ai when company opts out via override', function () {
|
||||
app(AiConfigurationService::class)->saveGlobalConfig([
|
||||
'ai_enabled' => 'YES',
|
||||
'ai_driver' => 'openrouter',
|
||||
'ai_api_key' => 'key',
|
||||
'ai_chat_enabled' => 'YES',
|
||||
'ai_chat_model' => 'openai/gpt-4o',
|
||||
]);
|
||||
|
||||
app(AiConfigurationService::class)->saveCompanyConfig($this->companyId, [
|
||||
'use_custom_ai_config' => 'YES',
|
||||
'ai_enabled' => 'NO',
|
||||
'ai_driver' => 'openrouter',
|
||||
'ai_api_key' => 'unused',
|
||||
]);
|
||||
|
||||
$response = getJson('/api/v1/bootstrap')->assertOk();
|
||||
|
||||
expect($response->json('ai.enabled'))->toBeFalse();
|
||||
});
|
||||
Reference in New Issue
Block a user