Support for Unix Domain Sockets #2471

dimitribouniol · 2020-08-12T17:18:55Z

Adds support for Unix Domain Sockets (#2471, #2226, #2371).

A server can be started using the serve command:

vapor run serve --unix-socket /tmp/vapor.socket

Alternatively, the app can be configured in code to connect to a socket:

app.http.server.configuration.unixDomainSocketPath = "/tmp/vapor.socket"

In either scenario, if a socket path is specified, it takes precedence over binding the server to a hostname/port. Note that TLS may be combined with this options if you wish the server to only listen to encrypted connections made to the socket file.

The socket file must not exist prior to starting the server. If one is left behind during an incomplete shutdown, however, and the app has permission to delete it, it will be overidden.

To assist with making connections to socket paths, URI.Scheme has a .httpUnixDomainSocket property.

try app.client.get(.init(scheme: .httpUnixDomainSocket, host: "/tmp/vapor.socket", path: "/foo"))

tanner0101

This looks great, thanks! LMK what you think of my comments inline.

Sources/Vapor/Commands/ServeCommand.swift

Sources/Vapor/HTTP/Server/HTTPServer.swift

Sources/Vapor/Utilities/URI.swift

Sources/Vapor/HTTP/Server/HTTPServer.swift

tanner0101

Great changes, thank you!

I've prefixed non-critical things with nit:. Feel free to ignore those. The other things I think must be fixed before merging.

Sources/Vapor/Commands/ServeCommand.swift

Sources/Vapor/HTTP/Server/HTTPServer.swift

Sources/Vapor/Server/Server.swift

Sources/Vapor/Utilities/URI.swift

Tests/VaporTests/ServerTests.swift

dimitribouniol · 2020-08-14T03:36:09Z

Ok, I think I got everything. Let me know if I should make any more changes!

Sources/Vapor/Utilities/URI.swift

…ile if one is provided

… a socket path as opposed to a hostname and port

…le wasn't removed beforehand

…a unix-socket

…PClient is happy with

…y be used for testing

Co-Authored-By: Gwynne Raskind <gwynne@users.noreply.github.com>

…ts http+unix URLs directly

…are used when starting up

…ic domain socket paths

…having multiple cases

…ck is valid

…ng connection point

…host

…I that takes a Scheme

dimitribouniol · 2020-08-17T16:33:31Z

Rebased off of the latest master.

tanner0101

Thanks! The updated Server protocol is much clearer and URI.Host is a great addition. Just a couple minor comments left. :)

Sources/Vapor/Server/Server.swift

Sources/Vapor/Commands/ServeCommand.swift

Sources/Vapor/Utilities/URI.swift

tanner0101

These changes LGTM. :) I've updated the PR body slightly to reflect the latest API. Ready to merge this?

dimitribouniol · 2020-08-19T20:44:46Z

Ready when you are! 🎉

dimitribouniol · 2020-08-20T02:52:32Z

Removed Note that making requests to other socket-path-based services requires AsyncHTTPClient 1.2.0 or newer. from the description, since Vapor now requires it anyways, so it should update on user's repos automatically.

tanner0101 · 2020-08-20T07:32:12Z

These changes are now available in 4.29.0

MrLotU · 2020-08-20T07:32:23Z

Thanks @dimitribouniol :D

tanner0101 · 2020-08-20T17:16:27Z

Thanks for the great additions @dimitribouniol !

dimitribouniol · 2020-08-20T17:22:08Z

@tanner0101 @MrLotU Thank you both for helping make this the best it could be!

dimitribouniol mentioned this pull request Aug 12, 2020

Support for Unix Domain Sockets #2371

Closed

tanner0101 added enhancement New feature or request semver-minor Contains new API labels Aug 12, 2020

tanner0101 added this to Awaiting Review in Vapor 4 via automation Aug 12, 2020

dimitribouniol force-pushed the unix-domain-sockets branch from d37beae to efb46a2 Compare August 12, 2020 17:50

tanner0101 reviewed Aug 12, 2020

View reviewed changes

dimitribouniol commented Aug 12, 2020

View reviewed changes

Sources/Vapor/HTTP/Server/HTTPServer.swift Outdated Show resolved Hide resolved

dimitribouniol commented Aug 12, 2020

View reviewed changes

Sources/Vapor/HTTP/Server/HTTPServer.swift Outdated Show resolved Hide resolved

tanner0101 reviewed Aug 13, 2020

View reviewed changes

dimitribouniol force-pushed the unix-domain-sockets branch from dbe3bb4 to 17a8df8 Compare August 14, 2020 00:36

