From faf123bda2796fe57a8654ae4a28b78aada923f1 Mon Sep 17 00:00:00 2001
From: Sam Kleinman <garen@tychoish.com>
Date: Tue, 15 Mar 2022 10:25:25 -0400
Subject: [PATCH] autofile: reduce minor panic and docs changes (#8122)

* autofile: reduce minor panic and docs changes

* fix lint
---
 internal/libs/autofile/autofile.go    |  4 +-
 internal/libs/autofile/cmd/logjack.go | 53 +++++++++++++++------------
 internal/libs/autofile/group.go       |  3 +-
 3 files changed, 33 insertions(+), 27 deletions(-)

diff --git a/internal/libs/autofile/autofile.go b/internal/libs/autofile/autofile.go
index 9d5a1d4b3..f554228ba 100644
--- a/internal/libs/autofile/autofile.go
+++ b/internal/libs/autofile/autofile.go
@@ -19,7 +19,7 @@ import (
 // Create/Append to ./autofile_test
 af, err := OpenAutoFile("autofile_test")
 if err != nil {
-	panic(err)
+        log.Fatal(err)
 }
 
 // Stream of writes.
@@ -32,7 +32,7 @@ for i := 0; i < 60; i++ {
 // Close the AutoFile
 err = af.Close()
 if err != nil {
-	panic(err)
+	log.Fatal(err)
 }
 */
 
diff --git a/internal/libs/autofile/cmd/logjack.go b/internal/libs/autofile/cmd/logjack.go
index a9f6cf766..c3c466503 100644
--- a/internal/libs/autofile/cmd/logjack.go
+++ b/internal/libs/autofile/cmd/logjack.go
@@ -5,6 +5,7 @@ import (
 	"flag"
 	"fmt"
 	"io"
+	stdlog "log"
 	"os"
 	"os/signal"
 	"strconv"
@@ -19,19 +20,26 @@ const Version = "0.0.1"
 const readBufferSize = 1024 // 1KB at a time
 
 // Parse command-line options
-func parseFlags() (headPath string, chopSize int64, limitSize int64, version bool) {
+func parseFlags() (headPath string, chopSize int64, limitSize int64, version bool, err error) {
 	var flagSet = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
 	var chopSizeStr, limitSizeStr string
 	flagSet.StringVar(&headPath, "head", "logjack.out", "Destination (head) file.")
 	flagSet.StringVar(&chopSizeStr, "chop", "100M", "Move file if greater than this")
 	flagSet.StringVar(&limitSizeStr, "limit", "10G", "Only keep this much (for each specified file). Remove old files.")
 	flagSet.BoolVar(&version, "version", false, "Version")
-	if err := flagSet.Parse(os.Args[1:]); err != nil {
-		fmt.Printf("err parsing flag: %v\n", err)
-		os.Exit(1)
+
+	if err = flagSet.Parse(os.Args[1:]); err != nil {
+		return
+	}
+
+	chopSize, err = parseByteSize(chopSizeStr)
+	if err != nil {
+		return
+	}
+	limitSize, err = parseByteSize(limitSizeStr)
+	if err != nil {
+		return
 	}
-	chopSize = parseBytesize(chopSizeStr)
-	limitSize = parseBytesize(limitSizeStr)
 	return
 }
 
@@ -41,22 +49,23 @@ func main() {
 	defer func() { fmt.Println("logjack shutting down") }()
 
 	// Read options
-	headPath, chopSize, limitSize, version := parseFlags()
+	headPath, chopSize, limitSize, version, err := parseFlags()
+	if err != nil {
+		stdlog.Fatalf("problem parsing arguments: %q", err.Error())
+	}
+
 	if version {
-		fmt.Printf("logjack version %v\n", Version)
-		return
+		stdlog.Printf("logjack version %s", Version)
 	}
 
 	// Open Group
 	group, err := auto.OpenGroup(ctx, log.NewNopLogger(), headPath, auto.GroupHeadSizeLimit(chopSize), auto.GroupTotalSizeLimit(limitSize))
 	if err != nil {
-		fmt.Printf("logjack couldn't create output file %v\n", headPath)
-		os.Exit(1)
+		stdlog.Fatalf("logjack couldn't create output file %q", headPath)
 	}
 
 	if err = group.Start(ctx); err != nil {
-		fmt.Printf("logjack couldn't start with file %v\n", headPath)
-		os.Exit(1)
+		stdlog.Fatalf("logjack couldn't start with file %q", headPath)
 	}
 
 	// Forever read from stdin and write to AutoFile.
@@ -65,25 +74,21 @@ func main() {
 		n, err := os.Stdin.Read(buf)
 		if err != nil {
 			if err == io.EOF {
-				os.Exit(0)
-			} else {
-				fmt.Println("logjack errored:", err.Error())
-				os.Exit(1)
+				return
 			}
+			stdlog.Fatalln("logjack errored:", err.Error())
 		}
 		_, err = group.Write(buf[:n])
 		if err != nil {
-			fmt.Fprintf(os.Stderr, "logjack failed write with error %v\n", headPath)
-			os.Exit(1)
+			stdlog.Fatalf("logjack failed write %q with error: %q", headPath, err.Error())
 		}
 		if err := group.FlushAndSync(); err != nil {
-			fmt.Fprintf(os.Stderr, "logjack flushsync fail with error %v\n", headPath)
-			os.Exit(1)
+			stdlog.Fatalf("logjack flushsync %q fail with error: %q", headPath, err.Error())
 		}
 	}
 }
 
-func parseBytesize(chopSize string) int64 {
+func parseByteSize(chopSize string) (int64, error) {
 	// Handle suffix multiplier
 	var multiplier int64 = 1
 	if strings.HasSuffix(chopSize, "T") {
@@ -106,8 +111,8 @@ func parseBytesize(chopSize string) int64 {
 	// Parse the numeric part
 	chopSizeInt, err := strconv.Atoi(chopSize)
 	if err != nil {
-		panic(err)
+		return 0, err
 	}
 
-	return int64(chopSizeInt) * multiplier
+	return int64(chopSizeInt) * multiplier, nil
 }
diff --git a/internal/libs/autofile/group.go b/internal/libs/autofile/group.go
index bb2c41808..0d1806f22 100644
--- a/internal/libs/autofile/group.go
+++ b/internal/libs/autofile/group.go
@@ -318,7 +318,8 @@ func (g *Group) checkTotalSizeLimit(ctx context.Context) {
 	}
 }
 
-// rotateFile causes group to close the current head and assign it some index.
+// rotateFile causes group to close the current head and assign it
+// some index. Panics if it encounters an error.
 func (g *Group) rotateFile(ctx context.Context) {
 	g.mtx.Lock()
 	defer g.mtx.Unlock()