Revert "feat: payload for a specific topic (#945)"

This reverts commit fb42dfa.

.golangci.yml

@@ -32,7 +32,6 @@ linters:
 
     # deprecated
     - execinquery
-    - exportloopref
 
 issues:
   exclude-rules:

authorization.go

@@ -19,11 +19,9 @@ type claims struct {
 }
 
 type mercureClaim struct {
-	Publish   []string `json:"publish"`
-	Subscribe []string `json:"subscribe"`
-	// Deprecated: use the Payloads field instead
-	Payload  interface{}            `json:"payload"`
-	Payloads map[string]interface{} `json:"payloads"`
+	Publish   []string    `json:"publish"`
+	Subscribe []string    `json:"subscribe"`
+	Payload   interface{} `json:"payload"`
 }
 
 type role int

hub_test.go

@@ -264,13 +264,12 @@ func createAnonymousDummy(options ...Option) *Hub {
 }
 
 func createDummyAuthorizedJWT(r role, topics []string) string {
-	payloads := map[string]interface{}{"*": make(map[string]string)}
-	payloads["*"].(map[string]string)["foo"] = "bar"
-
-	return createDummyAuthorizedJWTWithPayload(r, topics, payloads)
+	return createDummyAuthorizedJWTWithPayload(r, topics, struct {
+		Foo string `json:"foo"`
+	}{Foo: "bar"})
 }
 
