fix: code adaptability issue fixes. (#54)

* fix: code adaptability issue fixes.

golangci-lint config has been refactored to not include things checked by SonarLint so
as to not have dual functionality.

* fix: fixed issue we'd read a file of arbitrary size when processing an RPC call body. We now have a configurable limit defaulting to 20 megs

* fix: fixed several code adaptability issues

* fix: fixed remaining linting issues

* fix: refactored switch statement

Author: MadsRC

.golangci.yaml

@@ -8,6 +8,7 @@ output:
       path: build/report.xml
     - format: colored-line-number
 linters:
+  disable-all: true
   enable:
     - errcheck
     - gosimple
@@ -16,43 +17,19 @@ linters:
     - staticcheck
     - unused
     - goimports
-    - goheader
     - gosec
     - forbidigo
-    - goconst
     - godot
-issues:
-  exclude-rules:
-    - linters:
-        - goheader
-      path: cache.go # This file already has a header with another license
+    - errname
+    - errorlint
+    - asasalint
+    - asciicheck
+    - bidichk
+    - errchkjson
+    - gochecknoinits
+#    - wrapcheck
+    - sloglint
+    - tenv
 linters-settings:
   goimports:
     local-prefixes: github.com/madsrc/sophrosyne
-  gofmt:
-    simplify: true
-    rewrite-rules:
-      - pattern: 'interface{}'
-        replacement: 'any'
-      - pattern: 'a[b:len(a)]'
-        replacement: 'a[b:]'
-  goheader:
-    values:
-      const:
-        AUTHOR: 'Mads R. Havmand'
-    template: |-
-      Sophrosyne
-        Copyright (C) {{ YEAR }}  {{ AUTHOR }}
-
-      This program is free software: you can redistribute it and/or modify
-        it under the terms of the GNU Affero General Public License as published by
-        the Free Software Foundation, either version 3 of the License, or
-        (at your option) any later version.
-
-        This program is distributed in the hope that it will be useful,
-        but WITHOUT ANY WARRANTY; without even the implied warranty of
-        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-        GNU Affero General Public License for more details.
-
-        You should have received a copy of the GNU Affero General Public License
-        along with this program.  If not, see <http://www.gnu.org/licenses/>.

.idea/sonarlint.xml

@@ -1,5 +1,5 @@
 #!/bin/sh
-# mise sources=["go.mod", "go.sum", "internal/**/*", "cmd/**/*", "*.go"]
+# mise sources=["go.mod", "go.sum", "internal/**/*", "cmd/**/*", "*.go", ".golangci.yaml]
 # mise outputs=["build/report.xml"]
 
 nofail=1

.mise/tasks/dev/lint

@@ -92,6 +92,9 @@ func main() {
 					validate := validator.NewValidator()
 
 					config, err := getConfig(c.String("config"), nil, c.StringSlice("secretfiles"), validate)
+					if err != nil {
+						return err
+					}
 					migrationService, err := migrate.NewMigrationService(config)
 					if err != nil {
 						return err
@@ -102,7 +105,7 @@ func main() {
 						if !errors.Is(err, migrate.ErrNoChange) {
 							return err
 						} else {
-							_, _ = fmt.Fprintf(c.App.Writer, "No migrations to apply")
+							_, _ = fmt.Fprint(c.App.Writer, "No migrations to apply")
 							return nil
 						}
 					}
@@ -116,7 +119,7 @@ func main() {
 					} else {
 						msg = fmt.Sprintf("%s\n", msg)
 					}
-					_, _ = fmt.Fprintf(c.App.Writer, msg)
+					_, _ = fmt.Fprint(c.App.Writer, msg)
 					return nil
 				},
 			},
@@ -345,7 +348,7 @@ func run(c *cli.Context) error {
 						config,
 						userService,
 						logger,
-						http.RPCHandler(logger, rpcServer),
+						http.RPCHandler(logger, rpcServer, config),
 					),
 				),
 			),

cmd/sophrosyne/main.go

@@ -77,8 +77,11 @@ var DefaultConfig = map[string]interface{}{
 	"services.profiles.cacheTTL":      100,
 	"services.checks.pageSize":        2,
 	"services.checks.cacheTTL":        100,
+	"server.maxBodySize":              20 * megabyte,
 }
 
+const megabyte int64 = 1048576
+
 // The Config struct is used to store the configuration of the application.
 //
 // The ConfigProvider interface is used to retrieve the configuration of the
