mirror of
				https://gitea.invidious.io/iv-org/shard-kemal.git
				synced 2024-08-15 00:53:36 +00:00 
			
		
		
		
	Add context to WebSocket. This allows one to use context.params like url,query, body e.g
This commit is contained in:
		
							parent
							
								
									5a83522866
								
							
						
					
					
						commit
						2b604dfb30
					
				
					 9 changed files with 71 additions and 41 deletions
				
			
		|  | @ -55,6 +55,7 @@ describe "Context" do | ||||||
|         before_get_context_test: env.get("before_get_context_test"), |         before_get_context_test: env.get("before_get_context_test"), | ||||||
|       } |       } | ||||||
|     end |     end | ||||||
|  | 
 | ||||||
|     request = HTTP::Request.new("GET", "/") |     request = HTTP::Request.new("GET", "/") | ||||||
|     io = IO::Memory.new |     io = IO::Memory.new | ||||||
|     response = HTTP::Server::Response.new(io) |     response = HTTP::Server::Response.new(io) | ||||||
|  |  | ||||||
|  | @ -9,7 +9,7 @@ describe "Kemal::FilterHandler" do | ||||||
|     filter_middleware._add_route_filter("GET", "/greetings", :before) { test_filter.modified = "true" } |     filter_middleware._add_route_filter("GET", "/greetings", :before) { test_filter.modified = "true" } | ||||||
| 
 | 
 | ||||||
|     kemal = Kemal::RouteHandler::INSTANCE |     kemal = Kemal::RouteHandler::INSTANCE | ||||||
|     kemal.add_route "GET", "/greetings" { test_filter.modified } |     kemal.add_http_route "GET", "/greetings" { test_filter.modified } | ||||||
| 
 | 
 | ||||||
|     test_filter.modified.should eq("false") |     test_filter.modified.should eq("false") | ||||||
|     request = HTTP::Request.new("GET", "/greetings") |     request = HTTP::Request.new("GET", "/greetings") | ||||||
|  | @ -27,8 +27,8 @@ describe "Kemal::FilterHandler" do | ||||||
|     filter_middleware._add_route_filter("GET", "/greetings", :before) { test_filter.modified = test_filter.modified == "true" ? "false" : "true" } |     filter_middleware._add_route_filter("GET", "/greetings", :before) { test_filter.modified = test_filter.modified == "true" ? "false" : "true" } | ||||||
| 
 | 
 | ||||||
|     kemal = Kemal::RouteHandler::INSTANCE |     kemal = Kemal::RouteHandler::INSTANCE | ||||||
|     kemal.add_route "GET", "/greetings" { test_filter.modified } |     kemal.add_http_route "GET", "/greetings" { test_filter.modified } | ||||||
|     kemal.add_route "POST", "/greetings" { test_filter.modified } |     kemal.add_http_route "POST", "/greetings" { test_filter.modified } | ||||||
| 
 | 
 | ||||||
|     test_filter.modified.should eq("false") |     test_filter.modified.should eq("false") | ||||||
| 
 | 
 | ||||||
|  | @ -55,8 +55,8 @@ describe "Kemal::FilterHandler" do | ||||||
|     filter_middleware._add_route_filter("POST", "/greetings", :before) { test_filter.modified = test_filter.modified == "true" ? "false" : "true" } |     filter_middleware._add_route_filter("POST", "/greetings", :before) { test_filter.modified = test_filter.modified == "true" ? "false" : "true" } | ||||||
| 
 | 
 | ||||||
|     kemal = Kemal::RouteHandler::INSTANCE |     kemal = Kemal::RouteHandler::INSTANCE | ||||||
|     kemal.add_route "GET", "/greetings" { test_filter.modified } |     kemal.add_http_route "GET", "/greetings" { test_filter.modified } | ||||||
|     kemal.add_route "POST", "/greetings" { test_filter.modified } |     kemal.add_http_route "POST", "/greetings" { test_filter.modified } | ||||||
| 
 | 
 | ||||||
|     test_filter.modified.should eq("false") |     test_filter.modified.should eq("false") | ||||||
| 
 | 
 | ||||||
