Merge pull request #362 from dunglas/fix/linters

fix: errors raised by golangci-lint

cmd/root.go

@@ -3,10 +3,9 @@ package cmd
 import (
 	"fmt"
 
-	log "github.com/sirupsen/logrus"
-
 	"github.com/dunglas/mercure/common"
 	"github.com/dunglas/mercure/hub"
+	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )

hub/authorization.go

@@ -195,6 +195,7 @@ func canDispatch(s *TopicSelectorStore, topics, topicSelectors []string) bool {
 
 			if s.match(topic, topicSelector, false) {
 				matched = true
+
 				break
 			}
 		}

hub/authorization_test.go

@@ -4,10 +4,9 @@ import (
 	"net/http"
 	"testing"
 
+	"github.com/dgrijalva/jwt-go"
 	"github.com/spf13/viper"
 	"github.com/stretchr/testify/assert"
-
-	"github.com/dgrijalva/jwt-go"
 )
 
 const (

hub/bolt_transport.go

@@ -10,9 +10,8 @@ import (
 	"strconv"
 	"sync"
 
-	bolt "go.etcd.io/bbolt"
-
 	log "github.com/sirupsen/logrus"
+	bolt "go.etcd.io/bbolt"
 )
 
 const defaultBoltBucketName = "updates"
@@ -202,6 +201,7 @@ func (t *BoltTransport) dispatchHistory(s *Subscriber, toSeq uint64) {
 		b := tx.Bucket([]byte(t.bucketName))
 		if b == nil {
 			s.HistoryDispatched(EarliestLastEventID)
+
 			return nil // No data
 		}
 
@@ -222,11 +222,13 @@ func (t *BoltTransport) dispatchHistory(s *Subscriber, toSeq uint64) {
 			if err := json.Unmarshal(v, &update); err != nil {
 				s.HistoryDispatched(responseLastEventID)
 				log.Error(fmt.Errorf("bolt history: %w", err))
+
 				return err
 			}
 
 			if !s.Dispatch(update, true) || (toSeq > 0 && binary.BigEndian.Uint64(k[:8]) >= toSeq) {
 				s.HistoryDispatched(responseLastEventID)
+
 				return nil
 			}
 		}
@@ -250,6 +252,7 @@ func (t *BoltTransport) Close() (err error) {
 
 		err = t.db.Close()
 	})
+
 	return err
 }
 
@@ -258,7 +261,7 @@ func (t *BoltTransport) cleanup(bucket *bolt.Bucket, lastID uint64) error {
 	if t.size == 0 ||
 		t.cleanupFrequency == 0 ||
 		t.size >= lastID ||
-		(t.cleanupFrequency != 1 && rand.Float64() < t.cleanupFrequency) {
+		(t.cleanupFrequency != 1 && rand.Float64() < t.cleanupFrequency) { // nolint:gosec
 		return nil
 	}
 

hub/bolt_transport_test.go

@@ -319,6 +319,7 @@ func TestBoltLastEventID(t *testing.T) {
 
 		// The DB is append only
 		bucket.FillPercent = 1
+
 		return bucket.Put(key, []byte("invalid"))
 	})
 	require.Nil(t, db.Close())

hub/config.go

@@ -53,6 +53,7 @@ func ValidateConfig(v *viper.Viper) error {
 			return fmt.Errorf(`%w: if the "metrics_password" configuration parameter is defined, "metrics_login" must be defined too`, ErrInvalidConfig)
 		}
 	}
+
 	return nil
 }
 

hub/hub_test.go

