@mseep/obsidian-agent-client 0.10.6

package/src/services/session-storage.ts

@@ -0,0 +1,267 @@
+/**
+ * Session storage for persisting session metadata and message history.
+ *
+ * Handles:
+ * - Session metadata CRUD (in plugin settings savedSessions array)
+ * - Session message file I/O (sessions/{id}.json)
+ */
+
+import { Platform } from "obsidian";
+
+import type { AgentClientPluginSettings } from "../plugin";
+import type AgentClientPlugin from "../plugin";
+import type { ChatMessage, MessageContent } from "../types/chat";
+import type { SavedSessionInfo } from "../types/session";
+import { convertWindowsPathToWsl } from "../utils/platform";
+
+// ============================================================================
+// Types
+// ============================================================================
+
+/**
+ * Serialized format for session message files.
+ */
+interface SessionMessagesFile {
+	version: number;
+	sessionId: string;
+	agentId: string;
+	messages: Array<{
+		id: string;
+		role: "user" | "assistant";
+		content: MessageContent[];
+		timestamp: string;
+	}>;
+	savedAt: string;
+}
+
+/**
+ * Interface for settings access needed by SessionStorage.
+ * Subset of SettingsService to avoid circular dependency.
+ */
+interface SessionStorageSettingsAccess {
+	getSnapshot(): AgentClientPluginSettings;
+	updateSettings(updates: Partial<AgentClientPluginSettings>): Promise<void>;
+}
+
+// ============================================================================
+// Implementation
+// ============================================================================
+
+/** Maximum number of saved sessions to keep */
+const MAX_SAVED_SESSIONS = 50;
+
+export class SessionStorage {
+	private plugin: AgentClientPlugin;
+	private settingsAccess: SessionStorageSettingsAccess;
+
+	/** Lock for session operations to prevent race conditions */
+	private sessionLock: Promise<void> = Promise.resolve();
+
+	constructor(
+		plugin: AgentClientPlugin,
+		settingsAccess: SessionStorageSettingsAccess,
+	) {
+		this.plugin = plugin;
+		this.settingsAccess = settingsAccess;
+	}
+
+	// ============================================================
+	// Session Metadata Methods
+	// ============================================================
+
+	/**
+	 * Save a session to local storage.
+	 *
+	 * Updates existing session if sessionId matches.
+	 * Maintains max 50 sessions, removing oldest when exceeded.
+	 */
+	async saveSession(info: SavedSessionInfo): Promise<void> {
+		this.sessionLock = this.sessionLock.then(async () => {
+			// Convert Windows path to WSL path if in WSL mode
+			let sessionInfo = info;
+			const state = this.settingsAccess.getSnapshot();
+			if (Platform.isWin && state.windowsWslMode && info.cwd) {
+				sessionInfo = {
+					...info,
+					cwd: convertWindowsPathToWsl(info.cwd),
+				};
+			}
+
+			const sessions = [...(state.savedSessions || [])];
+
+			// Find existing session by sessionId
+			const existingIndex = sessions.findIndex(
+				(s) => s.sessionId === sessionInfo.sessionId,
+			);
+
+			if (existingIndex >= 0) {
+				sessions[existingIndex] = sessionInfo;
+			} else {
+				sessions.unshift(sessionInfo);
+				if (sessions.length > MAX_SAVED_SESSIONS) {
+					sessions.pop();
+				}
+			}
+
+			await this.settingsAccess.updateSettings({
+				savedSessions: sessions,
+			});
+		});
+		await this.sessionLock;
+	}
+
+	/**
+	 * Get saved sessions, optionally filtered by agentId and/or cwd.
+	 * Returns sessions sorted by updatedAt (newest first).
+	 */
+	getSavedSessions(agentId?: string, cwd?: string): SavedSessionInfo[] {
+		const state = this.settingsAccess.getSnapshot();
+		let sessions = state.savedSessions || [];
+
+		if (agentId) {
+			sessions = sessions.filter((s) => s.agentId === agentId);
+		}
+		if (cwd) {
+			let filterCwd = cwd;
+			if (Platform.isWin && state.windowsWslMode) {
+				filterCwd = convertWindowsPathToWsl(cwd);
+			}
+			sessions = sessions.filter((s) => s.cwd === filterCwd);
+		}
+
+		return [...sessions].sort(
+			(a, b) =>
+				new Date(b.updatedAt).getTime() -
+				new Date(a.updatedAt).getTime(),
+		);
+	}
+
+	/**
+	 * Delete a saved session by sessionId.
+	 * Also deletes the associated message history file.
+	 */
+	async deleteSession(sessionId: string): Promise<void> {
+		this.sessionLock = this.sessionLock.then(async () => {
+			const state = this.settingsAccess.getSnapshot();
+			const sessions = (state.savedSessions || []).filter(
+				(s) => s.sessionId !== sessionId,
+			);
+			await this.settingsAccess.updateSettings({
+				savedSessions: sessions,
+			});
+			await this.deleteSessionMessages(sessionId);
+		});
+		await this.sessionLock;
+	}
+
+	// ============================================================
+	// Session Message History Methods
+	// ============================================================
+
+	private getSessionsDir(): string {
+		return `${this.plugin.app.vault.configDir}/plugins/agent-client/sessions`;
+	}
+
+	private async ensureSessionsDir(): Promise<void> {
+		const adapter = this.plugin.app.vault.adapter;
+		const sessionsDir = this.getSessionsDir();
+		if (!(await adapter.exists(sessionsDir))) {
+			await adapter.mkdir(sessionsDir);
+		}
+	}
+
+	private getSessionFilePath(sessionId: string): string {
+		const safeId = sessionId.replace(/[^a-zA-Z0-9_-]/g, "_");
+		return `${this.getSessionsDir()}/${safeId}.json`;
+	}
+
+	/**
+	 * Save message history for a session.
+	 */
+	async saveSessionMessages(
+		sessionId: string,
+		agentId: string,
+		messages: ChatMessage[],
+	): Promise<void> {
+		await this.ensureSessionsDir();
+
+		const serialized = messages.map((msg) => ({
+			...msg,
+			timestamp: msg.timestamp.toISOString(),
+		}));
+
+		const data = {
+			version: 1,
+			sessionId,
+			agentId,
+			messages: serialized,
+			savedAt: new Date().toISOString(),
+		};
+
+		const filePath = this.getSessionFilePath(sessionId);
+		await this.plugin.app.vault.adapter.write(
+			filePath,
+			JSON.stringify(data, null, 2),
+		);
+	}
+
+	/**
+	 * Load message history for a session.
+	 * Returns null if file doesn't exist or on error.
+	 */
+	async loadSessionMessages(
+		sessionId: string,
+	): Promise<ChatMessage[] | null> {
+		const filePath = this.getSessionFilePath(sessionId);
+		const adapter = this.plugin.app.vault.adapter;
+
+		if (!(await adapter.exists(filePath))) {
+			return null;
+		}
+
+		try {
+			const content = await adapter.read(filePath);
+			const data = JSON.parse(content) as SessionMessagesFile;
+
+			if (
+				typeof data.version !== "number" ||
+				!Array.isArray(data.messages)
+			) {
+				console.warn(
+					`[SessionStorage] Invalid session file structure: ${filePath}`,
+				);
+				return null;
+			}
+
+			if (data.version !== 1) {
+				console.warn(
+					`[SessionStorage] Unknown session file version: ${data.version}`,
+				);
+				return null;
+			}
+
+			return data.messages.map((msg) => ({
+				...msg,
+				timestamp: new Date(msg.timestamp),
+			}));
+		} catch (error) {
+			console.error(
+				`[SessionStorage] Failed to load session messages: ${error}`,
+			);
+			return null;
+		}
+	}
+
+	/**
+	 * Delete message history file for a session.
+	 * Silently succeeds if file doesn't exist.
+	 */
+	async deleteSessionMessages(sessionId: string): Promise<void> {
+		const filePath = this.getSessionFilePath(sessionId);
+		const adapter = this.plugin.app.vault.adapter;
+
+		if (await adapter.exists(filePath)) {
+			await adapter.remove(filePath);
+		}
+	}
+}

