logancyang_obsidian-copilot/src/plusUtils.ts
Zero Liu 89823e1d03
feat(chat): power legacy chat from the model-management chat backend (#2556)
* feat(chat): power legacy chat from the model-management "chat" backend

Legacy chat, project chat, vault QA, quick command, and quick ask now
select models from the model-management "chat" backend
(backends.chat.enabledModels) instead of the legacy activeModels /
defaultModelKey. A new ConfiguredModel→CustomModel bridge feeds the
existing ChatModelManager (the stubbed v4 ChatModelFactory is untouched),
and a new "Quick Chat" curation section under the Agents settings tab
lets users choose which BYOK/Plus models appear in the chat picker.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* style(skills): apply prettier formatting to builtinSkills.test.ts

Collapse a multi-line expect() onto one line to satisfy the project's
prettier config (surfaced when running npm run format).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(chat): stabilize chat backend model selections

* fix(chat): address chat backend review regressions

* fix(chat): show legacy chat models in a flat list

Drop the per-provider _group on chat picker entries so the legacy chat
model picker renders a single flat list (provider icons inline, no
section headers), matching pre-migration behavior. Agent Mode keeps its
per-backend headers via its own helper.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* refactor(chat): remove dead per-model parameter editing

After the model-management chat migration, per-model parameter editing
is unreachable: the chat selection is now a configuredModelId UUID, so
the ChatSettingsPopover editor (gated on a legacy activeModels match)
never renders, and TokenLimitWarning's activeModels lookup always misses
and falls back to global settings. v4 agent mode no longer supports
per-model parameter editing.

- ChatSettingsPopover: drop the model-param plumbing (originalModel /
  bridgedModel / canEditModelParameters, local-model save/debounce,
  ModelParametersEditor); keep System Prompt + Disable Builtin controls.
- TokenLimitWarning: always open the global Copilot settings tab.
- Delete the now-orphaned ModelEditDialog and ModelParametersEditor.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* refactor(chat): drop dead legacy model-key fallback in streaming session

The streaming chat session's chain cache key fell back to name|provider
when configuredModelId was absent. Both callers (Quick Ask, custom-command
chat) now source their model from useResolvedChatBackendModel ->
configuredModelToCustomModel, which always stamps configuredModelId, so the
fallback was unreachable. Derive the key directly from configuredModelId;
a model without one is treated as no usable model via the existing guards.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* refactor(chat): remove test-only getLegacyChatModelKey helper

The singular getLegacyChatModelKey was exported but had no production
callers — only the barrel re-export and one test assertion referenced it.
Remove it (and its export + assertion); the load-bearing plural
getLegacyChatModelKeys, which powers legacy-key resolution in
isChatModelSelectionForEntry, is kept and now carries the rationale comment.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* refactor(model-management): dedupe catalog-id to provider map

Drop the duplicate CATALOG_ID_TO_LEGACY_PROVIDER table in chatModelSelection
and reuse the now-exported CATALOG_ID_TO_CHAT_PROVIDER from
configuredModelToCustomModel (extended with anthropic/google for the
legacy-key path). Single source of truth for catalog-id to ChatModelProviders.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-06 14:52:50 -07:00

420 lines
15 KiB
TypeScript

import { setChainType, setModelKey } from "@/aiParams";
import { ChainType } from "@/chainType";
import { CopilotPlusExpiredModal } from "@/components/modals/CopilotPlusExpiredModal";
import {
ChatModelProviders,
ChatModels,
EmbeddingModelProviders,
EmbeddingModels,
PlusUtmMedium,
} from "@/constants";
import { BrevilabsClient } from "@/LLMProviders/brevilabsClient";
import { logError, logInfo } from "@/logger";
import { getSettings, setSettings, updateSetting, useSettingsValue } from "@/settings/model";
import { App, Notice } from "obsidian";
import React from "react";
export const DEFAULT_COPILOT_PLUS_CHAT_MODEL = ChatModels.COPILOT_PLUS_FLASH;
const DEFAULT_COPILOT_PLUS_CHAT_MODEL_KEY =
DEFAULT_COPILOT_PLUS_CHAT_MODEL + "|" + ChatModelProviders.COPILOT_PLUS;
export const DEFAULT_COPILOT_PLUS_EMBEDDING_MODEL = EmbeddingModels.COPILOT_PLUS_SMALL;
export const DEFAULT_COPILOT_PLUS_EMBEDDING_MODEL_KEY =
DEFAULT_COPILOT_PLUS_EMBEDDING_MODEL + "|" + EmbeddingModelProviders.COPILOT_PLUS;
// ============================================================================
// SELF-HOST MODE VALIDATION
// ============================================================================
// Self-host mode allows Believer/Supporter users to use their own infrastructure.
//
// Validation flow:
// 1. User enables toggle → validateSelfHostMode() → count = 1, timestamp set
// 2. Every 15+ days on plugin load → refreshSelfHostModeValidation() → count++
// 3. After 3 successful validations → permanent (no more checks needed)
//
// Offline support:
// - Within 15-day grace period: Full functionality, can toggle off/on
// - Permanent (count >= 3): Full functionality forever
// - Grace expired while offline: Must go online to revalidate
//
// Settings section visibility (useIsSelfHostEligible):
// - Shown if: permanent OR within grace period OR API confirms eligibility
// - Hidden if: no license key OR grace expired + offline + not permanent
// ============================================================================
/** Grace period for self-host mode: 15 days */
const SELF_HOST_GRACE_PERIOD_MS = 15 * 24 * 60 * 60 * 1000;
/** Number of successful validations required for permanent self-host mode */
const SELF_HOST_PERMANENT_VALIDATION_COUNT = 3;
/** Plans that qualify for self-host mode */
const SELF_HOST_ELIGIBLE_PLANS = ["believer", "supporter"];
/**
* Check if self-host access is valid.
* Valid if: permanently validated (3+ successful checks) OR within 15-day grace period.
*/
export function isSelfHostAccessValid(): boolean {
const settings = getSettings();
if (settings.selfHostModeValidatedAt == null) {
return false;
}
// Permanently valid after 3 successful validations
if (settings.selfHostValidationCount >= SELF_HOST_PERMANENT_VALIDATION_COUNT) {
return true;
}
// Otherwise, check grace period
return Date.now() - settings.selfHostModeValidatedAt < SELF_HOST_GRACE_PERIOD_MS;
}
/**
* Check if self-host mode is valid and enabled.
* Requires the toggle to be on and access to be within the grace period or permanently validated.
*/
export function isSelfHostModeValid(): boolean {
const settings = getSettings();
if (!settings.enableSelfHostMode) {
return false;
}
return isSelfHostAccessValid();
}
/** Check if the model key is a Copilot Plus model. */
export function isPlusModel(modelKey: string): boolean {
const settings = getSettings();
const configuredModel = settings.configuredModels.find(
(model) => model.configuredModelId === modelKey
);
if (configuredModel) {
return settings.providers[configuredModel.providerId]?.origin.kind === "copilot-plus";
}
return (
(modelKey.split("|")[1] as EmbeddingModelProviders) === EmbeddingModelProviders.COPILOT_PLUS
);
}
/**
* Synchronous check if Plus features should be enabled.
* Returns true when self-host mode is valid OR user has valid Plus subscription.
* Use this for synchronous checks (e.g., model validation, UI state).
*/
export function isPlusEnabled(): boolean {
const settings = getSettings();
// Self-host mode with valid plan validation bypasses Plus requirements
if (isSelfHostModeValid()) {
return true;
}
return settings.isPlusUser === true;
}
/**
* Hook to get the isPlusUser setting.
* Returns true when self-host mode is valid to allow offline usage.
*/
export function useIsPlusUser(): boolean | undefined {
const settings = useSettingsValue();
// Self-host mode with valid plan validation bypasses Plus requirements (requires license key)
if (
settings.plusLicenseKey &&
settings.enableSelfHostMode &&
settings.selfHostModeValidatedAt != null
) {
// Permanently valid after 3 successful validations
if (settings.selfHostValidationCount >= SELF_HOST_PERMANENT_VALIDATION_COUNT) {
return true;
}
// Otherwise, check grace period
const isValid = Date.now() - settings.selfHostModeValidatedAt < SELF_HOST_GRACE_PERIOD_MS;
if (isValid) {
return true;
}
}
return settings.isPlusUser;
}
/**
* Check if the user is a Plus user.
* When self-host mode is valid, this returns true to allow offline usage.
*/
export async function checkIsPlusUser(
app?: App,
context?: Record<string, unknown>
): Promise<boolean | undefined> {
// Self-host mode with valid plan validation bypasses license check
if (isSelfHostModeValid()) {
return true;
}
if (!getSettings().plusLicenseKey) {
turnOffPlus(app);
return false;
}
const brevilabsClient = BrevilabsClient.getInstance();
const result = await brevilabsClient.validateLicenseKey(app, context);
return result.isValid;
}
/** Check if the user is on a plan that qualifies for self-host mode. */
async function isSelfHostEligiblePlan(): Promise<boolean> {
if (!getSettings().plusLicenseKey) {
return false;
}
const brevilabsClient = BrevilabsClient.getInstance();
const result = await brevilabsClient.validateLicenseKey();
const planName = result.plan?.toLowerCase();
return planName != null && SELF_HOST_ELIGIBLE_PLANS.includes(planName);
}
/**
* Hook to check if user should see the self-host mode settings section.
* Returns undefined while loading, boolean once checked.
*
* Eligibility rules:
* 1. No license key: Not eligible (immediately revokes access)
* 2. Has license key: Verify via API (handles key changes, e.g. believer → plus)
* - API success: Use result (revoke self-host mode if not eligible)
* - API failure (offline): Fall back to cached validation
* (permanent count >= 3 OR within 15-day grace period)
*/
export function useIsSelfHostEligible(): boolean | undefined {
const settings = useSettingsValue();
const [isEligible, setIsEligible] = React.useState<boolean | undefined>(undefined);
React.useEffect(() => {
// No license key = not eligible, regardless of cached validation state.
// Also force self-host mode OFF so the toggle reflects the revoked state.
if (!settings.plusLicenseKey) {
if (settings.enableSelfHostMode) {
updateSetting("enableSelfHostMode", false);
}
setIsEligible(false);
return;
}
// Has license key - always verify via API to handle key changes (e.g. believer → plus).
// Fall back to cached validation only when offline.
isSelfHostEligiblePlan()
.then((eligible) => {
if (!eligible && settings.enableSelfHostMode) {
updateSetting("enableSelfHostMode", false);
}
setIsEligible(eligible);
})
.catch(() => {
// Offline fallback: trust cached validation state
if (settings.selfHostValidationCount >= SELF_HOST_PERMANENT_VALIDATION_COUNT) {
setIsEligible(true);
return;
}
if (
settings.selfHostModeValidatedAt != null &&
Date.now() - settings.selfHostModeValidatedAt < SELF_HOST_GRACE_PERIOD_MS
) {
setIsEligible(true);
return;
}
setIsEligible(false);
});
}, [
settings.plusLicenseKey,
settings.enableSelfHostMode,
settings.selfHostModeValidatedAt,
settings.selfHostValidationCount,
]);
return isEligible;
}
/**
* Validate self-host mode when user enables the toggle.
* Called from UI when toggle is switched ON.
*
* Flow:
* 1. If permanently validated (count >= 3): Allow immediately (offline-safe)
* 2. If within grace period: Allow immediately (offline-safe)
* 3. Otherwise: Require API validation (online only)
* - Success: Set count = max(current, 1), update timestamp
* - Failure: Return false, UI should revert toggle
*
* @returns true if validation passed, false if user should not enable
*/
export async function validateSelfHostMode(): Promise<boolean> {
const settings = getSettings();
// Already permanently validated - allow re-enable (offline-safe)
if (settings.selfHostValidationCount >= SELF_HOST_PERMANENT_VALIDATION_COUNT) {
updateSetting("selfHostModeValidatedAt", Date.now());
logInfo("Self-host mode re-enabled (permanently validated)");
return true;
}
// Within grace period - allow re-enable (offline-safe)
if (
settings.selfHostModeValidatedAt != null &&
Date.now() - settings.selfHostModeValidatedAt < SELF_HOST_GRACE_PERIOD_MS
) {
logInfo("Self-host mode re-enabled (within grace period)");
return true;
}
// Not in grace period - require API validation (online only)
const isEligible = await isSelfHostEligiblePlan();
if (!isEligible) {
logInfo("Self-host mode requires an eligible plan (Believer, Supporter)");
new Notice("Self-host mode is only available for Believer and Supporter plan subscribers.");
return false;
}
// First-time or expired - set timestamp and initialize count
const newCount = Math.max(settings.selfHostValidationCount || 0, 1);
updateSetting("selfHostModeValidatedAt", Date.now());
updateSetting("selfHostValidationCount", newCount);
logInfo(`Self-host mode validation successful (${newCount}/3)`);
return true;
}
/**
* Refresh self-host mode validation on plugin startup.
* Called from main.ts on plugin load.
*
* Flow:
* 1. If toggle OFF or permanently validated: No-op
* 2. API check:
* - Eligible + 15+ days since last: Increment count, update timestamp
* - Eligible + <15 days: Log only (preserve countdown)
* - Not eligible: Disable toggle, reset count to 0
* - Offline/error: No-op (grace period continues)
*
* Count progression: 1 → 2 → 3 (permanent) over minimum 28 days.
*/
export async function refreshSelfHostModeValidation(): Promise<void> {
const settings = getSettings();
if (!settings.enableSelfHostMode && !settings.enableMiyo) {
return;
}
// Already permanently validated, no need to refresh
if (settings.selfHostValidationCount >= SELF_HOST_PERMANENT_VALIDATION_COUNT) {
logInfo("Self-host mode permanently validated, skipping refresh");
return;
}
try {
const isEligible = await isSelfHostEligiblePlan();
if (isEligible) {
const now = Date.now();
const timeSinceLastValidation = now - (settings.selfHostModeValidatedAt || 0);
const shouldIncrementCount = timeSinceLastValidation >= SELF_HOST_GRACE_PERIOD_MS;
if (shouldIncrementCount) {
// 15+ days since last validation - increment count and update timestamp
const newCount = (settings.selfHostValidationCount || 0) + 1;
updateSetting("selfHostModeValidatedAt", now);
updateSetting("selfHostValidationCount", newCount);
if (newCount >= SELF_HOST_PERMANENT_VALIDATION_COUNT) {
logInfo("Self-host mode permanently validated (3/3)");
new Notice("Self-host mode is now permanently enabled!");
} else {
logInfo(`Self-host mode validation refreshed (${newCount}/3)`);
}
} else {
// Less than 15 days - don't update timestamp (preserve interval countdown)
logInfo("Self-host mode validated (waiting for 15-day interval to increment count)");
}
} else {
// User is no longer on an eligible plan, disable self-host mode
updateSetting("enableSelfHostMode", false);
updateSetting("enableMiyo", false);
updateSetting("selfHostModeValidatedAt", null);
updateSetting("selfHostValidationCount", 0);
logInfo("Self-host mode disabled - user is no longer on an eligible plan");
new Notice("Self-host mode has been disabled. An eligible plan is required.");
}
} catch (error) {
// Offline or API error - keep existing validation (grace period still applies)
logInfo("Could not refresh self-host mode validation (offline?):", error);
}
}
/**
* Apply the Copilot Plus settings.
* Includes clinical fix to ensure indexing is triggered when embedding model changes,
* as the automatic detection doesn't work reliably in all scenarios.
*/
export function applyPlusSettings(): void {
const settings = getSettings();
const plusProviderIds = new Set(
Object.values(settings.providers)
.filter((provider) => provider.origin.kind === "copilot-plus")
.map((provider) => provider.providerId)
);
const defaultModelKey =
settings.configuredModels.find(
(model) =>
plusProviderIds.has(model.providerId) &&
model.info.id === (DEFAULT_COPILOT_PLUS_CHAT_MODEL as string)
)?.configuredModelId ?? DEFAULT_COPILOT_PLUS_CHAT_MODEL_KEY;
const embeddingModelKey = DEFAULT_COPILOT_PLUS_EMBEDDING_MODEL_KEY;
const previousEmbeddingModelKey = settings.embeddingModelKey;
logInfo("applyPlusSettings: Changing embedding model", {
from: previousEmbeddingModelKey,
to: embeddingModelKey,
changed: previousEmbeddingModelKey !== embeddingModelKey,
});
setModelKey(defaultModelKey);
setChainType(ChainType.COPILOT_PLUS_CHAIN);
setSettings({
defaultModelKey,
embeddingModelKey,
defaultChainType: ChainType.COPILOT_PLUS_CHAIN,
});
// Ensure indexing happens only once when embedding model changes
if (previousEmbeddingModelKey !== embeddingModelKey) {
logInfo("applyPlusSettings: Embedding model changed, triggering indexing");
import("@/search/vectorStoreManager")
.then(async (module) => {
await module.default.getInstance().indexVaultToVectorStore();
})
.catch((error) => {
logError("Failed to trigger indexing after Plus settings applied:", error);
new Notice(
"Failed to update Copilot index. Please try force reindexing from the command palette."
);
});
} else {
logInfo("applyPlusSettings: No embedding model change, skipping indexing");
}
}
export function createPlusPageUrl(medium: PlusUtmMedium): string {
return `https://www.obsidiancopilot.com?utm_source=obsidian&utm_medium=${medium}`;
}
export function navigateToPlusPage(medium: PlusUtmMedium): void {
window.open(createPlusPageUrl(medium), "_blank");
}
export function turnOnPlus(): void {
updateSetting("isPlusUser", true);
}
/**
* Turn off Plus user status.
* IMPORTANT: This is called on every plugin start for users without a Plus license key (see checkIsPlusUser).
* DO NOT reset model settings here - it will cause free users to lose their model selections on every app restart.
* Only update the isPlusUser flag.
*/
export function turnOffPlus(app?: App): void {
const previousIsPlusUser = getSettings().isPlusUser;
updateSetting("isPlusUser", false);
// The expiry modal needs `app`; interactive callers (load, settings, chat)
// pass it. Rare background paths (believer-model checks) flip the flag without
// a modal — they surface their own Notice instead.
if (previousIsPlusUser && app) {
new CopilotPlusExpiredModal(app).open();
}
}