Add expose_port previews with a Preview tab; leave setup to AGENTS.md

This commit is contained in:
Ian Gulliver
2026-10-15 13:15:49 -07:00
parent 86e4e772ed
commit f95a0e5332
32 changed files with 1042 additions and 431 deletions
+13
View File
@@ -42,4 +42,17 @@ func TestPortBlocksStartAtPortFirst(t *testing.T) {
t.Fatalf("task %s port_base = %d, want %d", id, task.PortBase, want)
}
}
_, err = st.DiscardTask(ctx, "t1", "alice")
if err != nil {
t.Fatalf("discard: %v", err)
}
err = st.CreateTask(ctx, api.Task{Id: "t3", ProjectId: "p1", Title: "t3", Branch: "t3", WorktreePath: "/nonexistent", BaseRef: "x", Status: api.TaskStatusActive, CreatedBy: "alice", CreatedAt: now}, "alice")
if err != nil {
t.Fatalf("create task t3: %v", err)
}
reused, err := st.GetTask(ctx, "t3")
if err != nil || reused.PortBase != 51000 {
t.Fatalf("t3 port_base = %d, want the freed 51000: %v", reused.PortBase, err)
}
}
+77
View File
@@ -0,0 +1,77 @@
package store
import (
"context"
"database/sql"
"errors"
"g.fc.run/misc/byre/internal/api"
)
const previewColumns = `task_id, name, port, created_at`
func (s *Store) SetPreview(ctx context.Context, p api.Preview, actor string) ([]int, error) {
dropped := []int{}
err := s.write(ctx, func(tx *sql.Tx, emit emitFunc) error {
projectID := ""
err := tx.QueryRowContext(ctx, `SELECT project_id FROM tasks WHERE id = ? AND status = ?`, p.TaskId, string(api.TaskStatusActive)).Scan(&projectID)
if errors.Is(err, sql.ErrNoRows) {
return ErrNotFound
}
if err != nil {
return err
}
rows, err := tx.QueryContext(ctx, `DELETE FROM previews WHERE task_id = ? AND (name = ? OR port = ?) RETURNING port`, p.TaskId, p.Name, p.Port)
if err != nil {
return err
}
for rows.Next() {
port := 0
err = rows.Scan(&port)
if err != nil {
rows.Close()
return err
}
if port != p.Port {
dropped = append(dropped, port)
}
}
rows.Close()
err = rows.Err()
if err != nil {
return err
}
_, err = tx.ExecContext(ctx, `INSERT INTO previews (`+previewColumns+`) VALUES (?, ?, ?, ?)`, p.TaskId, p.Name, p.Port, formatTime(p.CreatedAt))
if err != nil {
return err
}
return emit(api.Event{Kind: "preview.exposed", ProjectId: &projectID, TaskId: &p.TaskId, Actor: actor, Payload: ToPayload(p)})
})
return dropped, err
}
func (s *Store) ListPreviews(ctx context.Context, taskID string) ([]api.Preview, error) {
rows, err := s.db.QueryContext(ctx, `SELECT `+previewColumns+` FROM previews WHERE task_id = ? ORDER BY name`, taskID)
if err != nil {
return nil, err
}
defer rows.Close()
previews := []api.Preview{}
for rows.Next() {
p := api.Preview{}
createdAt := ""
err = rows.Scan(&p.TaskId, &p.Name, &p.Port, &createdAt)
if err != nil {
return nil, err
}
p.CreatedAt, err = parseTime(createdAt)
if err != nil {
return nil, err
}
previews = append(previews, p)
}
return previews, rows.Err()
}
+90
View File
@@ -0,0 +1,90 @@
package store_test
import (
"context"
"errors"
"fmt"
"path/filepath"
"slices"
"testing"
"time"
"g.fc.run/misc/byre/internal/api"
"g.fc.run/misc/byre/internal/store"
)
func TestSetPreviewReplacesNameAndPort(t *testing.T) {
ctx := context.Background()
events := []api.Event{}
st, err := store.Open(filepath.Join(t.TempDir(), "byre.db"), store.DefaultPortFirst, func(ev api.Event) { events = append(events, ev) })
if err != nil {
t.Fatalf("open store: %v", err)
}
t.Cleanup(func() { st.Close() })
now := time.Now().UTC()
_, err = st.EnsureUser(ctx, "alice", "Alice")
if err != nil {
t.Fatalf("ensure user: %v", err)
}
err = st.CreateProject(ctx, api.Project{Id: "p1", Name: "demo", RepoPath: "/nonexistent", DefaultBranch: "main", Remote: "none", CreatedBy: "alice", CreatedAt: now})
if err != nil {
t.Fatalf("create project: %v", err)
}
err = st.CreateTask(ctx, api.Task{Id: "t1", ProjectId: "p1", Title: "t1", Branch: "t1", WorktreePath: "/nonexistent", BaseRef: "x", Status: api.TaskStatusActive, CreatedBy: "alice", CreatedAt: now}, "alice")
if err != nil {
t.Fatalf("create task: %v", err)
}
set := func(name string, port int) []int {
t.Helper()
dropped, err := st.SetPreview(ctx, api.Preview{TaskId: "t1", Name: name, Port: port, CreatedAt: now}, "agent")
if err != nil {
t.Fatalf("set preview %s:%d: %v", name, port, err)
}
return dropped
}
list := func() []string {
t.Helper()
previews, err := st.ListPreviews(ctx, "t1")
if err != nil {
t.Fatalf("list previews: %v", err)
}
out := []string{}
for _, p := range previews {
out = append(out, fmt.Sprintf("%s:%d", p.Name, p.Port))
}
return out
}
if d := set("web", 41001); len(d) != 0 {
t.Fatalf("first preview dropped %v", d)
}
if d := set("api", 41002); len(d) != 0 {
t.Fatalf("second preview dropped %v", d)
}
if d := set("web", 41001); len(d) != 0 {
t.Fatalf("re-exposing the same name and port dropped %v", d)
}
if d := set("web", 41003); !slices.Equal(d, []int{41001}) {
t.Fatalf("moving web to 41003 dropped %v, want [41001]", d)
}
if d := set("storybook", 41002); len(d) != 0 {
t.Fatalf("renaming 41002 dropped %v, want none", d)
}
if got, want := list(), []string{"storybook:41002", "web:41003"}; !slices.Equal(got, want) {
t.Fatalf("previews = %v, want %v", got, want)
}
if last := events[len(events)-1]; last.Kind != "preview.exposed" || last.Payload["name"] != "storybook" {
t.Fatalf("last event = %s %v", last.Kind, last.Payload)
}
_, err = st.DiscardTask(ctx, "t1", "alice")
if err != nil {
t.Fatalf("discard: %v", err)
}
_, err = st.SetPreview(ctx, api.Preview{TaskId: "t1", Name: "late", Port: 41004, CreatedAt: now}, "agent")
if !errors.Is(err, store.ErrNotFound) {
t.Fatalf("set preview on a closed task: %v, want ErrNotFound", err)
}
}
+9
View File
@@ -271,6 +271,15 @@ UPDATE tasks SET port_base = (
`}, {"add-task-merge-queue", `
ALTER TABLE tasks ADD COLUMN merge_queued_by TEXT NOT NULL DEFAULT '';
ALTER TABLE tasks ADD COLUMN merge_queued_at TEXT NOT NULL DEFAULT '';
`}, {"add-task-previews", `
CREATE TABLE previews (
task_id TEXT NOT NULL REFERENCES tasks(id),
name TEXT NOT NULL,
port INTEGER NOT NULL,
created_at TEXT NOT NULL,
PRIMARY KEY (task_id, name),
UNIQUE (task_id, port)
);
`}}
const (