majordomo/agent/finalize.go

package agent

import (
	"regexp"
	"strings"

	"gitea.stevedudenhoeffer.com/steve/majordomo/llm"
)

// finalOutput selects the user-facing answer when the loop reaches a clean
// terminal turn (one with no tool calls).
//
// Normally that terminal turn's text IS the answer: well-behaved models defer
// their answer to the final, tool-free turn. But some models — notably several
// open-weight ones — "front-load" their full answer into an earlier turn that
// ALSO calls a tool (e.g. answer text alongside a citation call), then close
// with a degenerate terminal turn that is not itself the answer. Three shapes
// are recovered from the transcript (zero extra model calls):
//
//   - a trivial back-reference ("(Already answered above.)", "see above", …):
//     the real answer sits earlier, so recover it and DISCARD the worthless
//     closer.
//   - a sources/citations-only addendum ("Sources: [x](…), [y](…)"): the model
//     front-loaded the prose answer and closed with just its citations (the
//     glm-5.2 "cite" pattern behind mort issue #1418). The citations are real,
//     useful content — unlike a back-reference — so recover the prior answer and
//     KEEP the citations, appended below it.
//   - a bookkeeping closer ("Citations are logged. Short version: …"): the
//     model acknowledged the citation round and compressed the answer it had
//     already written into a one-liner (mort run b3cb9ee9 — a 2,089-char answer
//     shrank to a 153-byte closer at delivery). The compression is strictly
//     poorer than the front-loaded answer, so recover the prior turn and
//     DISCARD the closer — but only when the prior turn clearly dwarfs it,
//     because unlike a back-reference this closer DOES carry answer content
//     (see modeSummary).
//
// A citations addendum is tested first and wins over the other two (a short
// terminal can match more than one shape), so its links are never discarded.
// The back-reference test wins over the summary-closer test: a terminal
// matching both ("Citations are logged. As I said above…") carries no answer
// content of its own, so the looser back-ref recovery bar — not the summary
// closer's dwarf ratio — is the right one. When the terminal text stands
// on its own it is returned unchanged; when it is degenerate but nothing
// better can be recovered, it is returned as-is (a compressed answer still
// beats nothing).
//
// msgs must already include the terminal assistant message as its last element
// (the loop appends it before calling this); terminal is that message's text.
func finalOutput(msgs []llm.Message, terminal string) string {
	mode := modeBackRef
	switch {
	case isCitationsOnly(terminal):
		mode = modeCitations
	case isWeakFinal(terminal):
		// modeBackRef
	case isSummaryCloser(terminal):
		mode = modeSummary
	default:
		return terminal
	}
	rec, ok := lastSubstantiveAssistantText(msgs, terminal, mode)
	if !ok {
		return terminal
	}
	if mode == modeCitations {
		// Preserve the citations addendum below the recovered answer, unless the
		// recovered turn already carries it (guards against a duplicate sources
		// block when the front-loaded turn included its own citations). The
		// containment test ignores <url> angle-bracket wrappers so a turn that
		// listed the same sources unwrapped still suppresses the duplicate.
		if tail := strings.TrimSpace(terminal); !strings.Contains(stripURLAngles(rec), stripURLAngles(tail)) {
			return rec + "\n\n" + tail
		}
	}
	return rec
}

// stripURLAngles removes the <…> wrappers Discord uses to suppress link embeds,
// so the citations dedup compares URLs regardless of that formatting delta.
func stripURLAngles(s string) string {
	if !strings.ContainsAny(s, "<>") {
		return s
	}
	return strings.NewReplacer("<", "", ">", "").Replace(s)
}

// recoveryMode selects the bar a prior assistant turn must clear to replace
// the terminal turn (see isSubstantiveAnswer) and what finalOutput does with
// the terminal once recovery succeeds.
type recoveryMode int

const (
	// modeBackRef: the terminal is empty or a pure back-reference — worthless
	// on its own, so any real prior answer replaces it and it is discarded.
	modeBackRef recoveryMode = iota
	// modeCitations: the terminal is a sources-only addendum — not a rival
	// answer, so the dwarf ratio is skipped and the addendum is kept, appended
	// below the recovered answer.
	modeCitations
	// modeSummary: the terminal acknowledges the citation round and may carry
	// a short compression of the front-loaded answer. Unlike a back-reference
	// it DOES contain answer content, so it is only replaced when a prior turn
	// clearly dwarfs it — the ratio is mandatory at every length, the recovery
	// scan stops at the most recent user message (a compression can only be of
	// THIS turn's answer; never resurrect one from an earlier question), and
	// the closer is discarded (its content is a strict subset of what it
	// replaced).
	modeSummary
)

// backRefRe matches a terminal turn that merely points back to an earlier
// message instead of stating the answer ("(Already answered above.)",
// "see above", "as I said", ...).
var backRefRe = regexp.MustCompile(`(?i)(already answered|see above|as (i )?(said|mentioned|stated|noted)|answered (that )?above|per my (previous|earlier))`)

