You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2021/03/19 21:56:33 UTC
[GitHub] [nifi] exceptionfactory opened a new pull request #4918: NIFI-8347 Set ClassLoader for JettyWebSocketServer to resolve runtime exceptions
exceptionfactory opened a new pull request #4918:
URL: https://github.com/apache/nifi/pull/4918
#### Description of PR
NIFI-8347 Updates `JettyWebSocketServer.JettyWebSocketServlet` to override the `init()` method and call `Thread.currentThread().setContextClassLoader()` using the component's NAR ClassLoader. This change is necessary in order for the Jetty `WebSocketServerFactory.Loader` to have access to the `jetty-server` classes provided through the `nifi-jetty-bundle`.
The problem reported in the associated Jira issue can be reproduced using `ListenWebSocket` configured with `JettyWebSocketServer` and making a request to the configured listening port of the server.
Changes in this PR include an additional unit test method to test a successful connect to the Jetty WebSocket Server.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [X] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [X] Does your PR title start with **NIFI-XXXX** where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [X] Has your PR been rebased against the latest commit within the target branch (typically `main`)?
- [X] Is your initial contribution a single, squashed commit? _Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not `squash` or use `--force` when pushing to allow for clean monitoring of changes._
### For code changes:
- [X] Have you ensured that the full suite of tests is executed via `mvn -Pcontrib-check clean install` at the root `nifi` folder?
- [X] Have you written or updated unit tests to verify your changes?
- [X] Have you verified that the full build is successful on JDK 8?
- [ ] Have you verified that the full build is successful on JDK 11?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the `LICENSE` file, including the main `LICENSE` file under `nifi-assembly`?
- [ ] If applicable, have you updated the `NOTICE` file, including the main `NOTICE` file found under `nifi-assembly`?
- [ ] If adding new Properties, have you added `.displayName` in addition to .name (programmatic access) for each of the new properties?
### For documentation related changes:
- [ ] Have you ensured that format looks appropriate for the output in which it is rendered?
### Note:
Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] turcsanyip commented on a change in pull request #4918: NIFI-8347 Set ClassLoader for JettyWebSocketServer to resolve runtime exceptions
Posted by GitBox <gi...@apache.org>.
turcsanyip commented on a change in pull request #4918:
URL: https://github.com/apache/nifi/pull/4918#discussion_r600926356
##########
File path: nifi-nar-bundles/nifi-websocket-bundle/nifi-websocket-services-jetty/src/main/java/org/apache/nifi/websocket/jetty/JettyWebSocketServer.java
##########
@@ -213,6 +214,14 @@ public void configure(WebSocketServletFactory webSocketServletFactory) {
webSocketServletFactory.setCreator(this);
}
+ @Override
+ public void init() throws ServletException {
+ // Set Component ClassLoader as Thread Context ClassLoader so that jetty-server classes are available to WebSocketServletFactory.Loader
+ final ClassLoader componentClassLoader = getClass().getClassLoader();
+ Thread.currentThread().setContextClassLoader(componentClassLoader);
+ super.init();
+ }
Review comment:
The class loader for the servlet worker threads can be set on `ServletContextHandler` when you build up the Jetty server / servlets.
```
final ServletContextHandler contextHandler = new ServletContextHandler();
contextHandler.setClassLoader(Thread.currentThread().getContextClassLoader());
```
(I used the instance class loader here because it was originally in 1.12 but the component class loader can also be used).
I'm not sure which one is the right way to set the class loader but using the `ServletContextHandler` API seems to me less "hack".
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] asfgit closed pull request #4918: NIFI-8347 Set ClassLoader for JettyWebSocketServer to resolve runtime exceptions
Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #4918:
URL: https://github.com/apache/nifi/pull/4918
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] exceptionfactory commented on a change in pull request #4918: NIFI-8347 Set ClassLoader for JettyWebSocketServer to resolve runtime exceptions
Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on a change in pull request #4918:
URL: https://github.com/apache/nifi/pull/4918#discussion_r600953627
##########
File path: nifi-nar-bundles/nifi-websocket-bundle/nifi-websocket-services-jetty/src/main/java/org/apache/nifi/websocket/jetty/JettyWebSocketServer.java
##########
@@ -213,6 +214,14 @@ public void configure(WebSocketServletFactory webSocketServletFactory) {
webSocketServletFactory.setCreator(this);
}
+ @Override
+ public void init() throws ServletException {
+ // Set Component ClassLoader as Thread Context ClassLoader so that jetty-server classes are available to WebSocketServletFactory.Loader
+ final ClassLoader componentClassLoader = getClass().getClassLoader();
+ Thread.currentThread().setContextClassLoader(componentClassLoader);
+ super.init();
+ }
Review comment:
Thanks for the feedback @turcsanyip! That makes sense, and provides a cleaner solution. I confirmed that setting the `ServletContextLoader` `ClassLoader` works at runtime.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] wangfushun-work commented on pull request #4918: NIFI-8347 Set ClassLoader for JettyWebSocketServer to resolve runtime exceptions
Posted by GitBox <gi...@apache.org>.
wangfushun-work commented on pull request #4918:
URL: https://github.com/apache/nifi/pull/4918#issuecomment-824726639
And,i use JettyWebSocketServer :1.12.1 in nifi:1.13.2,the problem reported.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org