Improve logging and make linter happy

netquery/database.go

@@ -112,7 +112,7 @@ type (
 	}
 )
 
-// New opens a new in-memory database named path.
+// New opens a new in-memory database named path and attaches a persistent history database.
 //
 // The returned Database used connection pooling for read-only connections
 // (see Execute). To perform database writes use either Save() or ExecuteWrite().
@@ -131,7 +131,6 @@ func New(dbPath string) (*Database, error) {
 			dbPath,
 			sqlite.OpenReadOnly,
 			sqlite.OpenSharedCache,
-			//sqlite.OpenMemory,
 			sqlite.OpenURI,
 		)
 		if err != nil {
@@ -171,7 +170,6 @@ func New(dbPath string) (*Database, error) {
 		sqlite.OpenReadWrite,
 		sqlite.OpenWAL,
 		sqlite.OpenSharedCache,
-		//sqlite.OpenMemory,
 		sqlite.OpenURI,
 	)
 	if err != nil {
@@ -337,11 +335,14 @@ func (db *Database) Cleanup(ctx context.Context, threshold time.Time) (int, erro
 	return result[0].Count, nil
 }
 
+// RemoveAllHistoryData removes all connections from the history database.
 func (db *Database) RemoveAllHistoryData(ctx context.Context) error {
 	query := fmt.Sprintf("DELETE FROM %s.connections", HistoryDatabase)
 	return db.ExecuteWrite(ctx, query)
 }
 
+// RemoveHistoryForProfile removes all connections from the history database
+// for a given profile ID (source/id).
 func (db *Database) RemoveHistoryForProfile(ctx context.Context, profileID string) error {
 	query := fmt.Sprintf("DELETE FROM %s.connections WHERE profile = :profile", HistoryDatabase)
 	return db.ExecuteWrite(ctx, query, orm.WithNamedArgs(map[string]any{
@@ -389,13 +390,15 @@ func (db *Database) MarkAllHistoryConnectionsEnded(ctx context.Context) error {
 	return nil
 }
 
-func (db *Database) UpdateBandwidth(ctx context.Context, enableHistory bool, processKey string, connID string, incoming *uint64, outgoing *uint64) error {
+// UpdateBandwidth updates bandwidth data for the connection and optionally also writes
+// the bandwidth data to the history database.
+func (db *Database) UpdateBandwidth(ctx context.Context, enableHistory bool, processKey string, connID string, bytesReceived uint64, bytesSent uint64) error {
 	data := connID + "-" + processKey
 	hash := sha256.Sum256([]byte(data))
-	dbConnId := hex.EncodeToString(hash[:])
+	dbConnID := hex.EncodeToString(hash[:])
 
 	params := map[string]any{
-		":id": dbConnId,
+		":id": dbConnID,
 	}
 
 	parts := []string{}
@@ -439,7 +442,7 @@ func (db *Database) UpdateBandwidth(ctx context.Context, enableHistory bool, pro
 func (db *Database) Save(ctx context.Context, conn Conn, enableHistory bool) error {
 	// convert the connection to a param map where each key is already translated
 	// to the sql column name. We also skip bytes_received and bytes_sent since those
-	// will be updated independenly from the connection object.
+	// will be updated independently from the connection object.
 	connMap, err := orm.ToParamMap(ctx, conn, "", orm.DefaultEncodeConfig, []string{
 		"bytes_received",
 		"bytes_sent",

netquery/manager.go

@@ -31,16 +31,16 @@ type (
 		// database as ended NOW.
 		MarkAllHistoryConnectionsEnded(context.Context) error
 
-		// RemoveHistoryForProfile removes all connections from the history database
-		// for a given profile ID (source/id)
-		RemoveHistoryForProfile(context.Context, string) error
-
 		// RemoveAllHistoryData removes all connections from the history database.
 		RemoveAllHistoryData(context.Context) error
 
-		// UpdateBandwidth updates bandwith data for the connection and optionally also writes
+		// RemoveHistoryForProfile removes all connections from the history database.
+		// for a given profile ID (source/id)
+		RemoveHistoryForProfile(context.Context, string) error
+
+		// UpdateBandwidth updates bandwidth data for the connection and optionally also writes
 		// the bandwidth data to the history database.
-		UpdateBandwidth(ctx context.Context, enableHistory bool, processKey string, connID string, incoming *uint64, outgoing *uint64) error
+		UpdateBandwidth(ctx context.Context, enableHistory bool, processKey string, connID string, bytesReceived uint64, bytesSent uint64) error
 	}
 
 	// Manager handles new and updated network.Connections feeds and persists them

netquery/module_api.go

@@ -8,6 +8,7 @@ import (
 	"time"
 
 	"github.com/hashicorp/go-multierror"
+
 	"github.com/safing/portbase/api"
 	"github.com/safing/portbase/config"
 	"github.com/safing/portbase/database"
@@ -19,6 +20,7 @@ import (
 	"github.com/safing/portmaster/network"
 )
 
+// DefaultModule is the default netquery module.
 var DefaultModule *module
 
 type module struct {
@@ -120,8 +122,6 @@ func (m *module) prepare() error {
 				ProfileIDs []string `json:"profileIDs"`
 			}
 
-			defer r.Body.Close()
-
 			dec := json.NewDecoder(r.Body)
 			dec.DisallowUnknownFields()
 
@@ -240,7 +240,7 @@ func (m *module) stop() error {
 	if err := m.mng.store.MarkAllHistoryConnectionsEnded(ctx); err != nil {
 		// handle the error by just logging it. There's not much we can do here
 		// and returning an error to the module system doesn't help much as well...
-		log.Errorf("failed to mark connections in history database as eded: %w", err)
+		log.Errorf("netquery: failed to mark connections in history database as ended: %s", err)
 	}
 
 	return nil

netquery/orm/query_runner.go

@@ -148,7 +148,7 @@ func RunQuery(ctx context.Context, conn *sqlite.Conn, sql string, modifiers ...Q
 				for colIdx := 0; colIdx < stmt.ColumnCount(); colIdx++ {
 					name := stmt.ColumnName(colIdx)
 
-					switch stmt.ColumnType(colIdx) {
+					switch stmt.ColumnType(colIdx) { //nolint:exhaustive // TODO: handle type BLOB?
 					case sqlite.TypeText:
 						resultDump[name] = stmt.ColumnText(colIdx)
 					case sqlite.TypeFloat:

netquery/orm/schema_builder.go

@@ -7,8 +7,9 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/safing/portbase/log"
 	"zombiezen.com/go/sqlite"
+
+	"github.com/safing/portbase/log"
 )
 
 var errSkipStructField = errors.New("struct field should be skipped")
@@ -110,13 +111,13 @@ func (def ColumnDef) AsSQL() string {
 	}
 	if def.Default != nil {
 		sql += " DEFAULT "
-		switch def.Type {
+		switch def.Type { //nolint:exhaustive // TODO: handle types BLOB, NULL?
 		case sqlite.TypeFloat:
-			sql += strconv.FormatFloat(def.Default.(float64), 'b', 0, 64)
+			sql += strconv.FormatFloat(def.Default.(float64), 'b', 0, 64) //nolint:forcetypeassert
 		case sqlite.TypeInteger:
-			sql += strconv.FormatInt(def.Default.(int64), 10)
+			sql += strconv.FormatInt(def.Default.(int64), 10) //nolint:forcetypeassert
 		case sqlite.TypeText:
-			sql += fmt.Sprintf("%q", def.Default.(string))
+			sql += fmt.Sprintf("%q", def.Default.(string)) //nolint:forcetypeassert
 		default:
 			log.Errorf("unsupported default value: %q %q", def.Type, def.Default)
 			sql = strings.TrimSuffix(sql, " DEFAULT ")
@@ -257,7 +258,7 @@ func applyStructFieldTag(fieldType reflect.StructField, def *ColumnDef) error {
 
 				if strings.HasPrefix(k, TagTypePrefixDefault) {
 					defaultValue := strings.TrimPrefix(k, TagTypePrefixDefault)
-					switch def.Type {
+					switch def.Type { //nolint:exhaustive
 					case sqlite.TypeFloat:
 						fv, err := strconv.ParseFloat(defaultValue, 64)
 						if err != nil {

netquery/query.go

@@ -14,8 +14,10 @@ import (
 	"github.com/safing/portmaster/netquery/orm"
 )
 
+// DatabaseName is a database name constant.
 type DatabaseName string
 
+// Databases.
 const (
 	LiveDatabase    = DatabaseName("main")
 	HistoryDatabase = DatabaseName("history")

netquery/query_handler.go

@@ -12,9 +12,10 @@ import (
 	"strings"
 	"time"
 
+	"golang.org/x/exp/slices"
+
 	"github.com/safing/portbase/log"
 	"github.com/safing/portmaster/netquery/orm"
-	"golang.org/x/exp/slices"
 )
 
 var charOnlyRegexp = regexp.MustCompile("[a-zA-Z]+")