// summaryCloserRe matches a terminal turn that OPENS with a bookkeeping
// acknowledgment of the citation round — "Citations are logged.", "Sources
// cited.", "Logged the citations." — the shape a model produces when it
// front-loaded its answer into an earlier cite-call turn and closes by
// acknowledging the tool results, often followed by a "Short version: …"
// compression of the answer it already wrote. The ack clause must end at a
// sentence terminator ([.!]) DIRECTLY after the verb: "The citations are
// recorded in the court transcript…" is a real answer about citations, not
// bookkeeping, and must never match. A compression marker without the ack
// ("Short version: no.") is deliberately out of scope — a user who asked for
// brevity would be answered with exactly that shape, and misclassifying it
// would hijack a legitimate answer; an unmatched closer merely keeps today's
// behavior (fail closed). Assembled from named fragments so the alternations
// stay legible and extendable.
const (
	summaryLead    = `[\s>#*_+-]*`                          // leading markdown/list markers, as in citationLabelRe
	summaryPreface = `((done|all set|ok(ay)?)[\s,.!:—-]+)?` // optional "Done —" style opener
	summaryNouns   = `(citations?|sources?|references?|claims?)`
	summaryCopulas = `((are|were|have\s+been|all)\s+)*`
	summaryVerbs   = `(logged|recorded|cited|saved|noted|captured|filed)`
	summaryArticle = `((all|the)\s+)*` // star, not ?: "Logged all the citations."
)

var summaryCloserRe = regexp.MustCompile(`(?i)^` + summaryLead + summaryPreface +
	`(` + summaryArticle + summaryNouns + `\s+` + summaryCopulas + summaryVerbs +
	`|logged\s+` + summaryArticle + summaryNouns + `)[.!]`)

// preambleRe matches intent-announcing prefixes ("Let me search...", "I'll
// check...") so a preamble is never mistaken for the answer during recovery.
var preambleRe = regexp.MustCompile(`(?i)^(let me|let'?s|i'?ll|i will|first[, ]|sure[,. ]|okay[,. ]|on it|checking)`)

// citationLabelRe matches a terminal turn that OPENS with a sources/citations
// heading — the shape a model produces when it front-loads its answer into an
// earlier tool-call turn and closes with only its sources. Leading markdown
// emphasis (*, _), list (-, +, *), block-quote (>), and ATX-heading (#) markers
// — with their whitespace, since \s is in the class — are tolerated before the
// label, as is closing emphasis (** / __) plus whitespace between the label and
// the colon/dash separator. Anchored at ^ so a normal answer that merely
// mentions "sources" mid-sentence, or ends with a "Sources:" section AFTER its
// prose, is never matched.
var citationLabelRe = regexp.MustCompile(`(?i)^[\s>#*_+-]*(sources?|references?|citations?|works cited|further reading)\b[\s*_]*[:：\-—]`)

// linkRe matches a whole markdown link "[label](url)" or a bare URL. Used both
// to require that a citations terminal carries at least one link and to strip
// links out when measuring how citation-dominated the terminal is.
var linkRe = regexp.MustCompile(`\[[^\]]*\]\([^)]*\)|https?://\S+`)

// citationResidueCutset is trimmed from the ends of a citations terminal's
// non-link remainder before measuring it — list bullets, separators, and the
// short per-source annotations models add in parentheses.
const citationResidueCutset = " \t\r\n,;.:|·•*_()[]—-"

const (
	// weakFinalMaxChars bounds how long a back-reference closer can be. A
	// genuine final answer that merely contains "as I said" mid-sentence is
	// longer than this, so it is never treated as weak.
	weakFinalMaxChars = 120
	// recoverMinChars: a prior assistant turn this long is treated as a real
	// answer regardless of how it opens (the preamble filter is not applied at
	// this length — see isSubstantiveAnswer).
	recoverMinChars = 200
	// recoverFloorChars / recoverRatio gate the borderline band: a shorter
	// prior turn must clear the floor and — unless the terminal is a citations
	// addendum, which is not a rival answer — also clearly dwarf the (very
	// short) terminal. See isSubstantiveAnswer.
	recoverFloorChars = 80
	recoverRatio      = 3
	// citationDominatedDivisor: a citations terminal's non-link remainder must
	// be at most len/N of the whole, so a prose answer that merely opens with
	// "Source:" and cites a URL mid-sentence is not mistaken for a bare list.
	citationDominatedDivisor = 3
	// summaryCloserMaxChars bounds a summary closer: room for the ack sentence
	// plus a couple of compression sentences (the b3cb9ee9 closer was 153
	// bytes — Go len(), which is what every threshold here compares). Beyond
	// this the "short version" is substantial enough that replacing it risks
	// losing content the front-loaded turn never had.
	summaryCloserMaxChars = 300
)

