Files
claude-hud/tests/usage-api.test.js

332 lines
8.6 KiB
JavaScript
Raw Normal View History

feat: config system + usage API + bug fixes (supersedes #32) (#35) * feat: display last 3 path segments first in session line Shows the last 3 segments of the working directory path at the beginning of the session line for quick project identification. Before: [Opus 4.5] ████░░░░░░ 19% | my-project git:(main) | ... After: dev/apps/my-project git:(main) | [Opus 4.5] ████░░░░░░ 19% | ... This helps distinguish between projects with similar names in different locations and puts the most relevant info first. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: configurable path levels (1-3) and git status toggle - Add config system at ~/.claude/plugins/claude-hud/config.json - Default path display to 1 level (was hardcoded at 3) - Add pathLevels option: 1, 2, or 3 directory segments - Add gitStatus.enabled toggle to show/hide git branch - Add interactive CLI: npx claude-hud-configure - Add comprehensive tests for config and path levels - Update README with configuration documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: handle cross-platform path separators - Split paths by both / and \ for Windows compatibility - Always output forward slashes for consistent display - Add tests for Windows paths, UNC paths, and mixed separators 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: show existing config when reconfiguring - Display current values when config file exists - Prompt user that Enter keeps current values 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: interactive CLI with arrow-key selection - Add @inquirer/prompts for better UX - Arrow keys to select path levels - Visual feedback with checkmarks - Cleaner, more compact output 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add dirty indicator and ahead/behind git status - Add gitStatus.showDirty option (default: true) - Add gitStatus.showAheadBehind option (default: false) - Update getGitStatus to return isDirty, ahead, behind - Update CLI to configure new options with preview - Add tests for dirty and ahead/behind display - Update README with new options 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add configurable display options for all HUD elements - Add display configuration object with 8 boolean options: - showModel: Toggle model name display [Opus] - showContextBar: Toggle visual context bar ████░░░░░░ - showConfigCounts: Toggle CLAUDE.md, rules, MCPs, hooks counts - showDuration: Toggle session duration display - showTokenBreakdown: Toggle token details at high context (85%+) - showTools: Toggle tools activity line - showAgents: Toggle agents activity line - showTodos: Toggle todos progress line - All options default to true for backward compatibility - Enhanced CLI preview with colors matching actual HUD output - Added 5 new tests for display configuration (87 total) - Updated README with complete configuration reference 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add configurable layout options (default, condensed, separators) - Add layout config option with three styles: - default: All info on first line (original behavior) - condensed: Model/context top, project bottom - separators: Condensed with visual separator lines - Create project-line.ts for rendering project path in split layouts - Add renderSessionLineMinimal for condensed/separators layouts - Interactive CLI preview shows selected layout style - All 87 tests pass 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add interactive HUD preview and folder icon - Add live preview that updates as config options are selected - Show initial preview on startup based on existing/default config - Add folder icon (📁) in front of project path - Extract preview generation to separate module for reuse 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: update README with folder icon and live preview - Add folder icon (📁) to all path examples - Document live preview feature in interactive CLI section 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add menu-based navigation to configure CLI - Replace linear flow with main menu loop - Show current values in menu (layout, path levels, git status, etc.) - Users can edit any section and return to menu - Preview updates after each section change - Save & Exit or Exit without saving options 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: update tests for folder icon and config structure - Update integration test expected output with folder icon - Make config test environment-independent (validates structure, not specific values) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * test: add comprehensive config loading tests Add 23 new tests for config system validation: - DEFAULT_CONFIG structure (layout, gitStatus, 8 display options) - Layout validation (default, condensed, separators) - PathLevels validation (1, 2, or 3) - Git status configuration defaults - Display configuration (booleans, defaults to true, count) - loadConfig behavior (complete fields, valid values) - getConfigPath structure tests 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add usage API, config enhancements, and bug fixes This PR combines and enhances the config system from PR #32 with new features and bug fixes addressing the owner's review feedback. ## New Features - Usage API integration showing 5h/7d limits for Pro/Max/Team users - Interactive `/claude-hud:configure` skill for in-Claude-Code configuration - Hybrid showUsage toggle (env var + config for privacy control) ## Bug Fixes (addressing #32 review feedback) - Fix git status spacing: `main*↑2↓1` → `main* ↑2 ↓1` - Fix root path rendering: show `/` instead of empty folder icon - Fix Windows path normalization in truncatePath - Fix duplicate dependencies key in package.json - Fix multiSelect for mutually exclusive options in configure skill ## Credits - Config system, layouts, path levels, git toggle, CLI by @Tsopic (PR #32) - Usage API, configure skill, bug fixes by @melon-hub 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Co-Authored-By: Tsopic <Tsopic@users.noreply.github.com> * fix: move configure command to correct location - Move configure.md from .claude-plugin/skills/ to commands/ - Remove skills array from plugin.json (commands are auto-discovered) Commands must be in the commands/ directory at plugin root, not inside .claude-plugin/. This matches the existing setup.md pattern. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: layout order, remove condensed, redesign configure flow Render fixes (per PR feedback): - Fix element order: model first, project second - Remove condensed layout (only default/separators remain) - Separators: single line below header only when activity exists - Delete project-line.ts (no longer needed) - Remove renderSessionLineMinimal() function Configure skill redesign: - Context-aware tab order (returning users start on Turn Off) - Explicit Turn Off/Turn On questions (no toggle ambiguity) - Git Style question for dirty/ahead-behind options - Combined Layout/Reset tab for returning users - Duration now toggleable - Guards against empty submissions 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: rename 'Returning User' to 'Update Config' in configure flow 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * test: fix tests for new element order and removed function - Update render-basic.txt expected output (model first, project second) - Remove renderSessionLineMinimal import and test (function was deleted) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: update documentation for usage API, config flow, and troubleshooting - Remove stale CLAUDE_HUD_SHOW_USAGE env var references (now config-based) - Add usage API data sources to CLAUDE.md - Add new source files to file structure (config.ts, git.ts, usage-api.ts) - Update README with usage limits section and requirements - Add troubleshooting sections for config, git, and usage issues - Standardize output examples across all documentation files - Remove condensed layout references (only default/separators now) - Update configure skill reference (npx CLI → /claude-hud:configure) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: remove dist/ from PR and update outdated comment - Reset dist/ to main branch (dist will be built by CI after merge) - Update comment: "requires env var opt-in AND config" → "shown when enabled in config" 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * chore: remove internal design doc from release 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * chore: remove CLI and runtime dependency - Remove src/bin/configure.ts and src/bin/preview.ts - Remove @inquirer/prompts dependency (plugins don't run npm install) - Remove bin field from package.json - Users configure via /claude-hud:configure skill instead 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * chore: bump version to 0.0.4 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use file-based cache for usage API HUD runs as a new process every ~300ms, so in-memory cache was useless. Now caches to ~/.claude/plugins/claude-hud/.usage-cache.json. This reduces API calls from ~10,800/hour to max 60/hour. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use consistent homeDir/now in getUsage Avoids potential divergence if deps functions are non-deterministic. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * test: add real tests for usage API file cache - Test credential parsing with mock HOME directory - Test cache TTL behavior (success and failure) - Test apiUnavailable flag handling - Replace placeholder assert.ok(true) with actual assertions 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Martin Kask <martin@industrial.ninja> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: melon-hub <melon-hub@users.noreply.github.com> Co-authored-by: Tsopic <Tsopic@users.noreply.github.com> Co-authored-by: Jarrod Watts <jarrod@cubelabs.xyz>
2026-01-07 16:00:32 +11:00
import { test, describe, beforeEach, afterEach } from 'node:test';
import assert from 'node:assert/strict';
import { getUsage, clearCache } from '../dist/usage-api.js';
import { mkdtemp, rm, mkdir, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import path from 'node:path';
let tempHome = null;
async function createTempHome() {
return await mkdtemp(path.join(tmpdir(), 'claude-hud-usage-'));
}
async function writeCredentials(homeDir, credentials) {
const credDir = path.join(homeDir, '.claude');
await mkdir(credDir, { recursive: true });
await writeFile(path.join(credDir, '.credentials.json'), JSON.stringify(credentials), 'utf8');
}
function buildCredentials(overrides = {}) {
return {
claudeAiOauth: {
accessToken: 'test-token',
subscriptionType: 'claude_pro_2024',
expiresAt: Date.now() + 3600000, // 1 hour from now
...overrides,
},
};
}
function buildApiResponse(overrides = {}) {
return {
five_hour: {
utilization: 25,
resets_at: '2026-01-06T15:00:00Z',
},
seven_day: {
utilization: 10,
resets_at: '2026-01-13T00:00:00Z',
},
...overrides,
};
}
describe('getUsage', () => {
beforeEach(async () => {
tempHome = await createTempHome();
clearCache(tempHome);
});
afterEach(async () => {
if (tempHome) {
await rm(tempHome, { recursive: true, force: true });
tempHome = null;
}
});
test('returns null when credentials file does not exist', async () => {
let fetchCalls = 0;
const result = await getUsage({
homeDir: () => tempHome,
fetchApi: async () => {
fetchCalls += 1;
return null;
},
now: () => 1000,
});
assert.equal(result, null);
assert.equal(fetchCalls, 0);
});
test('returns null when claudeAiOauth is missing', async () => {
await writeCredentials(tempHome, {});
let fetchCalls = 0;
const result = await getUsage({
homeDir: () => tempHome,
fetchApi: async () => {
fetchCalls += 1;
return buildApiResponse();
},
now: () => 1000,
});
assert.equal(result, null);
assert.equal(fetchCalls, 0);
});
test('returns null when token is expired', async () => {
await writeCredentials(tempHome, buildCredentials({ expiresAt: 500 }));
let fetchCalls = 0;
const result = await getUsage({
homeDir: () => tempHome,
fetchApi: async () => {
fetchCalls += 1;
return buildApiResponse();
},
now: () => 1000,
});
assert.equal(result, null);
assert.equal(fetchCalls, 0);
});
test('returns null for API users (no subscriptionType)', async () => {
await writeCredentials(tempHome, buildCredentials({ subscriptionType: 'api' }));
let fetchCalls = 0;
const result = await getUsage({
homeDir: () => tempHome,
fetchApi: async () => {
fetchCalls += 1;
return buildApiResponse();
},
now: () => 1000,
});
assert.equal(result, null);
assert.equal(fetchCalls, 0);
});
test('parses plan name and usage data', async () => {
await writeCredentials(tempHome, buildCredentials({ subscriptionType: 'claude_pro_2024' }));
let fetchCalls = 0;
const result = await getUsage({
homeDir: () => tempHome,
fetchApi: async () => {
fetchCalls += 1;
return buildApiResponse();
},
now: () => 1000,
});
assert.equal(fetchCalls, 1);
assert.equal(result?.planName, 'Pro');
assert.equal(result?.fiveHour, 25);
assert.equal(result?.sevenDay, 10);
});
test('parses Team plan name', async () => {
await writeCredentials(tempHome, buildCredentials({ subscriptionType: 'claude_team_2024' }));
const result = await getUsage({
homeDir: () => tempHome,
fetchApi: async () => buildApiResponse(),
now: () => 1000,
});
assert.equal(result?.planName, 'Team');
});
test('returns apiUnavailable and caches failures', async () => {
await writeCredentials(tempHome, buildCredentials());
let fetchCalls = 0;
let nowValue = 1000;
const fetchApi = async () => {
fetchCalls += 1;
return null;
};
const first = await getUsage({
homeDir: () => tempHome,
fetchApi,
now: () => nowValue,
});
assert.equal(first?.apiUnavailable, true);
assert.equal(fetchCalls, 1);
nowValue += 10_000;
const cached = await getUsage({
homeDir: () => tempHome,
fetchApi,
now: () => nowValue,
});
assert.equal(cached?.apiUnavailable, true);
assert.equal(fetchCalls, 1);
nowValue += 6_000;
const second = await getUsage({
homeDir: () => tempHome,
fetchApi,
now: () => nowValue,
});
assert.equal(second?.apiUnavailable, true);
assert.equal(fetchCalls, 2);
});
});
describe('getUsage caching behavior', () => {
beforeEach(async () => {
tempHome = await createTempHome();
clearCache(tempHome);
});
afterEach(async () => {
if (tempHome) {
await rm(tempHome, { recursive: true, force: true });
tempHome = null;
}
});
test('cache expires after 60 seconds for success', async () => {
await writeCredentials(tempHome, buildCredentials());
let fetchCalls = 0;
let nowValue = 1000;
const fetchApi = async () => {
fetchCalls += 1;
return buildApiResponse();
};
await getUsage({ homeDir: () => tempHome, fetchApi, now: () => nowValue });
assert.equal(fetchCalls, 1);
nowValue += 30_000;
await getUsage({ homeDir: () => tempHome, fetchApi, now: () => nowValue });
assert.equal(fetchCalls, 1);
nowValue += 31_000;
await getUsage({ homeDir: () => tempHome, fetchApi, now: () => nowValue });
assert.equal(fetchCalls, 2);
});
test('cache expires after 15 seconds for failures', async () => {
await writeCredentials(tempHome, buildCredentials());
let fetchCalls = 0;
let nowValue = 1000;
const fetchApi = async () => {
fetchCalls += 1;
return null;
};
await getUsage({ homeDir: () => tempHome, fetchApi, now: () => nowValue });
assert.equal(fetchCalls, 1);
nowValue += 10_000;
await getUsage({ homeDir: () => tempHome, fetchApi, now: () => nowValue });
assert.equal(fetchCalls, 1);
nowValue += 6_000;
await getUsage({ homeDir: () => tempHome, fetchApi, now: () => nowValue });
assert.equal(fetchCalls, 2);
});
test('clearCache removes file-based cache', async () => {
await writeCredentials(tempHome, buildCredentials());
let fetchCalls = 0;
const fetchApi = async () => {
fetchCalls += 1;
return buildApiResponse();
};
await getUsage({ homeDir: () => tempHome, fetchApi, now: () => 1000 });
assert.equal(fetchCalls, 1);
clearCache(tempHome);
await getUsage({ homeDir: () => tempHome, fetchApi, now: () => 2000 });
assert.equal(fetchCalls, 2);
});
});
describe('isLimitReached', () => {
test('returns true when fiveHour is 100', async () => {
// Import from types since isLimitReached is exported there
const { isLimitReached } = await import('../dist/types.js');
const data = {
planName: 'Pro',
fiveHour: 100,
sevenDay: 50,
fiveHourResetAt: null,
sevenDayResetAt: null,
};
assert.equal(isLimitReached(data), true);
});
test('returns true when sevenDay is 100', async () => {
const { isLimitReached } = await import('../dist/types.js');
const data = {
planName: 'Pro',
fiveHour: 50,
sevenDay: 100,
fiveHourResetAt: null,
sevenDayResetAt: null,
};
assert.equal(isLimitReached(data), true);
});
test('returns false when both are below 100', async () => {
const { isLimitReached } = await import('../dist/types.js');
const data = {
planName: 'Pro',
fiveHour: 50,
sevenDay: 50,
fiveHourResetAt: null,
sevenDayResetAt: null,
};
assert.equal(isLimitReached(data), false);
});
test('handles null values correctly', async () => {
const { isLimitReached } = await import('../dist/types.js');
const data = {
planName: 'Pro',
fiveHour: null,
sevenDay: null,
fiveHourResetAt: null,
sevenDayResetAt: null,
};
// null !== 100, so should return false
assert.equal(isLimitReached(data), false);
});
test('returns true when sevenDay is 100 but fiveHour is null', async () => {
const { isLimitReached } = await import('../dist/types.js');
const data = {
planName: 'Pro',
fiveHour: null,
sevenDay: 100,
fiveHourResetAt: null,
sevenDayResetAt: null,
};
assert.equal(isLimitReached(data), true);
});
});