test: add custom API provider support

[marcveihl]

Enable users to define custom API providers (self-hosted LLMs, proxy servers, alternative providers) via config.json and the setup wizard.

• config.js: CRUD for customProviders in config.json
• api-key-store.js: dynamic provider→envVar map merging built-in + custom
• api-key-validation.js: HTTP/HTTPS validation for custom provider endpoints
• validators.js: custom provider lookup in API key validation
• alias-resolver.js: use dynamic env map for direct API fallback
• Electron UI: "Add Custom Provider" form with IPC handlers
• CLI setup: readline-based custom provider creation flow
• .env.example: document custom provider env vars

All 1477 tests pass.

Summary by CodeRabbit

Release Notes

• New Features
  • Support for configuring and managing custom API providers through the setup interface and CLI.
  • Ability to add, remove, and configure custom provider details including ID, name, base URL, and authentication type.
  • API key validation and persistent storage for custom providers.
  • Custom providers integrate seamlessly alongside built-in providers.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b7954c3d-d534-4070-9cd3-0c3068d840fc

📥 Commits

Reviewing files that changed from the base of the PR and between 251358e and b4d98ca.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (12)

• .env.example
• electron/ipc-setup.js
• electron/preload-setup.js
• electron/setup-ui-keys-script.js
• electron/setup-ui-keys.js
• src/sidecar/setup.js
• src/utils/alias-resolver.js
• src/utils/api-key-store.js
• src/utils/api-key-validation.js
• src/utils/config.js
• src/utils/validators.js
• tests/config-fallback.test.js

---

📝 Walkthrough

Walkthrough

This pull request introduces a custom API provider system enabling users to add, save, and manage their own API providers. The implementation spans configuration management, IPC communication, API key validation, persistent storage, and UI forms across Electron and Node.js components.

Changes

Cohort / File(s)	Summary
Configuration & Storage src/utils/config.js, src/utils/api-key-store.js	Introduce getCustomProviders(), saveCustomProvider(), and removeCustomProvider() with validation against builtin providers. Add getFullProviderEnvMap() to merge custom and builtin provider env mappings for unified resolution throughout the app.
IPC Communication electron/ipc-setup.js, electron/preload-setup.js	Add three new IPC handlers (sidecar:get-custom-providers, sidecar:save-custom-provider, sidecar:remove-custom-provider) with error handling and extend the preload whitelist to allow invoking these channels.
API Key Management src/utils/api-key-validation.js, src/utils/validators.js, src/utils/alias-resolver.js	Update validation and resolution logic to support custom providers: build dynamic endpoints for custom providers, fallback to custom provider lookup, and use the merged provider env map instead of static mappings.
Setup Flow Integration src/sidecar/setup.js	Add runCustomProviderSetup(rl) function to interactively gather custom provider details during readline configuration and persist via config utilities.
UI & Forms electron/setup-ui-keys.js, electron/setup-ui-keys-script.js	Add custom provider form with fields for ID, name, base URL, auth type, and env variable. Implement handlers to toggle form visibility, validate/save providers, render provider cards, and load existing custom providers on init. Update OpenRouter placeholder.
Documentation & Tests .env.example, tests/config-fallback.test.js	Add example documentation for custom provider environment variables and update test mocks to use shared MOCK_PROVIDER_ENV_MAP with getFullProviderEnvMap() mock.

Sequence Diagram(s)

sequenceDiagram
    actor User
    participant UI as Setup UI
    participant IPC as Electron IPC
    participant Config as Config Manager
    participant Storage as File Storage
    participant Validator as API Validator

    User->>UI: Fill custom provider form<br/>(ID, name, baseURL, etc.)
    User->>UI: Click "Add Custom Provider"
    UI->>IPC: invoke('sidecar:save-custom-provider',<br/>id, provider)
    IPC->>Config: saveCustomProvider(id, provider)
    Config->>Config: Validate against BUILTIN_PROVIDERS
    Config->>Config: Normalize baseUrl & set defaults
    Config->>Storage: Write to config.json
    Storage-->>Config: Persist complete
    Config-->>IPC: Return success
    IPC-->>UI: Handler resolves with result
    UI->>UI: Update in-memory providers map
    UI->>UI: Render provider card
    UI->>UI: Reset form

    User->>UI: Select custom provider & enter API key
    User->>UI: Test connection / Save
    UI->>Validator: validateApiKey(custom provider, key)
    Validator->>Config: getCustomProviders()
    Config-->>Validator: Custom provider details
    Validator->>Validator: buildCustomEndpoint(baseURL, authType)
    Validator->>Validator: Send HTTP/HTTPS request
    Validator-->>UI: Validation result

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~55 minutes

Possibly related PRs

• fix: post-merge follow-ups for direct API fallback #3 — Modifies src/utils/api-key-store.js and provider env mapping logic to support flexible provider resolution; overlaps with this PR's refactoring of readApiKeys and introduction of getFullProviderEnvMap().

Suggested reviewers

• jrenaldi79

Poem

🐰 Hop along, dear custom providers glow,
Painted forms and configs in a row.
IPC whispers, validation flows so free,
The sidecar dances with flexibility!
A rabbit's delight—more choices to sow! 🌱

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}