Merge pull request #54 from goark/develop

Refactor error handling and code structure for improved readability and maintainability

Author: spiegel-im-spiegel

.github/workflows/build.yml

@@ -14,21 +14,21 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
       -
         name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v6
         with:
           go-version-file: 'go.mod'
       -
         name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v4
+        uses: goreleaser/goreleaser-action@v7
         with:
           # either 'goreleaser' (default) or 'goreleaser-pro'
           distribution: goreleaser
-          version: latest
+          version: '~> v2'
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/lint.yml

@@ -14,12 +14,12 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v3
+      - uses: actions/checkout@v6
+      - uses: actions/setup-go@v6
         with:
           go-version-file: 'go.mod'
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v9
         with:
           # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
           version: latest

.golangci.yml

@@ -0,0 +1,7 @@
+version: "2"
+linters:
+  settings:
+    gosec:
+      # excludes rules G117
+      excludes:
+        - G117

.goreleaser.yml

@@ -28,10 +28,10 @@ builds:
 
 archives:
 -
-  format: tar.gz
+  formats: ["tar.gz"]
   format_overrides:
     - goos: windows
-      format: zip
+      formats: ["zip"]
   name_template: >-
     {{ .Binary }}_
     {{- .Version }}_

README.md

@@ -1,12 +1,11 @@
 # [toolbox] -- A collection of miscellaneous commands
 