|  | @ -81,7 +81,7 @@ describe "Kemal::FilterHandler" do | ||||||
|     filter_middleware._add_route_filter("GET", "/greetings", :after) { test_filter.modified = "true" } |     filter_middleware._add_route_filter("GET", "/greetings", :after) { test_filter.modified = "true" } | ||||||
| 
 | 
 | ||||||
|     kemal = Kemal::RouteHandler::INSTANCE |     kemal = Kemal::RouteHandler::INSTANCE | ||||||
|     kemal.add_route "GET", "/greetings" { test_filter.modified } |     kemal.add_http_route "GET", "/greetings" { test_filter.modified } | ||||||
| 
 | 
 | ||||||
|     test_filter.modified.should eq("false") |     test_filter.modified.should eq("false") | ||||||
|     request = HTTP::Request.new("GET", "/greetings") |     request = HTTP::Request.new("GET", "/greetings") | ||||||
|  | @ -99,8 +99,8 @@ describe "Kemal::FilterHandler" do | ||||||
|     filter_middleware._add_route_filter("GET", "/greetings", :after) { test_filter.modified = test_filter.modified == "true" ? "false" : "true" } |     filter_middleware._add_route_filter("GET", "/greetings", :after) { test_filter.modified = test_filter.modified == "true" ? "false" : "true" } | ||||||
| 
 | 
 | ||||||
|     kemal = Kemal::RouteHandler::INSTANCE |     kemal = Kemal::RouteHandler::INSTANCE | ||||||
|     kemal.add_route "GET", "/greetings" { test_filter.modified } |     kemal.add_http_route "GET", "/greetings" { test_filter.modified } | ||||||
|     kemal.add_route "POST", "/greetings" { test_filter.modified } |     kemal.add_http_route "POST", "/greetings" { test_filter.modified } | ||||||
| 
 | 
 | ||||||
|     test_filter.modified.should eq("false") |     test_filter.modified.should eq("false") | ||||||
| 
 | 
 | ||||||
|  | @ -127,8 +127,8 @@ describe "Kemal::FilterHandler" do | ||||||
|     filter_middleware._add_route_filter("POST", "/greetings", :after) { test_filter.modified = test_filter.modified == "true" ? "false" : "true" } |     filter_middleware._add_route_filter("POST", "/greetings", :after) { test_filter.modified = test_filter.modified == "true" ? "false" : "true" } | ||||||
| 
 | 
 | ||||||
|     kemal = Kemal::RouteHandler::INSTANCE |     kemal = Kemal::RouteHandler::INSTANCE | ||||||
|     kemal.add_route "GET", "/greetings" { test_filter.modified } |     kemal.add_http_route "GET", "/greetings" { test_filter.modified } | ||||||
|     kemal.add_route "POST", "/greetings" { test_filter.modified } |     kemal.add_http_route "POST", "/greetings" { test_filter.modified } | ||||||
| 
 | 
 | ||||||
|     test_filter.modified.should eq("false") |     test_filter.modified.should eq("false") | ||||||
|     request = HTTP::Request.new("GET", "/greetings") |     request = HTTP::Request.new("GET", "/greetings") | ||||||
|  | @ -158,9 +158,9 @@ describe "Kemal::FilterHandler" do | ||||||
|     filter_middleware._add_route_filter("ALL", "/greetings", :before) { test_filter_third.modified = test_filter_third.modified == "true" ? "false" : "true" } |     filter_middleware._add_route_filter("ALL", "/greetings", :before) { test_filter_third.modified = test_filter_third.modified == "true" ? "false" : "true" } | ||||||
| 
 | 
 | ||||||
|     kemal = Kemal::RouteHandler::INSTANCE |     kemal = Kemal::RouteHandler::INSTANCE | ||||||
|     kemal.add_route "GET", "/greetings" { test_filter.modified } |     kemal.add_http_route "GET", "/greetings" { test_filter.modified } | ||||||
|     kemal.add_route "POST", "/greetings" { test_filter_second.modified } |     kemal.add_http_route "POST", "/greetings" { test_filter_second.modified } | ||||||
|     kemal.add_route "PUT", "/greetings" { test_filter_third.modified } |     kemal.add_http_route "PUT", "/greetings" { test_filter_third.modified } | ||||||
| 
 | 
 | ||||||
