[WIP] Implement Dropwizard Unix socket connector #1893

arteam · 2017-01-18T08:39:26Z

This pull requests some basic work for supporting a Unix Socket connector in Dropwizard. The implementation seems to be rather simple, but I stumled on some problems:

I wasn't able to run a server in the default mode because of some admin thread pool management issues.
The server doesn't shut down gracefully. It waits 30 seconds and then killed forcefully after a SIGTERM signal is sent.

The original issue is #1889.

arteam · 2017-01-18T09:41:18Z

Regarding the second error I believe we affected by jetty/jetty.project#1044.
Linux native poll connector returns a null SelectionKey at some moment during graceful shutdown.

DEBUG [2017-01-18 09:36:19,876] org.eclipse.jetty.io.ManagedSelector: Could not run action org.eclipse.jetty.io.ManagedSelector$CloseEndPoints@38d525aa
! java.lang.NullPointerException: null
! at org.eclipse.jetty.io.ManagedSelector$CloseEndPoints.run(ManagedSelector.java:761)
! at org.eclipse.jetty.io.ManagedSelector$SelectorProducer.nextAction(ManagedSelector.java:284)
! at org.eclipse.jetty.io.ManagedSelector$SelectorProducer.produce(ManagedSelector.java:248)
! at org.eclipse.jetty.util.thread.strategy.ExecuteProduceConsume.produceConsume(ExecuteProduceConsume.java:147)
! at org.eclipse.jetty.util.thread.strategy.ExecuteProduceConsume.run(ExecuteProduceConsume.java:133)
! at org.eclipse.jetty.util.thread.QueuedThreadPool.runJob(QueuedThreadPool.java:672)
! at org.eclipse.jetty.util.thread.QueuedThreadPool$2.run(QueuedThreadPool.java:590)

nickbabcock · 2017-01-18T12:47:31Z

dropwizard-unixsocket/src/main/java/io/dropwizard/unixsocket/UnixSocketFactory.java

