@RouteFilter stopped working with WebSocket requests Quarkus 3.2.0.Final

[AlekseyMay]

Describe the bug

We were migrating from 2.16.7 to 3.2.0.Final

And we have WebSocket interceptor implemented with @RouteFilter

It looks like this:

@RouteFilter
 void authFilter(RoutingContext rc) {
    /// logic to search for websocket header etc
}

We use it to intercept GQL Subscriptions and its initial websocket request.
After migration to 3.2.0.Final it stopped intercepting WebSocket for some reason.

Expected behavior

Intercept all requests as it was in 2.16.7

Actual behavior

Not intercepting websocket initial request

How to Reproduce?

No response

Output of uname -a or ver

No response

Output of java -version

17

GraalVM version (if different from Java)

No response

Quarkus version or git rev

3.2.0.Final

Build tool (ie. output of mvnw --version or gradlew --version)

gradle 8.1.1

Additional information

No response

[geoand]

cc @mkouba

[AlekseyMay]

@mkouba
Any help or comments pls, maybe I am doing smth wrong with @RouteFilter in quarkus 3+?
Really need this functionality...

[mkouba]

We use it to intercept GQL Subscriptions and its initial websocket request.
After migration to 3.2.0.Final it stopped intercepting WebSocket for some reason.

I'm not aware of any change in the implementation of @RouteFilter.

Maybe it's related to some change in the smallrye-graphql?

CC @phillip-kruger @jmartisk

[jmartisk]

This doesn't look dependent on GraphQL, nor am I aware of any changes in this area. Perhaps a reproducer project would help?

[AlekseyMay]

Reproducer.zip

@jmartisk @mkouba

Thank you for the response. Here is the reproducer.

To reproduce you can do the following:

1. start the app
2. try to call query

query {
  sayHello
 }

3. You'll see that the request is intercepted and the headers are printed in the console.
4. Then try to initiate websocket connection. It can be manually called with 'ws://localhost:8085/graphql' from Postman or it can be done from dev gql ui by calling subscribe .
5. If you call it manually then you will see nothing in console, if you subscribed from ui you'll see the log from controller that is printed on subscription command. And no log from interceptor.

After all this the version of Quarkus can be changed to 2.16.9.Final in pom.xml.
You can try the same steps, and you should see the interception of websocket initiation and logs printed from interceptor on websocket initiation request.

This is very strange, maybe I am doing smth wrong...

[uPagge]

Hello everyone. I have the same problem :(

[mkouba]

Hm, the SmallRyeGraphQLOverWebSocketHandler which handles the HTTP UPGRADE header is registered with priority Integer.MIN_VALUE and does not call the next route so I would say that the filter route should not be called. But the same priority is used in 2.16 🤷.

[phillip-kruger]

Is it not working in any v3.x ? Or just 3.2.0 ? Because then it might be Dev UI ? Also check Dev Mode vs Prod mode ? That should rule out (or in) Dev UI

[AlekseyMay]

@phillip-kruger @mkouba

I have tested several versions from 3 up to 3.2.2 and the problem always appears.

I've recorded small video showing the problem using the Reproducer that is attached, maybe it can help to understand the problem. First I try with 3.2.0 Final then same steps with 2.16.9 Final. And the request is only intercepted in 2.16.9 Final.
https://drive.google.com/file/d/1Mi5HCaVy2fWL5CP5b52nypP0Gp-k8Jaq/view

[phillip-kruger]

@AlekseyMay can you test in non dev mode ? So build the jar and run with java -jar ?

[AlekseyMay]

@phillip-kruger

For me the result is the the same. Intercepted with 2.16.9 and not with 3.2.0. I ve done the same steps as on video.

[phillip-kruger]

Thanks ! That kind of rule out Dev UI. @jmartisk @mkouba are you going to look at this ? I can't look at this right away.

[mkouba]

I've recorded small video showing the problem using the Reproducer that is attached, maybe it can help to understand the problem.

I do understand the problem and I'm able to reproduce it. But I'm still not convinced it should work. Like I mentioned in #34908 (comment).

Thanks ! That kind of rule out Dev UI. @jmartisk @mkouba are you going to look at this ? I can't look at this right away.

I'm trying to debug the reproducer. With 2.16 the com.example.Interceptor.filter(RoutingContext) is executed before SmallRyeGraphQLOverWebSocketHandler even though it has order=-10 and SmallRyeGraphQLOverWebSocketHandler has order=-2147483648. Maybe the behavior changed between Vert.x 4.3.7 and 4.4.4? IIUIC it was fixed.

[mkouba]

Ok, I found it. It worked by coincidence because HttpRootPathBuildItem.Builder.orderedRoute() was never used before quarkus 3.0, i.e. the value -1 was always used and therefore the com.example.Interceptor#filter() which has the default priority for filters: -10, was executed before the SmallRyeGraphQLOverWebSocketHandler. We fixed this bug in #32008. So now the ordering is correct but since the SmallRyeGraphQLOverWebSocketHandler is registered with order=-2147483648 it's always executed before the Interceptor#filter().

@phillip-kruger I believe that SmallRyeGraphQLOverWebSocketHandler should use a different value so that it's possible to register a filter that can be executed before this handler. WDYT?

[phillip-kruger]

Nice ! Thanks @mkouba . Yes for sure. I recall some internal ranges somewhere.... It's probably on Integer.MAX_VALUE at the moment, we should defiantly change that. @mkouba do you want to do the fix ? Else @jmartisk can add it to our todo list :)

[mkouba]

Nice ! Thanks @mkouba . Yes for sure. I recall some internal ranges somewhere.... It's probably on Integer.MAX_VALUE at the moment, we should defiantly change that. @mkouba do you want to do the fix ? Else @jmartisk can add it to our todo list :)

I can send a PR shortly. I'm not aware of any "internal ranges" but using a fixed value such as -1000 should be enough.

[phillip-kruger]

Perfect ! Thanks.

[mkouba]

@AlekseyMay So once the #35188 is merged you can use @RouteFilter(10_001) (or any value > 10000).

[AlekseyMay]

@mkouba @phillip-kruger
Thanks a lot for the help