-func createDummyAuthorizedJWTWithPayload(r role, topics []string, payloads map[string]interface{}) string {
+func createDummyAuthorizedJWTWithPayload(r role, topics []string, payload interface{}) string {
 	token := jwt.New(jwt.SigningMethodHS256)
 
 	var key []byte
@@ -283,7 +282,7 @@ func createDummyAuthorizedJWTWithPayload(r role, topics []string, payloads map[s
 		token.Claims = &claims{
 			Mercure: mercureClaim{
 				Subscribe: topics,
-				Payloads:  payloads,
+				Payload:   payload,
 			},
 			RegisteredClaims: jwt.RegisteredClaims{},
 		}

subscribe.go

@@ -182,7 +182,7 @@ func (h *Hub) registerSubscriber(w http.ResponseWriter, r *http.Request) (*Subsc
 
 	topics := r.URL.Query()["topic"]
 	if len(topics) == 0 {
-		http.Error(w, `Missing "topic" parameter.`, http.StatusBadRequest)
+		http.Error(w, "Missing \"topic\" parameter.", http.StatusBadRequest)
 
 		return nil, nil
 	}
@@ -203,47 +203,17 @@ func (h *Hub) registerSubscriber(w http.ResponseWriter, r *http.Request) (*Subsc
 	rc := h.newResponseController(w, s)
 	rc.flush()
 
-	h.normalizeClaims(claims)
-	h.logNewSubscriber(claims, s)
-	h.metrics.SubscriberConnected(s)
-
-	return s, rc
-}
-
-func (h *Hub) logNewSubscriber(claims *claims, s *Subscriber) {
-	c := h.logger.Check(zap.InfoLevel, "New subscriber")
-	if c == nil {
-		return
-	}
-
-	fields := []LogField{zap.Object("subscriber", s)}
-	if claims != nil && h.logger.Level() == zap.DebugLevel {
-		if claims.Mercure.Payload != nil && h.opt.isBackwardCompatiblyEnabledWith(8) {
-			fields = append(
-				fields,
-				zap.Reflect("payload", claims.Mercure.Payload),
-			)
+	if c := h.logger.Check(zap.InfoLevel, "New subscriber"); c != nil {
+		fields := []LogField{zap.Object("subscriber", s)}
+		if claims != nil && h.logger.Level() == zap.DebugLevel {
+			fields = append(fields, zap.Reflect("payload", claims.Mercure.Payload))
 		}
 
-		fields = append(
-			fields,
-			zap.Reflect("payloads", claims.Mercure.Payloads),
-		)
-	}
-
-	c.Write(fields...)
-}
-
-func (h *Hub) normalizeClaims(c *claims) {
-	if c == nil || c.Mercure.Payload == nil {
-		return
+		c.Write(fields...)
 	}
+	h.metrics.SubscriberConnected(s)
 
-	if h.opt.isBackwardCompatiblyEnabledWith(8) {
-		h.logger.Info(`Deprecated: the "mercure.payload" JWT claim deprecated since the version 8 of the protocol, use "mercure.payloads" claim with a "*" key instead.`)
-	} else {
-		c.Mercure.Payload = nil
-	}
+	return s, rc
 }
 
 // sendHeaders sends correct HTTP headers to create a keep-alive connection.

subscribe_test.go

@@ -332,12 +332,12 @@ func TestSubscribe(t *testing.T) {
 	testSubscribe(t, 3)
 }
 
-func testSubscribeLogs(t *testing.T, hub *Hub, payloads map[string]interface{}) {
+func testSubscribeLogs(t *testing.T, hub *Hub, payload interface{}) {
 	t.Helper()
 
 	ctx, cancel := context.WithCancel(context.Background())
 	req := httptest.NewRequest(http.MethodGet, defaultHubURL+"?topic=http://example.com/reviews/{id}", nil).WithContext(ctx)
-	req.AddCookie(&http.Cookie{Name: "mercureAuthorization", Value: createDummyAuthorizedJWTWithPayload(roleSubscriber, []string{"http://example.com/reviews/22"}, payloads)})
+	req.AddCookie(&http.Cookie{Name: "mercureAuthorization", Value: createDummyAuthorizedJWTWithPayload(roleSubscriber, []string{"http://example.com/reviews/22"}, payload)})
 
 	w := &responseTester{
 		expectedStatusCode: http.StatusOK,
@@ -351,18 +351,18 @@ func testSubscribeLogs(t *testing.T, hub *Hub, payloads map[string]interface{})
 
 func TestSubscribeWithLogLevelDebug(t *testing.T) {
 	core, logs := observer.New(zapcore.DebugLevel)
-	payloads := map[string]interface{}{
-		"*": make(map[string]string),
+	payload := map[string]interface{}{
+		"bar": "baz",
+		"foo": "bar",
 	}
 
-	payloads["*"].(map[string]string)["bar"] = "baz"
-	payloads["*"].(map[string]string)["foo"] = "bar"
-
 	testSubscribeLogs(t, createDummy(
 		WithLogger(zap.New(core)),
-	), payloads)
+	), payload)
 
-	assert.Equal(t, 1, logs.FilterMessage("New subscriber").FilterFieldKey("payloads").Len())
+	assert.Equal(t, 1, logs.FilterMessage("New subscriber").FilterField(
+		zap.Reflect("payload", payload)).Len(),
+	)
 }
 
 func TestSubscribeLogLevelInfo(t *testing.T) {

subscriber.go

@@ -209,21 +209,8 @@ func (s *Subscriber) getSubscriptions(topic, context string, active bool) []subs
 			Topic:      t,
 			Active:     active,
 		}
-		if s.Claims != nil { //nolint:nestif
-			if s.Claims.Mercure.Payloads == nil {
-				if s.Claims.Mercure.Payload != nil {
-					subscription.Payload = s.Claims.Mercure.Payload
-				}
-			} else {
-				for k, v := range s.Claims.Mercure.Payloads {
-					if !s.topicSelectorStore.match(t, k) {
-						continue
-					}
-					subscription.Payload = v
-
-					break
-				}
-			}
+		if s.Claims != nil && s.Claims.Mercure.Payload != nil {
+			subscription.Payload = s.Claims.Mercure.Payload
 		}
 
 		subscriptions = append(subscriptions, subscription)

subscription_test.go

@@ -210,38 +210,3 @@ func TestSubscriptionHandler(t *testing.T) {
 	assert.Equal(t, http.StatusNotFound, res.StatusCode)
 	res.Body.Close()
 }
-
-func TestSubscriptionPayload(t *testing.T) {
-	logger := zap.NewNop()
-	tss := &TopicSelectorStore{}
-
-	for _, selector := range []string{"*", "http://example.com/foo", "http://example.com/{var}"} {
-		t.Run("selector "+selector, func(t *testing.T) {
-			hub := createDummy(WithLogger(logger))
-
-			s1 := NewSubscriber("", logger, tss)
-			s1.SetTopics([]string{"http://example.com/foo"}, nil)
-
-			s1.Claims = &claims{}
-			s1.Claims.Mercure.Payloads = map[string]interface{}{}
-			s1.Claims.Mercure.Payloads[selector] = "foo"
-			s1.Claims.Mercure.Payloads["http://example.com/bar"] = "bar"
-
-			require.NoError(t, hub.transport.AddSubscriber(s1))
-
-			req := httptest.NewRequest(http.MethodGet, defaultHubURL+subscriptionsPath, nil)
-			req.AddCookie(&http.Cookie{Name: "mercureAuthorization", Value: createDummyAuthorizedJWT(roleSubscriber, []string{"/.well-known/mercure/subscriptions"})})
-			w := httptest.NewRecorder()
-			hub.SubscriptionsHandler(w, req)
-			res := w.Result()
-			assert.Equal(t, http.StatusOK, res.StatusCode)
-			res.Body.Close()
-
-			var subscriptions subscriptionCollection
-			json.Unmarshal(w.Body.Bytes(), &subscriptions)
-
-			require.Len(t, subscriptions.Subscriptions, 1)
-			assert.Equal(t, "foo", subscriptions.Subscriptions[0].Payload)
-		})
-	}
-}