relay-flow 0.2.2-alpha → 0.2.4-alpha

package/internal/harness/opencode/opencode.go

@@ -30,7 +30,7 @@ Use the {{taskSystem}} tools to read the parent ticket {{ticket}}.
 
 Your mailbox is {{mailbox}}. Read its description and comments for node instructions and feedback.`
 	defaultFeedbackPrompt = `New feedback was added to the comments section of your mailbox subtask {{mailbox}}. Read it.`
-	defaultHITLPrompt     = `Before submitting your report, present the complete proposed report through OpenCode's built-in Question tool with exactly two options: Approve and Reject. Submit it only after an explicit Approve answer.`
+	defaultHITLPrompt     = `Return the complete report directly. Relay-flow will show a native TUI approval dialog after the report is valid. Do not use OpenCode's Question tool for relay-flow approval.`
 )
 
 var promptVarPattern = regexp.MustCompile(`\{\{([^{}]*)\}\}`)
@@ -133,9 +133,9 @@ func (h *Harness) FindSession(context.Context, string, string) (harness.Session,
 	return harness.Session{}, false, nil
 }
 
-// RenderPrompt renders the selected session prompt, appends HITL approval
-// instructions for HITL nodes, then renders and appends the node's nudge
-// template.
+// RenderPrompt renders the selected session prompt, appends the harness-owned
+// HITL/TUI instructions for HITL nodes, then renders and appends the node's
+// nudge template.
 func (h *Harness) RenderPrompt(kind harness.PromptKind, data harness.PromptData, nudgeTemplate string) (string, error) {
 	var tmpl string
 	switch kind {

package/internal/harness/opencode/opencode_test.go

@@ -14,7 +14,7 @@ import (
 	"github.com/rajpopat27/relay-flow/internal/workflow"
 )
 
-const configuredPlugin = "relay-flow-plugin@0.2.2-alpha"
+const configuredPlugin = "relay-flow-plugin@0.2.4-alpha"
 
 func TestBuildCommandArgv(t *testing.T) {
 	t.Setenv("RELAY_FLOW_HOME", "/var/lib/relay-flow-test")
@@ -61,7 +61,6 @@ func TestRenderPromptTemplatesExposeAllValues(t *testing.T) {
 	raw := config.RawValues{
 		"initial":  "initial {{taskSystem}}|{{ticket}}|{{workflow}}|{{repo}}|{{node}}|{{nodeType}}|{{agent}}|{{nodeDescription}}|{{nextSteps}}|{{mailbox}}",
 		"feedback": "feedback {{mailbox}}",
-		"hitl":     "hitl {{node}}",
 	}
 	h, err := harness.New("opencode", raw)
 	if err != nil {
@@ -77,7 +76,7 @@ func TestRenderPromptTemplatesExposeAllValues(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	wantInitial := "initial linear|PAY-101|basicFlow|payments|review|hitl|build|Review it.|end (when: approved)|PAY-234\n\nhitl review\n\nnudge linear|PAY-101|basicFlow|payments|review|end (when: approved)"
+	wantInitial := "initial linear|PAY-101|basicFlow|payments|review|hitl|build|Review it.|end (when: approved)|PAY-234\n\nReturn the complete report directly. Relay-flow will show a native TUI approval dialog after the report is valid. Do not use OpenCode's Question tool for relay-flow approval.\n\nnudge linear|PAY-101|basicFlow|payments|review|end (when: approved)"
 	if initial != wantInitial {
 		t.Fatalf("initial prompt = %q, want %q", initial, wantInitial)
 	}
@@ -85,7 +84,7 @@ func TestRenderPromptTemplatesExposeAllValues(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if want := "feedback PAY-234\n\nhitl review\n\nnudge linear|PAY-101|basicFlow|payments|review|end (when: approved)"; feedback != want {
+	if want := "feedback PAY-234\n\nReturn the complete report directly. Relay-flow will show a native TUI approval dialog after the report is valid. Do not use OpenCode's Question tool for relay-flow approval.\n\nnudge linear|PAY-101|basicFlow|payments|review|end (when: approved)"; feedback != want {
 		t.Fatalf("feedback prompt = %q, want %q", feedback, want)
 	}
 }
@@ -206,6 +205,62 @@ func TestSetupRepoAddsPluginPropertyToJSONCWithComments(t *testing.T) {
 	}
 }
 
+func TestSetupRepoCreatesOpenCodeTUIConfig(t *testing.T) {
+	dir := t.TempDir()
+	if err := opencode.New().SetupRepo(t.Context(), dir); err != nil {
+		t.Fatalf("SetupRepo: %v", err)
+	}
+	path := filepath.Join(dir, ".opencode", "tui.json")
+	data, err := os.ReadFile(path)
+	if err != nil {
+		t.Fatal(err)
+	}
+	var cfg struct {
+		Schema string   `json:"$schema"`
+		Plugin []string `json:"plugin"`
+	}
+	if err := json.Unmarshal(data, &cfg); err != nil {
+		t.Fatalf("created TUI config is invalid JSON: %v\n%s", err, data)
+	}
+	if cfg.Schema != "https://opencode.ai/tui.json" {
+		t.Fatalf("$schema = %q", cfg.Schema)
+	}
+	if !reflect.DeepEqual(cfg.Plugin, []string{configuredPlugin}) {
+		t.Fatalf("plugin = %v", cfg.Plugin)
+	}
+}
+
+func TestSetupRepoUpdatesExistingOpenCodeTUIJSONC(t *testing.T) {
+	dir := t.TempDir()
+	configDir := filepath.Join(dir, ".opencode")
+	if err := os.MkdirAll(configDir, 0o755); err != nil {
+		t.Fatal(err)
+	}
+	path := filepath.Join(configDir, "tui.jsonc")
+	original := `{
+  // keep the local theme
+  "theme": "catppuccin"
+}
+`
+	if err := os.WriteFile(path, []byte(original), 0o644); err != nil {
+		t.Fatal(err)
+	}
+	if err := opencode.New().SetupRepo(t.Context(), dir); err != nil {
+		t.Fatalf("SetupRepo: %v", err)
+	}
+	data, err := os.ReadFile(path)
+	if err != nil {
+		t.Fatal(err)
+	}
+	text := string(data)
+	if !strings.Contains(text, "// keep the local theme") || !strings.Contains(text, configuredPlugin) {
+		t.Fatalf("TUI config was not preserved and updated:\n%s", text)
+	}
+	if _, err := os.Stat(filepath.Join(configDir, "tui.json")); !os.IsNotExist(err) {
+		t.Fatalf("unexpected tui.json created: %v", err)
+	}
+}
+
 func setupTwice(t *testing.T, dir string) {
 	t.Helper()
 	h := opencode.New()

package/internal/harness/opencode/repo_setup.go

@@ -10,7 +10,7 @@ import (
 	"github.com/rajpopat27/relay-flow/internal/config"
 )
 
-const relayFlowPlugin = "relay-flow-plugin@0.2.2-alpha"
+const relayFlowPlugin = "relay-flow-plugin@0.2.4-alpha"
 
 type jsoncToken struct {
 	kind       byte
@@ -47,12 +47,34 @@ func setupRepo(repoPath string) error {
 	if err != nil {
 		return err
 	}
+	if err := ensurePluginConfig(path, mode, ""); err != nil {
+		return err
+	}
+
+	tuiPath, tuiMode, err := openCodeTUIConfigPath(repoPath)
+	if err != nil {
+		return err
+	}
+	if err := os.MkdirAll(filepath.Dir(tuiPath), 0o755); err != nil {
+		return fmt.Errorf("opencode: create TUI config directory: %w", err)
+	}
+	if err := ensurePluginConfig(tuiPath, tuiMode, "https://opencode.ai/tui.json"); err != nil {
+		return fmt.Errorf("opencode: setup TUI config: %w", err)
+	}
+	return nil
+}
+
+func ensurePluginConfig(path string, mode os.FileMode, schema string) error {
 	data, err := os.ReadFile(path)
 	if err != nil {
 		if !os.IsNotExist(err) {
 			return fmt.Errorf("opencode: read %s: %w", path, err)
 		}
-		data = []byte("{\n  \"plugin\": [\"" + relayFlowPlugin + "\"]\n}\n")
+		if schema == "" {
+			data = []byte("{\n  \"plugin\": [\"" + relayFlowPlugin + "\"]\n}\n")
+		} else {
+			data = []byte("{\n  \"$schema\": \"" + schema + "\",\n  \"plugin\": [\"" + relayFlowPlugin + "\"]\n}\n")
+		}
 	} else {
 		data, err = updateOpenCodeConfig(data)
 		if err != nil {
@@ -86,6 +108,24 @@ func openCodeConfigPath(repoPath string) (string, os.FileMode, error) {
 	return jsonPath, 0o644, nil
 }
 
+func openCodeTUIConfigPath(repoPath string) (string, os.FileMode, error) {
+	dir := filepath.Join(repoPath, ".opencode")
+	for _, name := range []string{"tui.json", "tui.jsonc"} {
+		path := filepath.Join(dir, name)
+		info, err := os.Stat(path)
+		if err == nil {
+			if !info.Mode().IsRegular() {
+				return "", 0, fmt.Errorf("opencode: TUI config %s is not a regular file", path)
+			}
+			return path, info.Mode().Perm(), nil
+		}
+		if !os.IsNotExist(err) {
+			return "", 0, fmt.Errorf("opencode: inspect TUI config %s: %w", path, err)
+		}
+	}
+	return filepath.Join(dir, "tui.json"), 0o644, nil
+}
+
 func updateOpenCodeConfig(data []byte) ([]byte, error) {
 	tokens, err := tokenizeJSONC(data)
 	if err != nil {

package/internal/harness/pi/config_test.go

@@ -0,0 +1,46 @@
+package pi
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/rajpopat27/relay-flow/internal/config"
+	"github.com/rajpopat27/relay-flow/internal/harness"
+)
+
+func TestPiHarnessConfigUsesDocumentedDefaults(t *testing.T) {
+	defaults, err := harness.Defaults("pi")
+	if err != nil {
+		t.Fatalf("harness.Defaults(pi): %v", err)
+	}
+	if defaults["initial"] != defaultInitialPrompt {
+		t.Fatalf("initial default = %#v, want %#v", defaults["initial"], defaultInitialPrompt)
+	}
+	if defaults["feedback"] != defaultFeedbackPrompt {
+		t.Fatalf("feedback default = %#v, want %#v", defaults["feedback"], defaultFeedbackPrompt)
+	}
+	if _, ok := defaults["hitl"]; ok {
+		t.Fatalf("Pi defaults unexpectedly contain a HITL prompt: %#v", defaults["hitl"])
+	}
+}
+
+func TestPiHarnessConfigRejectsNonTemplateFields(t *testing.T) {
+	for _, field := range []string{"hitl", "agent", "model"} {
+		t.Run(field, func(t *testing.T) {
+			_, err := harness.New("pi", config.RawValues{field: "unsupported"})
+			if err == nil {
+				t.Fatalf("Pi harness accepted unsupported config field %q", field)
+			}
+			if !strings.Contains(err.Error(), field) {
+				t.Fatalf("error = %q, want field name %q", err, field)
+			}
+		})
+	}
+}
+
+func TestPiHarnessConfigRejectsExplicitNullTemplate(t *testing.T) {
+	_, err := harness.New("pi", config.RawValues{"initial": nil})
+	if err == nil || !strings.Contains(err.Error(), "explicit null") {
+		t.Fatalf("explicit null template error = %v", err)
+	}
+}

package/internal/harness/pi/lifecycle_test.go

@@ -0,0 +1,69 @@
+package pi
+
+import (
+	"context"
+	"os"
+	"path/filepath"
+	"reflect"
+	"testing"
+
+	"github.com/rajpopat27/relay-flow/internal/harness"
+)
+
+func TestPiSetupRepoIsSideEffectFree(t *testing.T) {
+	repoPath := t.TempDir()
+	sentinelPath := filepath.Join(repoPath, "existing.txt")
+	sentinel := []byte("leave this repository unchanged")
+	if err := os.WriteFile(sentinelPath, sentinel, 0o640); err != nil {
+		t.Fatal(err)
+	}
+
+	h := newPiHarness(t)
+	if err := h.SetupRepo(context.Background(), repoPath); err != nil {
+		t.Fatalf("SetupRepo: %v", err)
+	}
+
+	data, err := os.ReadFile(sentinelPath)
+	if err != nil {
+		t.Fatalf("read sentinel: %v", err)
+	}
+	if !reflect.DeepEqual(data, sentinel) {
+		t.Fatalf("SetupRepo changed existing repository content: %q", data)
+	}
+	for _, name := range []string{"opencode.json", "opencode.jsonc", ".pi"} {
+		if _, err := os.Stat(filepath.Join(repoPath, name)); !os.IsNotExist(err) {
+			t.Fatalf("SetupRepo created %q: %v", name, err)
+		}
+	}
+}
+
+func TestPiFindSessionDoesNotDiscoverByTitle(t *testing.T) {
+	missingRepo := filepath.Join(t.TempDir(), "not-a-repository")
+	h := newPiHarness(t)
+
+	session, ok, err := h.FindSession(context.Background(), missingRepo, "PAY-101:implement")
+	if err != nil {
+		t.Fatalf("FindSession: %v", err)
+	}
+	if ok {
+		t.Fatalf("FindSession found an unrequested session: %+v", session)
+	}
+	if session != (harness.Session{}) {
+		t.Fatalf("FindSession returned session data: %+v", session)
+	}
+}
+
+func TestPiResumeUsesOnlyPersistedLaunchSpecSessionID(t *testing.T) {
+	spec := launchSpec(t)
+	spec.RepoPath = filepath.Join(t.TempDir(), "missing-ticket-environment")
+	spec.ResumeID = "session-123"
+
+	cmd, err := newPiHarness(t).BuildCommand(spec)
+	if err != nil {
+		t.Fatalf("BuildCommand: %v", err)
+	}
+	want := []string{"--name", spec.Title, "--session-id", spec.ResumeID, spec.Prompt}
+	if !reflect.DeepEqual(cmd.Args, want) {
+		t.Fatalf("Args = %#v, want %#v", cmd.Args, want)
+	}
+}

package/internal/harness/pi/pi.go

@@ -0,0 +1,261 @@
+// Package pi is the built-in launch-time Harness adapter for the Pi coding
+// agent. Pi supplies one built-in coding agent, represented by the logical
+// relay-flow agent name "default", plus repository-owned role prompts under
+// .pi/roles. The runtime extension is installed by the user and owns report
+// parsing and delivery.
+package pi
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"regexp"
+	"strings"
+
+	"github.com/rajpopat27/relay-flow/internal/config"
+	"github.com/rajpopat27/relay-flow/internal/harness"
+	"github.com/rajpopat27/relay-flow/internal/runner"
+)
+
+const (
+	defaultInitialPrompt = `Task system: {{taskSystem}}
+Use the {{taskSystem}} tools to read the parent ticket {{ticket}}.
+
+Your mailbox is {{mailbox}}. Read its description and comments for node instructions and feedback.`
+	defaultFeedbackPrompt = `New feedback was added to the comments section of your mailbox subtask {{mailbox}}. Read it.`
+)
+
+var promptVarPattern = regexp.MustCompile(`\{\{([^{}]*)\}\}`)
+
+var knownPromptVars = map[string]bool{
+	"taskSystem": true, "ticket": true, "workflow": true, "repo": true,
+	"node": true, "nodeType": true, "agent": true, "nodeDescription": true,
+	"nextSteps": true, "mailbox": true,
+}
+
+// Config is the adapter-owned root harnessConfig. Pi exposes no harness
+// prompt for HITL approval because approval is performed through Pi's host
+// UI by the runtime extension.
+type Config struct {
+	Initial  string `yaml:"initial"`
+	Feedback string `yaml:"feedback"`
+}
+
+// DefaultConfig is written by relay-flow init and fills omitted values when
+// configuration is loaded through the harness factory.
+func DefaultConfig() config.RawValues {
+	return config.RawValues{
+		"initial":  defaultInitialPrompt,
+		"feedback": defaultFeedbackPrompt,
+	}
+}
+
+func init() {
+	harness.Register("pi", harness.Factory{
+		DefaultConfig: DefaultConfig,
+		New: func(raw config.RawValues) (harness.Harness, error) {
+			var cfg Config
+			if err := config.DecodeStrict(raw, &cfg); err != nil {
+				return nil, fmt.Errorf("pi harnessConfig: %w", err)
+			}
+			for name, tmpl := range map[string]string{
+				"initial":  cfg.Initial,
+				"feedback": cfg.Feedback,
+			} {
+				if err := validateTemplate(tmpl); err != nil {
+					return nil, fmt.Errorf("pi harnessConfig templates.%s: %w", name, err)
+				}
+			}
+			return New(cfg), nil
+		},
+	})
+}
+
+// Harness implements harness.Harness for Pi.
+type Harness struct {
+	templates Config
+}
+
+// New returns the production Pi harness. The no-argument form uses the
+// adapter defaults; factory construction supplies an explicitly decoded
+// configuration.
+func New(cfg ...Config) *Harness {
+	if len(cfg) > 0 {
+		return &Harness{templates: cfg[0]}
+	}
+	return &Harness{templates: Config{
+		Initial:  defaultInitialPrompt,
+		Feedback: defaultFeedbackPrompt,
+	}}
+}
+
+// SetupRepo is intentionally a no-op. The relay-flow Pi runtime extension is
+// installed manually in Pi's global package settings rather than configured
+// in each repository.
+func (*Harness) SetupRepo(context.Context, string) error { return nil }
+
+// ValidateAgent accepts Pi's built-in logical agent or a repository role
+// prompt. Pi has no named-agent listing API, so custom roles are verified by
+// checking for a readable, non-empty .pi/roles/<agent>.md file.
+func (*Harness) ValidateAgent(_ context.Context, repoPath, agent string) error {
+	if _, err := resolveRolePrompt(repoPath, agent); err != nil {
+		return err
+	}
+	if _, err := exec.LookPath("pi"); err != nil {
+		return fmt.Errorf("pi: executable unavailable: %w", err)
+	}
+	return nil
+}
+
+func resolveRolePrompt(repoPath, agent string) (string, error) {
+	if agent == "default" {
+		return "", nil
+	}
+	if strings.TrimSpace(agent) == "" || strings.TrimSpace(agent) != agent || strings.ContainsAny(agent, `/\\`) || agent == "." || agent == ".." {
+		return "", fmt.Errorf("pi: invalid role %q", agent)
+	}
+	if repoPath == "" {
+		return "", fmt.Errorf("pi: role %q requires a repository path", agent)
+	}
+	root, err := filepath.Abs(repoPath)
+	if err != nil {
+		return "", fmt.Errorf("pi: resolve repository path for role %q: %w", agent, err)
+	}
+	path := filepath.Join(root, ".pi", "roles", agent+".md")
+	info, err := os.Stat(path)
+	if err != nil {
+		if os.IsNotExist(err) {
+			return "", fmt.Errorf("pi: role %q is unavailable; expected %s", agent, path)
+		}
+		return "", fmt.Errorf("pi: inspect role %q: %w", agent, err)
+	}
+	if !info.Mode().IsRegular() {
+		return "", fmt.Errorf("pi: role %q is not a regular file: %s", agent, path)
+	}
+	contents, err := os.ReadFile(path)
+	if err != nil {
+		return "", fmt.Errorf("pi: read role %q: %w", agent, err)
+	}
+	if strings.TrimSpace(string(contents)) == "" {
+		return "", fmt.Errorf("pi: role %q is empty: %s", agent, path)
+	}
+	return path, nil
+}
+
+// FindSession is intentionally discovery-free. Normal execution resumes only
+// the Pi session ID persisted by runtime registration.
+func (*Harness) FindSession(context.Context, string, string) (harness.Session, bool, error) {
+	return harness.Session{}, false, nil
+}
+
+// RenderPrompt renders the selected initial or feedback template and the
+// node's nudge template. HITL approval is not encoded in the prompt; the Pi
+// extension asks for approval through ctx.ui.select.
+func (h *Harness) RenderPrompt(kind harness.PromptKind, data harness.PromptData, nudgeTemplate string) (string, error) {
+	var tmpl string
+	switch kind {
+	case harness.PromptInitial:
+		tmpl = h.templates.Initial
+	case harness.PromptFeedback:
+		tmpl = h.templates.Feedback
+	default:
+		return "", fmt.Errorf("pi: unknown prompt kind %q", kind)
+	}
+	return appendPrompt(renderTemplate(tmpl, data), renderTemplate(nudgeTemplate, data)), nil
+}
+
+// BuildCommand returns the interactive Pi invocation. The runner supplies a
+// PTY for Pi's stdin/stdout; the rendered prompt is the final positional argv
+// value. A custom role adds Pi's --append-system-prompt option with the role
+// file from the registered repository. Pi 0.84.1 rejects a bare -- terminator,
+// so none is included. A non-empty ResumeID selects Pi's exact session-id
+// resume option.
+func (*Harness) BuildCommand(spec harness.LaunchSpec) (runner.Command, error) {
+	rolePath, err := resolveRolePrompt(spec.RepoPath, spec.Agent)
+	if err != nil {
+		return runner.Command{}, err
+	}
+	nextSteps, err := json.Marshal(spec.NextSteps)
+	if err != nil {
+		return runner.Command{}, fmt.Errorf("pi: marshal next steps: %w", err)
+	}
+	root, err := relayFlowHome()
+	if err != nil {
+		return runner.Command{}, err
+	}
+	env := map[string]string{
+		"RELAY_FLOW_HOME":            root,
+		"RELAY_FLOW_RUN_ID":          string(spec.RunID),
+		"RELAY_FLOW_WORKFLOW":        spec.Workflow,
+		"RELAY_FLOW_REPO":            spec.RepoName,
+		"RELAY_FLOW_TICKET":          spec.Ticket,
+		"RELAY_FLOW_NODE":            spec.Node,
+		"RELAY_FLOW_NODE_TYPE":       string(spec.NodeType),
+		"RELAY_FLOW_NUDGE_PROMPT":    spec.NudgePrompt,
+		"RELAY_FLOW_NEXT_STEPS_JSON": string(nextSteps),
+	}
+	args := []string{"--name", spec.Title}
+	if rolePath != "" {
+		args = append(args, "--append-system-prompt", rolePath)
+	}
+	if spec.ResumeID != "" {
+		args = append(args, "--session-id", spec.ResumeID)
+	}
+	args = append(args, spec.Prompt)
+	return runner.Command{
+		Executable: "pi",
+		Args:       args,
+		Env:        env,
+	}, nil
+}
+
+func relayFlowHome() (string, error) {
+	if root := os.Getenv("RELAY_FLOW_HOME"); root != "" {
+		return root, nil
+	}
+	home, err := os.UserHomeDir()
+	if err != nil {
+		return "", fmt.Errorf("pi: resolve relay-flow home: %w", err)
+	}
+	return filepath.Join(home, ".relay-flow"), nil
+}
+
+func validateTemplate(tmpl string) error {
+	for _, match := range promptVarPattern.FindAllStringSubmatch(tmpl, -1) {
+		if !knownPromptVars[match[1]] {
+			return fmt.Errorf("unknown template variable {{%s}}", match[1])
+		}
+	}
+	return nil
+}
+
+func renderTemplate(tmpl string, data harness.PromptData) string {
+	values := map[string]string{
+		"taskSystem":      data.TaskSystem,
+		"ticket":          data.Ticket,
+		"workflow":        data.Workflow,
+		"repo":            data.Repo,
+		"node":            data.Node,
+		"nodeType":        string(data.NodeType),
+		"agent":           data.Agent,
+		"nodeDescription": data.NodeDescription,
+		"nextSteps":       data.NextSteps,
+		"mailbox":         data.Mailbox,
+	}
+	return promptVarPattern.ReplaceAllStringFunc(tmpl, func(match string) string {
+		return values[promptVarPattern.FindStringSubmatch(match)[1]]
+	})
+}
+
+func appendPrompt(prompt, extra string) string {
+	if extra == "" {
+		return prompt
+	}
+	if prompt == "" {
+		return extra
+	}
+	return prompt + "\n\n" + extra
+}