|     test_filter.modified.should eq("false") |     test_filter.modified.should eq("false") | ||||||
|     test_filter_second.modified.should eq("false") |     test_filter_second.modified.should eq("false") | ||||||
|  |  | ||||||
|  | @ -23,7 +23,7 @@ describe "ParamParser" do | ||||||
| 
 | 
 | ||||||
|   it "parses url params" do |   it "parses url params" do | ||||||
|     kemal = Kemal::RouteHandler::INSTANCE |     kemal = Kemal::RouteHandler::INSTANCE | ||||||
|     kemal.add_route "POST", "/hello/:hasan" do |env| |     kemal.add_http_route "POST", "/hello/:hasan" do |env| | ||||||
|       "hello #{env.params.url["hasan"]}" |       "hello #{env.params.url["hasan"]}" | ||||||
|     end |     end | ||||||
|     request = HTTP::Request.new("POST", "/hello/cemal") |     request = HTTP::Request.new("POST", "/hello/cemal") | ||||||
|  | @ -35,7 +35,7 @@ describe "ParamParser" do | ||||||
| 
 | 
 | ||||||
|   it "decodes url params" do |   it "decodes url params" do | ||||||
|     kemal = Kemal::RouteHandler::INSTANCE |     kemal = Kemal::RouteHandler::INSTANCE | ||||||
|     kemal.add_route "POST", "/hello/:email/:money/:spanish" do |env| |     kemal.add_http_route "POST", "/hello/:email/:money/:spanish" do |env| | ||||||
|       email = env.params.url["email"] |       email = env.params.url["email"] | ||||||
|       money = env.params.url["money"] |       money = env.params.url["money"] | ||||||
|       spanish = env.params.url["spanish"] |       spanish = env.params.url["spanish"] | ||||||
|  |  | ||||||
|  | @ -81,5 +81,6 @@ end | ||||||
| 
 | 
 | ||||||
| Spec.after_each do | Spec.after_each do | ||||||
|   Kemal.config.clear |   Kemal.config.clear | ||||||
|   Kemal::RouteHandler::INSTANCE.tree = Radix::Tree(Route).new |   Kemal::RouteHandler::INSTANCE.http_routes = Radix::Tree(Route).new | ||||||
|  |   Kemal::RouteHandler::INSTANCE.ws_routes = Radix::Tree(String).new | ||||||
| end | end | ||||||
|  |  | ||||||
|  | @ -1,19 +1,6 @@ | ||||||
| require "./spec_helper" | require "./spec_helper" | ||||||
| 
 | 
 | ||||||
| describe "Kemal::WebSocketHandler" do | describe "Kemal::WebSocketHandler" do | ||||||
|   it "doesn't match on wrong route" do |  | ||||||
|     handler = Kemal::WebSocketHandler.new "/" { } |  | ||||||
|     headers = HTTP::Headers{ |  | ||||||
|       "Upgrade"           => "websocket", |  | ||||||
|       "Connection"        => "Upgrade", |  | ||||||
|       "Sec-WebSocket-Key" => "dGhlIHNhbXBsZSBub25jZQ==", |  | ||||||
|     } |  | ||||||
|     request = HTTP::Request.new("GET", "/asd", headers) |  | ||||||
|     io_with_context = create_request_and_return_io(handler, request) |  | ||||||
|     client_response = HTTP::Client::Response.from_io(io_with_context, decompress: false) |  | ||||||
|     client_response.status_code.should eq(404) |  | ||||||
|   end |  | ||||||
| 
 |  | ||||||
