refactor: rename garden to trim

Author: ItsNotGoodName

internal/core/bus.go

@@ -12,15 +12,15 @@ type EventEnvelopeDeleted struct {
 	IDS []int64
 }
 
-type EventGardenStart struct {
+type EventTrimStart struct {
 	Response chan<- bool
 }
 
 type Bus struct {
 	Mutex           sync.Mutex
 	EnvelopeCreated []func(cc *Context, evt EventEnvelopeCreated)
 	EnvelopeDeleted []func(cc *Context, evt EventEnvelopeDeleted)
-	GardenStart     func(cc *Context, evt EventGardenStart)
+	TrimStart       func(cc *Context, evt EventTrimStart)
 }
 
 func NewBus() *Bus {

internal/events/envelope.go

@@ -30,19 +30,19 @@ func PublishEnvelopeDeleted(cc *core.Context, ids ...int64) {
 	cc.Bus.Mutex.Unlock()
 }
 
-func OnGardenStart(app core.App, fn func(cc *core.Context, evt core.EventGardenStart)) {
+func OnTrimStart(app core.App, fn func(cc *core.Context, evt core.EventTrimStart)) {
 	app.Bus.Mutex.Lock()
-	if app.Bus.GardenStart != nil {
-		panic("GardenStart handler is being redefined")
+	if app.Bus.TrimStart != nil {
+		panic("TrimStart handler is being redefined")
 	}
-	app.Bus.GardenStart = fn
+	app.Bus.TrimStart = fn
 	app.Bus.Mutex.Unlock()
 }
 
-func PublishGardenStart(cc *core.Context) <-chan bool {
+func PublishTrimStart(cc *core.Context) <-chan bool {
 	res := make(chan bool)
 	cc.Bus.Mutex.Lock()
-	cc.Bus.GardenStart(cc, core.EventGardenStart{Response: res})
+	cc.Bus.TrimStart(cc, core.EventTrimStart{Response: res})
 	cc.Bus.Mutex.Unlock()
 	return res
 }

internal/procs/gardener.go internal/procs/trimmer.go

@@ -13,26 +13,26 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
-func GardenStart(cc *core.Context) error {
+func TrimStart(cc *core.Context) error {
 	ctx := cc.Context()
 	select {
 	case <-ctx.Done():
 		return ctx.Err()
-	case res := <-events.PublishGardenStart(cc):
+	case res := <-events.PublishTrimStart(cc):
 		if res {
 			return nil
 		}
 
-		return fmt.Errorf("already gardening")
+		return fmt.Errorf("already trimming")
 	}
 }
 
-func GardenerBackground(ctx context.Context, app core.App, policy models.RetentionPolicy) {
+func TrimmerBackground(ctx context.Context, app core.App, policy models.RetentionPolicy) {
 	envDeletedC := make(chan core.EventEnvelopeDeleted, 1)
 	envCreatedC := make(chan core.EventEnvelopeCreated, 1)
-	evtGardenStart := make(chan core.EventGardenStart, 1)
+	evtTrimStart := make(chan core.EventTrimStart, 1)
 
-	go gardener(app.Context(ctx), policy, envCreatedC, envDeletedC, evtGardenStart)
+	go trimmer(app.Context(ctx), policy, envCreatedC, envDeletedC, evtTrimStart)
 
 	events.OnEnvelopeCreated(app, func(cc *core.Context, evt core.EventEnvelopeCreated) {
 		select {
@@ -58,9 +58,9 @@ func GardenerBackground(ctx context.Context, app core.App, policy models.Retenti
 		}
 	})
 
-	events.OnGardenStart(app, func(cc *core.Context, evt core.EventGardenStart) {
+	events.OnTrimStart(app, func(cc *core.Context, evt core.EventTrimStart) {
 		select {
-		case evtGardenStart <- evt:
+		case evtTrimStart <- evt:
 		default:
 			select {
 			case <-ctx.Done():
@@ -71,28 +71,28 @@ func GardenerBackground(ctx context.Context, app core.App, policy models.Retenti
 	})
 }
 
-func gardener(
+func trimmer(
 	cc *core.Context,
 	policy models.RetentionPolicy,
 	envCreatedC <-chan core.EventEnvelopeCreated,
 	envDeletedC <-chan core.EventEnvelopeDeleted,
-	evtGardenStart <-chan core.EventGardenStart,
+	evtTrimStart <-chan core.EventTrimStart,
 ) {
 	ctx := cc.Context()
 	ticker := time.NewTicker(30 * time.Minute)
 
 	clean := func() {
-		gardenerDeleteByAge(cc, policy)
-		gardenerDeleteOrphanAttachments(cc)
+		trimmerDeleteByAge(cc, policy)
+		trimmerDeleteOrphanAttachments(cc)
 
 		storage, err := StorageGet(cc)
 		if err != nil {
 			log.Err(err).Msg("Failed to get storage")
 			return
 		}
 
-		gardenerDeleteByEnvelopeCount(cc, policy, storage)
-		gardenerDeleteByAttachmentSize(cc, policy, storage)
+		trimmerDeleteByEnvelopeCount(cc, policy, storage)
+		trimmerDeleteByAttachmentSize(cc, policy, storage)
 	}
 	clean()
 
@@ -107,13 +107,13 @@ func gardener(
 				continue
 			}
 
-			gardenerDeleteByEnvelopeCount(cc, policy, storage)
-			gardenerDeleteByAttachmentSize(cc, policy, storage)
+			trimmerDeleteByEnvelopeCount(cc, policy, storage)
+			trimmerDeleteByAttachmentSize(cc, policy, storage)
 		case <-envDeletedC:
-			gardenerDeleteOrphanAttachments(cc)
+			trimmerDeleteOrphanAttachments(cc)
 		case <-ticker.C:
 			clean()
-		case evt := <-evtGardenStart:
+		case evt := <-evtTrimStart:
 			clean()
 
 			select {
@@ -124,7 +124,7 @@ func gardener(
 		}
 	}
 }
-func gardenerDeleteByAttachmentSize(cc *core.Context, policy models.RetentionPolicy, storage models.Storage) {
+func trimmerDeleteByAttachmentSize(cc *core.Context, policy models.RetentionPolicy, storage models.Storage) {
 	if policy.AttachmentSize == nil {
 		return
 	}
@@ -140,7 +140,7 @@ func gardenerDeleteByAttachmentSize(cc *core.Context, policy models.RetentionPol
 	}
 }
 
-func gardenerDeleteByEnvelopeCount(cc *core.Context, policy models.RetentionPolicy, storage models.Storage) {
+func trimmerDeleteByEnvelopeCount(cc *core.Context, policy models.RetentionPolicy, storage models.Storage) {
 	if policy.EnvelopeCount == nil {
 		return
 	}
@@ -157,7 +157,7 @@ func gardenerDeleteByEnvelopeCount(cc *core.Context, policy models.RetentionPoli
 	}
 }
 
-func gardenerDeleteByAge(cc *core.Context, policy models.RetentionPolicy) {
+func trimmerDeleteByAge(cc *core.Context, policy models.RetentionPolicy) {
 	if policy.EnvelopeAge == nil {
 		return
 	}
@@ -171,7 +171,7 @@ func gardenerDeleteByAge(cc *core.Context, policy models.RetentionPolicy) {
 	}
 }
 
-func gardenerDeleteOrphanAttachments(cc *core.Context) {
+func trimmerDeleteOrphanAttachments(cc *core.Context) {
 	for {
 		atts, err := db.EnvelopeAttachmentListOrphan(cc, 10)
 		if err != nil {

internal/procs/vacuum.go

@@ -8,7 +8,7 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
-func VacuumStart(ctx context.Context, app core.App) {
+func VacuumBackground(ctx context.Context, app core.App) {
 	go vacuum(app.Context(ctx))
 }
 

main.go

@@ -62,8 +62,8 @@ func run(ctx context.Context, shutdown context.CancelFunc, cli config.CLI) <-cha
 	}
 
 	procs.MailmanBackground(ctx, app)
-	procs.GardenerBackground(ctx, app, cfg.RetentionPolicy)
-	procs.VacuumStart(ctx, app)
+	procs.TrimmerBackground(ctx, app, cfg.RetentionPolicy)
+	procs.VacuumBackground(ctx, app)
 
 	var backgrounds []background.Background
 

web/controllers/controllers.go

@@ -75,14 +75,14 @@ func Vacuum(c *fiber.Ctx, cc *core.Context) error {
 	return c.SendStatus(http.StatusNoContent)
 }
 
-func Garden(c *fiber.Ctx, cc *core.Context) error {
+func Trim(c *fiber.Ctx, cc *core.Context) error {
 	// Execute
-	err := procs.GardenStart(cc)
+	err := procs.TrimStart(cc)
 	if err != nil {
 		return helpers.Error(c, err)
 	}
 
 	// Response
-	c.Set("HX-Trigger", "garden")
+	c.Set("HX-Trigger", "trim")
 	return c.SendStatus(http.StatusNoContent)
 }

web/http/routes.go

@@ -43,7 +43,7 @@ func routes(http *fiber.App, app core.App, retentionPolicy models.RetentionPolic
 
 	http.Post("/send", middleware.App(app, controllers.Send))
 	http.Post("/vacuum", middleware.App(app, controllers.Vacuum))
-	http.Post("/garden", middleware.App(app, controllers.Garden))
+	http.Post("/trim", middleware.App(app, controllers.Trim))
 	http.Group("/files", controllers.Files(app))
 
 	http.Route("/p", func(http fiber.Router) {

web/views/index.html

@@ -16,7 +16,10 @@ <h2>Storage</h2>
         title="Rebuild database file to take the minimal amount of disk space.">
         Vacuum Database
       </button>
-      <button hx-delete="/envelopes" data-loading-path="/vacuum" data-loading-disable data-loading-aria-busy
+      <button hx-post="/trim" data-loading-path="/trim" data-loading-disable data-loading-aria-busy>
+        Trim Data
+      </button>
+      <button hx-delete="/envelopes" data-loading-path="/envelopes" data-loading-disable data-loading-aria-busy
         hx-confirm="Are you sure you wish to delete all envelopes?" class="contrast">
         Delete Envelopes
       </button>
@@ -53,9 +56,6 @@ <h2>Retention Policy</h2>
         </tbody>
       </table>
     </figure>
-    <button hx-post="/garden" data-loading-path="/garden" data-loading-disable data-loading-aria-busy>
-      Garden Data
-    </button>
   </article>
 
   <article>

web/views/p/storage-table.html

@@ -1,4 +1,4 @@
-<table hx-trigger="every 5s, databaseVacuum from:body, garden from:body, deleteEnvelopes from:body"
+<table hx-trigger="every 5s, databaseVacuum from:body, trim from:body, deleteEnvelopes from:body"
   hx-get="/p/storage-table" hx-swap="outerHTML">
   <tbody>
     <tr>