From 07af692ecb1a9cabf03af1575dff7a82cf18a7ac Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Mon, 18 Sep 2023 12:04:59 +0300 Subject: refactor(tvix/nar-bridge): simplify CLI interface Only keep the `serve` subcommand, and make it appear at the root. Introduce a --log-level argument, and be a bit less noisy in normal operation. Change-Id: I86b8abde1869a5c0c947508bcc29f845222aac09 Reviewed-on: https://cl.tvl.fyi/c/depot/+/9360 Autosubmit: flokli Reviewed-by: Connor Brewster Tested-by: BuildkiteCI --- tvix/nar-bridge/cmd/nar_bridge/import.go | 57 ------------------------ tvix/nar-bridge/cmd/nar_bridge/main.go | 60 +++++++++++++++++++++----- tvix/nar-bridge/cmd/nar_bridge/serve.go | 60 -------------------------- tvix/nar-bridge/pkg/server/blob_upload.go | 2 +- tvix/nar-bridge/pkg/server/directory_upload.go | 2 +- tvix/nar-bridge/pkg/server/nar_get.go | 9 ++-- tvix/nar-bridge/pkg/server/nar_put.go | 2 +- tvix/nar-bridge/pkg/server/narinfo_put.go | 2 +- 8 files changed, 56 insertions(+), 138 deletions(-) delete mode 100644 tvix/nar-bridge/cmd/nar_bridge/import.go delete mode 100644 tvix/nar-bridge/cmd/nar_bridge/serve.go diff --git a/tvix/nar-bridge/cmd/nar_bridge/import.go b/tvix/nar-bridge/cmd/nar_bridge/import.go deleted file mode 100644 index 51b99c93a04b..000000000000 --- a/tvix/nar-bridge/cmd/nar_bridge/import.go +++ /dev/null @@ -1,57 +0,0 @@ -package main - -import ( - "context" - "fmt" - "io" - "os" - "os/signal" - - storev1pb "code.tvl.fyi/tvix/store/protos" - - "code.tvl.fyi/tvix/nar-bridge/pkg/reader" - log "github.com/sirupsen/logrus" -) - -type ImportCmd struct { - NarPath string `name:"nar-path" help:"A path to a NAR file"` -} - -// `help:"Read a NAR file and display some information"` - -func (cmd *ImportCmd) Run() error { - retcode := 0 - - defer func() { os.Exit(retcode) }() - - c := make(chan os.Signal, 1) - signal.Notify(c, os.Interrupt) - - go func() { - for range c { - log.Info("Received Signal, shutting down…") - os.Exit(1) - } - }() - - log.Infof("Reading %v...", cmd.NarPath) - - f, _ := os.Open(cmd.NarPath) - - r := reader.New(f) - - actualPathInfo, _ := r.Import( - context.Background(), - func(fileReader io.Reader) error { - return nil - }, - func(directory *storev1pb.Directory) error { - return nil - }, - ) - - fmt.Printf("Node: %+v\n", actualPathInfo.Node) - fmt.Printf("References: %+v\n", actualPathInfo.References) - fmt.Printf("Narinfo: %+v\n", actualPathInfo.Narinfo) - return nil -} diff --git a/tvix/nar-bridge/cmd/nar_bridge/main.go b/tvix/nar-bridge/cmd/nar_bridge/main.go index 78ed3e272d69..482012f39b5f 100644 --- a/tvix/nar-bridge/cmd/nar_bridge/main.go +++ b/tvix/nar-bridge/cmd/nar_bridge/main.go @@ -2,29 +2,67 @@ package main import ( "os" + "os/signal" "github.com/alecthomas/kong" + + "google.golang.org/grpc" + "google.golang.org/grpc/credentials/insecure" + + "code.tvl.fyi/tvix/nar-bridge/pkg/server" + storev1pb "code.tvl.fyi/tvix/store/protos" + "github.com/sirupsen/logrus" + log "github.com/sirupsen/logrus" ) -//nolint:gochecknoglobals +// `help:"Expose a tvix-store gRPC Interface as HTTP NAR/NARinfo"` var cli struct { - // TODO: make log level configurable - Import ImportCmd `kong:"cmd,name='import',help='Import a local NAR file into a tvix-store'"` - Serve ServeCmd `kong:"cmd,name='serve',help='Expose a tvix-store RPC interface as NAR/NARInfo'"` + LogLevel string `enum:"trace,debug,info,warn,error,fatal,panic" help:"The log level to log with" default:"info"` + ListenAddr string `name:"listen-addr" help:"The address this service listens on" type:"string" default:"[::]:9000"` //nolint:lll + EnableAccessLog bool `name:"access-log" help:"Enable access logging" type:"bool" default:"true" negatable:""` //nolint:lll + StoreAddr string `name:"store-addr" help:"The address to the tvix-store RPC interface this will connect to"` } func main() { - parser, err := kong.New(&cli) + _ = kong.Parse(&cli) + + logLevel, err := logrus.ParseLevel(cli.LogLevel) if err != nil { - panic(err) + log.Panic("invalid log level") + return } + logrus.SetLevel(logLevel) + + c := make(chan os.Signal, 1) + signal.Notify(c, os.Interrupt) - ctx, err := parser.Parse(os.Args[1:]) + go func() { + for range c { + log.Info("Received Signal, shutting down…") + os.Exit(1) + } + }() + + // connect to tvix-store + log.Debugf("Dialing to %v", cli.StoreAddr) + conn, err := grpc.Dial(cli.StoreAddr, grpc.WithTransportCredentials(insecure.NewCredentials())) if err != nil { - panic(err) + log.Fatalf("did not connect: %v", err) } - // Call the Run() method of the selected parsed command. - err = ctx.Run() + defer conn.Close() + + log.Printf("Starting nar-bridge at %v", cli.ListenAddr) + s := server.New( + storev1pb.NewDirectoryServiceClient(conn), + storev1pb.NewBlobServiceClient(conn), + storev1pb.NewPathInfoServiceClient(conn), + cli.EnableAccessLog, + 30, + ) - ctx.FatalIfErrorf(err) + err = s.ListenAndServe(cli.ListenAddr) + if err != nil { + log.Error("Server failed: %w", err) + os.Exit(1) + } } diff --git a/tvix/nar-bridge/cmd/nar_bridge/serve.go b/tvix/nar-bridge/cmd/nar_bridge/serve.go deleted file mode 100644 index 6566257176d8..000000000000 --- a/tvix/nar-bridge/cmd/nar_bridge/serve.go +++ /dev/null @@ -1,60 +0,0 @@ -package main - -import ( - "os" - "os/signal" - - "google.golang.org/grpc" - "google.golang.org/grpc/credentials/insecure" - - "code.tvl.fyi/tvix/nar-bridge/pkg/server" - storev1pb "code.tvl.fyi/tvix/store/protos" - log "github.com/sirupsen/logrus" -) - -type ServeCmd struct { - ListenAddr string `name:"listen-addr" help:"The address this service listens on" type:"string" default:"[::]:9000"` //nolint:lll - EnableAccessLog bool `name:"access-log" help:"Enable access logging" type:"bool" default:"true" negatable:""` //nolint:lll - StoreAddr string `name:"store-addr" help:"The address to the tvix-store RPC interface this will connect to"` -} - -// `help:"Expose a tvix-store RPC interface as NAR/NARInfo"` -func (cmd *ServeCmd) Run() error { - retcode := 0 - - defer func() { os.Exit(retcode) }() - - c := make(chan os.Signal, 1) - signal.Notify(c, os.Interrupt) - - go func() { - for range c { - log.Info("Received Signal, shutting down…") - //s.Close() - os.Exit(1) - } - }() - - // connect to tvix-store - log.Debugf("Dialing to %v", cmd.StoreAddr) - conn, err := grpc.Dial(cmd.StoreAddr, grpc.WithTransportCredentials(insecure.NewCredentials())) - if err != nil { - log.Fatalf("did not connect: %v", err) - } - defer conn.Close() - - log.Printf("Starting nar-bridge at %v", cmd.ListenAddr) - s := server.New( - storev1pb.NewDirectoryServiceClient(conn), - storev1pb.NewBlobServiceClient(conn), - storev1pb.NewPathInfoServiceClient(conn), - cmd.EnableAccessLog, - 30, - ) - - err = s.ListenAndServe(cmd.ListenAddr) - if err != nil { - log.Error("Server failed: %w", err) - } - return nil -} diff --git a/tvix/nar-bridge/pkg/server/blob_upload.go b/tvix/nar-bridge/pkg/server/blob_upload.go index 82e22864a552..cfb65eddb14a 100644 --- a/tvix/nar-bridge/pkg/server/blob_upload.go +++ b/tvix/nar-bridge/pkg/server/blob_upload.go @@ -64,7 +64,7 @@ func genBlobServiceWriteCb(ctx context.Context, blobServiceClient storev1pb.Blob log.WithFields(log.Fields{ "blob_digest": base64.StdEncoding.EncodeToString(resp.GetDigest()), "blob_size": blobSize, - }).Info("uploaded blob") + }).Debug("uploaded blob") return nil } diff --git a/tvix/nar-bridge/pkg/server/directory_upload.go b/tvix/nar-bridge/pkg/server/directory_upload.go index 02b173698042..d679d3c0b31d 100644 --- a/tvix/nar-bridge/pkg/server/directory_upload.go +++ b/tvix/nar-bridge/pkg/server/directory_upload.go @@ -44,7 +44,7 @@ func (du *DirectoriesUploader) Put(directory *storev1pb.Directory) error { if err != nil { return fmt.Errorf("error sending directory: %w", err) } - log.WithField("digest", base64.StdEncoding.EncodeToString(directoryDgst)).Info("uploaded directory") + log.WithField("digest", base64.StdEncoding.EncodeToString(directoryDgst)).Debug("uploaded directory") return nil } diff --git a/tvix/nar-bridge/pkg/server/nar_get.go b/tvix/nar-bridge/pkg/server/nar_get.go index d1a9426f33d4..b1eb70b624f0 100644 --- a/tvix/nar-bridge/pkg/server/nar_get.go +++ b/tvix/nar-bridge/pkg/server/nar_get.go @@ -85,8 +85,7 @@ func renderNar( return fmt.Errorf("unable to calculate directory digest: %w", err) } - // TODO: debug level - log.WithField("directory", base64.StdEncoding.EncodeToString(directoryDgst)).Info("received directory node") + log.WithField("directory", base64.StdEncoding.EncodeToString(directoryDgst)).Debug("received directory node") directories[hex.EncodeToString(directoryDgst)] = directory } @@ -98,8 +97,7 @@ func renderNar( w, pathInfo, func(directoryDigest []byte) (*storev1pb.Directory, error) { - // TODO: debug level - log.WithField("directory", base64.StdEncoding.EncodeToString(directoryDigest)).Info("Get directory") + log.WithField("directory", base64.StdEncoding.EncodeToString(directoryDigest)).Debug("Get directory") directoryRefStr := hex.EncodeToString(directoryDigest) directory, found := directories[directoryRefStr] if !found { @@ -113,8 +111,7 @@ func renderNar( return directory, nil }, func(blobDigest []byte) (io.ReadCloser, error) { - // TODO: debug level - log.WithField("blob", base64.StdEncoding.EncodeToString(blobDigest)).Info("Get blob") + log.WithField("blob", base64.StdEncoding.EncodeToString(blobDigest)).Debug("Get blob") resp, err := blobServiceClient.Read(ctx, &storev1pb.ReadBlobRequest{ Digest: blobDigest, }) diff --git a/tvix/nar-bridge/pkg/server/nar_put.go b/tvix/nar-bridge/pkg/server/nar_put.go index 6d8b2bbd41ca..aecad571cdaa 100644 --- a/tvix/nar-bridge/pkg/server/nar_put.go +++ b/tvix/nar-bridge/pkg/server/nar_put.go @@ -60,7 +60,7 @@ func registerNarPut(s *Server) { return } - log.Infof("closing the stream") + log.Debug("closing the stream") // Close the directories uploader directoriesPutResponse, err := directoriesUploader.Done() diff --git a/tvix/nar-bridge/pkg/server/narinfo_put.go b/tvix/nar-bridge/pkg/server/narinfo_put.go index c5b4094f8582..1ad85d8a8bcb 100644 --- a/tvix/nar-bridge/pkg/server/narinfo_put.go +++ b/tvix/nar-bridge/pkg/server/narinfo_put.go @@ -167,7 +167,7 @@ func registerNarinfoPut(s *Server) { return } - log.Infof("received new pathInfo: %v+", receivedPathInfo) + log.Debugf("received new pathInfo: %v+", receivedPathInfo) // TODO: update the local temporary pathinfo with this? }) -- cgit 1.4.1