|   it "matches on given route" do |   it "matches on given route" do | ||||||
|     handler = Kemal::WebSocketHandler.new "/" { } |     handler = Kemal::WebSocketHandler.new "/" { } | ||||||
|     headers = HTTP::Headers{ |     headers = HTTP::Headers{ | ||||||
|  | @ -25,4 +12,16 @@ describe "Kemal::WebSocketHandler" do | ||||||
|     io_with_context = create_ws_request_and_return_io(handler, request) |     io_with_context = create_ws_request_and_return_io(handler, request) | ||||||
|     io_with_context.to_s.should eq("HTTP/1.1 101 Switching Protocols\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-Websocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r\n\r\n") |     io_with_context.to_s.should eq("HTTP/1.1 101 Switching Protocols\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-Websocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r\n\r\n") | ||||||
|   end |   end | ||||||
|  | 
 | ||||||
|  |   it "fetches named url parameters" do | ||||||
|  |     handler = Kemal::WebSocketHandler.new "/:id" { |s, c| c.params.url["id"] } | ||||||
|  |     headers = HTTP::Headers{ | ||||||
|  |       "Upgrade"           => "websocket", | ||||||
|  |       "Connection"        => "Upgrade", | ||||||
|  |       "Sec-WebSocket-Key" => "dGhlIHNhbXBsZSBub25jZQ==", | ||||||
|  |     } | ||||||
|  |     request = HTTP::Request.new("GET", "/1234", headers) | ||||||
|  |     io_with_context = create_ws_request_and_return_io(handler, request) | ||||||
|  |     io_with_context.to_s.should eq("HTTP/1.1 101 Switching Protocols\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-Websocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r\n\r\n") | ||||||
|  |   end | ||||||
| end | end | ||||||
|  |  | ||||||
|  | @ -10,7 +10,7 @@ FILTER_METHODS = %w(get post put patch delete options all) | ||||||
| {% for method in HTTP_METHODS %} | {% for method in HTTP_METHODS %} | ||||||
|   def {{method.id}}(path, &block : HTTP::Server::Context -> _) |   def {{method.id}}(path, &block : HTTP::Server::Context -> _) | ||||||
|     raise Kemal::Exceptions::InvalidPathStartException.new({{method}}, path) unless Kemal::Utils.path_starts_with_slash?(path) |     raise Kemal::Exceptions::InvalidPathStartException.new({{method}}, path) unless Kemal::Utils.path_starts_with_slash?(path) | ||||||
|     Kemal::RouteHandler::INSTANCE.add_route({{method}}.upcase, path, &block) |     Kemal::RouteHandler::INSTANCE.add_http_route({{method}}.upcase, path, &block) | ||||||
|   end |   end | ||||||
| {% end %} | {% end %} | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  | @ -13,7 +13,12 @@ class HTTP::Server | ||||||
|     end |     end | ||||||
| 
 | 
 | ||||||
|     def params |     def params | ||||||
|       @request.url_params ||= route_lookup.params |       websocket? = @request.headers.has_key?("Upgrade") | ||||||
|  |       @request.url_params ||= unless websocket? | ||||||
|  |         route_lookup.params | ||||||
|  |       else | ||||||
|  |         ws_route_lookup.params | ||||||
|  |       end | ||||||
|       @params ||= if @request.param_parser |       @params ||= if @request.param_parser | ||||||
|                     @request.param_parser.not_nil! |                     @request.param_parser.not_nil! | ||||||
|                   else |                   else | ||||||
|  | @ -34,6 +39,14 @@ class HTTP::Server | ||||||
|       route_lookup.found? |       route_lookup.found? | ||||||
|     end |     end | ||||||
| 
 | 
 | ||||||
|  |     def ws_route_lookup | ||||||
|  |       Kemal::RouteHandler::INSTANCE.lookup_ws_route(@request.path) | ||||||
|  |     end | ||||||
|  | 
 | ||||||
|  |     def ws_route_defined? | ||||||
|  |       ws_route_lookup.found? | ||||||
|  |     end | ||||||
|  | 
 | ||||||
|     def get(name) |     def get(name) | ||||||
|       @store[name] |       @store[name] | ||||||
|     end |     end | ||||||
|  |  | ||||||
|  | @ -7,10 +7,12 @@ module Kemal | ||||||
|     include HTTP::Handler |     include HTTP::Handler | ||||||
|     INSTANCE = new |     INSTANCE = new | ||||||
| 
 | 
 | ||||||
|     property tree |     property http_routes | ||||||
|  |     property ws_routes | ||||||
| 
 | 
 | ||||||
|     def initialize |     def initialize | ||||||
|       @tree = Radix::Tree(Route).new |       @http_routes = Radix::Tree(Route).new | ||||||
|  |       @ws_routes = Radix::Tree(String).new | ||||||
|     end |     end | ||||||
| 
 | 
 | ||||||
|     def call(context) |     def call(context) | ||||||
|  | @ -19,14 +21,22 @@ module Kemal | ||||||
| 
 | 
 | ||||||
|     # Adds a given route to routing tree. As an exception each `GET` route additionaly defines |     # Adds a given route to routing tree. As an exception each `GET` route additionaly defines | ||||||
|     # a corresponding `HEAD` route. |     # a corresponding `HEAD` route. | ||||||
|     def add_route(method, path, &handler : HTTP::Server::Context -> _) |     def add_http_route(method, path, &handler : HTTP::Server::Context -> _) | ||||||
|       add_to_radix_tree method, path, Route.new(method, path, &handler) |       add_to_http_radix_tree method, path, Route.new(method, path, &handler) | ||||||
|       add_to_radix_tree("HEAD", path, Route.new("HEAD", path) { |ctx| "" }) if method == "GET" |       add_to_http_radix_tree("HEAD", path, Route.new("HEAD", path) { |ctx| "" }) if method == "GET" | ||||||
|  |     end | ||||||
|  | 
 | ||||||
|  |     def add_ws_route(path) | ||||||
|  |       add_to_ws_radix_tree path | ||||||
|     end |     end | ||||||
| 
 | 
 | ||||||
|     # Check if a route is defined and returns the lookup |     # Check if a route is defined and returns the lookup | ||||||
|     def lookup_route(verb, path) |     def lookup_route(verb, path) | ||||||
|       @tree.find radix_path(verb, path) |       @http_routes.find radix_path(verb, path) | ||||||
|  |     end | ||||||
|  | 
 | ||||||
|  |     def lookup_ws_route(path) | ||||||
|  |       @ws_routes.find "/ws#{path}" | ||||||
|     end |     end | ||||||
| 
 | 
 | ||||||
|     # Processes the route if it's a match. Otherwise renders 404. |     # Processes the route if it's a match. Otherwise renders 404. | ||||||
|  | @ -49,13 +59,18 @@ module Kemal | ||||||
|       end |       end | ||||||
|     end |     end | ||||||
| 
 | 
 | ||||||
|     private def radix_path(method : String, path) |     private def radix_path(method, path) | ||||||
|       "/#{method.downcase}#{path}" |       "/#{method.downcase}#{path}" | ||||||
|     end |     end | ||||||
| 
 | 
 | ||||||
|     private def add_to_radix_tree(method, path, route) |     private def add_to_http_radix_tree(method, path, route) | ||||||
|       node = radix_path method, path |       node = radix_path method, path | ||||||
|       @tree.add node, route |       @http_routes.add node, route | ||||||
|  |     end | ||||||
|  | 
 | ||||||
|  |     private def add_to_ws_radix_tree(path) | ||||||
|  |       node = radix_path "ws", path | ||||||
|  |       @ws_routes.add node, node | ||||||
|     end |     end | ||||||
|   end |   end | ||||||
| end | end | ||||||
|  |  | ||||||
|  | @ -4,10 +4,11 @@ module Kemal | ||||||
|   class WebSocketHandler < HTTP::WebSocketHandler |   class WebSocketHandler < HTTP::WebSocketHandler | ||||||
|     def initialize(@path : String, &@proc : HTTP::WebSocket, HTTP::Server::Context -> Void) |     def initialize(@path : String, &@proc : HTTP::WebSocket, HTTP::Server::Context -> Void) | ||||||
|       Kemal.config.add_handler self |       Kemal.config.add_handler self | ||||||
|  |       Kemal::RouteHandler::INSTANCE.add_ws_route @path | ||||||
|     end |     end | ||||||
| 
 | 
 | ||||||
|     def call(context) |     def call(context) | ||||||
|       return call_next(context) unless context.request.path.not_nil! == @path |       raise Kemal::Exceptions::RouteNotFound.new(context) unless context.ws_route_defined? | ||||||
|       super |       super | ||||||
|     end |     end | ||||||
|   end |   end | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue