Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(proxy) supports websockets #1827

Merged
merged 3 commits into from
Dec 3, 2016
+57 −0
Merged

feat(proxy) supports websockets #1827

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b468e59
feat(proxy) supports websockets
subnetmarco Nov 17, 2016
eab1ffb
keep-alive by default, unless it is an Upgrade request
subnetmarco Nov 18, 2016
1bd0d20
bring back maps
subnetmarco Nov 19, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions kong/templates/nginx_kong.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ upstream kong_upstream {
keepalive ${{UPSTREAM_KEEPALIVE}};
}

map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
Copy link
Member

@thibaultcha thibaultcha Nov 17, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So if I understand correctly, this will set the headers to be sent to upstream as:

  • Connection: upgrade by default
  • Connection: close if the downstream Upgrade header is not set.

If so, this is a no-no. Switching to HTTP/1.1 is a good change (which we should have done a while ago but somehow never did. Properly managing the Connection header is also something that we somehow never implemented (very bad, proxies and gateways should never forward it to upstream services). But this is too rushed and not thought through.

In HTTP/1.1, connections are considered persistent by default. This means that unless a Connection: close header is sent from a client, the server will consider the connection as being persistent. Now, the problem here is that the defined behavior is to send Connection: close as soon as no Upgrade header is received from downstream, which means: no persistent connections, ever.

I believe a better solution could be:

map $http_upgrade $connection_upgrade {
    close close;
    upgrade  upgrade;
    default keep-alive;
}

To be tested of course.

}

server {
server_name kong;
listen ${{PROXY_LISTEN}};
Expand All @@ -89,10 +94,13 @@ server {
kong.access()
}

proxy_http_version 1.1;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header Host $upstream_host;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
proxy_pass_header Server;
proxy_pass $upstream_url;

Expand Down
44 changes: 44 additions & 0 deletions spec/02-integration/05-proxy/04-websockets_spec.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
local client = require "resty.websocket.client"
local helpers = require "spec.helpers"
local cjson = require "cjson"

describe("Websockets", function()
setup(function()
assert(helpers.start_kong())

assert(helpers.dao.apis:insert {
request_path = "/ws",
strip_request_path = true,
upstream_url = "http://sockb.in"
})
end)

teardown(function()
helpers.stop_kong()
end)

local function make_request(uri)
local wb = assert(client:new())
assert(wb:connect(uri))
assert(wb:send_text("testing Kong"))

local data = assert(wb:recv_frame())
assert.equal("testing Kong", cjson.decode(data).reqData)

assert(wb:send_close())

return true
end

it("works without Kong", function()
assert(make_request("ws://sockb.in"))
end)

it("works with Kong", function()
assert(make_request("ws://"..helpers.test_conf.proxy_ip..":"..helpers.test_conf.proxy_port.."/ws"))
end)

it("works with Kong under HTTPS", function()
assert(make_request("wss://"..helpers.test_conf.proxy_ssl_ip..":"..helpers.test_conf.proxy_ssl_port.."/ws"))
end)
end)