Files
claude-mem/tests/shared/settings-defaults-manager.test.ts
T
Alex Newman f38b5b85bc fix: resolve issues #543, #544, #545, #557 (#558)
* 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>
2026-01-05 19:45:09 -05:00

334 lines
12 KiB
TypeScript

/**
* SettingsDefaultsManager Tests
*
* Tests for the settings file auto-creation feature in loadFromFile().
* Uses temp directories for file system isolation.
*
* Test cases:
* 1. File doesn't exist - should create file with defaults and return defaults
* 2. File exists with valid content - should return parsed content
* 3. File exists but is empty/corrupt - should return defaults
* 4. Directory doesn't exist - should create directory and file
*/
import { describe, it, expect, beforeEach, afterEach } from 'bun:test';
import { mkdirSync, writeFileSync, readFileSync, existsSync, rmSync } from 'fs';
import { join } from 'path';
import { tmpdir } from 'os';
import { SettingsDefaultsManager } from '../../src/shared/SettingsDefaultsManager.js';
describe('SettingsDefaultsManager', () => {
let tempDir: string;
let settingsPath: string;
beforeEach(() => {
// Create unique temp directory for each test
tempDir = join(tmpdir(), `settings-test-${Date.now()}-${Math.random().toString(36).slice(2)}`);
mkdirSync(tempDir, { recursive: true });
settingsPath = join(tempDir, 'settings.json');
});
afterEach(() => {
// Clean up temp directory
try {
rmSync(tempDir, { recursive: true, force: true });
} catch {
// Ignore cleanup errors
}
});
describe('loadFromFile', () => {
describe('file does not exist', () => {
it('should create file with defaults when file does not exist', () => {
expect(existsSync(settingsPath)).toBe(false);
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(existsSync(settingsPath)).toBe(true);
expect(result).toEqual(SettingsDefaultsManager.getAllDefaults());
});
it('should write valid JSON to the created file', () => {
SettingsDefaultsManager.loadFromFile(settingsPath);
const content = readFileSync(settingsPath, 'utf-8');
expect(() => JSON.parse(content)).not.toThrow();
});
it('should write pretty-printed JSON (2-space indent)', () => {
SettingsDefaultsManager.loadFromFile(settingsPath);
const content = readFileSync(settingsPath, 'utf-8');
expect(content).toContain('\n');
expect(content).toContain(' "CLAUDE_MEM_MODEL"');
});
it('should write all default keys to the file', () => {
SettingsDefaultsManager.loadFromFile(settingsPath);
const content = readFileSync(settingsPath, 'utf-8');
const parsed = JSON.parse(content);
const defaults = SettingsDefaultsManager.getAllDefaults();
for (const key of Object.keys(defaults)) {
expect(parsed).toHaveProperty(key);
}
});
});
describe('directory does not exist', () => {
it('should create directory and file when parent directory does not exist', () => {
const nestedPath = join(tempDir, 'nested', 'deep', 'settings.json');
expect(existsSync(join(tempDir, 'nested'))).toBe(false);
const result = SettingsDefaultsManager.loadFromFile(nestedPath);
expect(existsSync(join(tempDir, 'nested', 'deep'))).toBe(true);
expect(existsSync(nestedPath)).toBe(true);
expect(result).toEqual(SettingsDefaultsManager.getAllDefaults());
});
it('should create deeply nested directories recursively', () => {
const deepPath = join(tempDir, 'a', 'b', 'c', 'd', 'e', 'settings.json');
SettingsDefaultsManager.loadFromFile(deepPath);
expect(existsSync(join(tempDir, 'a', 'b', 'c', 'd', 'e'))).toBe(true);
expect(existsSync(deepPath)).toBe(true);
});
});
describe('file exists with valid content', () => {
it('should return parsed content when file has valid JSON', () => {
const customSettings = {
CLAUDE_MEM_MODEL: 'custom-model',
CLAUDE_MEM_WORKER_PORT: '12345',
};
writeFileSync(settingsPath, JSON.stringify(customSettings));
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(result.CLAUDE_MEM_MODEL).toBe('custom-model');
expect(result.CLAUDE_MEM_WORKER_PORT).toBe('12345');
});
it('should merge file settings with defaults for missing keys', () => {
// Only set one value, defaults should fill the rest
const partialSettings = {
CLAUDE_MEM_MODEL: 'partial-model',
};
writeFileSync(settingsPath, JSON.stringify(partialSettings));
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
const defaults = SettingsDefaultsManager.getAllDefaults();
expect(result.CLAUDE_MEM_MODEL).toBe('partial-model');
// Other values should come from defaults
expect(result.CLAUDE_MEM_WORKER_PORT).toBe(defaults.CLAUDE_MEM_WORKER_PORT);
expect(result.CLAUDE_MEM_WORKER_HOST).toBe(defaults.CLAUDE_MEM_WORKER_HOST);
expect(result.CLAUDE_MEM_LOG_LEVEL).toBe(defaults.CLAUDE_MEM_LOG_LEVEL);
});
it('should not modify existing file when loading', () => {
const customSettings = {
CLAUDE_MEM_MODEL: 'do-not-change',
CUSTOM_KEY: 'should-persist', // Extra key not in defaults
};
writeFileSync(settingsPath, JSON.stringify(customSettings, null, 2));
const originalContent = readFileSync(settingsPath, 'utf-8');
SettingsDefaultsManager.loadFromFile(settingsPath);
const afterContent = readFileSync(settingsPath, 'utf-8');
expect(afterContent).toBe(originalContent);
});
it('should handle all settings keys correctly', () => {
const fullSettings = SettingsDefaultsManager.getAllDefaults();
fullSettings.CLAUDE_MEM_MODEL = 'all-keys-model';
fullSettings.CLAUDE_MEM_PROVIDER = 'gemini';
writeFileSync(settingsPath, JSON.stringify(fullSettings));
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(result.CLAUDE_MEM_MODEL).toBe('all-keys-model');
expect(result.CLAUDE_MEM_PROVIDER).toBe('gemini');
});
});
describe('file exists but is empty or corrupt', () => {
it('should return defaults when file is empty', () => {
writeFileSync(settingsPath, '');
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(result).toEqual(SettingsDefaultsManager.getAllDefaults());
});
it('should return defaults when file contains invalid JSON', () => {
writeFileSync(settingsPath, 'not valid json {{{{');
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(result).toEqual(SettingsDefaultsManager.getAllDefaults());
});
it('should return defaults when file contains only whitespace', () => {
writeFileSync(settingsPath, ' \n\t ');
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(result).toEqual(SettingsDefaultsManager.getAllDefaults());
});
it('should return defaults when file contains null', () => {
writeFileSync(settingsPath, 'null');
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(result).toEqual(SettingsDefaultsManager.getAllDefaults());
});
it('should return defaults when file contains array instead of object', () => {
writeFileSync(settingsPath, '["array", "not", "object"]');
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(result).toEqual(SettingsDefaultsManager.getAllDefaults());
});
it('should return defaults when file contains primitive value', () => {
writeFileSync(settingsPath, '"just a string"');
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(result).toEqual(SettingsDefaultsManager.getAllDefaults());
});
});
describe('nested schema migration', () => {
it('should migrate old nested { env: {...} } schema to flat schema', () => {
const nestedSettings = {
env: {
CLAUDE_MEM_MODEL: 'nested-model',
CLAUDE_MEM_WORKER_PORT: '54321',
},
};
writeFileSync(settingsPath, JSON.stringify(nestedSettings));
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(result.CLAUDE_MEM_MODEL).toBe('nested-model');
expect(result.CLAUDE_MEM_WORKER_PORT).toBe('54321');
});
it('should auto-migrate file from nested to flat schema', () => {
const nestedSettings = {
env: {
CLAUDE_MEM_MODEL: 'migrated-model',
},
};
writeFileSync(settingsPath, JSON.stringify(nestedSettings));
SettingsDefaultsManager.loadFromFile(settingsPath);
// File should now be flat schema
const content = readFileSync(settingsPath, 'utf-8');
const parsed = JSON.parse(content);
expect(parsed.env).toBeUndefined();
expect(parsed.CLAUDE_MEM_MODEL).toBe('migrated-model');
});
});
describe('edge cases', () => {
it('should handle empty object in file', () => {
writeFileSync(settingsPath, '{}');
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(result).toEqual(SettingsDefaultsManager.getAllDefaults());
});
it('should ignore unknown keys in file', () => {
const settingsWithUnknown = {
CLAUDE_MEM_MODEL: 'known-model',
UNKNOWN_KEY: 'should-be-ignored',
ANOTHER_UNKNOWN: 12345,
};
writeFileSync(settingsPath, JSON.stringify(settingsWithUnknown));
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
expect(result.CLAUDE_MEM_MODEL).toBe('known-model');
expect((result as Record<string, unknown>).UNKNOWN_KEY).toBeUndefined();
});
it('should handle file with BOM', () => {
const bom = '\uFEFF';
const settings = { CLAUDE_MEM_MODEL: 'bom-model' };
writeFileSync(settingsPath, bom + JSON.stringify(settings));
// JSON.parse handles BOM, but let's verify behavior
const result = SettingsDefaultsManager.loadFromFile(settingsPath);
// If it fails to parse due to BOM, it should return defaults
// If it succeeds, it should return the parsed value
// Either way, should not throw
expect(result).toBeDefined();
});
});
});
describe('getAllDefaults', () => {
it('should return a copy of defaults', () => {
const defaults1 = SettingsDefaultsManager.getAllDefaults();
const defaults2 = SettingsDefaultsManager.getAllDefaults();
expect(defaults1).toEqual(defaults2);
expect(defaults1).not.toBe(defaults2); // Different object references
});
it('should include all expected keys', () => {
const defaults = SettingsDefaultsManager.getAllDefaults();
// Core settings
expect(defaults.CLAUDE_MEM_MODEL).toBeDefined();
expect(defaults.CLAUDE_MEM_WORKER_PORT).toBeDefined();
expect(defaults.CLAUDE_MEM_WORKER_HOST).toBeDefined();
// Provider settings
expect(defaults.CLAUDE_MEM_PROVIDER).toBeDefined();
expect(defaults.CLAUDE_MEM_GEMINI_API_KEY).toBeDefined();
expect(defaults.CLAUDE_MEM_OPENROUTER_API_KEY).toBeDefined();
// System settings
expect(defaults.CLAUDE_MEM_DATA_DIR).toBeDefined();
expect(defaults.CLAUDE_MEM_LOG_LEVEL).toBeDefined();
});
});
describe('get', () => {
it('should return default value for key', () => {
expect(SettingsDefaultsManager.get('CLAUDE_MEM_MODEL')).toBe('claude-sonnet-4-5');
expect(SettingsDefaultsManager.get('CLAUDE_MEM_WORKER_PORT')).toBe('37777');
});
});
describe('getInt', () => {
it('should return integer value for numeric string', () => {
expect(SettingsDefaultsManager.getInt('CLAUDE_MEM_WORKER_PORT')).toBe(37777);
expect(SettingsDefaultsManager.getInt('CLAUDE_MEM_CONTEXT_OBSERVATIONS')).toBe(50);
});
});
describe('getBool', () => {
it('should return true for "true" string', () => {
expect(SettingsDefaultsManager.getBool('CLAUDE_MEM_CONTEXT_SHOW_READ_TOKENS')).toBe(true);
});
it('should return false for non-"true" string', () => {
expect(SettingsDefaultsManager.getBool('CLAUDE_MEM_CONTEXT_SHOW_LAST_MESSAGE')).toBe(false);
});
});
});