satellite/modular: modular satellite supports auditor subcommand

elek · elek · commit 8e6ce32cd977 · 2025-08-21T08:44:52.000Z
Change-Id: I52b8b66c020c2dfa3a8c0d0091a34a561d2e3851
diff --git a/satellite/audit/mud.go b/satellite/audit/mud.go
@@ -21,7 +21,9 @@ func Module(ball *mud.Ball) {
 	mud.Provide[*Verifier](ball, func(log *zap.Logger, metabase *metabase.DB, dialer rpc.Dialer, overlay *overlay.Service, containment Containment, orders *orders.Service, id *identity.FullIdentity, cfg Config) *Verifier {
 		return NewVerifier(log, metabase, dialer, overlay, containment, orders, id, cfg.MinBytesPerSecond, cfg.MinDownloadTimeout)
 	})
-
+	mud.Provide[*Worker](ball, NewWorker)
+	mud.Provide[*ReverifyWorker](ball, NewReverifyWorker)
+	mud.Provide[*Reverifier](ball, NewReverifier)
 	// TODO: we need real containment for running service.
 	mud.Provide[Containment](ball, func() Containment {
 		return &noContainment{}
diff --git a/satellite/mud.go b/satellite/mud.go
@@ -129,6 +129,8 @@ func Module(ball *mud.Ball) {
 	})
 	mud.Tag[audit.Reporter, mud.Nullable](ball, mud.Nullable{})
 	mud.Tag[audit.Reporter, mud.Optional](ball, mud.Optional{})
+	mud.View[DB, audit.ReverifyQueue](ball, DB.ReverifyQueue)
+	mud.View[DB, audit.VerifyQueue](ball, DB.VerifyQueue)
 
 	mud.View[*identity.FullIdentity, signing.Signee](ball, func(fullIdentity *identity.FullIdentity) signing.Signee {
 		return signing.SigneeFromPeerIdentity(fullIdentity.PeerIdentity())
diff --git a/satellite/run/auditor.go b/satellite/run/auditor.go
@@ -0,0 +1,23 @@
+// Copyright (C) 2025 Storj Labs, Inc.
+// See LICENSE for copying information.
+
+package root
+
+import (
+	"storj.io/storj/satellite/audit"
+	"storj.io/storj/shared/debug"
+	"storj.io/storj/shared/mud"
+)
+
+// Auditor is a subcommand to start only Auditor services.
+type Auditor struct {
+}
+
+// GetSelector implements mud.ComponentSelectorProvider.
+func (a *Auditor) GetSelector(ball *mud.Ball) mud.ComponentSelector {
+	return mud.Or(
+		mud.Select[debug.Wrapper](ball),
+		mud.Select[*audit.Worker](ball),
+		mud.Select[*audit.ReverifyWorker](ball))
+
+}
diff --git a/satellite/run/mud.go b/satellite/run/mud.go
@@ -8,6 +8,7 @@ import (
 	"storj.io/storj/satellite/satellitedb"
 	trustmud "storj.io/storj/satellite/trust/mud"
 	"storj.io/storj/shared/modular"
+	"storj.io/storj/shared/modular/cli"
 	"storj.io/storj/shared/modular/logger"
 	"storj.io/storj/shared/mud"
 )
@@ -20,4 +21,9 @@ func Module(ball *mud.Ball) {
 	satellite.Module(ball)
 	trustmud.Module(ball)
 	mud.Provide[*modular.MonkitReport](ball, modular.NewMonkitReport)
+
+	mud.Provide[*Auditor](ball, func() *Auditor {
+		return &Auditor{}
+	})
+	cli.RegisterSubcommand[*Auditor](ball, "auditor", "run the auditor service")
 }
diff --git a/shared/modular/cli/mudrunner.go b/shared/modular/cli/mudrunner.go
@@ -8,6 +8,7 @@ import (
 	"fmt"
 	"os"
 	"os/signal"
+	"reflect"
 
 	"github.com/zeebo/clingy"
 
@@ -92,6 +93,18 @@ func clingyRunner(cfg *ConfigSupport, ball *mud.Ball) func(cmds clingy.Commands)
 			cmdSelector := func(c *mud.Component) bool {
 				return c == component
 			}
+
+			// A specific case when the component implements SelectorOverride interface.
+			// In this case we call it for the real components to run, instead of just using the Run (what we usually do for tool subcommands).
+			selectorOverrideType := reflect.TypeOf((*SelectorOverride)(nil)).Elem()
+			if component.GetTarget().Implements(selectorOverrideType) {
+				err := component.Init(context.Background())
+				if err != nil {
+					panic(err)
+				}
+				cmdSelector = component.Instance().(SelectorOverride).GetSelector(ball)
+			}
+
 			cmds.New(sc.Name, sc.Description, &MudCommand{
 				ball:     ball,
 				selector: cmdSelector,
@@ -104,3 +117,8 @@ func clingyRunner(cfg *ConfigSupport, ball *mud.Ball) func(cmds clingy.Commands)
 		}
 	}
 }
+
+// SelectorOverride is an interface for components that can override the selector used in the command (instead of executing Run).
+type SelectorOverride interface {
+	GetSelector(ball *mud.Ball) mud.ComponentSelector
+}