@@ -103,7 +106,8 @@ type Config struct {
 		Name     string `key:"name" validate:"required"`
 	} `key:"database"`
 	Server struct {
-		Port int `key:"port" validate:"required,min=1,max=65535"`
+		Port        int   `key:"port" validate:"required,min=1,max=65535"`
+		MaxBodySize int64 `key:"maxBodySize" validate:"required,min=1"` // in bytes
 	} `key:"server"`
 	Logging struct {
 		Enabled bool      `key:"enabled"`

config.go

@@ -49,22 +49,22 @@ func envExtractor(s string, v string) (string, interface{}) {
 }
 
 func loadConfig(k *koanf.Koanf, defaultConfig map[string]interface{}, yamlFile koanf.Provider, overwrites map[string]interface{}, secretFiles []string) error {
-	k.Load(confmap.Provider(defaultConfig, sophrosyne.ConfigDelimiter), nil)
+	_ = k.Load(confmap.Provider(defaultConfig, sophrosyne.ConfigDelimiter), nil)
 
 	if err := loadYamlConfig(k, yamlFile); err != nil {
 		return err
 	}
 
-	k.Load(env.ProviderWithValue(sophrosyne.ConfigEnvironmentPrefix, sophrosyne.ConfigDelimiter, envExtractor), nil)
+	_ = k.Load(env.ProviderWithValue(sophrosyne.ConfigEnvironmentPrefix, sophrosyne.ConfigDelimiter, envExtractor), nil)
 
-	k.Load(confmap.Provider(overwrites, sophrosyne.ConfigDelimiter), nil)
+	_ = k.Load(confmap.Provider(overwrites, sophrosyne.ConfigDelimiter), nil)
 
 	for _, secretFile := range secretFiles {
 		secret, err := secretFromFile(secretFile)
 		if err != nil {
 			return err
 		}
-		k.Load(confmap.Provider(secret, sophrosyne.ConfigDelimiter), nil)
+		_ = k.Load(confmap.Provider(secret, sophrosyne.ConfigDelimiter), nil)
 	}
 
 	return nil
@@ -97,7 +97,7 @@ func NewConfigProvider(yamlFilePath string, overwrites map[string]interface{}, s
 		return nil, err
 	}
 
-	yamlFile.Watch(func(event interface{}, err error) {
+	_ = yamlFile.Watch(func(event interface{}, err error) {
 		if err != nil {
 			// Error occurred when watching the file.
 			return
@@ -111,7 +111,7 @@ func NewConfigProvider(yamlFilePath string, overwrites map[string]interface{}, s
 			return
 		}
 		newConf := &sophrosyne.Config{}
-		cfgProv.k.UnmarshalWithConf("", newConf, koanf.UnmarshalConf{Tag: "key"})
+		_ = cfgProv.k.UnmarshalWithConf("", newConf, koanf.UnmarshalConf{Tag: "key"})
 		err = cfgProv.validate.Validate(newConf)
 		if err != nil {
 			// Error occurred when validating the config.
@@ -124,7 +124,7 @@ func NewConfigProvider(yamlFilePath string, overwrites map[string]interface{}, s
 		*cfgProv.config = *newConf
 	})
 
-	cfgProv.k.UnmarshalWithConf("", cfgProv.config, koanf.UnmarshalConf{Tag: "key"})
+	_ = cfgProv.k.UnmarshalWithConf("", cfgProv.config, koanf.UnmarshalConf{Tag: "key"})
 
 	err := cfgProv.validate.Validate(cfgProv.config)
 	if err != nil {

internal/configProvider/config.go

@@ -84,10 +84,10 @@ func (s *Server) Handle(path string, handler http.Handler) {
 const JSONContentType = "application/json"
 const PlainTextContentType = "text/plain"
 
-func RPCHandler(logger *slog.Logger, rpcService sophrosyne.RPCServer) http.Handler {
+func RPCHandler(logger *slog.Logger, rpcService sophrosyne.RPCServer, config *sophrosyne.Config) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 
-		body, err := io.ReadAll(r.Body) // Find a way to implement a limit on the body size
+		body, err := io.ReadAll(http.MaxBytesReader(w, r.Body, config.Server.MaxBodySize))
 		if err != nil {
 			logger.ErrorContext(r.Context(), "failed to read request body", "error", err)
 			WriteInternalServerError(r.Context(), w, logger)

internal/http/http.go

@@ -132,7 +132,7 @@ func (p *CheckService) GetChecks(ctx context.Context, cursor *sophrosyne.Databas
 		cursor = &sophrosyne.DatabaseCursor{}
 	}
 	p.logger.DebugContext(ctx, "getting checks", "cursor", cursor)
-	rows, err := p.pool.Query(ctx, `SELECT * FROM checks WHERE id > $1 AND deleted_at IS NULL ORDER BY id ASC LIMIT $2`, cursor.Position, p.config.Services.Checks.PageSize+1)
+	rows, _ := p.pool.Query(ctx, `SELECT * FROM checks WHERE id > $1 AND deleted_at IS NULL ORDER BY id ASC LIMIT $2`, cursor.Position, p.config.Services.Checks.PageSize+1)
 	checks, err := pgx.CollectRows(rows, pgx.RowToStructByNameLax[sophrosyne.Check])
 	if err != nil {
 		return []sophrosyne.Check{}, err
@@ -154,7 +154,9 @@ func (p *CheckService) CreateCheck(ctx context.Context, check sophrosyne.CreateC
 	if err != nil {
 		return sophrosyne.Check{}, err
 	}
-	defer tx.Rollback(ctx)
+	defer func() {
+		_ = tx.Rollback(ctx)
+	}()
 
 	rows, _ := tx.Query(ctx, `INSERT INTO checks (name, upstream_services) VALUES ($1, $2) RETURNING *`, check.Name, check.UpstreamServices)
 	retP, err := pgx.CollectOneRow(rows, pgx.RowToAddrOfStructByNameLax[checkDbEntry])
@@ -220,7 +222,9 @@ func (p *CheckService) UpdateCheck(ctx context.Context, check sophrosyne.UpdateC
 	if err != nil {
 		return sophrosyne.Check{}, err
 	}
-	defer tx.Rollback(ctx)
+	defer func() {
+		_ = tx.Rollback(ctx)
+	}()
 
 	rows, _ := tx.Query(ctx, `SELECT id FROM checks WHERE name = $1 AND deleted_at IS NULL`, check.Name)
 	pp, err := pgx.CollectOneRow(rows, pgx.RowToStructByNameLax[sophrosyne.Check])

internal/pgx/checks.go

@@ -253,7 +253,7 @@ func (s *UserService) createRootUser(ctx context.Context) error {
 	}
 	defer func() {
 		s.logger.DebugContext(ctx, "rolling back transaction")
-		tx.Rollback(ctx)
+		_ = tx.Rollback(ctx)
 	}()
 	// Check if root user exists and exit early if it does
 	var exists bool

internal/pgx/pgx.go

@@ -127,7 +127,7 @@ func (p *ProfileService) GetProfiles(ctx context.Context, cursor *sophrosyne.Dat
 		cursor = &sophrosyne.DatabaseCursor{}
 	}
 	p.logger.DebugContext(ctx, "getting profiles", "cursor", cursor)
-	rows, err := p.pool.Query(ctx, `SELECT * FROM profiles WHERE id > $1 AND deleted_at IS NULL ORDER BY id ASC LIMIT $2`, cursor.Position, p.config.Services.Profiles.PageSize+1)
+	rows, _ := p.pool.Query(ctx, `SELECT * FROM profiles WHERE id > $1 AND deleted_at IS NULL ORDER BY id ASC LIMIT $2`, cursor.Position, p.config.Services.Profiles.PageSize+1)
 	profiles, err := pgx.CollectRows(rows, pgx.RowToStructByNameLax[sophrosyne.Profile])
 	if err != nil {
 		return []sophrosyne.Profile{}, err
@@ -149,7 +149,9 @@ func (p *ProfileService) CreateProfile(ctx context.Context, profile sophrosyne.C
 	if err != nil {
 		return sophrosyne.Profile{}, err
 	}
-	defer tx.Rollback(ctx)
+	defer func() {
+		_ = tx.Rollback(ctx)
+	}()
 
 	rows, _ := tx.Query(ctx, `INSERT INTO profiles (name) VALUES ($1) RETURNING *`, profile.Name)
 	retP, err := pgx.CollectOneRow(rows, pgx.RowToAddrOfStructByNameLax[sophrosyne.Profile])
@@ -190,7 +192,9 @@ func (p *ProfileService) UpdateProfile(ctx context.Context, profile sophrosyne.U
 	if err != nil {
 		return sophrosyne.Profile{}, err
 	}
-	defer tx.Rollback(ctx)
+	defer func() {
+		_ = tx.Rollback(ctx)
+	}()
 
 	rows, _ := tx.Query(ctx, `SELECT id FROM profiles WHERE name = $1 AND deleted_at IS NULL`, profile.Name)
 	pp, err := pgx.CollectOneRow(rows, pgx.RowToStructByNameLax[sophrosyne.Profile])