Перейти к основному содержимому

Подробный разбор алгоритма ApiKeyPoolService

ApiKeyPoolService реализует решение балансировки нагрузки для нескольких API-ключей: взвешенный round-robin для выбора ключа, сессионную привязку для поддержания Prompt Cache, экспоненциальный откат при превышении лимитов запросов (rate limiting) и постоянное отключение ключей при ошибках аутентификации.


Расположение файлов

ФайлПуть
ApiKeyPoolServicepackages/desktop/app/main/services/capabilities/llm/completion/ApiKeyPoolService.ts
Операции с API-ключами в БДpackages/desktop/app/main/workers/db/apiKeys.ts
Регистрация DB Workerpackages/desktop/app/main/workers/db/index.ts
Типы DB Workerpackages/desktop/app/main/workers/types.ts
IPC Routerpackages/desktop/app/main/services/routers/llm/ApiKeyRouter.ts
Frontend UIpackages/renderer/src/features/settings/components/provider-settings/llm/ApiKeyPoolSection.tsx

Архитектурный контекст

graph TB
subgraph CompletionService
Resolve[resolveApiKeyForRequest]
Retry[retry on 429/529]
Success[reportSuccess]
end

subgraph ApiKeyPoolService
direction TB
GetKey[getKeyForSession]
GetKeyNoSession[getKey]
Report[reportError]
ReportOk[reportSuccess]
Select[selectWeightedRoundRobin]
Available[getAvailableKeys]
Cooldown[applyCooldown]
AuthFail[handleAuthFailure]
Cleanup[cleanupExpiredCooldowns<br/>every 30 seconds]
end

subgraph InMemoryStructures ["In-Memory Data Structures"]
SB["sessionBindings<br/>Map&lt;sessionId, SessionBinding&gt;"]
RRI["rrIndex<br/>Map&lt;providerId, number&gt;"]
KC["keyCache<br/>Map&lt;providerId, ApiKeyEntry[]&gt;"]
CD["cooldowns<br/>Map&lt;keyId, KeyCooldown&gt;"]
end

subgraph ExternalDeps ["External Dependencies"]
DB[(SQLite<br/>llm_provider_api_keys)]
Loader["loadKeys(providerId)"]
Disabler["disableKey(keyId)"]
end

Resolve --> GetKey
Retry --> Report
Success --> ReportOk

GetKey --> SB
GetKey --> Available
Available --> KC
Available --> CD
KC --> Loader
Loader --> DB

Select --> RRI
Report --> Cooldown
Report --> AuthFail
AuthFail --> Disabler
Disabler --> DB
Cleanup --> CD

Структуры данных

Основные типы

// Сессионная привязка: закрепляет сессию за конкретным ключом
interface SessionBinding {
keyId: string; // ID привязанного ключа
providerId: string; // ID владеющего провайдера
}

// Состояние кулдауна ключа
interface KeyCooldown {
until: number; // Временная метка истечения кулдауна (Date.now() + cooldownMs)
errors: number; // Количество последовательных ошибок (используется для экспоненциального отката)
}

// Запись API-ключа (из базы данных)
interface ApiKeyEntry {
id: string; // UUID
providerId: string; // Владеющий провайдер
label?: string; // Отображаемая метка (например, "Производственный ключ №1")
apiKey: string; // Фактическое значение ключа (может начинаться с $ для переменной окружения)
enabled: boolean; // Включён ли ключ
weight: number; // Вес (1–100)
}

// Сигнатура функции загрузки ключей
type ApiKeysLoader = (providerId: string) => Promise<ApiKeyEntry[]>;

// Сигнатура функции отключения ключа
type ApiKeyDisabler = (keyId: string) => Promise<boolean>;

// Резолвер ключей (обрабатывает префикс $ для переменных окружения)
type ApiKeyResolver = (rawKey: string) => string;

Краткий обзор структур данных в памяти

СтруктураТипНазначениеЖизненный цикл
sessionBindingsMap<sessionId, SessionBinding>Сопоставляет сессии с привязанными ключамиОчищается через releaseSession() при завершении сессии
rrIndexMap<providerId, number>Индекс round-robin для каждого провайдераСохраняется на протяжении всего времени работы приложения
keyCacheMap<providerId, ApiKeyEntry[]>Кэш списка ключей (исключает запросы к БД при каждом обращении)Очищается через invalidateCache() после CRUD-операций
cooldownsMap<keyId, KeyCooldown>Состояние кулдауна ключаУстаревшие записи очищаются каждые 30 секунд

Алгоритмы и логика

Алгоритм взвешенного round-robin

