opencode-goal-plugin 0.1.11 → 0.1.13

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 ## Unreleased
 
+## 0.1.13 — 2026-06-11
+
+> Fixes a significant token-tracking bug where the reported token count could be 5–10× higher than what OpenCode displays, making budgets appear exhausted far sooner than expected.
+
+- **Fix token tracking to use context window size instead of cumulative API consumption.** Each `message.updated` event carries `input + output + reasoning` tokens where `input` already includes the full conversation context. Accumulating deltas across messages re-counted prior turns every time, inflating the total. The plugin now uses `Math.max` across all message updates so `totalTokens` reflects the peak context window size — matching what OpenCode reports.
+- Rename `tracked_tokens_used` / `tracked_tokens_remaining` → `context_tokens_used` / `context_tokens_remaining` in continuation prompts.
+- Rename `Tokens:` → `Context tokens:` in status and result displays.
+- Rename `tracked token limit` / `tracked token budget` → `context token limit` / `context token budget` in all user-facing messages.
+- Add regression test verifying that multi-message token tracking no longer accumulates across turns.
+
+## 0.1.12 — 2026-06-08
+
+- Harden `escapeGoalText` to escape all XML closing tags (`</` → `<\\/`) instead of only `</goal_objective>`, closing a prompt-injection path where user-supplied goal text could break structural framing in the continuation message.
+- Add unit tests for `outputTokensForMessage`, `budgetWrapupNeeded`, `getSessionID`, `stopReason`, `normalizeOptions` boundary inputs (zero, negative, NaN, null, `budgetWrapupRatio` at 0 and 1), and `escapeGoalText` covering all structural tags.
+
 ## 0.1.11 — 2026-06-04
 
 - Add `npm run smoke`, a package-export smoke test that exercises the `/goal` command hook without invoking a model.
@@ -86,4 +101,4 @@
 
 ## 0.1.0
 
-- Initial experimental marker-based `/goal` plugin.
+- Initial experimental marker-based `/goal` plugin.

package/CONTRIBUTING.md

@@ -17,6 +17,7 @@ npm test
 npm run test:coverage
 npm run smoke
 npm run check
+npm run smoke
 npm run pack:check
 ```
 
@@ -46,6 +47,10 @@ Before publishing or tagging a release:
 - perform at least one manual OpenCode smoke test if hook behavior changed
 - refresh compatibility notes if the tested OpenCode surface changed
 
+`npm run smoke` verifies the published package entrypoint and `/goal` command hook without
+invoking a model. It does not replace a manual OpenCode smoke test after hook or command
+behavior changes.
+
 ## Pull Requests
 
 Keep pull requests focused. Include:

package/README.md

@@ -110,15 +110,15 @@ Markers must appear on their own final line. The bracketed form is canonical, bu
 |---|---|
 | Auto-continue turns | 10 |
 | Max duration | 15 minutes |
-| Tracked tokens | 200,000 |
+| Context tokens | 200,000 |
 | Min delay between continues | 1.5 seconds |
 | No-progress pause | < 50 output tokens on a stalled turn (after a 2-turn grace window) |
-| Budget wrap-up threshold | 80% of tracked token budget |
+| Budget wrap-up threshold | 80% of context token budget |
 | Auto-continue failure pause | 3 consecutive prompt failures |
 
 **Effective turn count.** Each LLM turn on a real task typically takes 30–90 seconds. At that latency, raising `--max-minutes` is usually more useful than raising `--max-turns`. At 45 s/turn, the default 15-minute window gives roughly 15–20 turns of headroom before the turn limit becomes the binding brake.
 
-**Token budget.** The plugin tracks `input + output + reasoning` tokens across all session messages. In high-context sessions (large codebases, long conversation history), input overhead per turn can be substantial and the budget may be exhausted before the turn limit is reached. Treat it as a safety brake, not precise billing accounting.
+**Token budget.** The plugin tracks the session's context window size (`input + output + reasoning` tokens on the latest message). This matches the token count that OpenCode displays, so the numbers should be consistent. When the context window reaches the `--max-tokens` limit, the plugin sends a wrap-up prompt and stops. In high-context sessions (large codebases, long conversation history), the context can grow quickly — treat the budget as a safety brake.
 
 **No-progress heuristic.** A low-output turn does not pause immediately anymore. The plugin pauses only after `noProgressTurnsBeforePause` consecutive *stalled* low-output turns — repeated turns with very little output and no meaningful change in the latest assistant checkpoint.
 
@@ -141,7 +141,7 @@ Override any limit for a single goal:
 | `--max-turns <n>` | Auto-continue turn limit |
 | `--max-minutes <n>` | Duration limit in minutes |
 | `--max-duration-ms <n>` | Duration limit in milliseconds |
-| `--max-tokens <n>` | Tracked token limit |
+| `--max-tokens <n>` | Context token limit |
 | `--cooldown-ms <n>` | Minimum delay between continues |
 | `--no-progress-threshold <n>` | Output token floor before pausing |
 | `--no-progress-turns <n>` | Consecutive stalled low-output turns before pausing |
@@ -226,12 +226,6 @@ Keep test files outside OpenCode's auto-loaded plugin directory — OpenCode wil
 6. Verify `/goal status`, `/goal pause`, `/goal resume`, and `/goal clear` behave as expected.
 7. If you changed hook payload handling or command behavior, repeat the smoke test against the exact OpenCode version and provider/backend combination you care about.
 
-### Release checklist
-
-- Confirm `npm test`, `npm run test:coverage`, `npm run check`, `npm run smoke`, and `npm run pack:check` all pass.
-- Re-test against a real OpenCode install when touching command hooks, idle-event handling, or system-prompt transforms.
-- Update compatibility notes and changelog entries when behavior or tested surfaces change.
-
 ## Development
 
 ```sh

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-goal-plugin",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "Session-scoped /goal workflow for OpenCode.",
   "type": "module",
   "main": "./src/goal-plugin.js",