@@ -51,6 +51,7 @@ func TestNewHubTransportValidationError(t *testing.T) {
 func TestStartCrash(t *testing.T) {
 	if os.Getenv("BE_START_CRASH") == "1" {
 		Start()
+
 		return
 	}
 	cmd := exec.Command(os.Args[0], "-test.run=TestStartCrash") // nolint:gosec
@@ -110,6 +111,7 @@ func createDummyAuthorizedJWT(h *Hub, r role, topics []string) string {
 	}
 
 	tokenString, _ := token.SignedString(key)
+
 	return tokenString
 }
 

hub/publish.go

@@ -8,27 +8,35 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
+func logAccessError(r *http.Request, err error) {
+	if err == nil {
+		log.WithFields(log.Fields{"remote_addr": r.RemoteAddr}).Info("topic selectors not matched or not provided")
+
+		return
+	}
+	log.WithFields(log.Fields{"remote_addr": r.RemoteAddr}).Info(err)
+}
+
 // PublishHandler allows publisher to broadcast updates to all subscribers.
 func (h *Hub) PublishHandler(w http.ResponseWriter, r *http.Request) {
 	claims, err := authorize(r, h.getJWTKey(rolePublisher), h.getJWTAlgorithm(rolePublisher), h.config.GetStringSlice("publish_allowed_origins"))
 	if err != nil || claims == nil || claims.Mercure.Publish == nil {
 		http.Error(w, http.StatusText(http.StatusUnauthorized), http.StatusUnauthorized)
-		if err == nil {
-			log.WithFields(log.Fields{"remote_addr": r.RemoteAddr}).Info("topic selectors not matched or not provided")
-		} else {
-			log.WithFields(log.Fields{"remote_addr": r.RemoteAddr}).Info(err)
-		}
+		logAccessError(r, err)
+
 		return
 	}
 
 	if r.ParseForm() != nil {
 		http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusBadRequest)
+
 		return
 	}
 
 	topics := r.PostForm["topic"]
 	if len(topics) == 0 {
 		http.Error(w, "Missing \"topic\" parameter", http.StatusBadRequest)
+
 		return
 	}
 
@@ -38,13 +46,15 @@ func (h *Hub) PublishHandler(w http.ResponseWriter, r *http.Request) {
 		retry, err = strconv.ParseUint(retryString, 10, 64)
 		if err != nil {
 			http.Error(w, "Invalid \"retry\" parameter", http.StatusBadRequest)
+
 			return
 		}
 	}
 
 	private := len(r.PostForm["private"]) != 0
 	if private && !canDispatch(h.topicSelectorStore, topics, claims.Mercure.Publish) {
 		http.Error(w, http.StatusText(http.StatusUnauthorized), http.StatusUnauthorized)
+
 		return
 	}
 

hub/server.go

@@ -219,6 +219,7 @@ func basicAuthMiddleware(expectedLogin, expectedPassword string) func(next http.
 			if !ok || login != expectedLogin || password != expectedPassword {
 				w.Header().Add("WWW-Authenticate", `Basic realm="Mercure"`)
 				w.WriteHeader(http.StatusUnauthorized)
+
 				return
 			}
 

hub/server_test.go

@@ -216,6 +216,7 @@ func TestClientClosesThenReconnects(t *testing.T) {
 			receivedBody += string(buf)
 			if strings.Contains(receivedBody, "data: "+expectedBodyData+"\n") {
 				cancel()
+
 				break
 			}
 		}

hub/subscribe.go

@@ -85,12 +85,14 @@ func (h *Hub) registerSubscriber(w http.ResponseWriter, r *http.Request, debug b
 	if err != nil || (claims == nil && !h.config.GetBool("allow_anonymous")) {
 		http.Error(w, http.StatusText(http.StatusUnauthorized), http.StatusUnauthorized)
 		log.WithFields(s.LogFields).Info(err)
+
 		return nil
 	}
 
 	s.Topics = r.URL.Query()["topic"]
 	if len(s.Topics) == 0 {
 		http.Error(w, "Missing \"topic\" parameter.", http.StatusBadRequest)
+
 		return nil
 	}
 	s.LogFields["subscriber_topics"] = s.Topics
@@ -102,6 +104,7 @@ func (h *Hub) registerSubscriber(w http.ResponseWriter, r *http.Request, debug b
 		http.Error(w, http.StatusText(http.StatusServiceUnavailable), http.StatusServiceUnavailable)
 		h.dispatchSubscriptionUpdate(s, false)
 		log.WithFields(s.LogFields).Error(err)
+
 		return nil
 	}
 
@@ -155,6 +158,7 @@ func (h *Hub) write(w io.Writer, s *Subscriber, data string, d time.Duration) bo
 	if d == time.Duration(0) {
 		fmt.Fprint(w, data)
 		w.(http.Flusher).Flush()
+
 		return true
 	}
 
@@ -170,6 +174,7 @@ func (h *Hub) write(w io.Writer, s *Subscriber, data string, d time.Duration) bo
 		return true
 	case <-time.After(d):
 		log.WithFields(s.LogFields).Warn("Dispatch timeout reached")
+
 		return false
 	}
 }

hub/subscribe_test.go

@@ -326,6 +326,7 @@ func TestSubscribePrivate(t *testing.T) {
 				Event:   Event{Data: "Great", ID: "c", Retry: 1},
 				Private: true,
 			})
