refactor: various improvements and added comments

Author: d-Rickyy-b

cmd/certstream-server-go/main.go

@@ -35,6 +35,7 @@ func main() {
 		if createErr != nil {
 			log.Fatalf("Error while creating index file: %v", createErr)
 		}
+
 		return
 	}
 

internal/certificatetransparency/ct-watcher.go

@@ -106,6 +106,7 @@ func (w *Watcher) updateLogs() {
 	}
 
 	w.addNewlyAvailableLogs(logList)
+
 	if *config.AppConfig.General.DropOldLogs {
 		w.dropRemovedLogs(logList)
 	}
@@ -133,6 +134,7 @@ func (w *Watcher) addNewlyAvailableLogs(logList loglist3.LogList) {
 
 			// Check if the log is already being watched
 			alreadyWatched := false
+
 			for _, ctWorker := range w.workers {
 				workerURL := normalizeCtlogURL(ctWorker.ctURL)
 				if workerURL == newURL {
@@ -360,11 +362,13 @@ func (w *worker) startDownloadingCerts(ctx context.Context) {
 		select {
 		case <-ctx.Done():
 			log.Printf("Context was cancelled; Stopping worker for '%s'\n", w.ctURL)
+
 			return
 		default:
 			log.Printf("Worker for '%s' sleeping for 5 seconds due to error\n", w.ctURL)
 			time.Sleep(5 * time.Second)
 			log.Printf("Restarting worker for '%s'\n", w.ctURL)
+
 			continue
 		}
 	}
@@ -535,6 +539,7 @@ func getAllLogs() (loglist3.LogList, error) {
 				// TODO Check if the log is already in the list
 				operator.Logs = append(operator.Logs, &customLog)
 				operatorFound = true
+
 				break
 			}
 		}

internal/certificatetransparency/logmetrics.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"maps"
 	"os"
 	"sync"
 	"time"
@@ -16,7 +17,7 @@ type (
 	OperatorMetric map[string]int64
 	// CTMetrics is a map of operator names to a map of CT log urls to the number of certs processed by said log.
 	CTMetrics map[string]OperatorMetric
-	// CTCertIndex is a map of CT log urls to the last processed certficate index on the said log
+	// CTCertIndex is a map of CT log urls to the last processed certficate index on the said log.
 	CTCertIndex map[string]uint64
 )
 
@@ -40,13 +41,7 @@ func (m *LogMetrics) GetCTMetrics() CTMetrics {
 	defer m.mutex.RUnlock()
 
 	copiedMap := make(CTMetrics)
-
-	for operator, urls := range m.metrics {
-		copiedMap[operator] = make(OperatorMetric)
-		for url, count := range urls {
-			copiedMap[operator][url] = count
-		}
-	}
+	maps.Copy(copiedMap, m.metrics)
 
 	return copiedMap
 }
@@ -132,20 +127,19 @@ func (m *LogMetrics) Inc(operator, url string, index uint64) {
 	m.index[url] = index
 }
 
+// GetAllCTIndexes returns a copy of the internal CT index map.
 func (m *LogMetrics) GetAllCTIndexes() CTCertIndex {
 	m.mutex.RLock()
 	defer m.mutex.RUnlock()
 
-	// make a copy of the index and return it
-	// since map is a refrence type
+	// make a copy of the index and return it, since map is a reference type
 	copyOfIndex := make(map[string]uint64)
-	for k, v := range m.index {
-		copyOfIndex[k] = v
-	}
+	maps.Copy(copyOfIndex, m.index)
 
 	return copyOfIndex
 }
 
+// GetCTIndex returns the last cert index processed for a given CT url.
 func (m *LogMetrics) GetCTIndex(url string) uint64 {
 	m.mutex.RLock()
 	defer m.mutex.RUnlock()
@@ -158,7 +152,7 @@ func (m *LogMetrics) GetCTIndex(url string) uint64 {
 	return index
 }
 
-// LoadCTIndex loads the last cert index processed for each CT url if it exists
+// LoadCTIndex loads the last cert index processed for each CT url if it exists.
 func (m *LogMetrics) LoadCTIndex(ctIndexFilePath string) {
 	m.mutex.Lock()
 	defer m.mutex.Unlock()
@@ -259,10 +253,12 @@ func (m *LogMetrics) SaveCertIndexes(tempFilePath, ctIndexFilePath string) {
 	}
 }
 
+// GetProcessedCerts returns the total number of processed certificates.
 func GetProcessedCerts() int64 {
 	return processedCerts
 }
 
+// GetProcessedPrecerts returns the total number of processed precertificates.
 func GetProcessedPrecerts() int64 {
 	return processedPrecerts
 }

internal/certstream/certstream.go

@@ -122,6 +122,7 @@ func (cs *Certstream) CreateIndexFile() error {
 	if cs.watcher == nil {
 		cs.watcher = &certificatetransparency.Watcher{}
 	}
+
 	return cs.watcher.CreateIndexFile(cs.config.General.Recovery.CTIndexFile)
 }
 

internal/config/config.go

@@ -184,7 +184,6 @@ func validateConfig(config *Config) bool {
 	}
 
 	if config.Prometheus.Enabled {
-
 		if config.Prometheus.ListenAddr == "" || net.ParseIP(config.Prometheus.ListenAddr) == nil {
 			log.Fatalln("Metrics export IP is not a valid IP")
 			return false
@@ -222,7 +221,7 @@ func validateConfig(config *Config) bool {
 
 			validLogs = append(validLogs, ctLog)
 		}
-	} else if (config.General.AdditionalLogs == nil || len(config.General.AdditionalLogs) == 0) && config.General.DisableDefaultLogs {
+	} else if len(config.General.AdditionalLogs) == 0 && config.General.DisableDefaultLogs {
 		log.Fatalln("Default logs are disabled, but no additional logs are configured. Please add at least one log to the config or enable default logs.")
 	}
 

internal/metrics/prometheus.go

@@ -61,7 +61,7 @@ func initCtLogMetrics() {
 	for operator, urls := range logs {
 		operator := operator // Copy variable to new scope
 
-		for i := 0; i < len(urls); i++ {
+		for i := range urls {
 			url := urls[i]
 			name := fmt.Sprintf("certstreamservergo_certs_by_log_total{url=\"%s\",operator=\"%s\"}", url, operator)
 			metrics.NewGauge(name, func() float64 {

internal/web/client.go

@@ -94,14 +94,17 @@ func (c *client) listenWebsocket() {
 	_ = c.conn.SetReadDeadline(time.Now().Add(readWait))
 
 	defaultPingHandler := c.conn.PingHandler()
+
 	c.conn.SetPingHandler(func(appData string) error {
 		// Ping received - reset the deadline
 		err := c.conn.SetReadDeadline(time.Now().Add(readWait))
 		if err != nil {
 			return err
 		}
+
 		return defaultPingHandler(appData)
 	})
+
 	c.conn.SetPongHandler(func(string) error {
 		// Pong received - reset the deadline
 		err := c.conn.SetReadDeadline(time.Now().Add(readWait))

internal/web/examplecert.go

@@ -29,6 +29,7 @@ func exampleDomains(w http.ResponseWriter, _ *http.Request) {
 	w.Write(exampleCert.JSONDomains()) //nolint:errcheck
 }
 
+// SetExampleCert sets one certificate as the example Cert that is returned by the example endpoints.
 func SetExampleCert(cert models.Entry) {
 	exampleCert = cert
 }

internal/web/server.go

@@ -25,6 +25,8 @@ var (
 	upgrader      websocket.Upgrader
 )
 
+// WebServer is a struct that holds the necessary information to run a webserver.
+// It is used for the websocket server as well as the metrics server.
 type WebServer struct {
 	networkIf string
 	port      int
@@ -38,7 +40,7 @@ type WebServer struct {
 // in order to provide metrics for a prometheus server. This function signature was used, because VictoriaMetrics
 // offers exactly this function signature.
 func (ws *WebServer) RegisterPrometheus(url string, callback func(w io.Writer, exposeProcessMetrics bool)) {
-	ws.routes.HandleFunc(url, func(w http.ResponseWriter, r *http.Request) {
+	ws.routes.HandleFunc(url, func(w http.ResponseWriter, _ *http.Request) {
 		callback(w, config.AppConfig.Prometheus.ExposeSystemMetrics)
 	})
 }
@@ -51,14 +53,17 @@ func IPWhitelist(whitelist []string) func(next http.Handler) http.Handler {
 	var cidrList []net.IPNet
 
 	for _, element := range whitelist {
-		ip, ipNet, err := net.ParseCIDR(element)
+		_, ipNet, err := net.ParseCIDR(element)
 		if err != nil {
+			var ip net.IP
 			if ip = net.ParseIP(element); ip == nil {
 				log.Println("Invalid IP in metrics whitelist: ", element)
+
 				continue
 			}
 
 			ipList = append(ipList, ip)
+
 			continue
 		}
 
@@ -262,7 +267,7 @@ func NewWebsocketServer(networkIf string, port int, certPath, keyPath string) *W
 
 	upgrader = websocket.Upgrader{
 		EnableCompression: config.AppConfig.Webserver.CompressionEnabled,
-		CheckOrigin: func(r *http.Request) bool {
+		CheckOrigin: func(_ *http.Request) bool {
 			// Allow all connections by default
 			return true
 		},
@@ -302,6 +307,7 @@ func (ws *WebServer) Start() {
 	}
 }
 
+// Stop tries to stop the webserver gracefully. If it doesn't stop within 15 seconds, it is forcefully closed.
 func (ws *WebServer) Stop() {
 	log.Println("Stopping webserver...")