Rearrange logs, add version command

Author: bbkane

.goreleaser.yml

@@ -16,6 +16,8 @@ builds:
     goarch:
       - amd64
       # - i386  # does anyone care about i386?
+    ldflags:
+      - -s -w -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.Date}} -X main.builtBy=goreleaser
 archives:
   - replacements:
       darwin: Darwin
@@ -24,15 +26,15 @@ archives:
       386: i386
       amd64: x86_64
 checksum:
-  name_template: 'checksums.txt'
+  name_template: "checksums.txt"
 snapshot:
   name_template: "{{ .Tag }}-next"
 changelog:
   sort: asc
   filters:
     exclude:
-      - '^docs:'
-      - '^test:'
+      - "^docs:"
+      - "^test:"
 # https://goreleaser.com/customization/homebrew/
 brews:
   - tap:

dev_notes.md

@@ -17,7 +17,4 @@ git push origin v0.1
   - https://github.com/koekeishiya/homebrew-formulae/blob/master/yabai.rb
 - user agent change (reddit API best practices)
 - better image parsing (go/colly - see nagracks)
-- `write-schedule --path [defaults to ...] --format [cron|systemctl|mac thingie]`
-  - Lingon (in Downloads)
 - rate limiting ( fetchbot? )
-- better logging

grabbit.go

@@ -20,11 +20,22 @@ import (
 	"github.com/natefinch/lumberjack"
 	"github.com/vartanbeno/go-reddit/reddit"
 	"go.uber.org/zap"
-	"go.uber.org/zap/zapcore"
 	kingpin "gopkg.in/alecthomas/kingpin.v2"
 	"gopkg.in/yaml.v2"
 )
 
