Files
everything-claude-code/scripts/lib/session-aliases.js
Tom Cruise Missile 6a40469408 feat: Cursor-independent ECC memory via ECC_AGENT_DATA_HOME (#2066)
* feat: auto-isolate ECC memory data for Cursor via ECC_AGENT_DATA_HOME

Add ECC_AGENT_DATA_HOME (defaults to ~/.claude) with Cursor-aware resolution,
sessionStart env injection, install scaffolds, and hook bootstrap so memory
hooks do not collide with Claude Code when both harnesses are used.

Closes #2065

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix: log agent-data config errors and ship cursor sessionStart deps

Address CodeRabbit review: log invalid .cursor/ecc-agent-data.json parse
failures, and copy cursor-session-env.js plus lib deps on legacy Cursor
install so sessionStart hook path exists without hooks-runtime alone.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix: resolve relative agentDataHome paths from project root

Project config values like ".ecc-data" now resolve against the
repository root (parent of .cursor/), not process.cwd(), so Cursor
hooks persist memory in the intended directory regardless of hook cwd.

Addresses cubic review on PR #2066.

Co-authored-by: Cursor <cursoragent@cursor.com>

* docs: explain getHomeDir duplicate and docstring policy

Document why agent-data-home keeps a local home-dir helper (circular
require with utils.js) and list consolidation options for maintainers.
Note that CodeRabbit JSDoc coverage warnings are informational relative
to ECC's usual script documentation style.

Addresses cubic P2 context on PR #2066.

Co-authored-by: Cursor <cursoragent@cursor.com>

* test: isolate agent-data-home tests from dogfooded .cursor config

Use isolated temp cwd for default-resolution cases and assert
resolveAgentDataHome({ projectDir }) reads ecc-agent-data.json.
Document cwd/project caveats in the test file header.

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-07 13:27:00 +08:00

482 lines
12 KiB
JavaScript

/**
* Session Aliases Library for Claude Code
* Manages session aliases stored in $ECC_AGENT_DATA_HOME/session-aliases.json (default ~/.claude).
*/
const fs = require('fs');
const path = require('path');
const {
getClaudeDir,
ensureDir,
readFile,
log
} = require('./utils');
// Aliases file path
function getAliasesPath() {
return path.join(getClaudeDir(), 'session-aliases.json');
}
// Current alias storage format version
const ALIAS_VERSION = '1.0';
/**
* Default aliases file structure
*/
function getDefaultAliases() {
return {
version: ALIAS_VERSION,
aliases: {},
metadata: {
totalCount: 0,
lastUpdated: new Date().toISOString()
}
};
}
/**
* Load aliases from file
* @returns {object} Aliases object
*/
function loadAliases() {
const aliasesPath = getAliasesPath();
if (!fs.existsSync(aliasesPath)) {
return getDefaultAliases();
}
const content = readFile(aliasesPath);
if (!content) {
return getDefaultAliases();
}
try {
const data = JSON.parse(content);
// Validate structure
if (!data.aliases || typeof data.aliases !== 'object') {
log('[Aliases] Invalid aliases file structure, resetting');
return getDefaultAliases();
}
// Ensure version field
if (!data.version) {
data.version = ALIAS_VERSION;
}
// Ensure metadata
if (!data.metadata) {
data.metadata = {
totalCount: Object.keys(data.aliases).length,
lastUpdated: new Date().toISOString()
};
}
return data;
} catch (err) {
log(`[Aliases] Error parsing aliases file: ${err.message}`);
return getDefaultAliases();
}
}
/**
* Save aliases to file with atomic write
* @param {object} aliases - Aliases object to save
* @returns {boolean} Success status
*/
function saveAliases(aliases) {
const aliasesPath = getAliasesPath();
const tempPath = aliasesPath + '.tmp';
const backupPath = aliasesPath + '.bak';
try {
// Update metadata
aliases.metadata = {
totalCount: Object.keys(aliases.aliases).length,
lastUpdated: new Date().toISOString()
};
const content = JSON.stringify(aliases, null, 2);
// Ensure directory exists
ensureDir(path.dirname(aliasesPath));
// Create backup if file exists
if (fs.existsSync(aliasesPath)) {
fs.copyFileSync(aliasesPath, backupPath);
}
// Atomic write: write to temp file, then rename
fs.writeFileSync(tempPath, content, 'utf8');
// On Windows, rename fails with EEXIST if destination exists, so delete first.
// On Unix/macOS, rename(2) atomically replaces the destination — skip the
// delete to avoid an unnecessary non-atomic window between unlink and rename.
if (process.platform === 'win32' && fs.existsSync(aliasesPath)) {
fs.unlinkSync(aliasesPath);
}
fs.renameSync(tempPath, aliasesPath);
// Remove backup on success
if (fs.existsSync(backupPath)) {
fs.unlinkSync(backupPath);
}
return true;
} catch (err) {
log(`[Aliases] Error saving aliases: ${err.message}`);
// Restore from backup if exists
if (fs.existsSync(backupPath)) {
try {
fs.copyFileSync(backupPath, aliasesPath);
log('[Aliases] Restored from backup');
} catch (restoreErr) {
log(`[Aliases] Failed to restore backup: ${restoreErr.message}`);
}
}
// Clean up temp file (best-effort)
try {
if (fs.existsSync(tempPath)) {
fs.unlinkSync(tempPath);
}
} catch {
// Non-critical: temp file will be overwritten on next save
}
return false;
}
}
/**
* Resolve an alias to get session path
* @param {string} alias - Alias name to resolve
* @returns {object|null} Alias data or null if not found
*/
function resolveAlias(alias) {
if (!alias) return null;
// Validate alias name (alphanumeric, dash, underscore)
if (!/^[a-zA-Z0-9_-]+$/.test(alias)) {
return null;
}
const data = loadAliases();
const aliasData = data.aliases[alias];
if (!aliasData) {
return null;
}
return {
alias,
sessionPath: aliasData.sessionPath,
createdAt: aliasData.createdAt,
title: aliasData.title || null
};
}
/**
* Set or update an alias for a session
* @param {string} alias - Alias name (alphanumeric, dash, underscore)
* @param {string} sessionPath - Session directory path
* @param {string} title - Optional title for the alias
* @returns {object} Result with success status and message
*/
function setAlias(alias, sessionPath, title = null) {
// Validate alias name
if (!alias || alias.length === 0) {
return { success: false, error: 'Alias name cannot be empty' };
}
// Validate session path
if (!sessionPath || typeof sessionPath !== 'string' || sessionPath.trim().length === 0) {
return { success: false, error: 'Session path cannot be empty' };
}
if (alias.length > 128) {
return { success: false, error: 'Alias name cannot exceed 128 characters' };
}
if (!/^[a-zA-Z0-9_-]+$/.test(alias)) {
return { success: false, error: 'Alias name must contain only letters, numbers, dashes, and underscores' };
}
// Reserved alias names
const reserved = ['list', 'help', 'remove', 'delete', 'create', 'set'];
if (reserved.includes(alias.toLowerCase())) {
return { success: false, error: `'${alias}' is a reserved alias name` };
}
const data = loadAliases();
const existing = data.aliases[alias];
const isNew = !existing;
data.aliases[alias] = {
sessionPath,
createdAt: existing ? existing.createdAt : new Date().toISOString(),
updatedAt: new Date().toISOString(),
title: title || null
};
if (saveAliases(data)) {
return {
success: true,
isNew,
alias,
sessionPath,
title: data.aliases[alias].title
};
}
return { success: false, error: 'Failed to save alias' };
}
/**
* List all aliases
* @param {object} options - Options object
* @param {string} options.search - Filter aliases by name (partial match)
* @param {number} options.limit - Maximum number of aliases to return
* @returns {Array} Array of alias objects
*/
function listAliases(options = {}) {
const { search = null, limit = null } = options;
const data = loadAliases();
let aliases = Object.entries(data.aliases).map(([name, info]) => ({
name,
sessionPath: info.sessionPath,
createdAt: info.createdAt,
updatedAt: info.updatedAt,
title: info.title
}));
// Sort by updated time (newest first)
aliases.sort((a, b) => (new Date(b.updatedAt || b.createdAt || 0).getTime() || 0) - (new Date(a.updatedAt || a.createdAt || 0).getTime() || 0));
// Apply search filter
if (search) {
const searchLower = search.toLowerCase();
aliases = aliases.filter(a =>
a.name.toLowerCase().includes(searchLower) ||
(a.title && a.title.toLowerCase().includes(searchLower))
);
}
// Apply limit
if (limit && limit > 0) {
aliases = aliases.slice(0, limit);
}
return aliases;
}
/**
* Delete an alias
* @param {string} alias - Alias name to delete
* @returns {object} Result with success status
*/
function deleteAlias(alias) {
const data = loadAliases();
if (!data.aliases[alias]) {
return { success: false, error: `Alias '${alias}' not found` };
}
const deleted = data.aliases[alias];
delete data.aliases[alias];
if (saveAliases(data)) {
return {
success: true,
alias,
deletedSessionPath: deleted.sessionPath
};
}
return { success: false, error: 'Failed to delete alias' };
}
/**
* Rename an alias
* @param {string} oldAlias - Current alias name
* @param {string} newAlias - New alias name
* @returns {object} Result with success status
*/
function renameAlias(oldAlias, newAlias) {
const data = loadAliases();
if (!data.aliases[oldAlias]) {
return { success: false, error: `Alias '${oldAlias}' not found` };
}
// Validate new alias name (same rules as setAlias)
if (!newAlias || newAlias.length === 0) {
return { success: false, error: 'New alias name cannot be empty' };
}
if (newAlias.length > 128) {
return { success: false, error: 'New alias name cannot exceed 128 characters' };
}
if (!/^[a-zA-Z0-9_-]+$/.test(newAlias)) {
return { success: false, error: 'New alias name must contain only letters, numbers, dashes, and underscores' };
}
const reserved = ['list', 'help', 'remove', 'delete', 'create', 'set'];
if (reserved.includes(newAlias.toLowerCase())) {
return { success: false, error: `'${newAlias}' is a reserved alias name` };
}
if (data.aliases[newAlias]) {
return { success: false, error: `Alias '${newAlias}' already exists` };
}
const aliasData = data.aliases[oldAlias];
delete data.aliases[oldAlias];
aliasData.updatedAt = new Date().toISOString();
data.aliases[newAlias] = aliasData;
if (saveAliases(data)) {
return {
success: true,
oldAlias,
newAlias,
sessionPath: aliasData.sessionPath
};
}
// Restore old alias and remove new alias on failure
data.aliases[oldAlias] = aliasData;
delete data.aliases[newAlias];
// Attempt to persist the rollback
saveAliases(data);
return { success: false, error: 'Failed to save renamed alias — rolled back to original' };
}
/**
* Get session path by alias (convenience function)
* @param {string} aliasOrId - Alias name or session ID
* @returns {string|null} Session path or null if not found
*/
function resolveSessionAlias(aliasOrId) {
// First try to resolve as alias
const resolved = resolveAlias(aliasOrId);
if (resolved) {
return resolved.sessionPath;
}
// If not an alias, return as-is (might be a session path)
return aliasOrId;
}
/**
* Update alias title
* @param {string} alias - Alias name
* @param {string|null} title - New title (string or null to clear)
* @returns {object} Result with success status
*/
function updateAliasTitle(alias, title) {
if (title !== null && typeof title !== 'string') {
return { success: false, error: 'Title must be a string or null' };
}
const data = loadAliases();
if (!data.aliases[alias]) {
return { success: false, error: `Alias '${alias}' not found` };
}
data.aliases[alias].title = title || null;
data.aliases[alias].updatedAt = new Date().toISOString();
if (saveAliases(data)) {
return {
success: true,
alias,
title
};
}
return { success: false, error: 'Failed to update alias title' };
}
/**
* Get all aliases for a specific session
* @param {string} sessionPath - Session path to find aliases for
* @returns {Array} Array of alias names
*/
function getAliasesForSession(sessionPath) {
const data = loadAliases();
const aliases = [];
for (const [name, info] of Object.entries(data.aliases)) {
if (info.sessionPath === sessionPath) {
aliases.push({
name,
createdAt: info.createdAt,
title: info.title
});
}
}
return aliases;
}
/**
* Clean up aliases for non-existent sessions
* @param {Function} sessionExists - Function to check if session exists
* @returns {object} Cleanup result
*/
function cleanupAliases(sessionExists) {
if (typeof sessionExists !== 'function') {
return { totalChecked: 0, removed: 0, removedAliases: [], error: 'sessionExists must be a function' };
}
const data = loadAliases();
const removed = [];
for (const [name, info] of Object.entries(data.aliases)) {
if (!sessionExists(info.sessionPath)) {
removed.push({ name, sessionPath: info.sessionPath });
delete data.aliases[name];
}
}
if (removed.length > 0 && !saveAliases(data)) {
log('[Aliases] Failed to save after cleanup');
return {
success: false,
totalChecked: Object.keys(data.aliases).length + removed.length,
removed: removed.length,
removedAliases: removed,
error: 'Failed to save after cleanup'
};
}
return {
success: true,
totalChecked: Object.keys(data.aliases).length + removed.length,
removed: removed.length,
removedAliases: removed
};
}
module.exports = {
getAliasesPath,
loadAliases,
saveAliases,
resolveAlias,
setAlias,
listAliases,
deleteAlias,
renameAlias,
resolveSessionAlias,
updateAliasTitle,
getAliasesForSession,
cleanupAliases
};