opencode-goal-plugin 0.1.13 → 0.1.14

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Unreleased
 
+## 0.1.14 — 2026-06-12
+
+- **Count cached context tokens in the budget.** `totalTokensForMessage` now includes `tokens.cache.read` / `cache.write` alongside `input + output + reasoning`. On providers with prompt caching (e.g. Anthropic) most of the conversation context arrives as cache reads with a tiny `input`, so the prior estimate undercounted the context window and the token budget / wrap-up could effectively never trigger.
+- **Honor `/goal pause` issued mid-handler.** The post-await re-checks in the idle handler now use a new `activeGoal` helper that treats a `stopped` goal as inactive, so a pause sent while messages are being fetched or during the cooldown no longer lets one more auto-continue slip through. Adds a regression test.
+- **Harden `escapeGoalText` against forged opening tags.** In addition to escaping closing tags, the plugin now neutralizes opening forms of its own structural tags (`<budget_wrapup>`, `<next_step>`, `<completion_audit>`, `<goal_objective>`, `<goal_continuation>`, `<progress_budget>`), closing a prompt-injection path where goal text could mimic elevated-instruction blocks. Non-structural tag-like text (e.g. `<div>`) is left untouched.
+- **Stop the smoke test from touching real state.** `scripts/smoke-command-hook.mjs` now runs with `persistState: false`, so `npm run smoke` can no longer read or overwrite `~/.opencode-goal-plugin/state.json`.
+- Document the `warnTurnsRemaining` / `warnDurationMsRemaining` / `warnTokensRemaining` options in the README.
+
 ## 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.

package/README.md

@@ -187,6 +187,7 @@ Additional plugin-level options:
 
 - `maxRecentMessages` — how many recent session messages to scan when looking for the latest assistant turn before auto-continuing. Higher values make long, tool-heavy sessions less likely to lose the most recent assistant response.
 - `noProgressTurnsBeforePause` — grace window for low-output stalls. The plugin pauses only after this many consecutive stalled low-output turns rather than on the first one.
+- `warnTurnsRemaining` / `warnDurationMsRemaining` / `warnTokensRemaining` — thresholds at which the auto-continue prompt appends a "limits are near" warning (default `3` turns, `60000` ms, `25000` context tokens). Lower them to warn closer to the limit, or raise them to warn earlier.
 - `persistState` — whether to persist active goals and recent goal results to disk.
 - `stateFilePath` — where the persisted state JSON is written. Useful if you want per-project or ephemeral storage.
 - `resultRetentionMs` — how long a completed goal summary remains available through `/goal status` after the goal leaves active memory.

package/package.json

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

package/scripts/smoke-command-hook.mjs

