Files
claude-mem/tests/smart-install.test.ts
T
Ben Younes 4616f7ab1c fix: output valid JSON from smart-install.js hook to prevent SessionStart error (#1337)
smart-install.js used stdio: 'inherit' for execSync calls, leaking
plain-text install output (bun/npm progress) to stdout. Claude Code
expects hook output to start with '{' (valid JSON), so this caused
a confusing "SessionStart:startup hook error" on every session start.

Changes:
- Pipe stdout on all execSync calls to prevent non-JSON stdout leak
- Output {"continue":true,"suppressOutput":true} on both success and
  error paths so Claude Code always receives valid JSON
- Add tests verifying no stdio:'inherit' remains and JSON is output

Fixes #1253

Vibe-coded by Ousama Ben Younes

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-12 19:58:00 -07:00

240 lines
9.0 KiB
TypeScript

import { describe, it, expect, beforeEach, afterEach } from 'bun:test';
import { existsSync, mkdirSync, writeFileSync, rmSync, readFileSync } from 'fs';
import { join } from 'path';
import { tmpdir } from 'os';
import { spawnSync } from 'child_process';
/**
* Smart Install Script Tests
*
* Tests the resolveRoot() and verifyCriticalModules() logic used by
* plugin/scripts/smart-install.js to find the correct install directory
* for cache-based and marketplace installs.
*
* These are unit tests that exercise the resolution logic in isolation
* using temp directories, without running actual bun/npm install.
*/
const TEST_DIR = join(tmpdir(), `claude-mem-smart-install-test-${process.pid}`);
function createDir(relativePath: string): string {
const fullPath = join(TEST_DIR, relativePath);
mkdirSync(fullPath, { recursive: true });
return fullPath;
}
function createPackageJson(dir: string, version = '10.0.0', deps: Record<string, string> = {}): void {
writeFileSync(join(dir, 'package.json'), JSON.stringify({
name: 'claude-mem-plugin',
version,
dependencies: deps
}));
}
describe('smart-install resolveRoot logic', () => {
beforeEach(() => {
mkdirSync(TEST_DIR, { recursive: true });
});
afterEach(() => {
rmSync(TEST_DIR, { recursive: true, force: true });
});
it('should prefer CLAUDE_PLUGIN_ROOT when it contains package.json', () => {
const cacheDir = createDir('cache/thedotmack/claude-mem/10.0.0');
createPackageJson(cacheDir);
// Simulate what resolveRoot does
const root = cacheDir;
expect(existsSync(join(root, 'package.json'))).toBe(true);
});
it('should detect cache-based install paths', () => {
// Cache installs have paths like ~/.claude/plugins/cache/thedotmack/claude-mem/<version>/
const cacheDir = createDir('plugins/cache/thedotmack/claude-mem/10.3.0');
createPackageJson(cacheDir);
// Marketplace dir does NOT exist (fresh cache install, no marketplace)
const pluginRoot = cacheDir;
expect(existsSync(join(pluginRoot, 'package.json'))).toBe(true);
// The cache dir is valid — resolveRoot should use it, not try to navigate to marketplace
});
it('should fall back to script-relative path when CLAUDE_PLUGIN_ROOT is unset', () => {
// Simulate: scripts/smart-install.js lives in <root>/scripts/
const pluginRoot = createDir('marketplace-plugin');
createPackageJson(pluginRoot);
const scriptsDir = createDir('marketplace-plugin/scripts');
// dirname(scripts/) = marketplace-plugin/ which has package.json
const candidate = join(scriptsDir, '..');
expect(existsSync(join(candidate, 'package.json'))).toBe(true);
});
it('should handle missing package.json in CLAUDE_PLUGIN_ROOT gracefully', () => {
// CLAUDE_PLUGIN_ROOT points to a dir without package.json
const badDir = createDir('empty-cache-dir');
expect(existsSync(join(badDir, 'package.json'))).toBe(false);
// resolveRoot should fall through to next candidate
});
});
describe('smart-install verifyCriticalModules logic', () => {
beforeEach(() => {
mkdirSync(TEST_DIR, { recursive: true });
});
afterEach(() => {
rmSync(TEST_DIR, { recursive: true, force: true });
});
it('should pass when all dependencies exist in node_modules', () => {
const root = createDir('plugin-root');
createPackageJson(root, '10.0.0', {
'@chroma-core/default-embed': '^0.1.9'
});
// Create the module directory
mkdirSync(join(root, 'node_modules', '@chroma-core', 'default-embed'), { recursive: true });
// Simulate verifyCriticalModules
const pkg = JSON.parse(readFileSync(join(root, 'package.json'), 'utf-8'));
const dependencies = Object.keys(pkg.dependencies || {});
const missing: string[] = [];
for (const dep of dependencies) {
const modulePath = join(root, 'node_modules', ...dep.split('/'));
if (!existsSync(modulePath)) {
missing.push(dep);
}
}
expect(missing).toEqual([]);
});
it('should detect missing dependencies in node_modules', () => {
const root = createDir('plugin-root-missing');
createPackageJson(root, '10.0.0', {
'@chroma-core/default-embed': '^0.1.9'
});
// Do NOT create node_modules — simulate a failed install
const pkg = JSON.parse(readFileSync(join(root, 'package.json'), 'utf-8'));
const dependencies = Object.keys(pkg.dependencies || {});
const missing: string[] = [];
for (const dep of dependencies) {
const modulePath = join(root, 'node_modules', ...dep.split('/'));
if (!existsSync(modulePath)) {
missing.push(dep);
}
}
expect(missing).toEqual(['@chroma-core/default-embed']);
});
it('should handle packages with no dependencies gracefully', () => {
const root = createDir('plugin-root-no-deps');
createPackageJson(root, '10.0.0', {});
const pkg = JSON.parse(readFileSync(join(root, 'package.json'), 'utf-8'));
const dependencies = Object.keys(pkg.dependencies || {});
expect(dependencies).toEqual([]);
});
it('should detect partially installed scoped packages', () => {
const root = createDir('plugin-root-partial');
createPackageJson(root, '10.0.0', {
'@chroma-core/default-embed': '^0.1.9',
'@chroma-core/other-pkg': '^1.0.0'
});
// Only install one of the two packages
mkdirSync(join(root, 'node_modules', '@chroma-core', 'default-embed'), { recursive: true });
const pkg = JSON.parse(readFileSync(join(root, 'package.json'), 'utf-8'));
const dependencies = Object.keys(pkg.dependencies || {});
const missing: string[] = [];
for (const dep of dependencies) {
const modulePath = join(root, 'node_modules', ...dep.split('/'));
if (!existsSync(modulePath)) {
missing.push(dep);
}
}
expect(missing).toEqual(['@chroma-core/other-pkg']);
});
});
describe('smart-install stdout JSON output (#1253)', () => {
const SCRIPT_PATH = join(__dirname, '..', 'plugin', 'scripts', 'smart-install.js');
it('should not have any execSync with stdio: inherit (prevents stdout leak)', () => {
const content = readFileSync(SCRIPT_PATH, 'utf-8');
// stdio: 'inherit' would leak non-JSON output to stdout, breaking Claude Code hooks
expect(content).not.toContain("stdio: 'inherit'");
expect(content).not.toContain('stdio: "inherit"');
});
it('should output valid JSON to stdout on success path', () => {
const content = readFileSync(SCRIPT_PATH, 'utf-8');
// The script must print JSON to stdout for the Claude Code hook contract
expect(content).toContain('console.log(JSON.stringify(');
expect(content).toContain('continue');
expect(content).toContain('suppressOutput');
});
it('should output valid JSON to stdout even in error catch block', () => {
const content = readFileSync(SCRIPT_PATH, 'utf-8');
// Find the catch block and verify it also outputs JSON
const catchIndex = content.lastIndexOf('catch (e)');
expect(catchIndex).toBeGreaterThan(0);
const catchBlock = content.slice(catchIndex, catchIndex + 300);
expect(catchBlock).toContain('console.log(JSON.stringify(');
});
it('should use piped stdout for all execSync calls', () => {
const content = readFileSync(SCRIPT_PATH, 'utf-8');
// All execSync calls should pipe stdout to prevent leaking to the hook output.
// Match execSync calls that have a stdio option — they should all use array form.
// All execSync calls should either use 'ignore', array form, or the installStdio variable
// — never bare 'inherit' which leaks non-JSON output to stdout
expect(content).not.toContain("stdio: 'inherit'");
expect(content).not.toContain('stdio: "inherit"');
// Verify the installStdio variable is defined with the correct pipe config
expect(content).toContain("const installStdio = ['pipe', 'pipe', 'inherit']");
});
it('should produce valid JSON when run with plugin disabled', () => {
// Run the actual script with the plugin forcefully disabled via settings
// This exercises the early exit path
const settingsDir = join(tmpdir(), `claude-mem-test-settings-${process.pid}`);
const settingsFile = join(settingsDir, 'settings.json');
mkdirSync(settingsDir, { recursive: true });
writeFileSync(settingsFile, JSON.stringify({
enabledPlugins: { 'claude-mem@thedotmack': false }
}));
try {
const result = spawnSync('node', [SCRIPT_PATH], {
encoding: 'utf-8',
env: {
...process.env,
CLAUDE_CONFIG_DIR: settingsDir,
},
timeout: 10000,
});
// When plugin is disabled, script exits with 0 and produces no stdout
// (the early exit at line 31-33 calls process.exit(0) before any output)
expect(result.status).toBe(0);
// stdout should be empty or valid JSON (not plain text install messages)
const stdout = (result.stdout || '').trim();
if (stdout.length > 0) {
expect(() => JSON.parse(stdout)).not.toThrow();
}
} finally {
rmSync(settingsDir, { recursive: true, force: true });
}
});
});