internal/relui: persist logs to database

Save log output from workflow tasks in the database. Render logs in the
UI alongside each task. This will almost certainly be a performance
problem if we have many logs until we implement pagination.

For golang/go#47401

Change-Id: I4ddc3d7845e4559cc636b3b7972e0adefe9fcec4
Reviewed-on: https://go-review.googlesource.com/c/build/+/353170
Trust: Alexander Rakoczy <[email protected]>
Run-TryBot: Alexander Rakoczy <[email protected]>
TryBot-Result: Go Bot <[email protected]>
Reviewed-by: Carlos Amedee <[email protected]>
Reviewed-by: Heschi Kreinick <[email protected]>

Author: toothrot

cmd/relui/Makefile

@@ -33,7 +33,7 @@ postgres-dev: $(DEV_CFG)/pgpass
 
 schema.sql: $(MIGRATION_FILES) $(GO_FILES)
 	docker build -f Dockerfile -t golang/relui:$(VERSION) ../..
-	docker run --rm --name=relui-dev-migrate -v $(POSTGRES_RUN_DEV) $(DOCKER_TAG) --only-migrate
+	docker run --rm --name=relui-dev-migrate -v $(POSTGRES_RUN_DEV) -e PGUSER=$(POSTGRES_USER) -e PGDATABASE=relui-dev $(DOCKER_TAG) --only-migrate
 	docker exec postgres-dev pg_dump --username=$(POSTGRES_USER) --schema-only relui-dev > schema.sql
 
 .PHONY: test

cmd/relui/schema.sql

