fix: Fix regression when sync id check is disabled (#17238)

When syncId check is disabled, long-polling push cache filter always cached all messages. This change fixes the regression, by preventing message cache when syncId check is disabled.
vaadin · Jul 20, 2023 · 6b68024 · 6b68024
1 parent 643fcee
commit 6b68024
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/flow-server/src/main/java/com/vaadin/flow/server/communication/LongPollingCacheFilter.java b/flow-server/src/main/java/com/vaadin/flow/server/communication/LongPollingCacheFilter.java
@@ -68,7 +68,10 @@ public BroadcastAction filter(String broadcasterId, AtmosphereResource r,
             String uuid = r.uuid();
             int lastSeenOnClient = session.getAttribute(SEEN_SERVER_SYNC_ID,
                     Integer.class);
-            if (pushMessage.alreadySeen(lastSeenOnClient)) {
+            if (lastSeenOnClient == -1) {
+                return new BroadcastAction(BroadcastAction.ACTION.CONTINUE,
+                        message);
+            } else if (pushMessage.alreadySeen(lastSeenOnClient)) {
                 getLogger().trace(
                         "Discarding message {} for resource {} as client already seen {}. {}",
                         pushMessage.serverSyncId, uuid, lastSeenOnClient,

diff --git a/...server/src/test/java/com/vaadin/flow/server/communication/LongPollingCacheFilterTest.java b/...server/src/test/java/com/vaadin/flow/server/communication/LongPollingCacheFilterTest.java
@@ -73,6 +73,19 @@ public void filter_notLongPollingTransport_continueWithCurrentMessage() {
         verifyMessageIsNotCached();
     }
 
+    @Test
+    public void filter_syncIdCheckDisabled_continueWithCurrentMessage() {
+        setTransport(AtmosphereResource.TRANSPORT.LONG_POLLING);
+        setSeenServerSyncIdHeader(-1);
+        BroadcastAction action = filter.filter("broadcasterId", resource,
+                originalMessage, message);
+        Assert.assertEquals(ACTION.CONTINUE, action.action());
+        Assert.assertSame(
+                "Message should not be altered by filter if syncId check is disabled",
+                message, action.message());
+        verifyMessageIsNotCached();
+    }
+
     @Test
     public void filter_missingLastSeenServerSyncId_continueWithCurrentMessage() {
         setTransport(AtmosphereResource.TRANSPORT.LONG_POLLING);
@@ -216,4 +229,4 @@ private void simulatePushConnection() {
     private void verifyMessageIsNotCached() {
         Mockito.verifyNoInteractions(cache);
     }
-}
+}