F3 SLICE-3: applyAgentEdit seam + live tracking + decorations/toggle (INV-7/INV-9) (#6)
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,289 @@
|
||||
/**
|
||||
* AttributionController — the thin editor-facing layer for F3 (spec §6.2).
|
||||
* Wires the pure AttributionTracker + PendingEditRegistry + Store/Anchorer to
|
||||
* the editor: human typing → human spans, seam edits → agent spans (INV-9),
|
||||
* decorations (Claude tint / human gutter border / toggle), save-time
|
||||
* persistence, load/external-change resolve-or-orphan (INV-1/INV-6), and the
|
||||
* orphan status-bar count. Sidecar self-write suppression and the shared
|
||||
* FileSystemWatcher live in CoauthorStore / extension.ts (the sidecar is
|
||||
* co-owned with ThreadController).
|
||||
*/
|
||||
import * as vscode from "vscode";
|
||||
import { CoauthorStore } from "./store";
|
||||
import { newId, type AttributionRecord, type Provenance } from "./model";
|
||||
import { buildFingerprint, resolve, type OffsetRange } from "./anchorer";
|
||||
import { applyChange, coalesce, type LiveSpan } from "./attributionTracker";
|
||||
import { PendingEditRegistry } from "./pendingEdits";
|
||||
|
||||
/** Test-facing snapshot of live attribution state for a document. */
|
||||
export interface RenderedSpan {
|
||||
id: string;
|
||||
authorKind: "human" | "agent";
|
||||
authorId: string;
|
||||
turnId?: string;
|
||||
range: { start: number; end: number };
|
||||
}
|
||||
|
||||
interface DocAttribution {
|
||||
docPath: string;
|
||||
spans: LiveSpan[];
|
||||
/** persisted records whose fingerprints failed to resolve (PUC-4). */
|
||||
orphans: AttributionRecord[];
|
||||
/** record metadata per live span id (updatedAt bookkeeping). */
|
||||
records: Map<string, AttributionRecord>;
|
||||
}
|
||||
|
||||
const AGENT_DECO: vscode.DecorationRenderOptions = {
|
||||
backgroundColor: "rgba(99, 102, 241, 0.18)",
|
||||
overviewRulerColor: "rgba(99, 102, 241, 0.8)",
|
||||
overviewRulerLane: vscode.OverviewRulerLane.Right,
|
||||
};
|
||||
const HUMAN_DECO: vscode.DecorationRenderOptions = {
|
||||
borderColor: "rgba(16, 185, 129, 0.8)",
|
||||
borderStyle: "solid",
|
||||
borderWidth: "0 0 0 2px",
|
||||
};
|
||||
|
||||
export class AttributionController implements vscode.Disposable {
|
||||
private readonly disposables: vscode.Disposable[] = [];
|
||||
private readonly docs = new Map<string, DocAttribution>();
|
||||
private readonly pending = new PendingEditRegistry();
|
||||
private readonly agentType = vscode.window.createTextEditorDecorationType(AGENT_DECO);
|
||||
private readonly humanType = vscode.window.createTextEditorDecorationType(HUMAN_DECO);
|
||||
private readonly statusItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 90);
|
||||
private readonly output = vscode.window.createOutputChannel("Cowriting Attribution");
|
||||
private visible = true;
|
||||
|
||||
constructor(private readonly store: CoauthorStore, private readonly rootDir: string) {
|
||||
this.disposables.push(this.agentType, this.humanType, this.statusItem, this.output);
|
||||
this.disposables.push(
|
||||
vscode.commands.registerCommand("cowriting.toggleAttribution", () => this.toggle()),
|
||||
vscode.workspace.onDidChangeTextDocument((e) => this.onDidChange(e)),
|
||||
vscode.workspace.onDidSaveTextDocument((d) => this.onDidSave(d)),
|
||||
vscode.window.onDidChangeActiveTextEditor(() => this.renderActive()),
|
||||
);
|
||||
}
|
||||
|
||||
private isTracked(document: vscode.TextDocument): boolean {
|
||||
return document.uri.scheme === "file" && document.uri.fsPath.startsWith(this.rootDir);
|
||||
}
|
||||
private docPathOf(uri: vscode.Uri): string {
|
||||
return vscode.workspace.asRelativePath(uri, false);
|
||||
}
|
||||
private currentAuthor(): Provenance {
|
||||
const id = vscode.workspace.getConfiguration("git").get<string>("user.name") || process.env.USER || "human";
|
||||
return { kind: "human", id };
|
||||
}
|
||||
private state(docPath: string): DocAttribution {
|
||||
let s = this.docs.get(docPath);
|
||||
if (!s) {
|
||||
s = { docPath, spans: [], orphans: [], records: new Map() };
|
||||
this.docs.set(docPath, s);
|
||||
}
|
||||
return s;
|
||||
}
|
||||
|
||||
// ---- PUC-4: load / resolve-or-orphan ---------------------------------------------
|
||||
|
||||
/** Load the sidecar and re-resolve every attribution (live span | orphan). */
|
||||
loadAll(document: vscode.TextDocument): void {
|
||||
if (!this.isTracked(document)) return;
|
||||
const docPath = this.docPathOf(document.uri);
|
||||
const s = this.state(docPath);
|
||||
const artifact = this.store.load(docPath);
|
||||
s.spans = [];
|
||||
s.orphans = [];
|
||||
s.records.clear();
|
||||
if (artifact) {
|
||||
const text = document.getText();
|
||||
for (const rec of artifact.attributions) {
|
||||
const fp = artifact.anchors[rec.anchorId]?.fingerprint;
|
||||
const resolved = fp ? resolve(text, fp) : "orphaned";
|
||||
if (resolved === "orphaned") {
|
||||
s.orphans.push(rec);
|
||||
} else {
|
||||
s.spans.push({
|
||||
id: rec.id, start: resolved.start, end: resolved.end,
|
||||
author: rec.author, turnId: rec.turnId, createdAt: rec.createdAt,
|
||||
});
|
||||
s.records.set(rec.id, rec);
|
||||
}
|
||||
}
|
||||
s.spans = coalesce(s.spans);
|
||||
}
|
||||
this.render(document);
|
||||
}
|
||||
|
||||
/** Shared-watcher entry point (extension.ts): a sidecar changed externally. */
|
||||
handleExternalSidecarChange(uri: vscode.Uri): void {
|
||||
for (const s of this.docs.values()) {
|
||||
if (this.store.sidecarPath(s.docPath) === uri.fsPath) {
|
||||
const doc = vscode.workspace.textDocuments.find((d) => this.docPathOf(d.uri) === s.docPath);
|
||||
if (doc) this.loadAll(doc);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ---- PUC-1/PUC-3: live tracking ---------------------------------------------------
|
||||
|
||||
private onDidChange(e: vscode.TextDocumentChangeEvent): void {
|
||||
if (!this.isTracked(e.document) || e.contentChanges.length === 0) return;
|
||||
const docPath = this.docPathOf(e.document.uri);
|
||||
if (!e.document.isDirty) {
|
||||
// Disk sync (revert / reload): re-resolve, never attribute (PUC-4).
|
||||
this.loadAll(e.document);
|
||||
return;
|
||||
}
|
||||
const s = this.state(docPath);
|
||||
for (const change of e.contentChanges) {
|
||||
const edit = {
|
||||
start: change.rangeOffset,
|
||||
end: change.rangeOffset + change.rangeLength,
|
||||
newLength: change.text.length,
|
||||
};
|
||||
const hit = this.pending.match(docPath, { start: edit.start, end: edit.end, text: change.text });
|
||||
const author = hit ? hit.provenance : this.currentAuthor();
|
||||
s.spans = applyChange(s.spans, edit, author, {
|
||||
newId: () => newId("at"),
|
||||
now: () => new Date().toISOString(),
|
||||
turnId: hit?.turnId,
|
||||
});
|
||||
}
|
||||
this.render(e.document);
|
||||
}
|
||||
|
||||
// ---- the seam (INV-9) ---------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* The ONLY machine-edit ingress: register the exact expected change, then
|
||||
* apply it as a WorkspaceEdit. Returns false (applying nothing) on a stale
|
||||
* document version or a rejected edit — never partial-applies (spec §6.9).
|
||||
* The pending edit is unregistered unconditionally afterwards (a no-op when
|
||||
* `match` already consumed it), so a no-op edit never leaks a registration.
|
||||
*/
|
||||
async applyAgentEdit(
|
||||
document: vscode.TextDocument,
|
||||
range: vscode.Range,
|
||||
newText: string,
|
||||
provenance: Provenance,
|
||||
opts?: { expectedVersion?: number; turnId?: string },
|
||||
): Promise<boolean> {
|
||||
if (!this.isTracked(document)) return false;
|
||||
if (opts?.expectedVersion !== undefined && document.version !== opts.expectedVersion) return false;
|
||||
const docPath = this.docPathOf(document.uri);
|
||||
const pendingEdit = {
|
||||
docPath,
|
||||
start: document.offsetAt(range.start),
|
||||
end: document.offsetAt(range.end),
|
||||
newText,
|
||||
provenance,
|
||||
turnId: opts?.turnId,
|
||||
};
|
||||
this.pending.register(pendingEdit);
|
||||
const we = new vscode.WorkspaceEdit();
|
||||
we.replace(document.uri, range, newText);
|
||||
const ok = await vscode.workspace.applyEdit(we);
|
||||
this.pending.unregister(pendingEdit);
|
||||
return ok;
|
||||
}
|
||||
|
||||
// ---- PUC-4: persistence on save ----------------------------------------------------
|
||||
|
||||
private onDidSave(document: vscode.TextDocument): void {
|
||||
if (!this.isTracked(document)) return;
|
||||
const docPath = this.docPathOf(document.uri);
|
||||
const s = this.docs.get(docPath);
|
||||
if (!s || (s.spans.length === 0 && s.orphans.length === 0)) return;
|
||||
const text = document.getText();
|
||||
const now = new Date().toISOString();
|
||||
const records: AttributionRecord[] = [];
|
||||
const anchorOf = new Map<string, OffsetRange>();
|
||||
for (const span of s.spans) {
|
||||
const prev = s.records.get(span.id);
|
||||
const rec: AttributionRecord = {
|
||||
id: span.id,
|
||||
anchorId: prev?.anchorId ?? newId("a"),
|
||||
author: span.author,
|
||||
createdAt: span.createdAt,
|
||||
updatedAt: prev ? prev.updatedAt : now,
|
||||
...(span.turnId !== undefined ? { turnId: span.turnId } : {}),
|
||||
};
|
||||
anchorOf.set(rec.anchorId, { start: span.start, end: span.end });
|
||||
records.push(rec);
|
||||
s.records.set(span.id, rec);
|
||||
}
|
||||
this.store.update(docPath, (a) => {
|
||||
for (const rec of records) {
|
||||
const range = anchorOf.get(rec.anchorId)!;
|
||||
const fp = buildFingerprint(text, range);
|
||||
const prevFp = a.anchors[rec.anchorId]?.fingerprint;
|
||||
if (prevFp && JSON.stringify(prevFp) !== JSON.stringify(fp)) rec.updatedAt = now;
|
||||
a.anchors[rec.anchorId] = { fingerprint: fp };
|
||||
}
|
||||
// Orphans ride along unchanged (recoverable, spec §6.9): their records
|
||||
// stay in attributions[], so update()'s prune keeps their anchors too.
|
||||
a.attributions = [...records, ...s.orphans];
|
||||
});
|
||||
}
|
||||
|
||||
// ---- PUC-5: rendering ----------------------------------------------------------------
|
||||
|
||||
private toggle(): void {
|
||||
this.visible = !this.visible;
|
||||
this.renderActive();
|
||||
}
|
||||
|
||||
private renderActive(): void {
|
||||
const editor = vscode.window.activeTextEditor;
|
||||
if (editor) this.render(editor.document);
|
||||
}
|
||||
|
||||
private render(document: vscode.TextDocument): void {
|
||||
const editor = vscode.window.visibleTextEditors.find((e) => e.document === document);
|
||||
if (!editor || !this.isTracked(document)) return;
|
||||
const s = this.docs.get(this.docPathOf(document.uri));
|
||||
const spans = this.visible && s ? s.spans : [];
|
||||
const toRange = (sp: LiveSpan) =>
|
||||
new vscode.Range(document.positionAt(sp.start), document.positionAt(sp.end));
|
||||
editor.setDecorations(this.agentType, spans.filter((x) => x.author.kind === "agent").map(toRange));
|
||||
editor.setDecorations(this.humanType, spans.filter((x) => x.author.kind === "human").map(toRange));
|
||||
this.renderStatus(s);
|
||||
}
|
||||
|
||||
private renderStatus(s: DocAttribution | undefined): void {
|
||||
const n = s?.orphans.length ?? 0;
|
||||
if (n === 0) {
|
||||
this.statusItem.hide();
|
||||
return;
|
||||
}
|
||||
this.statusItem.text = `$(warning) ${n} orphaned attribution${n === 1 ? "" : "s"}`;
|
||||
this.statusItem.tooltip = "Cowriting: attribution anchors that no longer resolve (see output channel)";
|
||||
this.statusItem.show();
|
||||
this.output.clear();
|
||||
for (const o of s!.orphans) this.output.appendLine(`orphaned ${o.id} (${o.author.kind}:${o.author.id})`);
|
||||
}
|
||||
|
||||
// ---- test-facing surface ---------------------------------------------------------------
|
||||
|
||||
getSpans(docPath: string): RenderedSpan[] {
|
||||
const s = this.docs.get(docPath);
|
||||
if (!s) return [];
|
||||
return s.spans.map((sp) => ({
|
||||
id: sp.id,
|
||||
authorKind: sp.author.kind,
|
||||
authorId: sp.author.id,
|
||||
turnId: sp.turnId,
|
||||
range: { start: sp.start, end: sp.end },
|
||||
}));
|
||||
}
|
||||
getOrphanCount(docPath: string): number {
|
||||
return this.docs.get(docPath)?.orphans.length ?? 0;
|
||||
}
|
||||
isVisible(): boolean {
|
||||
return this.visible;
|
||||
}
|
||||
|
||||
dispose(): void {
|
||||
for (const d of this.disposables) d.dispose();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user