FELIX-6692 Add Jetty WebSocket support for jetty 11.x #309

enapps-enorman · 2024-04-23T03:18:09Z

I was trying to make this work with jetty 11.x before I saw there was similar work for the jetty12 branch. So this is a slightly different approach than what was merged for #298

The changes I'm proposing here will initialize the websocket support in the main ServletContextHandler

This was trying to follow the guidance from the jetty documentation at: https://eclipse.dev/jetty/documentation/jetty-11/programming-guide/index.html#pg-server-websocket

How this changes the http.jetty bundle:

No new jetty classes embedded in the http.jetty bundle. The websocket related classes remain optional and would be expected to be supplied by deploying the appropriate jetty bundles.
The following new entries are now in the Import-Package instruction to declare the new optional Import-Package values:

org.eclipse.jetty.websocket.server.config;version="[11.0,12)";resolution:=optional
org.eclipse.jetty.websocket.jakarta.server.config;version="[11.0,12)";resolution:=optional
These two new configuration properties are available in the JettyConfig that specify whether to enable the two possible websocket implementations

org.apache.felix.jakarta.ee9.websocket.enable

when set to true, the JakartaWebSocketServletContainerInitializer is called to setup the ServerContainer for the web application context. This also requires that the org.eclipse.jetty.websocket:websocket-jakarta-server bundle is also deployed and active. If that bundle is missing a warning is logged and the websocket initialization is skipped.

org.apache.felix.jetty.websocket.enable
when set to true, the JettyWebSocketServletContainerInitializer is called to setup the JettyWebSocketServerContainer for this web application context. This also requires that the org.eclipse.jetty.websocket:websocket-jetty-server bundle is also deployed and active. If that bundle is missing a warning is logged and the websocket initialization is skipped.

Then one way to declare a custom websocket from a servlet component in a bundle would be to override the servlet init method and do something like below:

@Override
public void init(ServletConfig config) throws ServletException {
    super.init(config);

    // The websocket container is attached to the main servlet context, not the per-bundle one.
    //  Lookup the ServletContext for the context path where the websocket server is attached.
    ServletContext servletContext = config.getServletContext();
    ServletContext rootContext = servletContext.getContext("/");

    // Retrieve the JettyWebSocketServerContainer.
    JettyWebSocketServerContainer container = JettyWebSocketServerContainer.getContainer(rootContext);

    // register the mapping to our custom websocket
    container.addMapping("/mywebsocketpath1", (upgradeRequest, upgradeResponse) -> new MyWebSocket1());
}

stbischof · 2024-04-23T06:00:11Z

Lgtm.

Fyi:
There is is spec process about this topic.
osgi/osgi#575

You may want to join the spec call.
https://calendar.google.com/calendar/u/0/embed?src=c_fh3lhb5p0l29f6phu2ndifh4a4@group.calendar.google.com&ctz=America/New_York&pli=1

paulrutter · 2024-04-23T12:58:07Z

This is a very nice solution. Would be worthwhile to see if this also works on 12, as this code is a lot neater in terms of initialization.

Can you list the jetty bundles that are required to be deployed in the OSGi environment?

enapps-enorman · 2024-04-23T18:10:52Z

@paulrutter Thanks for reviewing and providing feedback. I haven't tried this with jetty12, but the documentation looks similar with 2 additional implementations (Jakarta EE 8 and Jakarta EE 10).

After reviewing the jetty12 documentation, I will rename the "org.apache.felix.jakarta.websocket.enable" option to "org.apache.felix.jakarta.ee9.websocket.enable" to avoid conflicts if we decide to go with this solution and expand it to support the other two options for jetty12.

Regarding the jetty bundles that are required, below is what I believe is the minimum set of additional bundles to satisfy the dependencies:

For the jetty specific websocket implementation

org.eclipse.jetty:jetty-webapp
org.eclipse.jetty.websocket:websocket-core-common
org.eclipse.jetty.websocket:websocket-core-server
org.eclipse.jetty.websocket:websocket-jetty-api
org.eclipse.jetty.websocket:websocket-jetty-common
org.eclipse.jetty.websocket:websocket-jetty-server
org.eclipse.jetty.websocket:websocket-servlet
org.eclipse.jetty:jetty-xml