@@ -23,7 +23,9 @@ const client = {
 assert.equal(pluginModule.id, "opencode-goal-plugin")
 assert.equal(pluginModule.server, GoalPlugin)
 
-const hooks = await GoalPlugin({ client }, { minDelayMs: 1 })
+// persistState:false keeps the smoke test from reading or overwriting the
+// user's real ~/.opencode-goal-plugin/state.json.
+const hooks = await GoalPlugin({ client }, { minDelayMs: 1, persistState: false })
 assert.equal(typeof hooks["command.execute.before"], "function")
 assert.equal(typeof hooks.event, "function")
 assert.equal(typeof hooks["experimental.chat.system.transform"], "function")

package/src/goal-plugin.js

@@ -285,6 +285,16 @@ function currentGoal(sessionID, goalID) {
   return goal
 }
 
+// Like currentGoal, but also returns null if the goal was stopped (paused,
+// cleared-and-replaced, blocked) while an async step was in flight. Used at the
+// post-await re-checks so a `/goal pause` issued during messages-fetch or the
+// cooldown sleep actually prevents the next auto-continue from firing.
+function activeGoal(sessionID, goalID) {
+  const goal = currentGoal(sessionID, goalID)
+  if (!goal || goal.stopped) return null
+  return goal
+}
+
 function toPositiveInteger(value, fallback) {
   const parsed = Number(value)
   return Number.isSafeInteger(parsed) && parsed > 0 ? parsed : fallback
@@ -685,10 +695,28 @@ function buildLimitWarning(goal) {
   return warnings.length ? ` Limits are near: ${warnings.join(", ")}.` : ""
 }
 
+// Tag names the plugin uses to frame its own instructions. Goal text must not
+// be able to forge either an opening or a closing form of any of these.
+const STRUCTURAL_TAGS = [
+  "goal_continuation",
+  "goal_objective",
+  "progress_budget",
+  "budget_wrapup",
+  "next_step",
+  "completion_audit",
+]
+const STRUCTURAL_OPEN_TAG_RE = new RegExp(`<(${STRUCTURAL_TAGS.join("|")})\\b`, "gi")
+
 function escapeGoalText(text) {
   // Escape every XML closing tag so user-supplied goal text cannot break the
-  // structural framing used in buildGoalBlock and buildContinueMessage.
-  return String(text).replaceAll("</", "<\\/")
+  // structural framing used in buildGoalBlock and buildContinueMessage...
+  let escaped = String(text).replaceAll("</", "<\\/")
+  // ...and neutralize opening forms of the plugin's own structural tags so goal
+  // text cannot inject a forged block (e.g. <budget_wrapup>, <next_step>) that
+  // mimics elevated instructions. Closing forms are already broken above, so
+  // this regex only matches genuine `<tag` openings.
+  escaped = escaped.replace(STRUCTURAL_OPEN_TAG_RE, "<\\$1")
+  return escaped
 }
 
 function buildGoalBlock(goal) {
@@ -798,12 +826,23 @@ function messageTokens(message) {
       : {}
 }
 
+function cacheTokensForMessage(tokens) {
+  // OpenCode reports cached context separately as `cache: { read, write }`.
+  // On cache-heavy providers (e.g. Anthropic prompt caching) most of the
+  // conversation context arrives as `cache.read` with a small `input`, so the
+  // cache fields must be counted toward the context-window estimate or the
+  // token budget is undercounted by an order of magnitude.
+  const cache = isPlainObject(tokens.cache) ? tokens.cache : {}
+  return toNonNegativeInteger(cache.read) + toNonNegativeInteger(cache.write)
+}
+
 function totalTokensForMessage(message) {
   const tokens = messageTokens(message)
   return (
     toNonNegativeInteger(tokens.input) +
     toNonNegativeInteger(tokens.output) +
-    toNonNegativeInteger(tokens.reasoning)
+    toNonNegativeInteger(tokens.reasoning) +
+    cacheTokensForMessage(tokens)
   )
 }
 
@@ -1112,7 +1151,7 @@ export const GoalPlugin = async ({ client }, pluginOptions = {}) => {
           path: { id: sessionID },
           query: { limit: goal.options.maxRecentMessages },
         })
-        const activeGoalAfterMessages = currentGoal(sessionID, goalID)
+        const activeGoalAfterMessages = activeGoal(sessionID, goalID)
         if (!activeGoalAfterMessages) return
 
         const latestAssistant = findLatestAssistantMessage(messages.data)
@@ -1217,7 +1256,7 @@ export const GoalPlugin = async ({ client }, pluginOptions = {}) => {
           await sleep(activeGoalAfterMessages.options.minDelayMs - elapsedSinceLastContinue)
         }
 
-        const activeGoalBeforePrompt = currentGoal(sessionID, goalID)
+        const activeGoalBeforePrompt = activeGoal(sessionID, goalID)
         if (!activeGoalBeforePrompt) return
 
         const budgetWrapup = budgetWrapupNeeded(activeGoalBeforePrompt)
@@ -1332,6 +1371,7 @@ export default {
 }
 
 export const testInternals = {
+  activeGoal,
   buildLimitWarning,
   buildContinueMessage,
   buildGoalBlock,
@@ -1339,6 +1379,7 @@ export const testInternals = {
   cleanupGoal,
   currentGoal,
   escapeGoalText,
+  totalTokensForMessage,
   extractBlockedReason,
   findLatestAssistantMessage,
   formatArgumentErrors,