-[![check vulns](https://github.com/goark/toolbox/workflows/vulns/badge.svg)](https://github.com/goark/toolbox/actions)
 [![lint status](https://github.com/goark/toolbox/workflows/lint/badge.svg)](https://github.com/goark/toolbox/actions)
 [![lint status](https://github.com/goark/toolbox/workflows/build/badge.svg)](https://github.com/goark/toolbox/actions)
 [![GitHub license](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/goark/toolbox/master/LICENSE)
 [![GitHub release](http://img.shields.io/github/release/goark/toolbox.svg)](https://github.com/goark/toolbox/releases/latest)
 
-This package is required Go 1.20 or later.
+This package is required Go 1.26 or later.
 
 ## Build and Install
 

Taskfile.yml

@@ -5,7 +5,8 @@ tasks:
     cmds:
       - task: prepare
       - task: test
-      - task: nancy
+      - task: govulncheck
+      # - task: nancy
       - task: graph
 
   build-all:
@@ -19,7 +20,15 @@ tasks:
       - go mod verify
       - go test -shuffle on ./...
       - govulncheck ./...
-      - golangci-lint run --enable gosec --timeout 10m0s ./...
+      - golangci-lint-v2 run --enable gosec --timeout 10m0s ./...
+    sources:
+      - ./go.mod
+      - '**/*.go'
+
+  govulncheck:
+    desc: Check reachable vulnerabilities with latest govulncheck.
+    cmds:
+      - go run golang.org/x/vuln/cmd/govulncheck@latest ./...
     sources:
       - ./go.mod
       - '**/*.go'
@@ -33,7 +42,7 @@ tasks:
       - '**/*.go'
 
   prepare:
-      - go mod tidy -v -go=1.23
+      - go mod tidy -v -go=1.26
 
   clean:
     desc: Initialize module and build cache, and remake go.sum file.

apod/apod.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"os"
+	"path/filepath"
 
 	"github.com/goark/errs"
 	"github.com/goark/toolbox/db"
@@ -26,33 +27,39 @@ type APOD struct {
 }
 
 // New functions creates new APOD instance from file.
-func New(ctx context.Context, path, cacheDir string, logger *log.ZapEventLogger) (*APOD, error) {
+func New(ctx context.Context, path, cacheDir string, logger *log.ZapEventLogger) (cfg *APOD, err error) {
 	// open database
-	repos, err := db.Open(ctx, cacheDir, logger)
-	if err != nil {
-		return nil, errs.Wrap(err, errs.WithContext("cache_dir", cacheDir))
+	repos, ferr := db.Open(ctx, cacheDir, logger)
+	if ferr != nil {
+		err = errs.Wrap(ferr, errs.WithContext("cache_dir", cacheDir))
+		return
 	}
 
 	// read configuration file
 	if len(path) == 0 {
-		return fallthroughCfg(repos, logger), nil
+		cfg = fallthroughCfg(repos, logger)
+		return
 	}
-	file, err := os.Open(path)
-	if err != nil {
-		return fallthroughCfg(repos, logger), nil
+	file, ferr := os.Open(filepath.Clean(path))
+	if ferr != nil {
+		cfg = fallthroughCfg(repos, logger)
+		return
 	}
-	defer file.Close()
-	var cfg APOD
-	if err := json.NewDecoder(file).Decode(&cfg); err != nil {
-		return nil, errs.Wrap(err, errs.WithContext("path", path))
+	defer func() {
+		err = errs.Join(err, file.Close())
+	}()
+	var vcfg APOD
+	if jerr := json.NewDecoder(file).Decode(&vcfg); jerr != nil {
+		err = errs.Wrap(jerr, errs.WithContext("path", path))
+		return
 	}
-	cfg.logger = logger
-	cfg.cacheDir = cacheDir
-	cfg.repos = repos
-	cfg.cache = map[string]*nasaapod.Response{}
-	cfg.saveData = []*nasaapod.Response{}
-
-	return &cfg, nil
+	vcfg.logger = logger
+	vcfg.cacheDir = cacheDir
+	vcfg.repos = repos
+	vcfg.cache = map[string]*nasaapod.Response{}
+	vcfg.saveData = []*nasaapod.Response{}
+	cfg = &vcfg
+	return
 }
 
 func fallthroughCfg(repos *db.Repository, logger *log.ZapEventLogger) *APOD {
@@ -74,23 +81,28 @@ func (cfg *APOD) Logger() *zap.Logger {
 }
 
 // Export methods exports configuration to config file.
-func (cfg *APOD) Export(path string) error {
+func (cfg *APOD) Export(path string) (err error) {
 	if cfg == nil {
-		return errs.Wrap(ecode.ErrNullPointer)
+		err = errs.Wrap(ecode.ErrNullPointer)
+		return
 	}
-	file, err := os.OpenFile(path, os.O_RDWR|os.O_CREATE, 0600)
-	if err != nil {
-		return errs.Wrap(err, errs.WithContext("path", path))
+	file, ferr := os.OpenFile(filepath.Clean(path), os.O_RDWR|os.O_CREATE, 0600)
+	if ferr != nil {
+		err = errs.Wrap(ferr, errs.WithContext("path", path))
+		return
 	}
-	defer file.Close()
+	defer func() {
+		err = errs.Join(err, file.Close())
+	}()
 
-	if err := json.NewEncoder(file).Encode(cfg); err != nil {
-		return errs.Wrap(err, errs.WithContext("path", path))
+	if jerr := json.NewEncoder(file).Encode(cfg); jerr != nil {
+		err = errs.Wrap(jerr, errs.WithContext("path", path))
+		return
 	}
-	return nil
+	return
 }
 
-/* Copyright 2023-2024 Spiegel
+/* Copyright 2023-2026 Spiegel
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

apod/lookup.go

@@ -108,27 +108,27 @@ func MakeMessage(data *nasaapod.Response) string {
 	// hash tag
 	bld.WriteString("#apod " + data.Date.String())
 	if len(data.MediaType) > 0 && data.MediaType != "image" {
-		bld.WriteString(fmt.Sprintf(" (%s)", data.MediaType))
+		fmt.Fprintf(&bld, " (%s)", data.MediaType)
 	}
 	bld.WriteString("\n")
 	//title
 	if len(data.Title) > 0 {
-		bld.WriteString(fmt.Sprintln(data.Title))
+		fmt.Fprintln(&bld, data.Title)
 	}
 	// credit
 	if len(data.Copyright) > 0 {
-		bld.WriteString(fmt.Sprintln("Image Credit:", data.Copyright))
+		fmt.Fprintln(&bld, "Image Credit:", data.Copyright)
 	}
 	// Web page
-	bld.WriteString(fmt.Sprintln("Web page:", data.WebPage()))
+	fmt.Fprintln(&bld, "Web page:", data.WebPage())
 	// content URL
 	if data.MediaType != nasaapod.MediaImage && len(data.Url) > 0 {
-		bld.WriteString(fmt.Sprintln("Content:", data.Url))
+		fmt.Fprintln(&bld, "Content:", data.Url)
 	}
 	return bld.String()
 }
 
-/* Copyright 2023 Spiegel
+/* Copyright 2023-2026 Spiegel
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

bluesky/authfile.go

@@ -18,34 +18,43 @@ func (cfg *Bluesky) authPath() string {
 	return filepath.Join(cfg.BaseDir(), "bluesky.auth")
 }
 
-func (cfg *Bluesky) readAuth() (*xrpc.AuthInfo, error) {
-	file, err := os.Open(cfg.authPath())
-	if err != nil {
-		return nil, errs.Wrap(err, errs.WithContext("authfile", cfg.authPath()))
+func (cfg *Bluesky) readAuth() (auth *xrpc.AuthInfo, err error) {
+	file, ferr := os.Open(cfg.authPath())
+	if ferr != nil {
+		err = errs.Wrap(ferr, errs.WithContext("authfile", cfg.authPath()))
+		return
 	}
-	defer file.Close()
+	defer func() {
+		err = errs.Join(err, file.Close())
+	}()
 
-	var auth xrpc.AuthInfo
-	if err := json.NewDecoder(file).Decode(&auth); err != nil {
-		return nil, errs.Wrap(err, errs.WithContext("authfile", cfg.authPath()))
+	var vauth xrpc.AuthInfo
+	if jerr := json.NewDecoder(file).Decode(&vauth); jerr != nil {
+		err = errs.Wrap(jerr, errs.WithContext("authfile", cfg.authPath()))
+		return
 	}
-	return &auth, nil
+	auth = &vauth
+	return
 }
 
-func (cfg *Bluesky) writeAuth(auth *xrpc.AuthInfo) error {
-	file, err := os.OpenFile(cfg.authPath(), os.O_RDWR|os.O_CREATE, 0600)
-	if err != nil {
-		return errs.Wrap(err, errs.WithContext("authfile", cfg.authPath()))
+func (cfg *Bluesky) writeAuth(auth *xrpc.AuthInfo) (err error) {
+	file, ferr := os.OpenFile(cfg.authPath(), os.O_RDWR|os.O_CREATE, 0600)
+	if ferr != nil {
+		err = errs.Wrap(ferr, errs.WithContext("authfile", cfg.authPath()))
+		return
 	}
-	defer file.Close()
+	defer func() {
+		err = errs.Join(err, file.Close())
+	}()
 
-	if err := json.NewEncoder(file).Encode(auth); err != nil {
-		return errs.Wrap(err, errs.WithContext("authfile", cfg.authPath()))
+	if jerr := json.NewEncoder(file).Encode(auth); jerr != nil {
+		err = errs.Wrap(jerr, errs.WithContext("authfile", cfg.authPath()))
+		return
 	}
-	return nil
+	return
 }
 
-/* Copyright 2023 Spiegel
+/* Copyright 2023-2026 Spiegel
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.