f38b5b85bc
* docs: add investigation reports for 5 open GitHub issues Comprehensive analysis of issues #543, #544, #545, #555, and #557: - #557: settings.json not generated, module loader error (node/bun mismatch) - #555: Windows hooks not executing, hasIpc always false - #545: formatTool crashes on non-JSON tool_input strings - #544: mem-search skill hint shown incorrectly to Claude Code users - #543: /claude-mem slash command unavailable despite installation Each report includes root cause analysis, affected files, and proposed fixes. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(logger): handle non-JSON tool_input in formatTool (#545) Wrap JSON.parse in try-catch to handle raw string inputs (e.g., Bash commands) that aren't valid JSON. Falls back to using the string as-is. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(context): update mem-search hint to reference MCP tools (#544) Update hint messages to reference MCP tools (search, get_observations) instead of the deprecated "mem-search skill" terminology. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(settings): auto-create settings.json on first load (#557, #543) When settings.json doesn't exist, create it with defaults instead of returning in-memory defaults. Creates parent directory if needed. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(hooks): use bun runtime for hooks except smart-install (#557) Change hook commands from node to bun since hooks use bun:sqlite. Keep smart-install.js on node since it bootstraps bun installation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * chore: rebuild plugin scripts * docs: clarify that build artifacts must be committed * fix(docs): update build artifacts directory reference in CLAUDE.md * test: add test coverage for PR #558 fixes - Fix 2 failing tests: update "mem-search skill" → "MCP tools" expectations - Add 56 tests for formatTool() JSON.parse crash fix (Issue #545) - Add 27 tests for settings.json auto-creation (Issue #543) Test coverage includes: - formatTool: JSON parsing, raw strings, objects, null/undefined, all tool types - Settings: file creation, directory creation, schema migration, edge cases 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix(tests): clean up flaky tests and fix circular dependency Phase 1 of test quality improvements: - Delete 6 harmful/worthless test files that used problematic mock.module() patterns or tested implementation details rather than behavior: - context-builder.test.ts (tested internal implementation) - export-types.test.ts (fragile mock patterns) - smart-install.test.ts (shell script testing antipattern) - session_id_refactor.test.ts (outdated, tested refactoring itself) - validate_sql_update.test.ts (one-time migration validation) - observation-broadcaster.test.ts (excessive mocking) - Fix circular dependency between logger.ts and SettingsDefaultsManager.ts by using late binding pattern - logger now lazily loads settings - Refactor mock.module() to spyOn() in several test files for more maintainable and less brittle tests: - observation-compiler.test.ts - gemini_agent.test.ts - error-handler.test.ts - server.test.ts - response-processor.test.ts All 649 tests pass. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor(tests): phase 2 - reduce mock-heavy tests and improve focus - Remove mock-heavy query tests from observation-compiler.test.ts, keep real buildTimeline tests - Convert session_id_usage_validation.test.ts from 477 to 178 lines of focused smoke tests - Remove tests for language built-ins from worker-spawn.test.ts (JSON.parse, array indexing) - Rename logger-coverage.test.ts to logger-usage-standards.test.ts for clarity 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs(tests): phase 3 - add JSDoc mock justification to test files Document mock usage rationale in 5 test files to improve maintainability: - error-handler.test.ts: Express req/res mocks, logger spies (~11%) - fallback-error-handler.test.ts: Zero mocks, pure function tests - session-cleanup-helper.test.ts: Session fixtures, worker mocks (~19%) - hook-constants.test.ts: process.platform mock for Windows tests (~12%) - session_store.test.ts: Zero mocks, real SQLite :memory: database Part of ongoing effort to document mock justifications per TESTING.md guidelines. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * test(integration): phase 5 - add 72 tests for critical coverage gaps Add comprehensive test coverage for previously untested areas: - tests/integration/hook-execution-e2e.test.ts (10 tests) Tests lifecycle hooks execution flow and context propagation - tests/integration/worker-api-endpoints.test.ts (19 tests) Tests all worker service HTTP endpoints without heavy mocking - tests/integration/chroma-vector-sync.test.ts (16 tests) Tests vector embedding synchronization with ChromaDB - tests/utils/tag-stripping.test.ts (27 tests) Tests privacy tag stripping utilities for both <private> and <meta-observation> tags All tests use real implementations where feasible, following the project's testing philosophy of preferring integration-style tests over unit tests with extensive mocking. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * context update * docs: add comment linking DEFAULT_DATA_DIR locations Added NOTE comment in logger.ts pointing to the canonical DEFAULT_DATA_DIR in SettingsDefaultsManager.ts. This addresses PR reviewer feedback about the fragility of having the default defined in two places to avoid circular dependencies. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
186 lines
7.3 KiB
TypeScript
186 lines
7.3 KiB
TypeScript
/**
|
|
* SettingsDefaultsManager
|
|
*
|
|
* Single source of truth for all default configuration values.
|
|
* Provides methods to get defaults with optional environment variable overrides.
|
|
*/
|
|
|
|
import { readFileSync, writeFileSync, existsSync, mkdirSync } from 'fs';
|
|
import { join, dirname } from 'path';
|
|
import { homedir } from 'os';
|
|
import { DEFAULT_OBSERVATION_TYPES_STRING, DEFAULT_OBSERVATION_CONCEPTS_STRING } from '../constants/observation-metadata.js';
|
|
// NOTE: Do NOT import logger here - it creates a circular dependency
|
|
// logger.ts depends on SettingsDefaultsManager for its initialization
|
|
|
|
export interface SettingsDefaults {
|
|
CLAUDE_MEM_MODEL: string;
|
|
CLAUDE_MEM_CONTEXT_OBSERVATIONS: string;
|
|
CLAUDE_MEM_WORKER_PORT: string;
|
|
CLAUDE_MEM_WORKER_HOST: string;
|
|
CLAUDE_MEM_SKIP_TOOLS: string;
|
|
// AI Provider Configuration
|
|
CLAUDE_MEM_PROVIDER: string; // 'claude' | 'gemini' | 'openrouter'
|
|
CLAUDE_MEM_GEMINI_API_KEY: string;
|
|
CLAUDE_MEM_GEMINI_MODEL: string; // 'gemini-2.5-flash-lite' | 'gemini-2.5-flash' | 'gemini-3-flash'
|
|
CLAUDE_MEM_GEMINI_RATE_LIMITING_ENABLED: string; // 'true' | 'false' - enable rate limiting for free tier
|
|
CLAUDE_MEM_OPENROUTER_API_KEY: string;
|
|
CLAUDE_MEM_OPENROUTER_MODEL: string;
|
|
CLAUDE_MEM_OPENROUTER_SITE_URL: string;
|
|
CLAUDE_MEM_OPENROUTER_APP_NAME: string;
|
|
CLAUDE_MEM_OPENROUTER_MAX_CONTEXT_MESSAGES: string;
|
|
CLAUDE_MEM_OPENROUTER_MAX_TOKENS: string;
|
|
// System Configuration
|
|
CLAUDE_MEM_DATA_DIR: string;
|
|
CLAUDE_MEM_LOG_LEVEL: string;
|
|
CLAUDE_MEM_PYTHON_VERSION: string;
|
|
CLAUDE_CODE_PATH: string;
|
|
CLAUDE_MEM_MODE: string;
|
|
// Token Economics
|
|
CLAUDE_MEM_CONTEXT_SHOW_READ_TOKENS: string;
|
|
CLAUDE_MEM_CONTEXT_SHOW_WORK_TOKENS: string;
|
|
CLAUDE_MEM_CONTEXT_SHOW_SAVINGS_AMOUNT: string;
|
|
CLAUDE_MEM_CONTEXT_SHOW_SAVINGS_PERCENT: string;
|
|
// Observation Filtering
|
|
CLAUDE_MEM_CONTEXT_OBSERVATION_TYPES: string;
|
|
CLAUDE_MEM_CONTEXT_OBSERVATION_CONCEPTS: string;
|
|
// Display Configuration
|
|
CLAUDE_MEM_CONTEXT_FULL_COUNT: string;
|
|
CLAUDE_MEM_CONTEXT_FULL_FIELD: string;
|
|
CLAUDE_MEM_CONTEXT_SESSION_COUNT: string;
|
|
// Feature Toggles
|
|
CLAUDE_MEM_CONTEXT_SHOW_LAST_SUMMARY: string;
|
|
CLAUDE_MEM_CONTEXT_SHOW_LAST_MESSAGE: string;
|
|
}
|
|
|
|
export class SettingsDefaultsManager {
|
|
/**
|
|
* Default values for all settings
|
|
*/
|
|
private static readonly DEFAULTS: SettingsDefaults = {
|
|
CLAUDE_MEM_MODEL: 'claude-sonnet-4-5',
|
|
CLAUDE_MEM_CONTEXT_OBSERVATIONS: '50',
|
|
CLAUDE_MEM_WORKER_PORT: '37777',
|
|
CLAUDE_MEM_WORKER_HOST: '127.0.0.1',
|
|
CLAUDE_MEM_SKIP_TOOLS: 'ListMcpResourcesTool,SlashCommand,Skill,TodoWrite,AskUserQuestion',
|
|
// AI Provider Configuration
|
|
CLAUDE_MEM_PROVIDER: 'claude', // Default to Claude
|
|
CLAUDE_MEM_GEMINI_API_KEY: '', // Empty by default, can be set via UI or env
|
|
CLAUDE_MEM_GEMINI_MODEL: 'gemini-2.5-flash-lite', // Default Gemini model (highest free tier RPM)
|
|
CLAUDE_MEM_GEMINI_RATE_LIMITING_ENABLED: 'true', // Rate limiting ON by default for free tier users
|
|
CLAUDE_MEM_OPENROUTER_API_KEY: '', // Empty by default, can be set via UI or env
|
|
CLAUDE_MEM_OPENROUTER_MODEL: 'xiaomi/mimo-v2-flash:free', // Default OpenRouter model (free tier)
|
|
CLAUDE_MEM_OPENROUTER_SITE_URL: '', // Optional: for OpenRouter analytics
|
|
CLAUDE_MEM_OPENROUTER_APP_NAME: 'claude-mem', // App name for OpenRouter analytics
|
|
CLAUDE_MEM_OPENROUTER_MAX_CONTEXT_MESSAGES: '20', // Max messages in context window
|
|
CLAUDE_MEM_OPENROUTER_MAX_TOKENS: '100000', // Max estimated tokens (~100k safety limit)
|
|
// System Configuration
|
|
CLAUDE_MEM_DATA_DIR: join(homedir(), '.claude-mem'),
|
|
CLAUDE_MEM_LOG_LEVEL: 'INFO',
|
|
CLAUDE_MEM_PYTHON_VERSION: '3.13',
|
|
CLAUDE_CODE_PATH: '', // Empty means auto-detect via 'which claude'
|
|
CLAUDE_MEM_MODE: 'code', // Default mode profile
|
|
// Token Economics
|
|
CLAUDE_MEM_CONTEXT_SHOW_READ_TOKENS: 'true',
|
|
CLAUDE_MEM_CONTEXT_SHOW_WORK_TOKENS: 'true',
|
|
CLAUDE_MEM_CONTEXT_SHOW_SAVINGS_AMOUNT: 'true',
|
|
CLAUDE_MEM_CONTEXT_SHOW_SAVINGS_PERCENT: 'true',
|
|
// Observation Filtering
|
|
CLAUDE_MEM_CONTEXT_OBSERVATION_TYPES: DEFAULT_OBSERVATION_TYPES_STRING,
|
|
CLAUDE_MEM_CONTEXT_OBSERVATION_CONCEPTS: DEFAULT_OBSERVATION_CONCEPTS_STRING,
|
|
// Display Configuration
|
|
CLAUDE_MEM_CONTEXT_FULL_COUNT: '5',
|
|
CLAUDE_MEM_CONTEXT_FULL_FIELD: 'narrative',
|
|
CLAUDE_MEM_CONTEXT_SESSION_COUNT: '10',
|
|
// Feature Toggles
|
|
CLAUDE_MEM_CONTEXT_SHOW_LAST_SUMMARY: 'true',
|
|
CLAUDE_MEM_CONTEXT_SHOW_LAST_MESSAGE: 'false',
|
|
};
|
|
|
|
/**
|
|
* Get all defaults as an object
|
|
*/
|
|
static getAllDefaults(): SettingsDefaults {
|
|
return { ...this.DEFAULTS };
|
|
}
|
|
|
|
/**
|
|
* Get a default value from defaults (no environment variable override)
|
|
*/
|
|
static get(key: keyof SettingsDefaults): string {
|
|
return this.DEFAULTS[key];
|
|
}
|
|
|
|
/**
|
|
* Get an integer default value
|
|
*/
|
|
static getInt(key: keyof SettingsDefaults): number {
|
|
const value = this.get(key);
|
|
return parseInt(value, 10);
|
|
}
|
|
|
|
/**
|
|
* Get a boolean default value
|
|
*/
|
|
static getBool(key: keyof SettingsDefaults): boolean {
|
|
const value = this.get(key);
|
|
return value === 'true';
|
|
}
|
|
|
|
/**
|
|
* Load settings from file with fallback to defaults
|
|
* Returns merged settings with defaults as fallback
|
|
* Handles all errors (missing file, corrupted JSON, permissions) by returning defaults
|
|
*/
|
|
static loadFromFile(settingsPath: string): SettingsDefaults {
|
|
try {
|
|
if (!existsSync(settingsPath)) {
|
|
const defaults = this.getAllDefaults();
|
|
try {
|
|
const dir = dirname(settingsPath);
|
|
if (!existsSync(dir)) {
|
|
mkdirSync(dir, { recursive: true });
|
|
}
|
|
writeFileSync(settingsPath, JSON.stringify(defaults, null, 2), 'utf-8');
|
|
// Use console instead of logger to avoid circular dependency
|
|
console.log('[SETTINGS] Created settings file with defaults:', settingsPath);
|
|
} catch (error) {
|
|
console.warn('[SETTINGS] Failed to create settings file, using in-memory defaults:', settingsPath, error);
|
|
}
|
|
return defaults;
|
|
}
|
|
|
|
const settingsData = readFileSync(settingsPath, 'utf-8');
|
|
const settings = JSON.parse(settingsData);
|
|
|
|
// MIGRATION: Handle old nested schema { env: {...} }
|
|
let flatSettings = settings;
|
|
if (settings.env && typeof settings.env === 'object') {
|
|
// Migrate from nested to flat schema
|
|
flatSettings = settings.env;
|
|
|
|
// Auto-migrate the file to flat schema
|
|
try {
|
|
writeFileSync(settingsPath, JSON.stringify(flatSettings, null, 2), 'utf-8');
|
|
console.log('[SETTINGS] Migrated settings file from nested to flat schema:', settingsPath);
|
|
} catch (error) {
|
|
console.warn('[SETTINGS] Failed to auto-migrate settings file:', settingsPath, error);
|
|
// Continue with in-memory migration even if write fails
|
|
}
|
|
}
|
|
|
|
// Merge file settings with defaults (flat schema)
|
|
const result: SettingsDefaults = { ...this.DEFAULTS };
|
|
for (const key of Object.keys(this.DEFAULTS) as Array<keyof SettingsDefaults>) {
|
|
if (flatSettings[key] !== undefined) {
|
|
result[key] = flatSettings[key];
|
|
}
|
|
}
|
|
|
|
return result;
|
|
} catch (error) {
|
|
console.warn('[SETTINGS] Failed to load settings, using defaults:', settingsPath, error);
|
|
return this.getAllDefaults();
|
|
}
|
|
}
|
|
}
|