// isWeakFinal reports whether a terminal turn's text fails to stand on its own
// as the answer: empty/whitespace, or a short pure back-reference.
func isWeakFinal(s string) bool {
	t := strings.TrimSpace(s)
	if t == "" {
		return true
	}
	return len(t) <= weakFinalMaxChars && backRefRe.MatchString(t)
}

// isCitationsOnly reports whether a terminal turn is essentially just a
// sources/citations addendum: it OPENS with a citations heading, carries at
// least one link, and — once the heading and links are removed — is dominated
// by that citation structure (only list punctuation and short per-source
// annotations remain). The dominance check is what separates a bare sources
// list (recover the front-loaded answer, keep the links) from a real prose
// answer that merely opens with "Source:" and references a URL mid-sentence
// (leave it as the answer). Unlike a back-reference closer the links are worth
// keeping, so finalOutput appends them to the recovered answer.
//
// A citations terminal whose sources are bare domains (no scheme, no markdown
// link) is intentionally out of scope — there is no reliable link signal, so it
// is left as-is rather than risk misclassifying prose.
func isCitationsOnly(s string) bool {
	t := strings.TrimSpace(s)
	if !citationLabelRe.MatchString(t) {
		return false
	}
	body := citationLabelRe.ReplaceAllString(t, "")
	if !linkRe.MatchString(body) {
		return false
	}
	residue := strings.Trim(linkRe.ReplaceAllString(body, ""), citationResidueCutset)
	return len(residue) <= len(t)/citationDominatedDivisor
}

// isSummaryCloser reports whether a terminal turn is a bookkeeping closer: it
// opens with a complete "citations are logged"-style ack sentence (see
// summaryCloserRe) and is short enough that whatever follows the ack can only
// be a compression of an earlier, fuller answer. Whether that fuller answer
// actually exists is modeSummary's job — the dwarf ratio in
// isSubstantiveAnswer keeps a matching closer in place when nothing earlier
// clearly outweighs it.
func isSummaryCloser(s string) bool {
	t := strings.TrimSpace(s)
	if t == "" || len(t) > summaryCloserMaxChars {
		return false
	}
	return summaryCloserRe.MatchString(t)
}

// lastSubstantiveAssistantText scans msgs newest→oldest (skipping the terminal
// turn and empty tool-only turns) for the most recent assistant turn whose text
// reads like a real answer. mode selects the recovery bar (see
// isSubstantiveAnswer). Returns ("", false) when nothing qualifies.
func lastSubstantiveAssistantText(msgs []llm.Message, terminal string, mode recoveryMode) (string, bool) {
	tt := strings.TrimSpace(terminal)
	for i := len(msgs) - 1; i >= 0; i-- {
		m := msgs[i]
		if mode == modeSummary && m.Role == llm.RoleUser {
			// A summary closer compresses THIS turn's front-loaded answer, so
			// the scan must not cross into an earlier question: once the dwarf
			// ratio has rejected the current turn's text, walking further back
			// would resurrect a stale answer to a DIFFERENT question — strictly
			// worse than keeping the closer. (A mid-run steer message is also a
			// user-role boundary; recovery then fails closed, which is fine.)
			// The other modes keep their historical unbounded scan.
			break
		}
		if m.Role != llm.RoleAssistant {
			continue
		}
		txt := strings.TrimSpace(m.Text())
		if txt == "" || txt == tt {
			continue // the terminal turn itself, or an empty tool-only turn
		}
		if isSubstantiveAnswer(txt, tt, mode) {
			return txt, true
		}
	}
	return "", false
}

// isSubstantiveAnswer reports whether txt (a prior assistant turn) reads like a
// real answer rather than a preamble, relative to the terminal text.
//
// modeSummary demands the dwarf ratio FIRST, at every length: a summary closer
// carries a real (compressed) answer, so replacing it is only justified when
// the prior turn is clearly the fuller original it was compressed from.
//
// A sufficiently long turn (>= recoverMinChars) is otherwise accepted
// unconditionally: a multi-hundred-char turn is an answer even when it opens
// conversationally ("Sure, here's…", "Let me explain: …"), so the preamble
// filter is NOT applied to it — applying it there would drop a legitimate long
// front-loaded answer. Only in the borderline band does a turn have to clear a
// floor, not read like a short planning preamble ("Let me look that up…"),
// and — for modeBackRef only — also clearly dwarf the terminal (a citations
// addendum is not a rival answer, so its length is irrelevant; a summary
// closer already proved the ratio above).
func isSubstantiveAnswer(txt, terminal string, mode recoveryMode) bool {
	dwarfs := len(txt) >= recoverRatio*len(terminal)
	if mode == modeSummary && !dwarfs {
		return false
	}
	if len(txt) >= recoverMinChars {
		return true
	}
	if len(txt) < recoverFloorChars || preambleRe.MatchString(txt) {
		return false
	}
	return mode != modeBackRef || dwarfs
}