@@ -32,6 +32,44 @@ CREATE TABLE public.migrations (
 
 ALTER TABLE public.migrations OWNER TO postgres;
 
+--
+-- Name: task_logs; Type: TABLE; Schema: public; Owner: postgres
+--
+
+CREATE TABLE public.task_logs (
+    id integer NOT NULL,
+    workflow_id uuid NOT NULL,
+    task_name text NOT NULL,
+    body text NOT NULL,
+    created_at timestamp with time zone DEFAULT CURRENT_TIMESTAMP NOT NULL,
+    updated_at timestamp with time zone DEFAULT CURRENT_TIMESTAMP NOT NULL
+);
+
+
+ALTER TABLE public.task_logs OWNER TO postgres;
+
+--
+-- Name: task_logs_id_seq; Type: SEQUENCE; Schema: public; Owner: postgres
+--
+
+CREATE SEQUENCE public.task_logs_id_seq
+    AS integer
+    START WITH 1
+    INCREMENT BY 1
+    NO MINVALUE
+    NO MAXVALUE
+    CACHE 1;
+
+
+ALTER TABLE public.task_logs_id_seq OWNER TO postgres;
+
+--
+-- Name: task_logs_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: postgres
+--
+
+ALTER SEQUENCE public.task_logs_id_seq OWNED BY public.task_logs.id;
+
+
 --
 -- Name: tasks; Type: TABLE; Schema: public; Owner: postgres
 --
@@ -64,6 +102,13 @@ CREATE TABLE public.workflows (
 
 ALTER TABLE public.workflows OWNER TO postgres;
 
+--
+-- Name: task_logs id; Type: DEFAULT; Schema: public; Owner: postgres
+--
+
+ALTER TABLE ONLY public.task_logs ALTER COLUMN id SET DEFAULT nextval('public.task_logs_id_seq'::regclass);
+
+
 --
 -- Name: migrations migrations_pkey; Type: CONSTRAINT; Schema: public; Owner: postgres
 --
@@ -72,6 +117,14 @@ ALTER TABLE ONLY public.migrations
     ADD CONSTRAINT migrations_pkey PRIMARY KEY (version);
 
 
+--
+-- Name: task_logs task_logs_pkey; Type: CONSTRAINT; Schema: public; Owner: postgres
+--
+
+ALTER TABLE ONLY public.task_logs
+    ADD CONSTRAINT task_logs_pkey PRIMARY KEY (id);
+
+
 --
 -- Name: tasks tasks_pkey; Type: CONSTRAINT; Schema: public; Owner: postgres
 --
@@ -88,6 +141,14 @@ ALTER TABLE ONLY public.workflows
     ADD CONSTRAINT workflows_pkey PRIMARY KEY (id);
 
 
+--
+-- Name: task_logs task_logs_workflow_id_task_name_fkey; Type: FK CONSTRAINT; Schema: public; Owner: postgres
+--
+
+ALTER TABLE ONLY public.task_logs
+    ADD CONSTRAINT task_logs_workflow_id_task_name_fkey FOREIGN KEY (workflow_id, task_name) REFERENCES public.tasks(workflow_id, name);
+
+
 --
 -- Name: tasks tasks_workflow_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: postgres
 --

internal/relui/db/models.go

@@ -0,0 +1,91 @@
+// Copyright 2021 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package relui
+
+import (
+	"context"
+	"database/sql"
+	"encoding/json"
+	"fmt"
+	"log"
+	"time"
+
+	"github.com/google/uuid"
+	"github.com/jackc/pgx/v4"
+	"github.com/jackc/pgx/v4/pgxpool"
+	"golang.org/x/build/internal/relui/db"
+	"golang.org/x/build/internal/workflow"
+)
+
+// listener implements workflow.Listener for recording workflow state.
+type listener struct {
+	db *pgxpool.Pool
+}
+
+// TaskStateChanged is called whenever a task is updated by the
+// workflow. The workflow.TaskState is persisted as a db.Task,
+// creating or updating a row as necessary.
+func (l *listener) TaskStateChanged(workflowID uuid.UUID, taskName string, state *workflow.TaskState) error {
+	log.Printf("TaskStateChanged(%q, %q, %v)", workflowID, taskName, state)
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+	result, err := json.Marshal(state.Result)
+	if err != nil {
+		return err
+	}
+	err = l.db.BeginFunc(ctx, func(tx pgx.Tx) error {
+		q := db.New(tx)
+		updated := time.Now()
+		_, err := q.UpsertTask(ctx, db.UpsertTaskParams{
+			WorkflowID: workflowID,
+			Name:       taskName,
+			Finished:   state.Finished,
+			Result:     sql.NullString{String: string(result), Valid: len(result) > 0},
+			Error:      sql.NullString{},
+			CreatedAt:  updated,
+			UpdatedAt:  updated,
+		})
+		return err
+	})
+	if err != nil {
+		log.Printf("TaskStateChanged(%q, %q, %v) = %v", workflowID, taskName, state, err)
+	}
+	return err
+}
+
+func (l *listener) Logger(workflowID uuid.UUID, taskName string) workflow.Logger {
+	return &postgresLogger{
+		db:         l.db,
+		workflowID: workflowID,
+		taskName:   taskName,
+	}
+}
+
+// postgresLogger logs task output to the database. It implements workflow.Logger.
+type postgresLogger struct {
+	db         *pgxpool.Pool
+	workflowID uuid.UUID
+	taskName   string
+}
+
+func (l *postgresLogger) Printf(format string, v ...interface{}) {
+	ctx := context.Background()
+	err := l.db.BeginFunc(ctx, func(tx pgx.Tx) error {
+		q := db.New(tx)
+		body := fmt.Sprintf(format, v...)
+		_, err := q.CreateTaskLog(ctx, db.CreateTaskLogParams{
+			WorkflowID: l.workflowID,
+			TaskName:   l.taskName,
+			Body:       body,
+		})
+		if err != nil {
+			log.Printf("q.CreateTaskLog(%v, %v, %q) = %v", l.workflowID, l.taskName, body, err)
+		}
+		return err
+	})
+	if err != nil {
+		log.Printf("l.Printf(%q, %v) = %v", format, v, err)
+	}
+}