staretta opened a new issue, #1899:
URL: https://github.com/apache/wicket/issues/1899

   ## Description
   
   When a client opens a native WebSocket for a page id that the session's page 
manager can no longer find, `AbstractWebSocketProcessor` accepts the handshake, 
registers the connection, and then does nothing. No behavior's `onConnect` 
runs, the connection is not closed, and the only trace is a debug log line. The 
client sees an open socket that never receives anything.
   
   This can occur when the HTTP/Wicket session survives an application restart 
or redeployment but the page store does not. Existing browser pages reconnect 
using their previous page IDs. If those pages cannot be restored, the 
connections remain open without reaching their behaviors. Page-store eviction 
can produce the same condition without a restart.
   
   ## Where
   
   `AbstractWebSocketProcessor.broadcastMessage(IWebSocketMessage, 
IWebSocketConnection, boolean, long)`, 10.12.0 and 11.0.0 around line 328:
   
   ```java
   IPageManager pageManager = session.getPageManager();
   Page page = getPage(pageManager);
   
   if (page != null)
   {
       // ... broadcast to the page's behaviors
   }
   else
   {
       LOG.debug("Page with id '{}' has been expired. No message will be 
broadcast!", pageId);
   }
   ```
   
   For the `ConnectedMessage` broadcast from `onConnect`, the connection stays 
in the registry and open. Later client frames and pushes take the same branch, 
so nothing reaches a behavior and the client gets no answer.
   
   The null check was added by WICKET-6267, to stop a push to an expired page 
from throwing in `WebSocketRequestHandler`'s constructor. That fixed the 
exception but left the connection open.
   
   The neighboring cases already close the connection: since 10.12 a missing 
session closes with `POLICY_VIOLATION_ERROR_CODE` and `SESSION_ENDED` ("Session 
ended"), and a refused `WebSocketResource` closes with `NOT_AUTHORIZED` ("Not 
authorized"). A missing page is the one outcome of that lookup that leaves the 
connection open and unusable.
   
   ## Effect on clients
   
   A client cannot tell this apart from a slow server. A client that waits for 
a first message from the server (a hello, an initial state push) times out, 
closes, reconnects with the same page id, and gets the same silent connection, 
until its retry budget runs out. Reloading the page fixes it at once, but 
nothing tells the client or the user to do that.
   
   ## Steps to reproduce
   
   1. Render a stateful page with a `WebSocketBehavior` whose `onConnect` sends 
a text message.
   2. Connect its socket and see the message arrive.
   3. Clear the page store, keeping the session alive.
   4. Close the socket and reconnect using the original socket URL (same 
`pageId` parameter).
   5. The handshake succeeds, `onConnect` is never called, no message arrives, 
and the connection stays open and registered. The server logs only, at debug: 
"Page with id 'N' has been expired. No message will be broadcast!"
   
   No external session store or restart is needed.
   
   ## Proposed change
   
   Close for `ConnectedMessage`, client text/binary messages, and pushes. Do 
not initiate another close for `ClosedMessage`, `ErrorMessage`, or 
`AbortedMessage`. As in the session-ended branch, remove the registry entry in 
every case:
   
   ```java
   static final String PAGE_EXPIRED = "Page expired";
   ...
   else
   {
       connectionRegistry.removeConnection(application, sessionId, 
connection.getKey());
       LOG.debug("Page with id '{}' has expired. No message will be 
broadcast!", pageId);
       if (isSpecialMessage(message) == false)
       {
           
connection.close(WebSocketConnectionOriginFilter.POLICY_VIOLATION_ERROR_CODE,
                   PAGE_EXPIRED);
       }
   }
   ```
   
   1008 with "Page expired" fits alongside Wicket's existing closes. What 
matters is that the distinction is documented and stable, so clients can depend 
on it: a client handles "this page is gone, reload it" very differently from 
"the session is no longer available". It can then react to a definite close 
instead of a timeout, for example by telling the user that the page is out of 
date.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to