Initial version of the new declarative WebSocket server API

[mkouba]

• see also Towards a new websocket model #38473

This pull request supersedes #38783.

[franz1981]

In theory , if you need telemetry; you could just use the uncompleted one which can report the number of in-flight requests

[mkouba]

The queueCounter is currently only used to distinguish queued actions in log messages. So I don't think we can use uncompleted there. In theory, we could initialize the queueCounter only if Logger.isDebugEnabled(). However, I do remember some problems with native image as described in #27735.

[gastaldi]

@mkouba nice! One question: Does it support PING/PONG messages OOTB? This is described here: #31157

[mkouba]

@mkouba nice! One question: Does it support PING/PONG messages OOTB? This is described here: #31157

We don't add anything special but AFAIK Vert.x does respond to a PING frame sent from the client automatically.

We might need to add something for the server -> client communication though (to ensure the client is still responsive), i.e. add WebSocketServerConnection#sendPing() or so.

CC @cescoffier

[cescoffier]

Yes,

Normally pong are handled automatically. However, we may want to add the possibility to send them explicitly.

I'm wondering if this can be used to avoid being cut on OpenShift/Kubernetes after 10s of inactivity.

[geoand]

websockets-next needs to be after this.

[mkouba]

websockets-next needs to be after this.

Good point! 👍

[mkouba]

@Ladicek @geoand Guys I appreciate your comments about javadoc and I'll incorporate them in this PR but keep in mind that the javadoc and docs in general is still WIP (docs do not exist yet actually ;-) and will require a lot of refinements. That said, the goal of this PR is to introduce a minimum viable product version of the API.

PS. The same applies to tests.

[Ladicek]

I'm not capable of reviewing this in full, but I went through some parts that felt important (or interesting). I vaguely recall I had some ideas about codecs, but I no longer recall. Maybe I'll remember later.

One thing I wanted to ask: what happens if we (at some point) introduce a CDI session context for Vert.x Web sessions (imagine only for the in-memory, non-clustered scenario, where the Vert.x Web session can store arbitrary objects)? Will it clash with the WebSocket session context added here?

[mkouba]

One thing I wanted to ask: what happens if we (at some point) introduce a CDI session context for Vert.x Web sessions (imagine only for the in-memory, non-clustered scenario, where the Vert.x Web session can store arbitrary objects)? Will it clash with the WebSocket session context added here?

That's a good question. I think that it would depend on how and when we activate the session context. In theory, we only care about the handshake request in case WebSockets. So I assume that if the route handler of a WS endpoint has higher priority than the handler that activates the Vert.x Web session context then we're fine. And ofc it would mean that those two session contexts are completely separated. Which is IMO fine if properly documented.

[geoand]

Guys I appreciate your comments about javadoc and I'll incorporate them in this PR but keep in mind that the javadoc and docs in general is still WIP

That's why my comment explicitly mentioned the next iteration :)

[quarkus-bot]

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit d73514d.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

---

Flaky tests - Develocity

⚙️ JVM Tests - JDK 17 Windows

📦 extensions/websockets-next/server/deployment

✖ io.quarkus.websockets.next.test.broadcast.BroadcastOnMessageTest.testUpMultiBidi - History

• expected: <true> but was: <false> - org.opentest4j.AssertionFailedError

org.opentest4j.AssertionFailedError: expected: <true> but was: <false>
	at org.junit.jupiter.api.AssertionFailureBuilder.build(AssertionFailureBuilder.java:151)
	at org.junit.jupiter.api.AssertionFailureBuilder.buildAndThrow(AssertionFailureBuilder.java:132)
	at org.junit.jupiter.api.AssertTrue.failNotTrue(AssertTrue.java:63)
	at org.junit.jupiter.api.AssertTrue.assertTrue(AssertTrue.java:36)
	at org.junit.jupiter.api.AssertTrue.assertTrue(AssertTrue.java:31)
	at org.junit.jupiter.api.Assertions.assertTrue(Assertions.java:183)
	at io.quarkus.websockets.next.test.broadcast.BroadcastOnMessageTest.assertBroadcast(BroadcastOnMessageTest.java:96)