Параметр weight каждого ключа определяет количество «слотов», которые он занимает в цикле round-robin.

Шаги:

selectWeightedRoundRobin(providerId, keys):
1. Если только 1 ключ → вернуть сразу
2. Вычислить totalWeight = sum(keys[i].weight)
3. Продвинуть индекс round-robin: idx = (rrIndex[providerId] + 1) % totalWeight
4. Сохранить новый индекс: rrIndex[providerId] = idx
5. Накопительный обход:
accum = 0
for each key in keys:
accum += key.weight
if idx < accum:
return key
6. Запасной вариант: вернуть keys[0]

Пример:

Три ключа: A(weight=3), B(weight=1), C(weight=2), totalWeight=6

Индекс round-robin (idx)Накопленное значениеВыбранный ключ
0A: 3A (0 < 3)
1A: 3A (1 < 3)
2A: 3A (2 < 3)
3A: 3, B: 4B (3 < 4)
4A: 3, B: 4, C: 6C (4 < 6)
5A: 3, B: 4, C: 6C (5 < 6)
0(цикл повторяется)A

Смысл веса: ключ с weight=3 выбирается 3 раза за цикл, ключ с weight=1 — один раз.


Сессионная привязка (Session Affinity)

flowchart TD
Start[getKeyForSession] --> CheckBinding{Сессия имеет привязку?}
CheckBinding -->|Да| CheckProvider{providerId совпадает?}
CheckProvider -->|Да| CheckAvailable{Привязанный ключ доступен?}
CheckAvailable -->|Да| Return[Вернуть привязанный ключ]
CheckAvailable -->|Нет| ReBind[Перепривязать]
CheckProvider -->|Нет| ReBind
CheckBinding -->|Нет| ReBind

ReBind --> GetKeys[getAvailableKeys]
GetKeys --> Empty{Список ключей пуст?}
Empty -->|Да| ReturnEmpty[Вернуть пустую строку]
Empty -->|Нет| WRR[selectWeightedRoundRobin]
WRR --> Bind[sessionBindings.set]
Bind --> ReturnNew[Вернуть новый ключ]

Зачем нужна сессионная привязка:

  • Провайдеры, например Anthropic, реализуют Prompt Cache
  • Отправка запросов с одним и тем же API Key позволяет попасть в кэш, экономя средства и время
  • Смена ключа приводит к промаху кэша
  • Поэтому в пределах одной сессии следует по возможности использовать один и тот же ключ

Обработка недоступного ключа:

getKeyForSession(providerId, sessionId):
binding = sessionBindings.get(sessionId)
if binding && binding.providerId === providerId:
keys = getAvailableKeys(providerId) // фильтр: enabled + не на кулдауне
boundKey = keys.find(k.id === binding.keyId)
if boundKey:
return resolveKey(boundKey.apiKey) // попадание: вернуть
// Ключ отключён/удалён/на кулдауне → нужна перепривязка
log.info("Session key no longer available, re-binding")

// Выбрать новый ключ и привязать
keys = getAvailableKeys(providerId)
if keys.length === 0: return ''
selected = selectWeightedRoundRobin(providerId, keys)
sessionBindings.set(sessionId, { keyId: selected.id, providerId })
return resolveKey(selected.apiKey)

Механизм кулдауна / экспоненциального отката

Формула экспоненциального отката

cooldownMs = min(DEFAULT_COOLDOWN_MS * 2^(errors - 1), MAX_COOLDOWN_MS)
Количество последовательных ошибокВычислениеДлительность кулдауна
160,000 * 2^060 с (1 минута)
260,000 * 2^1120 с (2 минуты)
360,000 * 2^2240 с (4 минуты)
460,000 * 2^3480 с (8 минут)
5+60,000 * 2^4900 с (максимум 15 минут)

Конфигурация констант:

КонстантаЗначениеОписание
DEFAULT_COOLDOWN_MS60,000 (60 с)Базовая длительность кулдауна
MAX_COOLDOWN_MS900,000 (15 мин)Максимальная длительность кулдауна
COOLDOWN_MULTIPLIER2Основание степени для отката
Интервал очистки30,000 (30 с)Интервал cleanupExpiredCooldowns()

Процесс применения кулдауна

applyCooldown(keyId, providerId, statusCode):
current = cooldowns.get(keyId)
errors = (current?.errors ?? 0) + 1
cooldownMs = min(60_000 * 2^(errors-1), 900_000)
cooldowns.set(keyId, {
until: Date.now() + cooldownMs,
errors: errors
})

Сброс кулдауна

  • При успешном запросе вызовите reportSuccess(sessionId)
  • Если у привязанного ключа есть запись кулдауна, она немедленно удаляется