+// Version will be overwritten at build time
+var Version = "devVersion"
+
+// Commit will be overwritten at build time
+var Commit = "devCommit"
+
+// Date will be overwritten at build time
+var Date = "devDate"
+
+// BuiltBy will be overwritten at build time
+var BuiltBy = "devBuiltBy"
+
 type subreddit struct {
 	Name        string
 	Destination string
@@ -91,16 +102,10 @@ func genFilePath(destinationDir string, title string, fullURL string) (string, e
 	return fileName, nil
 }
 
-func readConfig(configPath string) (*lumberjack.Logger, []subreddit, error) {
-
-	configBytes, err := ioutil.ReadFile(configPath)
-	if err != nil {
-		// It's ok to not have a config (first run, for example)
-		return nil, nil, errors.WithStack(err)
-	}
+func readConfig(configBytes []byte) (*lumberjack.Logger, []subreddit) {
 
 	cfg := config{}
-	err = yaml.UnmarshalStrict(configBytes, &cfg)
+	err := yaml.UnmarshalStrict(configBytes, &cfg)
 	if err != nil {
 		// not ok to get invalid YAML
 		log.Panicf("readConfig: yaml decode: %+v\n", errors.WithStack(err))
@@ -128,7 +133,14 @@ func readConfig(configPath string) (*lumberjack.Logger, []subreddit, error) {
 		subreddits = append(subreddits, sr)
 	}
 
-	return lumberjackLogger, subreddits, nil
+	return lumberjackLogger, subreddits
+}
+
+func isImage(URL string) error {
+	if strings.HasSuffix(URL, ".jpg") {
+		return nil
+	}
+	return errors.New("string doesn't end in .jpg")
 }
 
 func grab(sugar *zap.SugaredLogger, subreddits []subreddit) error {
@@ -149,6 +161,7 @@ func grab(sugar *zap.SugaredLogger, subreddits []subreddit) error {
 	for _, subreddit := range subreddits {
 
 		info, err := os.Stat(subreddit.Destination)
+		// NOTE: should I move these checks to config parsing time?
 		if err != nil {
 			logAndPrint(sugar, os.Stderr,
 				"destination error - skipping all posts",
@@ -187,56 +200,59 @@ func grab(sugar *zap.SugaredLogger, subreddits []subreddit) error {
 		}
 
 		for _, post := range posts {
-			if strings.HasSuffix(post.URL, ".jpg") {
-
-				filePath, err := genFilePath(subreddit.Destination, post.Title, post.URL)
-				if err != nil {
-					logAndPrint(sugar, os.Stderr,
-						"genFilePath err",
-						"subreddit", subreddit.Name,
-						"url", post.URL,
-						"err", errors.WithStack(err),
-					)
-					continue
-				}
-				if fileExists(filePath) {
-					logAndPrint(sugar, os.Stdout,
-						"file already exists!",
-						"filePath", filePath,
-					)
-					continue
-				}
-				err = downloadFile(post.URL, filePath)
-				if err != nil {
-					logAndPrint(sugar, os.Stderr,
-						"downloadFile error",
-						"subreddit", subreddit.Name,
-						"url", post.URL,
-						"err", errors.WithStack(err),
-					)
-
-				} else {
-					logAndPrint(sugar, os.Stdout,
-						"downloaded file",
-						"subreddit", subreddit.Name,
-						"filePath", filePath,
-						"url", post.URL,
-					)
-				}
-			} else {
+			err = isImage(post.URL)
+			if err != nil {
+				logAndPrint(sugar, os.Stderr,
+					"can't download image",
+					"subreddit", subreddit.Name,
+					"url", post.URL,
+					"err", err,
+				)
+				continue
+			}
+
+			filePath, err := genFilePath(subreddit.Destination, post.Title, post.URL)
+			if err != nil {
 				logAndPrint(sugar, os.Stderr,
-					"Could not download",
+					"genFilePath err",
 					"subreddit", subreddit.Name,
 					"url", post.URL,
+					"err", errors.WithStack(err),
 				)
+				continue
 			}
+			if fileExists(filePath) {
+				logAndPrint(sugar, os.Stdout,
+					"file already exists!",
+					"filePath", filePath,
+				)
+				continue
+			}
+			err = downloadFile(post.URL, filePath)
+			if err != nil {
+				logAndPrint(sugar, os.Stderr,
+					"downloadFile error",
+					"subreddit", subreddit.Name,
+					"url", post.URL,
+					"err", errors.WithStack(err),
+				)
+				continue
+
+			}
+			logAndPrint(sugar, os.Stdout,
+				"downloaded file",
+				"subreddit", subreddit.Name,
+				"filePath", filePath,
+				"url", post.URL,
+			)
 		}
 	}
-
 	return nil
 }
 
 func editConfig(sugar *zap.SugaredLogger, configPath string, editor string) error {
+	// TODO: make this a serialized config struct
+	// so I get a compile warning if there's problems
 	emptyConfigContent := []byte(`version: 2.0.0
 # make lumberjacklogger nil to not log to file
 lumberjacklogger:
@@ -258,6 +274,11 @@ subreddits:
 	_, err := os.Stat(configPath)
 	if os.IsNotExist(err) {
 		err = ioutil.WriteFile(configPath, emptyConfigContent, 0644)
+		logAndPrint(
+			sugar, os.Stdout,
+			"wrote default config",
+			"configPath", configPath,
+		)
 		if err != nil {
 			logAndPrint(
 				sugar, os.Stderr,
@@ -299,8 +320,9 @@ subreddits:
 		return err
 	}
 
-	fmt.Printf("Executing: %s %s\n", executable, configPath)
-	sugar.Infow("Executing",
+	logAndPrint(
+		sugar, os.Stdout,
+		"Opening editor",
 		"editor", executable,
 		"configPath", configPath,
 	)
@@ -322,62 +344,8 @@ subreddits:
 	return nil
 }
 
-// newLogger builds a logger. if lumberjackLogger or fp are nil, then that respective sink won't be made
-func newLogger(lumberjackLogger *lumberjack.Logger, fp *os.File, lvl zapcore.LevelEnabler) *zap.Logger {
-	encoderConfig := zapcore.EncoderConfig{
-		// Keys can be anything except the empty string.
-		TimeKey:        "timestamp",
-		LevelKey:       "level",
-		NameKey:        "name", // TODO: what is this?
-		CallerKey:      "caller",
-		FunctionKey:    "function", // zapcore.OmitKey,
-		MessageKey:     "msg",
-		StacktraceKey:  "stacktrace",
-		LineEnding:     zapcore.DefaultLineEnding,
-		EncodeLevel:    zapcore.CapitalLevelEncoder,
-		EncodeTime:     zapcore.ISO8601TimeEncoder,
-		EncodeDuration: zapcore.StringDurationEncoder,
-		EncodeCaller:   zapcore.ShortCallerEncoder,
-	}
-
-	coreSlice := make([]zapcore.Core, 0, 2)
-
-	if lumberjackLogger != nil {
-		jsonCore := zapcore.NewCore(
-			zapcore.NewJSONEncoder(encoderConfig),
-			zapcore.AddSync(lumberjackLogger),
-			lvl,
-		)
-		coreSlice = append(coreSlice, jsonCore)
-	}
-
-	if fp != nil {
-		encoderConfig.EncodeLevel = zapcore.CapitalColorLevelEncoder
-		fpCore := zapcore.NewCore(
-			zapcore.NewConsoleEncoder(encoderConfig),
-			zapcore.Lock(fp),
-			lvl,
-		)
-		coreSlice = append(coreSlice, fpCore)
-	}
-
-	combinedCore := zapcore.NewTee(
-		coreSlice...,
-	)
-
-	logger := zap.New(
-		combinedCore,
-		zap.AddCaller(),
-		// Using errors package to get better stack traces
-		// zap.AddStacktrace(stackTraceLvl),
-		// TODO: replace with version (goreleaser embeds it)
-		zap.Fields(zap.Int("pid", os.Getpid())),
-	)
-
-	return logger
-}
-
 func run() error {
+
 	// cli and go!
 	app := kingpin.New("grabbit", "Get top images from subreddits").UsageTemplate(kingpin.DefaultUsageTemplate)
 	app.HelpFlag.Short('h')
@@ -389,6 +357,8 @@ func run() error {
 
 	grabCmd := app.Command("grab", "Grab images. Use `edit-config` first to create a config")
 
+	versionCmd := app.Command("version", "print grabbit build and version information")
+
 	cmd := kingpin.MustParse(app.Parse(os.Args[1:]))
 
 	configPath, err := homedir.Expand(*appConfigPathFlag)
@@ -398,11 +368,15 @@ func run() error {
 		panic(err)
 	}
 
-	lumberjackLogger, subreddits, cfgErr := readConfig(configPath)
+	configBytes, cfgErr := ioutil.ReadFile(configPath)
+
+	// if configBytes == []byte{}, then this will be
+	// defaulted to nothing and the logging won't work
+	// Stuff will still be printed out with logAndPrint though
+	lumberjackLogger, subreddits := readConfig(configBytes)
 
 	logger := newLogger(
 		lumberjackLogger,
-		// os.Stdout, // TODO: get an os.File from readConfig to put in here - os.Stderr
 		nil,
 		zap.DebugLevel,
 	)
@@ -415,55 +389,32 @@ func run() error {
 		return editConfig(sugar, configPath, *editConfigCmdEditorFlag)
 	case grabCmd.FullCommand():
 		if cfgErr != nil {
-			fmt.Fprintf(os.Stderr, "Config error: maybe try `edit-config`: %v\n", cfgErr)
+			logAndPrint(
+				sugar, os.Stderr,
+				"Config error - try `edit-config`",
+				"cfgErr", cfgErr,
+				"cfgErrMsg", cfgErr.Error(),
+			)
 			return cfgErr
 		}
 		return grab(sugar, subreddits)
+	case versionCmd.FullCommand():
+		logAndPrint(
+			sugar, os.Stdout,
+			"Version and build information",
+			"BuiltBy", BuiltBy,
+			"Commit", Commit,
+			"Date", Date,
+			"Version", Version,
+		)
 	}
 
 	return nil
 }
 
-// logAndPrint produces a more human readable error message for the console.
-// It's really only designed for simple keys/value messages It prints Info if
-// fp == os.Stdout, Error if fp == os.Stderr, and panics otherwise.
-func logAndPrint(sugar *zap.SugaredLogger, fp *os.File, msg string, keysAndValues ...interface{}) {
-
-	switch fp {
-	case os.Stdout:
-		sugar.Infow(msg, keysAndValues...)
-		msg = "INFO: " + msg
-	case os.Stderr:
-		sugar.Errorw(msg, keysAndValues...)
-		msg = "ERROR: " + msg
-	default:
-		log.Panicf("logAndPrint: fp not os.Stderr or os.Stdout: %#v\n", fp)
-	}
-
-	length := len(keysAndValues)
-	if length%2 != 0 {
-		log.Panicf("printMsgKeysAndValues: len() not even: %#v\n", keysAndValues...)
-	}
-
-	keys := make([]string, length/2)
-	values := make([]interface{}, length/2)
-	for i := 0; i < length/2; i++ {
-		keys[i] = keysAndValues[i*2].(string)
-		values[i] = keysAndValues[i*2+1]
-	}
-
-	fmtStr := msg + "\n"
-	for i := 0; i < length/2; i++ {
-		fmtStr += ("  " + keys[i] + ": %#v\n")
-	}
-
-	fmtStr += "\n"
-	fmt.Fprintf(fp, fmtStr, values...)
-}
-
 func main() {
 	err := run()
 	if err != nil {
-		panic(err)
+		os.Exit(1)
 	}
 }