For the jakarta EE9 specific websocket implementation

jakarta.websocket:jakarta.websocket-api
org.eclipse.jetty:jetty-alpn-client
org.eclipse.jetty:jetty-client
org.eclipse.jetty:jetty-webapp
org.eclipse.jetty.websocket:websocket-core-client
org.eclipse.jetty.websocket:websocket-core-common
org.eclipse.jetty.websocket:websocket-core-server
org.eclipse.jetty.websocket:websocket-jakarta-client
org.eclipse.jetty.websocket:websocket-jakarta-common
org.eclipse.jetty.websocket:websocket-jakarta-server
org.eclipse.jetty.websocket:websocket-servlet
org.eclipse.jetty:jetty-xml

paulrutter · 2024-04-24T18:25:42Z

@enapps-enorman could you add an example to the whiteboard sample project? It would help understand the solution and annotations needed.

https://github.com/apache/felix-dev/tree/master/http/samples/whiteboard

You might need to create a separate project as the current one relies on the jetty12 bundle.

enapps-enorman · 2024-04-24T23:17:50Z

@paulrutter With my last commit f256aab I added some paxexam integration tests to verify the functionality.

Is that a good enough sample to demonstrate how to use it?

paulrutter · 2024-04-25T15:57:08Z

It would be interesting to see if this approach would also work for the jetty12 bundle, although i'm not a fan of needing to install all those jetty bundles in the OSGi runtime. But that's a matter of taste i suppose.

enapps-enorman · 2024-04-25T17:14:18Z

It would be interesting to see if this approach would also work for the jetty12 bundle, although i'm not a fan of needing to install all those jetty bundles in the OSGi runtime. But that's a matter of taste i suppose.

Yes that could be interesting, but I am not going to spend any time on experimenting with jetty12 until I get a yes or no regarding whether there is any chance that this proposal is going to be accepted or not. The source code is available here if you want to try something similar on jetty12 and tell us if it worked.

FYI: In my projects, I am using the "light" classifier variant of the http.jetty bundle which doesn't embed the classes from any of the jetty bundles so I am used to declaring all of the individual jetty bundles that I need. I prefer this so I have the flexibility to switch to a newer release of jetty without waiting for felix to do a new release with the newer version of the jetty classes embedded.

If the consensus is to embed the content of the extra websocket-* bundles into the non-light variant then I would not care too much either way. It would just make the binary a bit bigger.

paulrutter · 2024-04-25T17:24:34Z

Yes, i understand. I think @cziegeler is the one that works on the http part regularly. He can give some more guidance maybe.

Since the websocket change for jetty12 is not released yet, this is the moment to check alternatives.

cziegeler · 2024-04-26T05:24:00Z

Thanks @enapps-enorman , I like this approach as it is not enlarging the felix http jetty bundle.
I think, it would be good if we have the same approach for jetty and jetty12 to make the transition easier.
@paulrutter Could you maybe try if that works for jetty12 as well?
For the list of additional bundles needed, I don't think that this is really problematic that you need to install all of them in addition. You just have to define that list once.
Now if we think that this is problematic, we could create two additional artifacts which combine all those bundles into a single one, so we would have a felix http jetty bundle with a classifier jettywebsocket and ee9websocket (or whatever names we choose). But we can wait with that one, if too many people complain

paulrutter · 2024-04-26T06:25:27Z

I will try it out @cziegeler, maybe we should wait with releasing a new version of jetty12 until we know it's feasible or not.
I won't be able to finish this today, but hopefully next week.

If the approach would work with Jetty12, i would propose to do the following:

incorporate the changes from this PR, the main (fat) jar remains as is (no websocket classes)
add one or two classifiers for having either jakarta ee10 or jetty ee10 websockets added to the main jar
the light jar won't have these additional classes, so one can just use the Jetty OSGi bundles as desired

paulrutter · 2024-04-26T09:43:26Z

@enapps-enorman @cziegeler what do you think of this? #310

This way, both styles are supported:

using the main jar won't have websocket classes
if someone wants to use Jakarta or Jetty WebSocket classes, those classifiers can be used
if someone wants to run with their own Jetty jars, use light classifier