package/src/services/settings-normalizer.ts

@@ -0,0 +1,255 @@
+/**
+ * Settings normalization and validation utilities.
+ *
+ * Pure functions for validating and normalizing plugin settings values.
+ * Used by plugin.ts (loadSettings) and SettingsTab.ts.
+ */
+
+import type { AgentEnvVar, CustomAgentSettings } from "../plugin";
+import type { BaseAgentSettings } from "../types/agent";
+import type { AgentConfig } from "../acp/acp-client";
+
+// ============================================================================
+// Display Settings
+// ============================================================================
+
+export const CHAT_FONT_SIZE_MIN = 10;
+export const CHAT_FONT_SIZE_MAX = 30;
+
+export const parseChatFontSize = (value: unknown): number | null => {
+	if (value === null || value === undefined) {
+		return null;
+	}
+
+	const numericValue = (() => {
+		if (typeof value === "number") {
+			return value;
+		}
+
+		if (typeof value === "string") {
+			const trimmedValue = value.trim();
+			if (trimmedValue.length === 0) {
+				return Number.NaN;
+			}
+			if (!/^-?\d+$/.test(trimmedValue)) {
+				return Number.NaN;
+			}
+			return Number.parseInt(trimmedValue, 10);
+		}
+
+		return Number.NaN;
+	})();
+
+	if (!Number.isFinite(numericValue)) {
+		return null;
+	}
+
+	return Math.min(
+		CHAT_FONT_SIZE_MAX,
+		Math.max(CHAT_FONT_SIZE_MIN, Math.round(numericValue)),
+	);
+};
+
+// ============================================================================
+// Settings Utilities
+// ============================================================================
+
+export const sanitizeArgs = (value: unknown): string[] => {
+	if (Array.isArray(value)) {
+		return value
+			.map((item) => (typeof item === "string" ? item.trim() : ""))
+			.filter((item) => item.length > 0);
+	}
+	if (typeof value === "string") {
+		return value
+			.split(/\r?\n/)
+			.map((item) => item.trim())
+			.filter((item) => item.length > 0);
+	}
+	return [];
+};
+
+// Convert stored env structures into a deduplicated list
+export const normalizeEnvVars = (value: unknown): AgentEnvVar[] => {
+	const pairs: AgentEnvVar[] = [];
+	if (!value) {
+		return pairs;
+	}
+
+	if (Array.isArray(value)) {
+		for (const entry of value) {
+			if (entry && typeof entry === "object") {
+				// Type guard: check if entry has key and value properties
+				const entryObj = entry as Record<string, unknown>;
+				const key = "key" in entryObj ? entryObj.key : undefined;
+				const val = "value" in entryObj ? entryObj.value : undefined;
+				if (typeof key === "string" && key.trim().length > 0) {
+					pairs.push({
+						key: key.trim(),
+						value: typeof val === "string" ? val : "",
+					});
+				}
+			}
+		}
+	} else if (typeof value === "object") {
+		for (const [key, val] of Object.entries(
+			value as Record<string, unknown>,
+		)) {
+			if (typeof key === "string" && key.trim().length > 0) {
+				pairs.push({
+					key: key.trim(),
+					value: typeof val === "string" ? val : "",
+				});
+			}
+		}
+	}
+
+	const seen = new Set<string>();
+	return pairs.filter((pair) => {
+		if (seen.has(pair.key)) {
+			return false;
+		}
+		seen.add(pair.key);
+		return true;
+	});
+};
+
+// Rebuild a custom agent entry with defaults and cleaned values
+export const normalizeCustomAgent = (
+	agent: Record<string, unknown>,
+): CustomAgentSettings => {
+	const rawId =
+		agent && typeof agent.id === "string" && agent.id.trim().length > 0
+			? agent.id.trim()
+			: "custom-agent";
+	const rawDisplayName =
+		agent &&
+		typeof agent.displayName === "string" &&
+		agent.displayName.trim().length > 0
+			? agent.displayName.trim()
+			: rawId;
+	return {
+		id: rawId,
+		displayName: rawDisplayName,
+		command:
+			agent &&
+			typeof agent.command === "string" &&
+			agent.command.trim().length > 0
+				? agent.command.trim()
+				: "",
+		args: sanitizeArgs(agent?.args),
+		env: normalizeEnvVars(agent?.env),
+	};
+};
+
+// Ensure custom agent IDs are unique within the collection
+export const ensureUniqueCustomAgentIds = (
+	agents: CustomAgentSettings[],
+): CustomAgentSettings[] => {
+	const seen = new Set<string>();
+	return agents.map((agent) => {
+		const base =
+			agent.id && agent.id.trim().length > 0
+				? agent.id.trim()
+				: "custom-agent";
+		let candidate = base;
+		let suffix = 2;
+		while (seen.has(candidate)) {
+			candidate = `${base}-${suffix}`;
+			suffix += 1;
+		}
+		seen.add(candidate);
+		return { ...agent, id: candidate };
+	});
+};
+
+/**
+ * Convert BaseAgentSettings to AgentConfig for process execution.
+ *
+ * Transforms the storage format (BaseAgentSettings) to the runtime format (AgentConfig)
+ * needed by AcpClient.initialize().
+ */
+export const toAgentConfig = (
+	settings: BaseAgentSettings,
+	workingDirectory: string,
+): AgentConfig => {
+	// Convert AgentEnvVar[] to Record<string, string> for process.spawn()
+	const env = settings.env.reduce(
+		(acc, { key, value }) => {
+			acc[key] = value;
+			return acc;
+		},
+		{} as Record<string, string>,
+	);
+
+	return {
+		id: settings.id,
+		displayName: settings.displayName,
+		command: settings.command,
+		args: settings.args,
+		env,
+		workingDirectory,
+	};
+};
+
+// ============================================================================
+// Settings Loading Helpers
+// ============================================================================
+
+/** Extract a string value, falling back to default if not a string */
+export function str(raw: unknown, fallback: string): string {
+	return typeof raw === "string" ? raw : fallback;
+}
+
+/** Extract a boolean value, falling back to default if not a boolean */
+export function bool(raw: unknown, fallback: boolean): boolean {
+	return typeof raw === "boolean" ? raw : fallback;
+}
+
+/** Extract a number value with optional minimum, falling back to default */
+export function num(raw: unknown, fallback: number, min?: number): number {
+	if (typeof raw !== "number") return fallback;
+	if (min !== undefined && raw < min) return fallback;
+	return raw;
+}
+
+/** Extract a value that must be one of the valid options */
+export function enumVal<T extends string>(
+	raw: unknown,
+	valid: T[],
+	fallback: T,
+): T {
+	return valid.includes(raw as T) ? (raw as T) : fallback;
+}
+
+/** Extract a plain object, or return null */
+export function obj(raw: unknown): Record<string, unknown> | null {
+	return raw && typeof raw === "object" && !Array.isArray(raw)
+		? (raw as Record<string, unknown>)
+		: null;
+}
+
+/** Extract a Record<string, string> with validated entries */
+export function strRecord(raw: unknown): Record<string, string> {
+	const result: Record<string, string> = {};
+	const o = obj(raw);
+	if (!o) return result;
+	for (const [key, value] of Object.entries(o)) {
+		if (
+			typeof key === "string" &&
+			key.length > 0 &&
+			typeof value === "string" &&
+			value.length > 0
+		) {
+			result[key] = value;
+		}
+	}
+	return result;
+}
+
+/** Extract an {x, y} point, or return null if invalid */
+export function xyPoint(raw: unknown): { x: number; y: number } | null {
+	const o = obj(raw);
+	if (!o || typeof o.x !== "number" || typeof o.y !== "number") return null;
+	return { x: o.x, y: o.y };
+}