@leo000001/opencode-quota-sidebar 1.0.2 → 1.0.3

package/README.md

@@ -55,6 +55,7 @@ Want to add support for another provider (Google Antigravity, Zhipu AI, Firmware
   - line 5: `$X.XX as API cost` (equivalent API billing for subscription-auth providers)
   - quota lines: quota text like `OpenAI 5h 80% Rst 16:20`, with multi-window continuation lines indented (e.g. `       Weekly 70% Rst 03-01`)
   - RightCode daily quota shows `$remaining/$dailyTotal` + expiry (e.g. `RC Daily $105/$60 Exp 02-27`, without trailing percent) and also shows balance on the next indented line when available
+- Session-scoped usage/quota can include descendant subagent sessions (enabled by default via `sidebar.includeChildren=true`). Traversal is bounded by `childrenMaxDepth` (default 6), `childrenMaxSessions` (default 128), and `childrenConcurrency` (default 5); truncation is logged when `OPENCODE_QUOTA_DEBUG=1`. Day/week/month ranges never merge children — only session scope does.
 - Toast message includes three sections: `Token Usage`, `Cost as API` (per provider), and `Quota`
 - Quota snapshots are de-duplicated before rendering to avoid repeated provider lines
 - Custom tools:
@@ -81,6 +82,7 @@ The plugin stores lightweight global state and date-partitioned session chunks.
 - Session chunks: `<opencode-data>/quota-sidebar-sessions/YYYY/MM/DD.json`
   - per-session title state (`baseTitle`, `lastAppliedTitle`)
   - `createdAt`
+  - `parentID` (when the session is a subagent child session)
   - cached usage summary used by `quota_summary`
   - incremental aggregation cursor
 
@@ -141,7 +143,11 @@ Create `quota-sidebar.config.json` under your project root:
     "enabled": true,
     "width": 36,
     "showCost": true,
-    "showQuota": true
+    "showQuota": true,
+    "includeChildren": true,
+    "childrenMaxDepth": 6,
+    "childrenMaxSessions": 128,
+    "childrenConcurrency": 5
   },
   "quota": {
     "refreshMs": 300000,
@@ -166,11 +172,18 @@ Create `quota-sidebar.config.json` under your project root:
 Notes:
 
 - `sidebar.showCost` controls API-cost visibility in sidebar title, `quota_summary` markdown report, and toast message.
+- `sidebar.width` is measured in terminal cells. CJK/emoji truncation is best-effort to avoid sidebar overflow.
+- `sidebar.includeChildren` controls whether session-scoped usage/quota includes descendant subagent sessions (default: `true`).
+- `sidebar.childrenMaxDepth` limits how many levels of nested subagents are traversed (default: `6`, clamped 1–32).
+- `sidebar.childrenMaxSessions` caps the total number of descendant sessions aggregated (default: `128`, clamped 0–2000).
+- `sidebar.childrenConcurrency` controls parallel fetches for descendant session messages (default: `5`, clamped 1–10).
 - `output` now includes reasoning tokens. Reasoning is no longer rendered as a separate line.
 - API cost excludes reasoning tokens from output billing (uses `tokens.output` only for output-price multiplication).
 - `quota.providers` is the extensible per-adapter switch map.
 - If API Cost is `$0.00`, it usually means the model/provider has no pricing mapping in OpenCode at the moment, so equivalent API cost cannot be estimated.
 
+`quota_summary` also supports an optional `includeChildren` flag (only effective for `period=session`) to override the config per call. For `day`/`week`/`month` periods, children are never merged — each session is counted independently.
+
 ## Debug logging
 
 Set `OPENCODE_QUOTA_DEBUG=1` to enable debug logging to stderr. This logs:
@@ -196,9 +209,9 @@ Set `OPENCODE_QUOTA_DEBUG=1` to enable debug logging to stderr. This logs:
 - OpenAI OAuth token refresh is disabled by default; set
   `quota.refreshAccessToken=true` if you want the plugin to refresh access
   tokens when expired.
-- State file writes refuse to follow symlinks to prevent symlink attacks.
-- The `OPENCODE_QUOTA_DATA_HOME` env var can override the home directory for
-  testing; do not set this in production.
+- State/chunk file writes refuse to write through symlinked targets (best-effort defense-in-depth).
+- The `OPENCODE_QUOTA_DATA_HOME` env var overrides the OpenCode data directory
+  path (for testing); do not set this in production.
 
 ## Contributing
 

package/dist/descendants.d.ts

@@ -0,0 +1,22 @@
+import type { Session } from '@opencode-ai/sdk';
+export type DescendantsOptions = {
+    maxDepth: number;
+    maxSessions: number;
+    concurrency: number;
+};
+export type DescendantsDeps = {
+    listChildren: (sessionID: string) => Promise<Session[]>;
+    getParentID: (sessionID: string) => string | undefined;
+    onDiscover: (session: {
+        id: string;
+        title: string;
+        createdAt: number;
+        parentID: string | undefined;
+    }) => void;
+    debug?: (message: string) => void;
+    now?: () => number;
+};
+export declare function createDescendantsResolver(deps: DescendantsDeps): {
+    invalidateForAncestors: (sessionID: string | undefined) => void;
+    listDescendantSessionIDs: (sessionID: string, opts: DescendantsOptions) => Promise<string[]>;
+};

package/dist/descendants.js

@@ -0,0 +1,78 @@
+import { mapConcurrent } from './helpers.js';
+export function createDescendantsResolver(deps) {
+    const cache = new Map();
+    const ttlMs = 5_000;
+    const now = deps.now || Date.now;
+    const debug = deps.debug || (() => { });
+    const invalidateForAncestors = (sessionID) => {
+        if (!sessionID)
+            return;
+        const visited = new Set();
+        let current = sessionID;
+        for (let i = 0; i < 512 && current; i++) {
+            if (visited.has(current))
+                return;
+            visited.add(current);
+            cache.delete(current);
+            current = deps.getParentID(current);
+        }
+    };
+    const listDescendantSessionIDs = async (sessionID, opts) => {
+        if (opts.maxSessions <= 0) {
+            cache.set(sessionID, { sessionIDs: [], expiresAt: now() + ttlMs });
+            return [];
+        }
+        const cached = cache.get(sessionID);
+        if (cached && cached.expiresAt > now()) {
+            return cached.sessionIDs;
+        }
+        const visited = new Set([sessionID]);
+        const descendants = [];
+        let frontier = [sessionID];
+        let depth = 0;
+        while (frontier.length > 0 &&
+            depth < opts.maxDepth &&
+            descendants.length < opts.maxSessions) {
+            const levels = await mapConcurrent(frontier, opts.concurrency, async (id) => {
+                const children = await deps.listChildren(id).catch((error) => {
+                    debug(`listChildren failed for ${id}: ${String(error)}`);
+                    return [];
+                });
+                return children;
+            });
+            const nextFrontier = [];
+            for (const children of levels) {
+                for (const child of children) {
+                    if (visited.has(child.id))
+                        continue;
+                    visited.add(child.id);
+                    descendants.push(child.id);
+                    deps.onDiscover({
+                        id: child.id,
+                        title: child.title,
+                        createdAt: child.time.created,
+                        parentID: child.parentID,
+                    });
+                    nextFrontier.push(child.id);
+                    if (descendants.length >= opts.maxSessions)
+                        break;
+                }
+                if (descendants.length >= opts.maxSessions)
+                    break;
+            }
+            frontier = nextFrontier;
+            depth += 1;
+        }
+        cache.set(sessionID, { sessionIDs: descendants, expiresAt: now() + ttlMs });
+        const truncatedByDepth = depth >= opts.maxDepth && frontier.length > 0;
+        const truncatedByCount = descendants.length >= opts.maxSessions && frontier.length > 0;
+        if (truncatedByDepth || truncatedByCount) {
+            debug(`descendants truncated for ${sessionID}: depth=${depth}/${opts.maxDepth}, sessions=${descendants.length}/${opts.maxSessions}`);
+        }
+        return descendants;
+    };
+    return {
+        invalidateForAncestors,
+        listDescendantSessionIDs,
+    };
+}

package/dist/events.d.ts

@@ -0,0 +1,8 @@
+import type { AssistantMessage, Event, Session } from '@opencode-ai/sdk';
+export declare function createEventDispatcher(handlers: {
+    onSessionCreated: (session: Session) => Promise<void>;
+    onSessionUpdated: (session: Session) => Promise<void>;
+    onSessionDeleted: (session: Session) => Promise<void>;
+    onMessageRemoved: (sessionID: string) => Promise<void>;
+    onAssistantMessageCompleted: (message: AssistantMessage) => Promise<void>;
+}): (event: Event) => Promise<void>;

package/dist/events.js

@@ -0,0 +1,31 @@
+function isAssistantMessage(message) {
+    return message.role === 'assistant';
+}
+export function createEventDispatcher(handlers) {
+    return async (event) => {
+        if (event.type === 'session.created') {
+            await handlers.onSessionCreated(event.properties.info);
+            return;
+        }
+        if (event.type === 'session.updated') {
+            await handlers.onSessionUpdated(event.properties.info);
+            return;
+        }
+        if (event.type === 'session.deleted') {
+            await handlers.onSessionDeleted(event.properties.info);
+            return;
+        }
+        if (event.type === 'message.removed') {
+            await handlers.onMessageRemoved(event.properties.sessionID);
+            return;
+        }
+        if (event.type !== 'message.updated')
+            return;
+        if (!isAssistantMessage(event.properties.info))
+            return;
+        const completed = event.properties.info.time.completed;
+        if (typeof completed !== 'number' || !Number.isFinite(completed))
+            return;
+        await handlers.onAssistantMessageCompleted(event.properties.info);
+    };
+}

package/dist/format.js

@@ -19,17 +19,113 @@ function shortNumber(value, decimals = 1) {
 function sidebarNumber(value) {
     return shortNumber(value, 1);
 }
+function sanitizeLine(value) {
+    // Sidebars/titles must be plain text: no ANSI and no embedded newlines.
+    return (stripAnsi(value)
+        .replace(/\r?\n/g, ' ')
+        // Remove control characters that can corrupt TUI rendering.
+        .replace(/[\x00-\x1F\x7F-\x9F]/g, ' '));
+}
+function isCombiningCodePoint(codePoint) {
+    return ((codePoint >= 0x0300 && codePoint <= 0x036f) ||
+        (codePoint >= 0x1ab0 && codePoint <= 0x1aff) ||
+        (codePoint >= 0x1dc0 && codePoint <= 0x1dff) ||
+        (codePoint >= 0x20d0 && codePoint <= 0x20ff) ||
+        (codePoint >= 0xfe20 && codePoint <= 0xfe2f));
+}
+function isVariationSelector(codePoint) {
+    return ((codePoint >= 0xfe00 && codePoint <= 0xfe0f) ||
+        (codePoint >= 0xe0100 && codePoint <= 0xe01ef));
+}
+function isWideCodePoint(codePoint) {
+    // Based on commonly used fullwidth ranges (similar to string-width).
+    // This intentionally errs toward width=2 to avoid sidebar overflow.
+    if (codePoint >= 0x1100) {
+        if (codePoint <= 0x115f ||
+            codePoint === 0x2329 ||
+            codePoint === 0x232a ||
+            (codePoint >= 0x2e80 && codePoint <= 0xa4cf && codePoint !== 0x303f) ||
+            (codePoint >= 0xac00 && codePoint <= 0xd7a3) ||
+            (codePoint >= 0xf900 && codePoint <= 0xfaff) ||
+            (codePoint >= 0xfe10 && codePoint <= 0xfe19) ||
+            (codePoint >= 0xfe30 && codePoint <= 0xfe6f) ||
+            (codePoint >= 0xff00 && codePoint <= 0xff60) ||
+            (codePoint >= 0xffe0 && codePoint <= 0xffe6) ||
+            (codePoint >= 0x20000 && codePoint <= 0x3fffd)) {
+            return true;
+        }
+    }
+    // Emoji/symbol ranges (best-effort).
+    if ((codePoint >= 0x1f300 && codePoint <= 0x1f5ff) ||
+        (codePoint >= 0x1f600 && codePoint <= 0x1f64f) ||
+        (codePoint >= 0x1f680 && codePoint <= 0x1f6ff) ||
+        (codePoint >= 0x1f900 && codePoint <= 0x1f9ff) ||
+        (codePoint >= 0x1fa70 && codePoint <= 0x1faff) ||
+        (codePoint >= 0x2600 && codePoint <= 0x26ff) ||
+        (codePoint >= 0x2700 && codePoint <= 0x27bf)) {
+        return true;
+    }
+    return false;
+}
+function cellWidthOfCodePoint(codePoint) {
+    if (codePoint === 0)
+        return 0;
+    // ZWJ sequences should not add width (best-effort).
+    if (codePoint === 0x200d)
+        return 0;
+    if (codePoint < 32 || (codePoint >= 0x7f && codePoint < 0xa0))
+        return 0;
+    if (isCombiningCodePoint(codePoint))
+        return 0;
+    if (isVariationSelector(codePoint))
+        return 0;
+    return isWideCodePoint(codePoint) ? 2 : 1;
+}
+function stringCellWidth(value) {
+    let width = 0;
+    for (const char of value) {
+        width += cellWidthOfCodePoint(char.codePointAt(0) || 0);
+    }
+    return width;
+}
+function padEndCells(value, targetWidth) {
+    const current = stringCellWidth(value);
+    if (current >= targetWidth)
+        return value;
+    return `${value}${' '.repeat(targetWidth - current)}`;
+}
+function truncateToCellWidth(value, width) {
+    if (width <= 0)
+        return '';
+    let used = 0;
+    let out = '';
+    for (const char of value) {
+        const w = cellWidthOfCodePoint(char.codePointAt(0) || 0);
+        if (used + w > width)
+            break;
+        used += w;
+        out += char;
+    }
+    return out;
+}
 /**
- * Truncate `value` to at most `width` visible characters.
+ * Truncate `value` to at most `width` terminal cells.
  * Keep plain text only (no ANSI) to avoid renderer corruption.
  */
 function fitLine(value, width) {
     if (width <= 0)
         return '';
-    if (value.length > width) {
-        return width <= 1 ? value.slice(0, width) : `${value.slice(0, width - 1)}~`;
-    }
-    return value;
+    const safe = sanitizeLine(value);
+    if (stringCellWidth(safe) <= width)
+        return safe;
+    if (width <= 1)
+        return truncateToCellWidth(safe, width);
+    const head = truncateToCellWidth(safe, width - 1);
+    // If we couldn't fit any characters with a suffix reserved, fall back to a
+    // best-effort truncation without the suffix.
+    if (!head)
+        return truncateToCellWidth(safe, width);
+    return `${head}~`;
 }
 function formatApiCostValue(value) {
     const safe = Number.isFinite(value) && value > 0 ? value : 0;
@@ -41,12 +137,16 @@ function formatApiCostLine(value) {
 function alignPairs(pairs, indent = '  ') {
     if (pairs.length === 0)
         return [];
-    const labelWidth = Math.max(...pairs.map((pair) => pair.label.length), 0);
-    return pairs.map((pair) => {
+    const safePairs = pairs.map((pair) => ({
+        label: sanitizeLine(pair.label || ''),
+        value: sanitizeLine(pair.value || ''),
+    }));
+    const labelWidth = Math.max(...safePairs.map((pair) => stringCellWidth(pair.label)), 0);
+    return safePairs.map((pair) => {
         if (!pair.label) {
             return `${indent}${' '.repeat(labelWidth)}  ${pair.value}`;
         }
-        return `${indent}${pair.label.padEnd(labelWidth)}  ${pair.value}`;
+        return `${indent}${padEndCells(pair.label, labelWidth)}  ${pair.value}`;
     });
 }
 /**
@@ -83,8 +183,8 @@ export function renderSidebarTitle(baseTitle, usage, quotas, config) {
     if (config.sidebar.showQuota) {
         const visibleQuotas = collapseQuotaSnapshots(quotas).filter((q) => ['ok', 'error', 'unsupported', 'unavailable'].includes(q.status));
         const labelWidth = visibleQuotas.reduce((max, item) => {
-            const label = quotaDisplayLabel(item);
-            return Math.max(max, label.length);
+            const label = sanitizeLine(quotaDisplayLabel(item));
+            return Math.max(max, stringCellWidth(label));
         }, 0);
         const quotaItems = visibleQuotas
             .flatMap((item) => compactQuotaWide(item, labelWidth))
@@ -105,9 +205,9 @@ export function renderSidebarTitle(baseTitle, usage, quotas, config) {
  * Copilot:        "Copilot Monthly 70% Rst 03-01"
  */
 function compactQuotaWide(quota, labelWidth = 0) {
-    const label = quotaDisplayLabel(quota);
-    const labelPadding = ' '.repeat(Math.max(0, labelWidth - label.length));
-    const withLabel = (content) => `${label}${labelPadding} ${content}`;
+    const label = sanitizeLine(quotaDisplayLabel(quota));
+    const labelPadded = padEndCells(label, labelWidth);
+    const withLabel = (content) => `${labelPadded} ${content}`;
     if (quota.status === 'error')
         return [withLabel('Remaining ?')];
     if (quota.status === 'unsupported')
@@ -126,12 +226,12 @@ function compactQuotaWide(quota, labelWidth = 0) {
             : `${Math.round(win.remainingPercent)}%`;
         const parts = win.label
             ? showPercent
-                ? [win.label, pct]
-                : [win.label]
+                ? [sanitizeLine(win.label), pct]
+                : [sanitizeLine(win.label)]
             : [pct];
         const reset = compactReset(win.resetAt);
         if (reset) {
-            parts.push(`${win.resetLabel || 'Rst'} ${reset}`);
+            parts.push(`${sanitizeLine(win.resetLabel || 'Rst')} ${reset}`);
         }
         return parts.join(' ');
     };
@@ -203,6 +303,7 @@ function periodLabel(period) {
 }
 export function renderMarkdownReport(period, usage, quotas, options) {
     const showCost = options?.showCost !== false;
+    const mdCell = (value) => sanitizeLine(value).replace(/\|/g, '\\|');
     const rightCodeSubscriptionProviderIDs = new Set(collapseQuotaSnapshots(quotas)
         .filter((quota) => quota.adapterID === 'rightcode')
         .filter((quota) => quota.status === 'ok')
@@ -252,34 +353,37 @@ export function renderMarkdownReport(period, usage, quotas, options) {
     };
     const providerRows = Object.values(usage.providers)
         .sort((a, b) => b.total - a.total)
-        .map((provider) => showCost
-        ? `| ${provider.providerID} | ${shortNumber(provider.input)} | ${shortNumber(provider.output)} | ${shortNumber(provider.cacheRead + provider.cacheWrite)} | ${shortNumber(provider.total)} | ${measuredCostCell(provider.providerID, provider.cost)} | ${apiCostCell(provider.providerID, provider.apiCost)} |`
-        : `| ${provider.providerID} | ${shortNumber(provider.input)} | ${shortNumber(provider.output)} | ${shortNumber(provider.cacheRead + provider.cacheWrite)} | ${shortNumber(provider.total)} |`);
+        .map((provider) => {
+        const providerID = mdCell(provider.providerID);
+        return showCost
+            ? `| ${providerID} | ${shortNumber(provider.input)} | ${shortNumber(provider.output)} | ${shortNumber(provider.cacheRead + provider.cacheWrite)} | ${shortNumber(provider.total)} | ${measuredCostCell(provider.providerID, provider.cost)} | ${apiCostCell(provider.providerID, provider.apiCost)} |`
+            : `| ${providerID} | ${shortNumber(provider.input)} | ${shortNumber(provider.output)} | ${shortNumber(provider.cacheRead + provider.cacheWrite)} | ${shortNumber(provider.total)} |`;
+    });
     const quotaLines = collapseQuotaSnapshots(quotas).flatMap((quota) => {
         // Multi-window detail
         if (quota.windows && quota.windows.length > 0 && quota.status === 'ok') {
             return quota.windows.map((win) => {
                 if (win.showPercent === false) {
                     const winLabel = win.label ? ` (${win.label})` : '';
-                    return `- ${quota.label}${winLabel}: ${quota.status} | reset ${dateLine(win.resetAt)}`;
+                    return mdCell(`- ${quota.label}${winLabel}: ${quota.status} | reset ${dateLine(win.resetAt)}`);
                 }
                 const remaining = win.remainingPercent === undefined
                     ? '-'
                     : `${win.remainingPercent.toFixed(1)}%`;
                 const winLabel = win.label ? ` (${win.label})` : '';
-                return `- ${quota.label}${winLabel}: ${quota.status} | remaining ${remaining} | reset ${dateLine(win.resetAt)}`;
+                return mdCell(`- ${quota.label}${winLabel}: ${quota.status} | remaining ${remaining} | reset ${dateLine(win.resetAt)}`);
             });
         }
         if (quota.status === 'ok' && quota.balance) {
             return [
-                `- ${quota.label}: ${quota.status} | balance ${quota.balance.currency}${quota.balance.amount.toFixed(2)}`,
+                mdCell(`- ${quota.label}: ${quota.status} | balance ${quota.balance.currency}${quota.balance.amount.toFixed(2)}`),
             ];
         }
         const remaining = quota.remainingPercent === undefined
             ? '-'
             : `${quota.remainingPercent.toFixed(1)}%`;
         return [
-            `- ${quota.label}: ${quota.status} | remaining ${remaining} | reset ${dateLine(quota.resetAt)}${quota.note ? ` | ${quota.note}` : ''}`,
+            mdCell(`- ${quota.label}: ${quota.status} | remaining ${remaining} | reset ${dateLine(quota.resetAt)}${quota.note ? ` | ${quota.note}` : ''}`),
         ];
     });
     return [