jetty/jetty.project

Jetty 12 - Add a WebSocket MessageSink for Flow.Publisher

Open

#9722 opened on May 2, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Java (3,701 stars) (1,913 forks)batch import
EnhancementHelp Wanted

Description

Jetty version(s) 12+

Enhancement Description As we have MessageSink for InputStream, we could have an implementation for Flow.Publisher<ByteBuffer> since we cannot directly have Content.Source due to classloading issues.

@WebSocket
public class WSEndpoint {
  @OnWebSocketMessage
  public void onMessage(Flow.Publisher<ByteBuffer> publisher) {
    // Consume the message asynchronously.
  }
}

Contributor guide

Tech stack
java
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Java 17+Jetty WebSocket APIReactive Streams (Flow.Publisher)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
This issue requests adding a WebSocket MessageSink implementation that accepts a Flow.Publisher<ByteBuffer>, similar to the existing MessageSink for InputStream. The challenge is classloading issues preventing direct use of Content.Source. The implementation should be placed in the Jetty WebSocket module (likely under `jetty websocket/websocket core common`). Review the existing `InputStreamMessageSink` as a template. The new class should implement `MessageSink` and handle subscription to the publisher. There are no linked PRs or assignees, so this is open for contribution.