Refactor settings manager (#39)
Co-authored-by: Shubham Naik <shub@memgpt.ai>
This commit is contained in:
Shubham Naik
377
src/settings-manager.ts
Normal file
377
src/settings-manager.ts
Normal file
@@ -0,0 +1,377 @@
|
||||
// src/settings-manager.ts
|
||||
// In-memory settings manager that loads once and provides sync access
|
||||
|
||||
import { homedir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import type { PermissionRules } from "./permissions/types";
|
||||
import { exists, mkdir, readFile, writeFile } from "./utils/fs.js";
|
||||
|
||||
export type UIMode = "simple" | "rich";
|
||||
|
||||
export interface Settings {
|
||||
uiMode: UIMode;
|
||||
lastAgent: string | null;
|
||||
tokenStreaming: boolean;
|
||||
globalSharedBlockIds: Record<string, string>;
|
||||
permissions?: PermissionRules;
|
||||
env?: Record<string, string>;
|
||||
}
|
||||
|
||||
export interface ProjectSettings {
|
||||
localSharedBlockIds: Record<string, string>;
|
||||
}
|
||||
|
||||
export interface LocalProjectSettings {
|
||||
lastAgent: string | null;
|
||||
permissions?: PermissionRules;
|
||||
}
|
||||
|
||||
const DEFAULT_SETTINGS: Settings = {
|
||||
uiMode: "simple",
|
||||
lastAgent: null,
|
||||
tokenStreaming: false,
|
||||
globalSharedBlockIds: {},
|
||||
};
|
||||
|
||||
const DEFAULT_PROJECT_SETTINGS: ProjectSettings = {
|
||||
localSharedBlockIds: {},
|
||||
};
|
||||
|
||||
const DEFAULT_LOCAL_PROJECT_SETTINGS: LocalProjectSettings = {
|
||||
lastAgent: null,
|
||||
};
|
||||
|
||||
class SettingsManager {
|
||||
private settings: Settings | null = null;
|
||||
private projectSettings: Map<string, ProjectSettings> = new Map();
|
||||
private localProjectSettings: Map<string, LocalProjectSettings> = new Map();
|
||||
private initialized = false;
|
||||
|
||||
/**
|
||||
* Initialize the settings manager (loads from disk)
|
||||
* Should be called once at app startup
|
||||
*/
|
||||
async initialize(): Promise<void> {
|
||||
if (this.initialized) return;
|
||||
|
||||
const settingsPath = this.getSettingsPath();
|
||||
|
||||
try {
|
||||
// Check if settings file exists
|
||||
if (!exists(settingsPath)) {
|
||||
// Create default settings file
|
||||
this.settings = { ...DEFAULT_SETTINGS };
|
||||
await this.persistSettings();
|
||||
} else {
|
||||
// Read and parse settings
|
||||
const content = await readFile(settingsPath);
|
||||
const loadedSettings = JSON.parse(content) as Settings;
|
||||
// Merge with defaults in case new fields were added
|
||||
this.settings = { ...DEFAULT_SETTINGS, ...loadedSettings };
|
||||
}
|
||||
|
||||
this.initialized = true;
|
||||
} catch (error) {
|
||||
console.error("Error loading settings, using defaults:", error);
|
||||
this.settings = { ...DEFAULT_SETTINGS };
|
||||
this.initialized = true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all settings (synchronous, from memory)
|
||||
*/
|
||||
getSettings(): Settings {
|
||||
if (!this.initialized || !this.settings) {
|
||||
throw new Error(
|
||||
"Settings not initialized. Call settingsManager.initialize() first.",
|
||||
);
|
||||
}
|
||||
return { ...this.settings };
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a specific setting value (synchronous)
|
||||
*/
|
||||
getSetting<K extends keyof Settings>(key: K): Settings[K] {
|
||||
return this.getSettings()[key];
|
||||
}
|
||||
|
||||
/**
|
||||
* Update settings (synchronous in-memory, async persist)
|
||||
*/
|
||||
updateSettings(updates: Partial<Settings>): void {
|
||||
if (!this.initialized || !this.settings) {
|
||||
throw new Error(
|
||||
"Settings not initialized. Call settingsManager.initialize() first.",
|
||||
);
|
||||
}
|
||||
|
||||
this.settings = { ...this.settings, ...updates };
|
||||
|
||||
// Persist asynchronously (fire and forget, errors logged)
|
||||
this.persistSettings().catch((error) => {
|
||||
console.error("Failed to persist settings:", error);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Load project settings for a specific directory
|
||||
*/
|
||||
async loadProjectSettings(
|
||||
workingDirectory: string = process.cwd(),
|
||||
): Promise<ProjectSettings> {
|
||||
// Check cache first
|
||||
const cached = this.projectSettings.get(workingDirectory);
|
||||
if (cached) {
|
||||
return { ...cached };
|
||||
}
|
||||
|
||||
const settingsPath = this.getProjectSettingsPath(workingDirectory);
|
||||
|
||||
try {
|
||||
if (!exists(settingsPath)) {
|
||||
const defaults = { ...DEFAULT_PROJECT_SETTINGS };
|
||||
this.projectSettings.set(workingDirectory, defaults);
|
||||
return defaults;
|
||||
}
|
||||
|
||||
const content = await readFile(settingsPath);
|
||||
const rawSettings = JSON.parse(content) as Record<string, unknown>;
|
||||
|
||||
const projectSettings: ProjectSettings = {
|
||||
localSharedBlockIds:
|
||||
(rawSettings.localSharedBlockIds as Record<string, string>) ?? {},
|
||||
};
|
||||
|
||||
this.projectSettings.set(workingDirectory, projectSettings);
|
||||
return { ...projectSettings };
|
||||
} catch (error) {
|
||||
console.error("Error loading project settings, using defaults:", error);
|
||||
const defaults = { ...DEFAULT_PROJECT_SETTINGS };
|
||||
this.projectSettings.set(workingDirectory, defaults);
|
||||
return defaults;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get project settings (synchronous, from memory)
|
||||
*/
|
||||
getProjectSettings(
|
||||
workingDirectory: string = process.cwd(),
|
||||
): ProjectSettings {
|
||||
const cached = this.projectSettings.get(workingDirectory);
|
||||
if (!cached) {
|
||||
throw new Error(
|
||||
`Project settings for ${workingDirectory} not loaded. Call loadProjectSettings() first.`,
|
||||
);
|
||||
}
|
||||
return { ...cached };
|
||||
}
|
||||
|
||||
/**
|
||||
* Update project settings (synchronous in-memory, async persist)
|
||||
*/
|
||||
updateProjectSettings(
|
||||
updates: Partial<ProjectSettings>,
|
||||
workingDirectory: string = process.cwd(),
|
||||
): void {
|
||||
const current = this.projectSettings.get(workingDirectory);
|
||||
if (!current) {
|
||||
throw new Error(
|
||||
`Project settings for ${workingDirectory} not loaded. Call loadProjectSettings() first.`,
|
||||
);
|
||||
}
|
||||
|
||||
const updated = { ...current, ...updates };
|
||||
this.projectSettings.set(workingDirectory, updated);
|
||||
|
||||
// Persist asynchronously
|
||||
this.persistProjectSettings(workingDirectory).catch((error) => {
|
||||
console.error("Failed to persist project settings:", error);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Persist settings to disk (private helper)
|
||||
*/
|
||||
private async persistSettings(): Promise<void> {
|
||||
if (!this.settings) return;
|
||||
|
||||
const settingsPath = this.getSettingsPath();
|
||||
const dirPath = join(homedir(), ".letta");
|
||||
|
||||
try {
|
||||
if (!exists(dirPath)) {
|
||||
await mkdir(dirPath, { recursive: true });
|
||||
}
|
||||
await writeFile(settingsPath, JSON.stringify(this.settings, null, 2));
|
||||
} catch (error) {
|
||||
console.error("Error saving settings:", error);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Persist project settings to disk (private helper)
|
||||
*/
|
||||
private async persistProjectSettings(
|
||||
workingDirectory: string,
|
||||
): Promise<void> {
|
||||
const settings = this.projectSettings.get(workingDirectory);
|
||||
if (!settings) return;
|
||||
|
||||
const settingsPath = this.getProjectSettingsPath(workingDirectory);
|
||||
const dirPath = join(workingDirectory, ".letta");
|
||||
|
||||
try {
|
||||
// Read existing settings (might have permissions, etc.)
|
||||
let existingSettings: Record<string, unknown> = {};
|
||||
if (exists(settingsPath)) {
|
||||
const content = await readFile(settingsPath);
|
||||
existingSettings = JSON.parse(content) as Record<string, unknown>;
|
||||
}
|
||||
|
||||
// Create directory if needed
|
||||
if (!exists(dirPath)) {
|
||||
await mkdir(dirPath, { recursive: true });
|
||||
}
|
||||
|
||||
// Merge updates with existing settings
|
||||
const newSettings = {
|
||||
...existingSettings,
|
||||
...settings,
|
||||
};
|
||||
|
||||
await writeFile(settingsPath, JSON.stringify(newSettings, null, 2));
|
||||
} catch (error) {
|
||||
console.error("Error saving project settings:", error);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
private getSettingsPath(): string {
|
||||
return join(homedir(), ".letta", "settings.json");
|
||||
}
|
||||
|
||||
private getProjectSettingsPath(workingDirectory: string): string {
|
||||
return join(workingDirectory, ".letta", "settings.json");
|
||||
}
|
||||
|
||||
private getLocalProjectSettingsPath(workingDirectory: string): string {
|
||||
return join(workingDirectory, ".letta", "settings.local.json");
|
||||
}
|
||||
|
||||
/**
|
||||
* Load local project settings (.letta/settings.local.json)
|
||||
*/
|
||||
async loadLocalProjectSettings(
|
||||
workingDirectory: string = process.cwd(),
|
||||
): Promise<LocalProjectSettings> {
|
||||
// Check cache first
|
||||
const cached = this.localProjectSettings.get(workingDirectory);
|
||||
if (cached) {
|
||||
return { ...cached };
|
||||
}
|
||||
|
||||
const settingsPath = this.getLocalProjectSettingsPath(workingDirectory);
|
||||
|
||||
try {
|
||||
if (!exists(settingsPath)) {
|
||||
const defaults = { ...DEFAULT_LOCAL_PROJECT_SETTINGS };
|
||||
this.localProjectSettings.set(workingDirectory, defaults);
|
||||
return defaults;
|
||||
}
|
||||
|
||||
const content = await readFile(settingsPath);
|
||||
const localSettings = JSON.parse(content) as LocalProjectSettings;
|
||||
|
||||
this.localProjectSettings.set(workingDirectory, localSettings);
|
||||
return { ...localSettings };
|
||||
} catch (error) {
|
||||
console.error(
|
||||
"Error loading local project settings, using defaults:",
|
||||
error,
|
||||
);
|
||||
const defaults = { ...DEFAULT_LOCAL_PROJECT_SETTINGS };
|
||||
this.localProjectSettings.set(workingDirectory, defaults);
|
||||
return defaults;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get local project settings (synchronous, from memory)
|
||||
*/
|
||||
getLocalProjectSettings(
|
||||
workingDirectory: string = process.cwd(),
|
||||
): LocalProjectSettings {
|
||||
const cached = this.localProjectSettings.get(workingDirectory);
|
||||
if (!cached) {
|
||||
throw new Error(
|
||||
`Local project settings for ${workingDirectory} not loaded. Call loadLocalProjectSettings() first.`,
|
||||
);
|
||||
}
|
||||
return { ...cached };
|
||||
}
|
||||
|
||||
/**
|
||||
* Update local project settings (synchronous in-memory, async persist)
|
||||
*/
|
||||
updateLocalProjectSettings(
|
||||
updates: Partial<LocalProjectSettings>,
|
||||
workingDirectory: string = process.cwd(),
|
||||
): void {
|
||||
const current = this.localProjectSettings.get(workingDirectory);
|
||||
if (!current) {
|
||||
throw new Error(
|
||||
`Local project settings for ${workingDirectory} not loaded. Call loadLocalProjectSettings() first.`,
|
||||
);
|
||||
}
|
||||
|
||||
const updated = { ...current, ...updates };
|
||||
this.localProjectSettings.set(workingDirectory, updated);
|
||||
|
||||
// Persist asynchronously
|
||||
this.persistLocalProjectSettings(workingDirectory).catch((error) => {
|
||||
console.error("Failed to persist local project settings:", error);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Persist local project settings to disk (private helper)
|
||||
*/
|
||||
private async persistLocalProjectSettings(
|
||||
workingDirectory: string,
|
||||
): Promise<void> {
|
||||
const settings = this.localProjectSettings.get(workingDirectory);
|
||||
if (!settings) return;
|
||||
|
||||
const settingsPath = this.getLocalProjectSettingsPath(workingDirectory);
|
||||
const dirPath = join(workingDirectory, ".letta");
|
||||
|
||||
try {
|
||||
// Create directory if needed
|
||||
if (!exists(dirPath)) {
|
||||
await mkdir(dirPath, { recursive: true });
|
||||
}
|
||||
|
||||
await writeFile(settingsPath, JSON.stringify(settings, null, 2));
|
||||
} catch (error) {
|
||||
console.error("Error saving local project settings:", error);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Reset the manager (mainly for testing)
|
||||
*/
|
||||
reset(): void {
|
||||
this.settings = null;
|
||||
this.projectSettings.clear();
|
||||
this.localProjectSettings.clear();
|
||||
this.initialized = false;
|
||||
}
|
||||
}
|
||||
|
||||
// Singleton instance
|
||||
export const settingsManager = new SettingsManager();
|
||||
Reference in New Issue
Block a user