The PR doesn't contain tests yet, but if we align on the approach, i could do that based on the work from @enapps-enorman.

paulrutter · 2024-04-29T11:53:13Z

If we go along with this PR and #310, i think the following changes would need to be made to this PR:

Rename org.apache.felix.jetty.websocket.enable to org.apache.felix.jetty.ee9.websocket.enable, as Jetty12 can support both EE8/9/10, but one needs to specify which EE version to use.
Currently, only EE10 is supported. But if needed, EE8 and EE9 could be added.
Update the README to document the new options for the Jetty 11 bundle (see https://github.com/apache/felix-dev/pull/310/files#diff-8e568763d7d4e15f9465300afa93c121c7f8e399acfff4c2aee7e70ed1199401)
Incorporate the changes for using maybeStoreWebSocketContainerAttributes.

Rename org.apache.felix.jetty.websocket.enable to org.apache.felix.jetty.ee9.websocket.enable Incorporate the changes for using maybeStoreWebSocketContainerAttributes

enapps-enorman · 2024-05-01T02:51:25Z

@paulrutter Thanks for working out the jetty12 stuff. I've made an attempt to integrate the code changes you suggested.

paulrutter · 2024-05-01T05:39:41Z

The changes look good, only thing left would be to update the documentation to include the new settings.

Update the README to document the new options for the Jetty 11 bundle (see https://github.com/apache/felix-dev/pull/310/files#diff-8e568763d7d4e15f9465300afa93c121c7f8e399acfff4c2aee7e70ed1199401)

enapps-enorman · 2024-05-01T05:58:31Z

Update the README to document the new options for the Jetty 11 bundle

I could do that but I guess I was thinking that it might be an awkward to merge with two PRs making changes to that file. I believe at this point the changes in #309 and #310 are changing different files (or identical changes to the same file). Would it be easier to do a followup PR for the README after the other two are merged?

paulrutter · 2024-05-01T06:58:31Z

We could do that, or i merge in your branch into mine and make the changes there?
Then we have one PR with all the changes for both Jetty bundles.

* Revert "Add jetty websocket support to Jetty12 (#298)" This reverts commit 6d95c93. * FELIX-6692 Add Jetty WebSocket support for jetty 12.x - Apply 11.x approach to jetty12 bundle - Add two new classifiers 'with-jetty-ee10-websockets' and 'with-jakarta-ee10-websockets' to have a fat jar containing the appropriate websocket classes * Working example base on previous code. Do note that the workaround in FelixJettyWebSocketServlet are still required; the initialization code in the Jetty12 bundle doesn't seem to work * * Enable cross context support to allow WebSockets to be registered in Jetty 12. See https://github.com/jetty/jetty.project/blob/jetty-12.0.x/jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java#L510 and jetty/jetty.project#9774 * Add example based on registering the websocket to the main servlet context instead of the per-bundle one - * Added paxweb unit tests based on the Jetty11 work from #309 * Fix version * Fix message * Test casing * Update README.md * Make client optional * Add Jetty12 bundle to pom * Store the WebSocket container reference and set it on the shared servlet context once available This removes the need to set setCrossContextDispatchSupported, as the WS container is available on the proper servlet context itself * Update example to no longer use the root context. Removed other WebSocket example, as this is no longer needed with the new approach. Updated documentation. * Add servlet based example again, as it shows another example of how to register a WebSocket endpoint that abides to the servlet context it's registered to. * Rename class * Comment * Comments * Remove classloader code as it now also works without * Rename test class to EE10 * Small changes to README.md

paulrutter · 2024-05-01T07:08:38Z

Created PR: #312

paulrutter · 2024-05-01T07:48:43Z

@enapps-enorman i just noticed that in the Jetty11 bundle, there is this import: https://github.com/apache/felix-dev/blob/master/http/jetty/src/main/java/org/apache/felix/http/jetty/internal/JettyService.java#L56C1-L56C73

I think this could cause issues when the Jetty websocket bundle is not loaded. Does this need adjusting before the release?

Created #313 for it.

FELIX-6692 Add Jetty WebSocket support for jetty 11.x

c585f32

FELIX-6692 rename jakarta websocket enable config for future expansion

4e0c710

FELIX-6692 add paxexam integration tests to verify the functionality

f256aab

FELIX-6692 cleanup

a104322

paulrutter mentioned this pull request Apr 26, 2024

FELIX-6692 jetty 12.x websockets new approach (based on #309) #310

Merged

paulrutter added a commit to blueconic/felix-dev that referenced this pull request Apr 29, 2024

Added paxweb unit tests based on the Jetty11 work from apache#309

2e39c11

FELIX-6692 merge changes from PR apache#310

d576f7e

Rename org.apache.felix.jetty.websocket.enable to org.apache.felix.jetty.ee9.websocket.enable Incorporate the changes for using maybeStoreWebSocketContainerAttributes

FELIX-6692 renamed for consistency

1486d79

paulrutter approved these changes May 1, 2024

View reviewed changes

cziegeler approved these changes May 1, 2024

View reviewed changes

cziegeler merged commit a49d9f3 into apache:master May 1, 2024

enapps-enorman deleted the issue/FELIX-6692 branch May 1, 2024 16:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FELIX-6692 Add Jetty WebSocket support for jetty 11.x #309

FELIX-6692 Add Jetty WebSocket support for jetty 11.x #309

enapps-enorman commented Apr 23, 2024 •

edited

Loading

stbischof commented Apr 23, 2024 •

edited

Loading

paulrutter commented Apr 23, 2024

enapps-enorman commented Apr 23, 2024

paulrutter commented Apr 24, 2024 •

edited

Loading

enapps-enorman commented Apr 24, 2024

paulrutter commented Apr 25, 2024 •

edited

Loading

enapps-enorman commented Apr 25, 2024 •

edited

Loading

paulrutter commented Apr 25, 2024 •

edited

Loading

cziegeler commented Apr 26, 2024

paulrutter commented Apr 26, 2024 •

edited

Loading

paulrutter commented Apr 26, 2024

paulrutter commented Apr 29, 2024 •

edited

Loading

enapps-enorman commented May 1, 2024

paulrutter commented May 1, 2024 •

edited

Loading

enapps-enorman commented May 1, 2024

paulrutter commented May 1, 2024

paulrutter commented May 1, 2024

paulrutter commented May 1, 2024 •

edited

Loading

FELIX-6692 Add Jetty WebSocket support for jetty 11.x #309

FELIX-6692 Add Jetty WebSocket support for jetty 11.x #309

Conversation

enapps-enorman commented Apr 23, 2024 • edited Loading

stbischof commented Apr 23, 2024 • edited Loading

paulrutter commented Apr 23, 2024

enapps-enorman commented Apr 23, 2024

For the jetty specific websocket implementation

For the jakarta EE9 specific websocket implementation

paulrutter commented Apr 24, 2024 • edited Loading

enapps-enorman commented Apr 24, 2024

paulrutter commented Apr 25, 2024 • edited Loading

enapps-enorman commented Apr 25, 2024 • edited Loading

paulrutter commented Apr 25, 2024 • edited Loading

cziegeler commented Apr 26, 2024

paulrutter commented Apr 26, 2024 • edited Loading

paulrutter commented Apr 26, 2024

paulrutter commented Apr 29, 2024 • edited Loading

enapps-enorman commented May 1, 2024

paulrutter commented May 1, 2024 • edited Loading

enapps-enorman commented May 1, 2024

paulrutter commented May 1, 2024

paulrutter commented May 1, 2024

paulrutter commented May 1, 2024 • edited Loading

enapps-enorman commented Apr 23, 2024 •

edited

Loading

stbischof commented Apr 23, 2024 •

edited

Loading

paulrutter commented Apr 24, 2024 •

edited

Loading

paulrutter commented Apr 25, 2024 •

edited

Loading

enapps-enorman commented Apr 25, 2024 •

edited

Loading

paulrutter commented Apr 25, 2024 •

edited

Loading

paulrutter commented Apr 26, 2024 •

edited

Loading

paulrutter commented Apr 29, 2024 •

edited

Loading

paulrutter commented May 1, 2024 •

edited

Loading

paulrutter commented May 1, 2024 •

edited

Loading