New lint rules

Author: jc21

backend/.golangci.yml

@@ -1,63 +1,166 @@
+---
 linters:
-    enable:
-        - bodyclose
-        - errcheck
-        - gosimple
-        - govet
-        - gosec
-        - goconst
-        - gocritic
-        - gocyclo
-        - gofmt
-        - goimports
-        - ineffassign
-        - misspell
-        - nakedret
-        - prealloc
-        #- revive
-        - staticcheck
-        - typecheck
-        - unused
-        - unconvert
-        - unparam
+  enable:
+    # Prevents against memory leaks in production caused by not closing
+    # file handle
+    - bodyclose
+    # Detects cloned code. DRY is good programming practice. Can cause issues
+    # with testing code where simplicity is preferred over duplication.
+    # Disabled for test code.
+    # - dupl
+    # Detects unchecked errors in go programs. These unchecked errors can be
+    # critical bugs in some cases.
+    - errcheck
+    # Simplifies go code.
+    - gosimple
+    # Controls Go package import order and makes it always deterministic.
+    - gci
+    # Reports suspicious constructs, maintained by goteam. e.g. Printf unused
+    # params not caught at compile time.
+    - govet
+    # Detect security issues with gocode. Use of secrets in code or obsolete
+    # security algorithms. It's imaged heuristic methods are used in finding
+    # problems. If issues with rules are found particular rules can be disabled
+    # as required. Could possibility cause issues with testing.
+    # Disabled for test code.
+    - gosec
+    # Detect repeated strings that could be replaced by a constant
+    - goconst
+    # Misc linters missing from other projects. Grouped into 3 categories
+    # diagnostics, style and performance
+    - gocritic
+    # Limits code cyclomatic complexity
+    - gocyclo
+    # Detects if code needs to be gofmt'd
+    - gofmt
+    # Detects unused go package imports
+    - goimports
+    # Detects style mistakes not correctness. Golint is meant to carry out the
+    # stylistic conventions put forth in Effective Go and CodeReviewComments.
+    # golint has false positives and false negatives and can be tweaked.
+    - revive
+    # Detects ineffectual assignments in code
+    - ineffassign
+    # Reports long lines
+    # - lll
+    # Detect commonly misspelled english words in comments
+    - misspell
+    # Detect naked returns on non-trivial functions, and conform with
+    # Go CodeReviewComments
+    - nakedret
+    # Detect slice allocations that can be preallocated
+    - prealloc
+    # Misc collection of static analysis tools
+    - staticcheck
+    # Detects unused struct fields
+    # - structcheck
+    # Parses and typechecks the code like the go compiler
+    - typecheck
+    # Detects unused constants, variables, functions and types
+    - unused
+    # Remove unnecessary type conversions
+    - unconvert
+    # Remove unnecessary(unused) function parameters
+    - unparam
 linters-settings:
-    gosec:
-      excludes:
-        - G115
-    errcheck:
-      exclude-functions:
-        - fmt.Fprint
-        - fmt.Fprintf
-    goconst:
-        # minimal length of string constant
-        # default: 3
-        min-len: 2
-        # minimum number of occurrences of string constant
-        # default: 3
-        min-occurences: 2
-    misspell:
-        locale: UK
-        ignore-words:
-            - color
+  errcheck:
+    exclude-functions:
+      - fmt.Fprint
+      - fmt.Fprintf
+  gci:
+    sections:
+      - standard            # Standard section: captures all standard packages.
+      - localmodule         # Local module section: contains all local packages.
+      # - prefix(gogs.jc21.com)  # Prefixed gerrit.lan packages (jumgo).
+      - default             # Everything else (github.com, golang.org, etc).
+      - blank               # Blank section: contains all blank imports.
+    custom-order: true
+  goconst:
+    # minimal length of string constant
+    # default: 3
+    min-len: 2
+    # minimum number of occurrences of string constant
+    # default: 3
+    min-occurences: 2
+  revive:
+    enable-all-rules: true
+    rules:
+      - name: unchecked-type-assertion
+        disabled: true
+      # handled by goconst
+      - name: add-constant
+        disabled: true
+      # cant limit this arbitrarily
+      - name: argument-limit
+        disabled: true
+      # handled by gocyclo
+      - name: cognitive-complexity
+        disabled: true
+      # false positive for Exported vs non-exported functions of the same name
+      - name: confusing-naming
+        disabled: true
+      # false positives for "" - which is the nil value of a string (also 0)
+      - name: confusing-results
+        disabled: true
+      # handled by gocyclo
+      - name: cyclomatic
+        disabled: true
+      # have comments on exported functions but not on vars/types/constants
+      - name: exported
+        arguments:
+          - "disableChecksOnConstants"
+          - "disableChecksOnTypes"
+          - "disableChecksOnVariables"
+      # false positives on bool params
+      - name: flag-parameter
+        disabled: true
+      # extreme verticalization can happen
+      - name: function-length
+        disabled: true
+      # can false positive for non-getters
+      - name: get-return
+        disabled: true
+      # only allows lowercase names
+      - name: import-alias-naming
+        disabled: true
+      # handled by lll
+      - name: line-length-limit
+        disabled: true
+      # don't want to arbitrarily limit this
+      # many places have specific model.go files to contain all structs
+      - name: max-public-structs
+        disabled: true
+      # disable package-comments
+      - name: package-comments
+        disabled: true
+      # this is handled by errcheck
+      - name: unhandled-error
+        disabled: true
+      - name: function-result-limit
+        disabled: true
 issues:
