admin/gc: purge old events

Add event garbage collection to the gc command. Events older than a
configurable maximum age are deleted. The age limit defaults to 30 days
and can be set via [database].event-max-age in the config file or
overridden with --event-max-age on the command line.

Introduce a custom Duration type that extends Go's time.Duration with
support for "d" (days) and "w" (weeks) suffixes.

Signed-off-by: Robin Jarry <robin@jarry.cc>

Author: rjarry

cmd/pw/admin/gc.go

@@ -7,6 +7,7 @@ package admin
 
 import (
 	"fmt"
+	"time"
 
 	"github.com/getpatchwork/patchwork/cmd/pw/pw"
 	"github.com/getpatchwork/patchwork/pkg/db"
@@ -41,5 +42,16 @@ func (c *GcCmd) Run(ctx *pw.Context) error {
 		fmt.Printf("deleted %d inactive user(s)\n", n)
 	}
 
+	if ctx.Config.Database.EventMaxAge > 0 {
+		cutoff := time.Now().Add(-ctx.Config.Database.EventMaxAge.Duration())
+		n, err = q.CleanOldEvents(cutoff)
+		if err != nil {
+			return fmt.Errorf("events: %w", err)
+		}
+		if n > 0 {
+			fmt.Printf("deleted %d old event(s)\n", n)
+		}
+	}
+
 	return nil
 }

docs/deployment/configuration.rst

@@ -65,6 +65,14 @@ Settings Reference
 
    Automatically run pending migrations when the HTTP server starts.
 
+.. confval:: [database].event-max-age
+   :type: duration
+   :default: `30d`
+
+   Maximum age of events to keep. Events older than this are deleted when
+   running :program:`pw admin gc`. Accepts duration suffixes: `s`, `m`, `h`,
+   `d` (days) and `w` (weeks). Set to `0s` to disable event purging.
+
 .. confval:: [http].listen
    :type: string
    :default: `"127.0.0.1:8080"`

docs/deployment/management.rst

@@ -529,8 +529,13 @@ Garbage Collection
 
 .. program:: pw admin gc
 
-Clean up expired sessions, stale email confirmations, and inactive users with
-no pending confirmation. Run this periodically via cron or a systemd timer.
+Clean up expired sessions, stale email confirmations, inactive users with no
+pending confirmation, and old events. Run this periodically via cron or
+a systemd timer.
+
+.. option:: --event-max-age <duration>
+
+   Override :confval:`[database].event-max-age` for this run.
 
 
 Email Ingress

pkg/config/config.go

@@ -21,8 +21,9 @@ type Config struct {
 }
 
 type DatabaseConfig struct {
-	URL      string `help:"Database connection URL." completion:"sqlite://,postgres://,mysql://"`
-	AutoSync bool   `help:"Automatically run pending migrations at startup."`
+	URL         string   `help:"Database connection URL." completion:"sqlite://,postgres://,mysql://"`
+	AutoSync    bool     `help:"Automatically run pending migrations at startup."`
+	EventMaxAge Duration `help:"Maximum age of events. Used by pw admin gc." default:"30d"`
 }
 
 type IngressConfig struct {

pkg/config/duration.go

@@ -0,0 +1,67 @@
+// Patchwork - automated patch tracking system
+// Copyright (C) The Patchwork Contributors (see CONTRIBUTORS)
+//
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+package config
+
+import (
+	"fmt"
+	"regexp"
+	"strconv"
+	"time"
+)
+
+type Duration time.Duration
+
+var durationRe = regexp.MustCompile(`^(\d+)(w|d|h|m|s|ms|us|ns)$`)
+
+func ParseDuration(s string) (Duration, error) {
+	m := durationRe.FindStringSubmatch(s)
+	if m != nil {
+		n, err := strconv.ParseInt(m[1], 10, 64)
+		if err != nil {
+			return 0, err
+		}
+		switch m[2] {
+		case "w":
+			return Duration(time.Duration(n) * 7 * 24 * time.Hour), nil
+		case "d":
+			return Duration(time.Duration(n) * 24 * time.Hour), nil
+		}
+	}
+	d, err := time.ParseDuration(s)
+	if err != nil {
+		return 0, fmt.Errorf("invalid duration %q", s)
+	}
+	return Duration(d), nil
+}
+
+func (d Duration) Duration() time.Duration {
+	return time.Duration(d)
+}
+
+func (d Duration) String() string {
+	td := time.Duration(d)
+	if td == 0 {
+		return "0s"
+	}
+	week := 7 * 24 * time.Hour
+	day := 24 * time.Hour
+	if td%week == 0 {
+		return fmt.Sprintf("%dw", td/week)
+	}
+	if td%day == 0 {
+		return fmt.Sprintf("%dd", td/day)
+	}
+	return td.String()
+}
+
+func (d *Duration) UnmarshalText(b []byte) error {
+	v, err := ParseDuration(string(b))
+	if err != nil {
+		return err
+	}
+	*d = v
+	return nil
+}

pkg/db/event.go

@@ -0,0 +1,18 @@
+// Patchwork - automated patch tracking system
+// Copyright (C) The Patchwork Contributors (see CONTRIBUTORS)
+//
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+package db
+
+import "time"
+
+func (q *Queries) CleanOldEvents(cutoff time.Time) (int64, error) {
+	res, err := q.DB.NewDelete().Model((*Event)(nil)).
+		Where("date < ?", cutoff).Exec(q.Ctx)
+	if err != nil {
+		return 0, err
+	}
+	n, _ := res.RowsAffected()
+	return n, nil
+}