Обработка ошибок аутентификации

При HTTP-ошибках 401 и 403 ключ считается постоянно недействительным:

flowchart TD
Error[reportError] --> Check{HTTP-код статуса}
Check -->|429/529| Cooldown[applyCooldown<br/>экспоненциальный откат]
Check -->|401/403| AuthFail[handleAuthFailure]
Check -->|другой| Ignore[Игнорировать]

AuthFail --> Disable[disableKey<br/>отключить в базе данных]
Disable --> InvalidateCache[keyCache.delete<br/>очистить кэш]

Cooldown --> Rebind[Выбрать новый ключ]
InvalidateCache --> Rebind

Rebind --> HasMore{Есть ещё доступные ключи?}
HasMore -->|Да| Return[Вернуть новый ключ]
HasMore -->|Нет| ReturnNull[Вернуть null]

Классификация HTTP-кодов статуса:

Код статусаКлассОбработка
401AUTH_FAILUREПостоянно отключить ключ
403AUTH_FAILUREПостоянно отключить ключ
429RATE_LIMITЭкспоненциальный откат кулдауна
529RATE_LIMITЭкспоненциальный откат кулдауна (перегрузка Anthropic)
ДругиеНикаких действий, вернуть null

Фильтрация доступности ключей

getAvailableKeys(providerId):
all = getAllKeys(providerId) // загрузить из кэша или базы данных
now = Date.now()
return all.filter(key =>
key.enabled === true // должен быть включён
&& !(cooldowns[key.id]?.until > now) // не на кулдауне
)

Интервал очистки

cleanupExpiredCooldowns() запускается каждые 30 секунд:

cleanupExpiredCooldowns():
now = Date.now()
for each [keyId, cd] in cooldowns:
if cd.until <= now:
cooldowns.delete(keyId)

Таблица интеграции IPC

IPC-каналНаправлениеПараметрыZod-схемаОписание
llmConfig:getApiKeysR → MproviderId: stringНетПолучить все ключи провайдера
llmConfig:addApiKeyR → M{ providerId, label?, apiKey, enabled?, weight? }AddApiKeySchemaДобавить ключ (по умолчанию weight=1, enabled=true)
llmConfig:updateApiKeyR → M{ id, label?, apiKey?, enabled?, weight? }UpdateApiKeySchemaОбновить информацию о ключе
llmConfig:deleteApiKeyR → M{ id: string }НетУдалить ключ
llmConfig:toggleApiKeyR → M{ id, enabled }ToggleApiKeySchemaВключить/отключить ключ

Правила валидации Zod:

// ограничение диапазона weight
weight: z.number().int().min(1).max(100)

// apiKey не пустой
apiKey: z.string().min(1)

// providerId не пустой
providerId: z.string().min(1)

Инвалидация кэша: все операции записи (add/update/delete/toggle) по завершении вызывают apiKeyPool.invalidateCache(providerId), чтобы следующий запрос перезагружал данные из базы.


Точки расширения

Настройка стратегии кулдауна

Измените константы в ApiKeyPoolService:

// Более агрессивный кулдаун (для сценариев с низким QPS)
private readonly DEFAULT_COOLDOWN_MS = 30_000; // 30 с
private readonly MAX_COOLDOWN_MS = 5 * 60_000; // 5 минут

// Более мягкий кулдаун (для сценариев с высоким QPS)
private readonly DEFAULT_COOLDOWN_MS = 120_000; // 2 минуты
private readonly MAX_COOLDOWN_MS = 30 * 60_000; // 30 минут

Пользовательская стратегия выбора ключа

Текущая стратегия — взвешенный round-robin. Для использования альтернативной (например, наименьшее количество подключений, случайный взвешенный выбор) замените метод selectWeightedRoundRobin().

Ключи из переменных окружения

Значения ключей с префиксом $ автоматически раскрываются как переменные окружения:

$OPENAI_API_KEY → process.env.OPENAI_API_KEY

Это обрабатывается функцией ApiKeyResolver, реализованной в CompletionService.resolveApiKey().


Связанные файлы

ФайлВзаимосвязь
capabilities/llm/completion/CompletionService.tsПотребитель: обращается к пулу через resolveApiKeyForRequest()
workers/db/apiKeys.tsИсточник данных: предоставляет loadKeys и CRUD-операции
workers/types.tsОпределения типов DB Worker
routers/llm/ApiKeyRouter.tsIPC-слой: операции управления ключами на стороне фронтенда
renderer/.../ApiKeyPoolSection.tsxFrontend UI: CRUD для списка ключей
shared/llm-config.tsОпределение типа ApiKeyEntry