dimitribouniol commented Aug 14, 2020

View reviewed changes

Sources/Vapor/Utilities/URI.swift Outdated Show resolved Hide resolved

dimitribouniol and others added 18 commits August 17, 2020 09:28

Added socket path to the HTTPServer.Configuration

0d398b6

Updated the HTTPServerConnection start() method to bind to a socket f…

7f1e2b4

…ile if one is provided

Refactored the Server start() methods to allow starting a server with…

d62b14b

… a socket path as opposed to a hostname and port

Fixed an issue where the server could not be started if the socket fi…

0eb77b1

…le wasn't removed beforehand

Added an option to serve an instance via swift run Run serve using …

de37ff1

…a unix-socket

Added an extension to URI that encodes socket paths in a way AsyncHTT…

2cd6aa9

…PClient is happy with

Updated the EventLoopHTTPClient to decode socket path URIs so they ma…

889a01a

…y be used for testing

Refactored socket file checking code to be more versatile

7d81d0f

Co-Authored-By: Gwynne Raskind <gwynne@users.noreply.github.com>

Removed an unnecessary check for the socket path option

b7063ad

Removed unnecessary URL handling code now that AsyncHTTPClient suppor…

f803d4d

…ts http+unix URLs directly

Removed socket file handling code in favor of NIO handling it natively

cadcdec

Added additional checks to ensure only valid combinations of options …

042d1f0

…are used when starting up

Renamed the convenience initializer for creating URIs that bind to un…

71f9924

…ic domain socket paths

Refactored server start methods to use a BindAddress enum instead of …

e78fd60

…having multiple cases

Deprecated the old start(hostname: String?, port: Int?) Server method

9892d2d

Added deprecated fallback implementations for Server start methods

6c2a53a

Simplified startup option checks to start the server as soon as a che…

e56a21d

…ck is valid

Refactored HTTPServer.Configuration to use an address as its underlyi…

7d51de9

…ng connection point

dimitribouniol added 2 commits August 17, 2020 09:28

Removed the extension on URI, integrating the transformation for any …

c302cd0

…host

Added URI.Scheme with common schemes, along with an initializer on UR…

6c77aaa

…I that takes a Scheme

dimitribouniol force-pushed the unix-domain-sockets branch from ea2cd0b to 6c77aaa Compare August 17, 2020 16:28

tanner0101 reviewed Aug 18, 2020

View reviewed changes

dimitribouniol added 2 commits August 18, 2020 14:52

Refactored ServeCommand.Error and made ServerStartError internal

1f4392e

Refactored URI.Scheme into a struct and added tests

c5e3bd3

tanner0101 approved these changes Aug 19, 2020

View reviewed changes

MrLotU merged commit d910be4 into vapor:master Aug 20, 2020

Vapor 4 automation moved this from Awaiting Review to Done Aug 20, 2020

dimitribouniol deleted the unix-domain-sockets branch August 22, 2020 14:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for Unix Domain Sockets #2471

Support for Unix Domain Sockets #2471

dimitribouniol commented Aug 12, 2020 •

edited

tanner0101 left a comment

tanner0101 left a comment •

edited

dimitribouniol commented Aug 14, 2020

dimitribouniol commented Aug 17, 2020

tanner0101 left a comment

tanner0101 left a comment

dimitribouniol commented Aug 19, 2020

dimitribouniol commented Aug 20, 2020

tanner0101 commented Aug 20, 2020

MrLotU commented Aug 20, 2020

tanner0101 commented Aug 20, 2020 •

edited

dimitribouniol commented Aug 20, 2020

Support for Unix Domain Sockets #2471

Support for Unix Domain Sockets #2471

Conversation

dimitribouniol commented Aug 12, 2020 • edited

tanner0101 left a comment

Choose a reason for hiding this comment

tanner0101 left a comment • edited

Choose a reason for hiding this comment

dimitribouniol commented Aug 14, 2020

dimitribouniol commented Aug 17, 2020

tanner0101 left a comment

Choose a reason for hiding this comment

tanner0101 left a comment

Choose a reason for hiding this comment

dimitribouniol commented Aug 19, 2020

dimitribouniol commented Aug 20, 2020

tanner0101 commented Aug 20, 2020

MrLotU commented Aug 20, 2020

tanner0101 commented Aug 20, 2020 • edited

dimitribouniol commented Aug 20, 2020

dimitribouniol commented Aug 12, 2020 •

edited

tanner0101 left a comment •

edited

tanner0101 commented Aug 20, 2020 •

edited