+
 			return
 		}
 	}()

hub/subscriber.go

@@ -69,6 +69,7 @@ func (s *Subscriber) start() {
 		case u, ok := <-s.history.in:
 			if !ok {
 				s.history.in = nil
+
 				break
 			}
 			if s.CanDispatch(u) {
@@ -85,6 +86,7 @@ func (s *Subscriber) start() {
 		case s.outChan() <- s.nextUpdate():
 			if len(s.history.buffer) > 0 {
 				s.history.buffer = s.history.buffer[1:]
+
 				break
 			}
 
@@ -105,6 +107,7 @@ func (s *Subscriber) outChan() chan<- *Update {
 	if len(s.live.buffer) > 0 || len(s.history.buffer) > 0 {
 		return s.out
 	}
+
 	return nil
 }
 
@@ -116,6 +119,7 @@ func (s *Subscriber) nextUpdate() *Update {
 		if len(s.history.buffer) > 0 {
 			return s.history.buffer[0]
 		}
+
 		return nil
 	}
 
@@ -138,6 +142,7 @@ func (s *Subscriber) Dispatch(u *Update, fromHistory bool) bool {
 	select {
 	case <-s.disconnected:
 		close(s.live.in)
+
 		return false
 
 	default:
@@ -146,6 +151,7 @@ func (s *Subscriber) Dispatch(u *Update, fromHistory bool) bool {
 	select {
 	case <-s.disconnected:
 		close(s.live.in)
+
 		return false
 
 	case in <- u:
@@ -176,11 +182,13 @@ func (s *Subscriber) Disconnect() {
 func (s *Subscriber) CanDispatch(u *Update) bool {
 	if !canReceive(s.topicSelectorStore, u.Topics, s.Topics, true) {
 		log.WithFields(createFields(u, s)).Debug("Subscriber has not subscribed to this update")
+
 		return false
 	}
 
 	if u.Private && (s.Claims == nil || s.Claims.Mercure.Subscribe == nil || !canReceive(s.topicSelectorStore, u.Topics, s.Claims.Mercure.Subscribe, true)) {
 		log.WithFields(createFields(u, s)).Debug("Subscriber not authorized to receive this update")
+
 		return false
 	}
 

hub/subscription.go

@@ -94,6 +94,7 @@ func (h *Hub) SubscriptionHandler(w http.ResponseWriter, r *http.Request) {
 			}
 
 			w.Write(json)
+
 			return
 		}
 	}
@@ -110,6 +111,7 @@ func (h *Hub) initSubscription(currentURL string, w http.ResponseWriter, r *http
 		} else {
 			log.WithFields(log.Fields{"remote_addr": r.RemoteAddr}).Info(err)
 		}
+
 		return "", nil, false
 	}
 
@@ -121,6 +123,7 @@ func (h *Hub) initSubscription(currentURL string, w http.ResponseWriter, r *http
 	lastEventID, subscribers = transport.GetSubscribers()
 	if r.Header.Get("If-None-Match") == lastEventID {
 		w.WriteHeader(http.StatusNotModified)
+
 		return "", nil, false
 	}
 

hub/topic_selector.go

@@ -98,6 +98,7 @@ func (tss *TopicSelectorStore) cleanup(topics []string) {
 		if tc, ok := tss.m[topic]; ok {
 			if tc.counter == 0 {
 				delete(tss.m, topic)
+
 				continue
 			}