-    # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
-    # We have chosen an arbitrary value that works based on practical usage.
-    max-same: 20
-    # See cmdline flag documentation for more info about default excludes --exclude-use-default
-    # Nothing is excluded by default
-    exclude-use-default: false
-    # Excluding configuration per-path, per-linter, per-text and per-source
-    exclude-rules:
-        # Exclude some linters from running on tests files. # TODO: Add examples why this is good
-
-        - path: _test\.go
-          linters:
-              # Tests should be simple? Add example why this is good?
-              - gocyclo
-              # Error checking adds verbosity and complexity for minimal value
-              - errcheck
-              # Table test encourage duplication in defining the table tests.
-              - dupl
-              # Hard coded example tokens, SQL injection and other bad practices may
-              # want to be tested
-              - gosec
+  # Maximum count of issues with the same text. Set to 0 to disable. Default
+  # is 3. We have chosen an arbitrary value that works based on practical usage.
+  max-same: 20
+  # See cmdline flag documentation for more info about default excludes
+  # --exclude-use-default. Nothing is excluded by default
+  exclude-use-default: false
+  # Excluding configuration per-path, per-linter, per-text and per-source
+  exclude-rules:
+    # Exclude some linters from running on tests files.
+    # TODO: Add examples why this is good
+    - path: _test\.go
+      linters:
+        # Tests should be simple? Add example why this is good?
+        - gocyclo
+        # Error checking adds verbosity and complexity for minimal value
+        - errcheck
+        # Table test encourage duplication in defining the table tests.
+        - dupl
+        # Hard coded example tokens, SQL injection and other bad practices may
+        # want to be tested
+        - gosec
+        # Test data can long
+        # - lll
+run:
+  go: '1.23'

backend/internal/api/handler/auth.go

@@ -3,17 +3,17 @@ package handler
 import (
 	"encoding/json"
 	"net/http"
-	h "npm/internal/api/http"
-	"npm/internal/errors"
-	"npm/internal/logger"
 	"slices"
 	"time"
 
 	c "npm/internal/api/context"
+	h "npm/internal/api/http"
 	"npm/internal/entity/auth"
 	"npm/internal/entity/setting"
 	"npm/internal/entity/user"
+	"npm/internal/errors"
 	njwt "npm/internal/jwt"
+	"npm/internal/logger"
 
 	"gorm.io/gorm"
 )

backend/internal/api/handler/certificates.go

@@ -151,7 +151,7 @@ func getCertificateFromRequest(w http.ResponseWriter, r *http.Request) *certific
 
 // fillObjectFromBody has some reusable code for all endpoints that
 // have a certificate id in the url. it will write errors to the output.