+@JsonTypeName("unixsocket")
+public class UnixSocketFactory extends HttpConnectorFactory {
+
+    private String socketFilename = "/tmp/dropwizard.sock";


Should we prefer /var/run/dropwizard.sock (Stackoverflow)?

That's a good idea.

After the second thought, it looks not so good. Not every process has enough permissions to write to the /var/run directory. I believe, you need to have a special directory under /var/run with the permissions for the user which runs the process.

Yeah that's fine. If I were using unix sockets I'd most likely change the socket location anyways...to something like /var/run/<servicename>.sock. But it may be something to add in the documentation (eg. normally unix domain sockets are in /var/run, but since we may not be running as root or have adequate permissions, store the file in /tmp)

nickbabcock · 2017-01-18T20:27:17Z

...wizard-unixsocket/src/test/java/io/dropwizard/unixsocket/UnixSocketConnectorFactoryTest.java

+import java.io.Reader;
+import java.nio.channels.Channels;
+
+public class UnixSocketConnectorFactoryTest {


May need to disable this test for windows builds, no?

jplock · 2017-01-18T21:00:43Z

dropwizard-unixsocket/src/main/java/io/dropwizard/unixsocket/UnixSocketConnectorFactory.java

+ *     </tr>
+ *     <tr>
+ *         <td>{@code socketFilename}</td>
+ *         <td></tmp/dropwizard.sock</td>


there's an extra < in here

nickbabcock · 2017-01-27T16:14:20Z

jetty-9.4.1.v20170120 is out and fixes the timeout issue, though it doesn't fix the bug where socket errors arise under load

arteam · 2018-02-19T18:29:41Z

I think the bug in the jnr library hasn't been fixed. I believe I submitted a PR for a while: jnr/jnr-enxio#25

joschi · 2018-07-30T11:06:24Z

...wizard-unixsocket/src/test/java/io/dropwizard/unixsocket/UnixSocketConnectorFactoryTest.java

+
+    @Before
+    public void setUp() {
+        assumeFalse(SystemUtils.IS_OS_WINDOWS);


Does anyone have an idea why this doesn't seem to work on AppVeyor?

https://ci.appveyor.com/project/arteam/dropwizard/build/1836#L10337

[ERROR] testManyClientCalls(io.dropwizard.unixsocket.UnixSocketConnectorFactoryTest) Time elapsed: 1.795 s <<< ERROR! java.lang.UnsatisfiedLinkError: The operation completed successfully. [ERROR] testClient(io.dropwizard.unixsocket.UnixSocketConnectorFactoryTest) Time elapsed: 0 s <<< ERROR! java.lang.UnsatisfiedLinkError: The operation completed successfully.

By UnsatisfiedLinkError looks like that native method not found.
Maybe you have to specify image to run maven in appveyor, e.g. image: ubuntu

Here more info:
https://www.appveyor.com/docs/getting-started-with-appveyor-for-linux/#running-your-build-on-linux

@alex-shpak The whole point of using AppVeyor is to make sure that Dropwizard can be built on Windows. 😉

From my understanding, the assumption in the @Before method should prevent all tests from running on Windows. But that doesn't seem to work. 🤔

https://static.javadoc.io/junit/junit/4.12/org/junit/Assume.html

https://github.com/junit-team/junit4/wiki/assumptions-with-assume

Try:

@BeforeClass public static void setUp() { assumeFalse(SystemUtils.IS_OS_WINDOWS); }

Edit: (that made the test ignored on my windows machine)

@nickbabcock Seems to have worked. Thanks!
https://ci.appveyor.com/project/arteam/dropwizard/build/1838#L8658

jplock · 2018-07-31T13:49:13Z

@arteam @joschi @nickbabcock this all set? tests passed 👍 💯 🎉

joschi · 2018-07-31T13:51:34Z

@jplock I'd like to wait for the pull request in jnr/jnr-enxio to be merged until we merge this PR.

Additionally, the tests in UnixSocketConnectorFactoryTest don't have any assertions right now and should be reworked.

But at least the branch now builds on all of our CI systems. 😉

arteam · 2018-08-02T19:54:06Z

It looks like Jetty fixed their integration issues with jnr, and I don't see 30 seconds timeouts during shutdown. I don't know anything about socket errors under load, haven't done any performance testing.

nickbabcock · 2018-08-02T20:21:30Z

I don't know anything about socket errors under load, haven't done any performance testing.

Don't worry, I did the load test in the jetty issue: jetty/jetty.project#1281 and no errors arose.

MadalinaPatrichi · 2019-02-06T10:49:02Z

Is this going to be merged in? It would be awesome to have this feature in

joschi · 2019-02-07T08:52:49Z

@MadalinaPatrichi We currently don't plan to push this further.

If you're interested in this feature, it would be great if you could help us work out the problems with this PR.

natnan · 2019-02-24T09:53:44Z

What are the current problems? Travis builds and no assertions in UnixSocketConnectorFactoryTest?

Refs 8baa80f

joschi · 2019-02-24T10:41:20Z

What are the current problems? Travis builds and no assertions in UnixSocketConnectorFactoryTest?

@natnan Yes, pretty much the missing test coverage, the flaky tests, and some transitive dependency foobar.

joschi · 2019-02-24T11:45:29Z

I'm a bit hesitant to invest more time into this, given that it's not a stable feature in Jetty.

jetty/jetty.project#3136 (comment)

first let me say that UnixSocket support in Jetty is at best experimental, at worst it is neglected and close to being ejected. We stopped working on the unix socket connector when JNR was not being maintained and our PRs to them were not being accepted.

joschi · 2019-02-24T11:46:24Z

@dropwizard/committers Anyone wants to chime in? Otherwise I'd close this PR unless it's working reliably and the UNIX socket support in Jetty becomes stable.

nickbabcock · 2019-02-24T13:55:32Z

Yeah an relying on an experimental feature would be shaky. I'm in favor of closing and re-evaluating in the future.

joschi · 2019-03-03T12:56:14Z

Closed due to experimental feature in upstream project.

natan-abolafya · 2023-09-27T14:52:53Z

hey there. this can potentially be revived now considering it's not experimental anymore: https://webtide.com/unixdomain-support-in-jetty/
I applied the code here with some adjustments to our application and it seems to be functioning well. Though I haven't done any stress testing or anything.

joschi · 2023-10-04T08:43:53Z

@natan-abolafya Thanks for looking into this.

Would you like to create a pull request against the release/4.0.x branch with the updated implementation?

natan-abolafya · 2023-10-04T08:46:13Z

Will be very happy to try. I should be able to look into it probably early next week.

Co-authored-by: Steffen Nießing <zuniquex@protonmail.com> ###### Problem: Since Java 16, Unix Domain Sockets are supported natively. And since Jetty 10, there is a ready made connector for it and it is not considered experimental anymore. The typical use case is a reverse proxy connecting to UNIX socket instead of TCP which has various advantages. ###### Solution: Created a new connector type `unix-socket`. I've reimplemented #1893 but it needed some adjustments considering how much Dropwizard changed since then. The test was also a little tricky (and not very pretty) considering there is no UNIX socket support in Apache HTTP client. Or at least I couldn't find any but please correct me otherwise. ###### Result: It's pretty simple to listen on unix sockets now. That was something we wanted in our product for a long time. Also this works on Windows since Windows now also supports UNIX domain sockets. Refs #1893

Co-authored-by: Steffen Nießing <zuniquex@protonmail.com> Since Java 16, Unix Domain Sockets are supported natively. And since Jetty 10, there is a ready made connector for it and it is not considered experimental anymore. The typical use case is a reverse proxy connecting to UNIX socket instead of TCP which has various advantages. Created a new connector type `unix-socket`. I've reimplemented #1893 but it needed some adjustments considering how much Dropwizard changed since then. The test was also a little tricky (and not very pretty) considering there is no UNIX socket support in Apache HTTP client. Or at least I couldn't find any but please correct me otherwise. It's pretty simple to listen on UNIX sockets now. That was something we wanted in our product for a long time. Also this works on Windows since Windows now also supports UNIX domain sockets. Refs #1893 Refs #7614 (cherry picked from commit 1de3eef)

Co-authored-by: Steffen Nießing <zuniquex@protonmail.com> Co-authored-by: Natan Abolafya <natan.abolafya@appgate.com> Since Java 16, Unix Domain Sockets are supported natively. And since Jetty 10, there is a ready made connector for it and it is not considered experimental anymore. The typical use case is a reverse proxy connecting to UNIX socket instead of TCP which has various advantages. Created a new connector type `unix-socket`. I've reimplemented #1893 but it needed some adjustments considering how much Dropwizard changed since then. The test was also a little tricky (and not very pretty) considering there is no UNIX socket support in Apache HTTP client. Or at least I couldn't find any but please correct me otherwise. It's pretty simple to listen on UNIX sockets now. That was something we wanted in our product for a long time. Also this works on Windows since Windows now also supports UNIX domain sockets. Refs #1893 Refs #7614 (cherry picked from commit 1de3eef)

arteam force-pushed the dropwizard_unix_sockets branch 3 times, most recently from 3525675 to b577d32 Compare January 18, 2017 09:11

nickbabcock reviewed Jan 18, 2017

View reviewed changes

arteam force-pushed the dropwizard_unix_sockets branch from b577d32 to b30c295 Compare January 18, 2017 18:15

nickbabcock reviewed Jan 18, 2017

View reviewed changes

jplock reviewed Jan 18, 2017

View reviewed changes

nickbabcock mentioned this pull request Jan 20, 2017

UnixSocketConnector support #1889

Closed

arteam force-pushed the master branch from 6668cfa to d98bfe5 Compare January 21, 2017 14:10

arteam force-pushed the dropwizard_unix_sockets branch from b30c295 to 1ef2b68 Compare January 28, 2017 10:19

arteam force-pushed the dropwizard_unix_sockets branch from f0f336f to 31598aa Compare February 19, 2018 18:06

joschi force-pushed the dropwizard_unix_sockets branch from bfd004b to 6e7bfd9 Compare July 27, 2018 15:04

jplock approved these changes Jul 27, 2018

View reviewed changes

jplock added this to the 2.0.0 milestone Jul 27, 2018

jplock added the feature label Jul 27, 2018

joschi added the blocked label Jul 30, 2018

joschi reviewed Jul 30, 2018

View reviewed changes

arteam mentioned this pull request Aug 2, 2018

Fix the keys method for PollSelector jnr/jnr-enxio#25

Closed

arteam added 2 commits February 24, 2019 11:13

Set up a framework for the dropwizad-unixsocket module

a7b068a

Add a unix socket connector

e32d879

joschi and others added 3 commits February 24, 2019 11:13

Show Maven version on AppVeyor (for real!)

8276d68

Refs 8baa80f

Try not running UnixSocketConnectorFactoryTest on Windows

1a185df

Add assertions for UNIX socket tests

682895d

joschi force-pushed the dropwizard_unix_sockets branch from dd9dfd4 to 682895d Compare February 24, 2019 10:13

Set correct version in dropwizard-unixsocket

65ebd95

joschi added 2 commits February 24, 2019 12:03

Pin various com.github.jnr versions

3702010

Simplify tests

04f10e1

jplock removed this from the 2.0.0 milestone Feb 24, 2019

joschi closed this Mar 3, 2019

joschi deleted the dropwizard_unix_sockets branch March 3, 2019 12:56

natan-abolafya mentioned this pull request Oct 6, 2023

Unix domain socket connector #7614

Merged

This was referenced Jan 26, 2024

Unix domain socket connector #8287

Merged

Unix domain socket connector #8288

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Implement Dropwizard Unix socket connector #1893

[WIP] Implement Dropwizard Unix socket connector #1893

arteam commented Jan 18, 2017 •

edited

Loading

arteam commented Jan 18, 2017

nickbabcock Jan 18, 2017

arteam Jan 18, 2017 •

edited

Loading

arteam Jan 18, 2017 •

edited

Loading

nickbabcock Jan 18, 2017

nickbabcock Jan 18, 2017

jplock Jan 18, 2017

nickbabcock commented Jan 27, 2017

arteam commented Feb 19, 2018 •

edited

Loading

joschi Jul 30, 2018 •

edited

Loading

alex-shpak Jul 30, 2018

joschi Jul 30, 2018

nickbabcock Jul 30, 2018 •

edited

Loading

joschi Jul 30, 2018

jplock commented Jul 31, 2018

joschi commented Jul 31, 2018

arteam commented Aug 2, 2018

nickbabcock commented Aug 2, 2018

MadalinaPatrichi commented Feb 6, 2019 •

edited

Loading

joschi commented Feb 7, 2019

natnan commented Feb 24, 2019

joschi commented Feb 24, 2019

joschi commented Feb 24, 2019

joschi commented Feb 24, 2019

nickbabcock commented Feb 24, 2019

joschi commented Mar 3, 2019

natan-abolafya commented Sep 27, 2023 •

edited

Loading

joschi commented Oct 4, 2023

natan-abolafya commented Oct 4, 2023

[WIP] Implement Dropwizard Unix socket connector #1893

[WIP] Implement Dropwizard Unix socket connector #1893

Conversation

arteam commented Jan 18, 2017 • edited Loading

arteam commented Jan 18, 2017

nickbabcock Jan 18, 2017

Choose a reason for hiding this comment

arteam Jan 18, 2017 • edited Loading

Choose a reason for hiding this comment

arteam Jan 18, 2017 • edited Loading

Choose a reason for hiding this comment

nickbabcock Jan 18, 2017

Choose a reason for hiding this comment

nickbabcock Jan 18, 2017

Choose a reason for hiding this comment

jplock Jan 18, 2017

Choose a reason for hiding this comment

nickbabcock commented Jan 27, 2017

arteam commented Feb 19, 2018 • edited Loading

joschi Jul 30, 2018 • edited Loading

Choose a reason for hiding this comment

alex-shpak Jul 30, 2018

Choose a reason for hiding this comment

joschi Jul 30, 2018

Choose a reason for hiding this comment

nickbabcock Jul 30, 2018 • edited Loading

Choose a reason for hiding this comment

joschi Jul 30, 2018

Choose a reason for hiding this comment

jplock commented Jul 31, 2018

joschi commented Jul 31, 2018

arteam commented Aug 2, 2018

nickbabcock commented Aug 2, 2018

MadalinaPatrichi commented Feb 6, 2019 • edited Loading

joschi commented Feb 7, 2019

natnan commented Feb 24, 2019

joschi commented Feb 24, 2019

joschi commented Feb 24, 2019

joschi commented Feb 24, 2019

nickbabcock commented Feb 24, 2019

joschi commented Mar 3, 2019

natan-abolafya commented Sep 27, 2023 • edited Loading

joschi commented Oct 4, 2023

natan-abolafya commented Oct 4, 2023

arteam commented Jan 18, 2017 •

edited

Loading

arteam Jan 18, 2017 •

edited

Loading

arteam Jan 18, 2017 •

edited

Loading

arteam commented Feb 19, 2018 •

edited

Loading

joschi Jul 30, 2018 •

edited

Loading

nickbabcock Jul 30, 2018 •

edited

Loading

MadalinaPatrichi commented Feb 6, 2019 •

edited

Loading

natan-abolafya commented Sep 27, 2023 •

edited

Loading