@@ -47,4 +47,4 @@
   "author": {
     "name": "willytop8"
   }
-}
+}

package/src/goal-plugin.js

@@ -142,7 +142,7 @@ function formatStatus(goal) {
   const lines = [
     `Active goal: ${goal.condition}`,
     `Auto-continues sent: ${goal.turnCount}/${goal.options.maxTurns}`,
-    `Tokens: ${goal.totalTokens.toLocaleString()}/${goal.options.maxTokens.toLocaleString()}`,
+    `Context tokens: ${goal.totalTokens.toLocaleString()}/${goal.options.maxTokens.toLocaleString()}`,
     `Elapsed: ${elapsed}s/${Math.round(goal.options.maxDurationMs / 1000)}s`,
     `Last progress: ${lastProgress}`,
     `No-progress turns: ${goal.noProgressTurns}`,
@@ -168,7 +168,7 @@ function formatGoalResult(result) {
     `Last goal: ${result.condition}`,
     `State: ${result.state}`,
     `Auto-continues sent: ${result.turnCount}`,
-    `Tokens: ${result.totalTokens.toLocaleString()}`,
+    `Context tokens: ${result.totalTokens.toLocaleString()}`,
     `Elapsed: ${elapsed}s`,
     `Last checkpoint: ${lastCheckpoint}`,
     `Last status: ${result.lastStatus || "No status recorded."}`,
@@ -198,7 +198,7 @@ function stopReason(goal) {
   if (Date.now() - goal.startedAt >= goal.options.maxDurationMs) {
     return `max duration reached (${Math.round(goal.options.maxDurationMs / 1000)}s)`
   }
-  if (goal.totalTokens >= goal.options.maxTokens) return `max tokens reached (${goal.options.maxTokens})`
+  if (goal.totalTokens >= goal.options.maxTokens) return `max context tokens reached (${goal.options.maxTokens.toLocaleString()})`
   return null
 }
 
@@ -679,14 +679,16 @@ function buildLimitWarning(goal) {
     warnings.push(`${Math.max(0, Math.round(remainingMs / 1000))}s remaining`)
   }
   if (remainingTokens <= goal.options.warnTokensRemaining) {
-    warnings.push(`${Math.max(0, remainingTokens).toLocaleString()} tracked token(s) remaining`)
+    warnings.push(`${Math.max(0, remainingTokens).toLocaleString()} context token(s) remaining`)
   }
 
   return warnings.length ? ` Limits are near: ${warnings.join(", ")}.` : ""
 }
 
 function escapeGoalText(text) {
-  return String(text).replaceAll("</goal_objective>", "<\\/goal_objective>")
+  // Escape every XML closing tag so user-supplied goal text cannot break the
+  // structural framing used in buildGoalBlock and buildContinueMessage.
+  return String(text).replaceAll("</", "<\\/")
 }
 
 function buildGoalBlock(goal) {
@@ -709,8 +711,8 @@ function buildContinueMessage(goal, { budgetWrapup = false } = {}) {
     "<progress_budget>",
     `auto_continues_used: ${goal.turnCount}`,
     `auto_continues_remaining: ${remainingTurns}`,
-    `tracked_tokens_used: ${goal.totalTokens}`,
-    `tracked_tokens_remaining: ${remainingTokens}`,
+    `context_tokens_used: ${goal.totalTokens}`,
+    `context_tokens_remaining: ${remainingTokens}`,
     `elapsed_seconds: ${elapsedSeconds}`,
     "</progress_budget>",
     "",
@@ -719,7 +721,7 @@ function buildContinueMessage(goal, { budgetWrapup = false } = {}) {
   if (budgetWrapup) {
     lines.push(
       "<budget_wrapup>",
-      "This goal is near its tracked token limit. Finish the current step if it is small and safe.",
+      "This goal is near its context token limit. Finish the current step if it is small and safe.",
       "Then write a concise handoff summary covering what is done, what remains, and the next concrete command or file to inspect.",
       "Do not output [goal:complete] unless the goal is actually finished and verified.",
       "After the handoff, stop.",
@@ -1028,7 +1030,7 @@ export const GoalPlugin = async ({ client }, pluginOptions = {}) => {
       pushHistory(
         goal,
         "set",
-        `Goal created with limits: ${goal.options.maxTurns} auto-continues, ${Math.round(goal.options.maxDurationMs / 1000)}s, ${goal.options.maxTokens.toLocaleString()} tracked tokens.`,
+        `Goal created with limits: ${goal.options.maxTurns} auto-continues, ${Math.round(goal.options.maxDurationMs / 1000)}s, ${goal.options.maxTokens.toLocaleString()} context tokens.`,
       )
 
       cleanupGoal(sessionID)
@@ -1047,7 +1049,7 @@ export const GoalPlugin = async ({ client }, pluginOptions = {}) => {
             "",
             `Limits: ${goal.options.maxTurns} auto-continues, ${Math.round(
               goal.options.maxDurationMs / 1000,
-            )}s, ${goal.options.maxTokens.toLocaleString()} tracked tokens.`,
+            )}s, ${goal.options.maxTokens.toLocaleString()} context tokens.`,
           ].join("\n"),
         ),
       ]
@@ -1070,7 +1072,13 @@ export const GoalPlugin = async ({ client }, pluginOptions = {}) => {
         const currentTokens = totalTokensForMessage(message)
         const previousTokens = seenTokens.get(currentMessageID) || 0
         if (currentTokens > previousTokens) {
-          goal.totalTokens += currentTokens - previousTokens
+          // Track the context window size (peak input+output+reasoning),
+          // not cumulative API token consumption. Each message's tokens
+          // include the full conversation context, so accumulating deltas
+          // across messages inflates the count by re-counting prior turns.
+          // Using Math.max gives the current context size, matching what
+          // OpenCode displays and making the budget check intuitive.
+          goal.totalTokens = Math.max(goal.totalTokens, currentTokens)
           seenTokens.set(currentMessageID, currentTokens)
           goal.messageIDs.add(currentMessageID)
           changed = true
@@ -1259,7 +1267,7 @@ export const GoalPlugin = async ({ client }, pluginOptions = {}) => {
               activeGoalAfterPrompt,
               budgetWrapup ? "budget-wrapup" : "auto-continue",
               budgetWrapup
-                ? "Sent a final handoff request near the tracked token budget."
+                ? "Sent a final handoff request near the context token budget."
                 : `Sent auto-continue prompt ${activeGoalAfterPrompt.turnCount}/${activeGoalAfterPrompt.options.maxTurns}.`,
             )
           }