-func fillObjectFromBody(w http.ResponseWriter, r *http.Request, validationSchema string, o interface{}) bool {
+func fillObjectFromBody(w http.ResponseWriter, r *http.Request, validationSchema string, o any) bool {
 	bodyBytes, _ := r.Context().Value(c.BodyCtxKey).([]byte)
 
 	if validationSchema != "" {
@@ -176,10 +176,10 @@ func fillObjectFromBody(w http.ResponseWriter, r *http.Request, validationSchema
 	return true
 }
 
-func configureCertificate(c certificate.Model) {
+func configureCertificate(cert certificate.Model) {
 	err := jobqueue.AddJob(jobqueue.Job{
 		Name:   "RequestCertificate",
-		Action: c.Request,
+		Action: cert.Request,
 	})
 	if err != nil {
 		logger.Error("ConfigureCertificateError", err)

backend/internal/api/handler/config.go

@@ -2,6 +2,7 @@ package handler
 
 import (
 	"net/http"
+
 	h "npm/internal/api/http"
 	"npm/internal/config"
 )

backend/internal/api/handler/health.go

@@ -2,6 +2,7 @@ package handler
 
 import (
 	"net/http"
+
 	"npm/internal/acme"
 	h "npm/internal/api/http"
 	"npm/internal/config"

backend/internal/api/handler/helpers.go

@@ -56,7 +56,7 @@ func getQueryVarInt(r *http.Request, varName string, required bool, defaultValue
 }
 
 func getURLParamInt(r *http.Request, varName string) (uint, error) {
-	var defaultValue uint = 0
+	var defaultValue uint
 
 	required := true
 	paramStr := chi.URLParam(r, varName)

backend/internal/api/handler/helpers_test.go

@@ -3,9 +3,10 @@ package handler
 import (
 	"net/http"
 	"net/http/httptest"
-	"npm/internal/model"
 	"testing"
 
+	"npm/internal/model"
+
 	"github.com/stretchr/testify/assert"
 )
 

backend/internal/api/handler/hosts.go

@@ -192,7 +192,7 @@ func GetHostNginxConfig(format string) func(http.ResponseWriter, *http.Request)
 				return
 			}
 			if format == "text" {
-				h.ResultResponseText(w, r, http.StatusOK, content)
+				h.ResultResponseText(w, http.StatusOK, content)
 				return
 			}
 			h.ResultResponseJSON(w, r, http.StatusOK, content)
@@ -202,11 +202,11 @@ func GetHostNginxConfig(format string) func(http.ResponseWriter, *http.Request)
 	}
 }
 
-func configureHost(h host.Model) {
+func configureHost(hst host.Model) {
 	err := jobqueue.AddJob(jobqueue.Job{
 		Name: "NginxConfigureHost",
 		Action: func() error {
-			return nginx.ConfigureHost(h)
+			return nginx.ConfigureHost(hst)
 		},
 	})
 	if err != nil {

backend/internal/api/handler/schema.go

@@ -12,7 +12,7 @@ import (
 	"npm/internal/config"
 	"npm/internal/logger"
 
-	jsref "github.com/jc21/jsref"
+	"github.com/jc21/jsref"
 	"github.com/jc21/jsref/provider"
 )
 
@@ -24,7 +24,7 @@ var (
 // Schema simply reads the swagger schema from disk and returns is raw
 // Route: GET /schema
 func Schema() func(http.ResponseWriter, *http.Request) {
-	return func(w http.ResponseWriter, r *http.Request) {
+	return func(w http.ResponseWriter, _ *http.Request) {
 		w.Header().Set("Content-Type", "application/json; charset=utf-8")
 		w.WriteHeader(http.StatusOK)
 		fmt.Fprint(w, string(getSchema()))
@@ -42,8 +42,8 @@ func getSchema() []byte {
 		swaggerSchema = []byte(strings.ReplaceAll(string(swaggerSchema), "{{VERSION}}", config.Version))
 
 		// Dereference the JSON Schema:
-		var schema interface{}
-		if err := json.Unmarshal(swaggerSchema, &schema); err != nil {
+		var sch any
+		if err := json.Unmarshal(swaggerSchema, &sch); err != nil {
 			logger.Error("SwaggerUnmarshalError", err)
 			return nil
 		}
@@ -55,7 +55,7 @@ func getSchema() []byte {
 			logger.Error("SchemaProviderError", err)
 		}
 
-		result, err := resolver.Resolve(schema, "", []jsref.Option{jsref.WithRecursiveResolution(true)}...)
+		result, err := resolver.Resolve(sch, "", []jsref.Option{jsref.WithRecursiveResolution(true)}...)
 		if err != nil {
 			logger.Error("SwaggerResolveError", err)
 		} else {

backend/internal/api/handler/upstreams.go

@@ -95,7 +95,7 @@ func CreateUpstream() func(http.ResponseWriter, *http.Request) {
 	}
 }
 
-// UpdateHost updates a host
+// UpdateUpstream updates a stream
 // Route: PUT /upstreams/{upstreamID}
 func UpdateUpstream() func(http.ResponseWriter, *http.Request) {
 	return func(w http.ResponseWriter, r *http.Request) {
@@ -167,7 +167,7 @@ func DeleteUpstream() func(http.ResponseWriter, *http.Request) {
 	}
 }
 
-// GetHostNginxConfig will return a Host's nginx config from disk
+// GetUpstreamNginxConfig will return a Host's nginx config from disk
 // Route: GET /upstreams/{upstreamID}/nginx-config
 // Route: GET /upstreams/{upstreamID}/nginx-config.txt
 func GetUpstreamNginxConfig(format string) func(http.ResponseWriter, *http.Request) {
@@ -191,7 +191,7 @@ func GetUpstreamNginxConfig(format string) func(http.ResponseWriter, *http.Reque
 				return
 			}
 			if format == "text" {
-				h.ResultResponseText(w, r, http.StatusOK, content)
+				h.ResultResponseText(w, http.StatusOK, content)
 				return
 			}
 			h.ResultResponseJSON(w, r, http.StatusOK, content)