RubyGems - falcon - Versions diffs - 0.36.4 - Mend

falcon 0.36.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (92) hide show

checksums.yaml +7 -0
data/.editorconfig +5 -0
data/.github/FUNDING.yml +3 -0
data/.github/workflows/development.yml +60 -0
data/.gitignore +14 -0
data/.rspec +3 -0
data/Gemfile +17 -0
data/README.md +316 -0
data/bake/falcon/supervisor.rb +8 -0
data/bin/falcon +32 -0
data/bin/falcon-host +28 -0
data/examples/beer/config.ru +57 -0
data/examples/beer/falcon.rb +8 -0
data/examples/benchmark/config.ru +39 -0
data/examples/benchmark/falcon.rb +6 -0
data/examples/csv/config.ru +31 -0
data/examples/google/falcon.rb +14 -0
data/examples/hello/config.ru +22 -0
data/examples/hello/falcon.rb +24 -0
data/examples/hello/preload.rb +7 -0
data/examples/internet/config.ru +54 -0
data/examples/memory/allocations.rb +39 -0
data/examples/memory/config.ru +14 -0
data/examples/push/client.rb +29 -0
data/examples/push/config.ru +28 -0
data/examples/push/index.html +14 -0
data/examples/push/script.js +2 -0
data/examples/push/style.css +4 -0
data/examples/redis/Gemfile +9 -0
data/examples/redis/config.ru +28 -0
data/examples/sequel/Gemfile +4 -0
data/examples/sequel/config.ru +8 -0
data/examples/sequel/data.sqlite3 +0 -0
data/examples/server/standalone.rb +27 -0
data/examples/sinatra/Gemfile +7 -0
data/examples/sinatra/Gemfile.lock +53 -0
data/examples/sinatra/config.ru +16 -0
data/examples/trailers/config.ru +34 -0
data/examples/trailers/falcon.rb +8 -0
data/falcon.gemspec +45 -0
data/gems/rack1.gemfile +4 -0
data/gems/rack3.gemfile +4 -0
data/lib/falcon.rb +23 -0
data/lib/falcon/adapters/early_hints.rb +49 -0
data/lib/falcon/adapters/input.rb +131 -0
data/lib/falcon/adapters/output.rb +101 -0
data/lib/falcon/adapters/rack.rb +202 -0
data/lib/falcon/adapters/response.rb +91 -0
data/lib/falcon/adapters/rewindable.rb +67 -0
data/lib/falcon/command.rb +31 -0
data/lib/falcon/command/host.rb +69 -0
data/lib/falcon/command/paths.rb +47 -0
data/lib/falcon/command/proxy.rb +71 -0
data/lib/falcon/command/redirect.rb +76 -0
data/lib/falcon/command/serve.rb +151 -0
data/lib/falcon/command/supervisor.rb +78 -0
data/lib/falcon/command/top.rb +94 -0
data/lib/falcon/command/virtual.rb +89 -0
data/lib/falcon/configuration.rb +147 -0
data/lib/falcon/configuration/application.rb +46 -0
data/lib/falcon/configuration/lets_encrypt_tls.rb +30 -0
data/lib/falcon/configuration/proxy.rb +27 -0
data/lib/falcon/configuration/rack.rb +38 -0
data/lib/falcon/configuration/self_signed_tls.rb +47 -0
data/lib/falcon/configuration/supervisor.rb +37 -0
data/lib/falcon/configuration/tls.rb +70 -0
data/lib/falcon/controller/host.rb +60 -0
data/lib/falcon/controller/proxy.rb +109 -0
data/lib/falcon/controller/redirect.rb +69 -0
data/lib/falcon/controller/serve.rb +111 -0
data/lib/falcon/controller/virtual.rb +100 -0
data/lib/falcon/endpoint.rb +52 -0
data/lib/falcon/extensions/openssl.rb +33 -0
data/lib/falcon/middleware/proxy.rb +145 -0
data/lib/falcon/middleware/redirect.rb +66 -0
data/lib/falcon/proxy_endpoint.rb +71 -0
data/lib/falcon/server.rb +54 -0
data/lib/falcon/service/application.rb +93 -0
data/lib/falcon/service/generic.rb +60 -0
data/lib/falcon/service/proxy.rb +60 -0
data/lib/falcon/service/supervisor.rb +104 -0
data/lib/falcon/services.rb +78 -0
data/lib/falcon/tls.rb +46 -0
data/lib/falcon/verbose.rb +59 -0
data/lib/falcon/version.rb +25 -0
data/lib/rack/handler/falcon.rb +40 -0
data/logo-square.afdesign +0 -0
data/logo.afdesign +0 -0
data/logo.svg +107 -0
data/server.rb +21 -0
data/tasks/benchmark.rake +103 -0
metadata +386 -0

data/bin/falcon-host ADDED

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+require_relative '../lib/falcon/command/host'
+begin
+	Falcon::Command::Host.call
+rescue Interrupt
+end

data/examples/beer/config.ru ADDED

@@ -0,0 +1,57 @@
+#!/usr/bin/env falcon --verbose serve -c
+# frozen_string_literal: true
+require 'rack'
+require 'cgi'
+def bottles(n)
+	n == 1 ? "#{n} bottle" : "#{n} bottles"
+end
+# Browsers don't show streaming content until a certain threshold has been met. For most browers, it's about 1024 bytes. So, we have a comment of about that length which we feed to the client before streaming actual content. For more details see https://stackoverflow.com/questions/16909227
+COMMENT = "<!--#{'-' * 1024}-->"
+# To test this example with the curl command-line tool, you'll need to add the `--no-buffer` flag or set the COMMENT size to the required 4096 bytes in order for curl to start streaming.
+# curl http://localhost:9292/ --no-buffer
+run lambda {|env|
+	task = Async::Task.current
+	body = Async::HTTP::Body::Writable.new
+	request = Rack::Request.new(env)
+	count = (request.params['count'] || 99).to_i
+	body.write("<!DOCTYPE html><html><head><title>#{count} Bottles of Beer</title></head><body>")
+	task.async do |task|
+		begin
+			body.write(COMMENT)
+			count.downto(1) do |i|
+				task.annotate "bottles of beer #{i}"
+				Async.logger.info(body) {"#{bottles(i)} of beer on the wall..."}
+				body.write("<p>#{bottles(i)} of beer on the wall, ")
+				task.sleep(0.1)
+				body.write("#{bottles(i)} of beer, ")
+				task.sleep(0.1)
+				body.write("take one down and pass it around, ")
+				task.sleep(0.1)
+				body.write("#{bottles(i-1)} of beer on the wall.</p>")
+				task.sleep(0.1)
+				body.write("<script>var child; while (child = document.body.firstChild) child.remove();</script>")
+			end
+			code = File.read(__FILE__)
+			body.write("<h1>Source Code</h1>")
+			body.write("<pre><code>#{CGI.escapeHTML code}</code></pre>")
+			body.write("</body></html>")
+		rescue
+			puts "Remote end closed connection: #{$!}"
+		ensure
+			body.close
+		end
+	end
+	[200, {'content-type' => 'text/html; charset=utf-8'}, body]
+}

data/examples/beer/falcon.rb ADDED

@@ -0,0 +1,8 @@
+#!/usr/bin/env falcon-host
+# frozen_string_literal: true
+load :rack, :self_signed_tls, :supervisor
+rack 'beer.localhost', :self_signed_tls
+supervisor

data/examples/benchmark/config.ru ADDED

@@ -0,0 +1,39 @@
+#!/usr/bin/env falcon --verbose serve -c
+# frozen_string_literal: true
+class Benchmark
+	def initialize(app)
+		@app = app
+	end
+	PATH_INFO = 'PATH_INFO'.freeze
+	SMALL = [200, {}, ["Hello World\n" * 10] * 10].freeze
+	def small(env)
+		SMALL
+	end
+	BIG = [200, {}, ["Hello World\n" * 1000] * 1000].freeze
+	def big(env)
+		BIG
+	end
+	def call(env)
+		_, name, *path = env[PATH_INFO].split("/")
+		method = name&.to_sym
+		if method and self.respond_to?(method)
+			self.send(method, env)
+		else
+			@app.call(env)
+		end
+	end
+end
+use Benchmark
+run lambda {|env| [200, {}, ["Hello World"]]}

data/examples/benchmark/falcon.rb ADDED

@@ -0,0 +1,6 @@
+#!/usr/bin/env -S ./bin/falcon virtual
+# frozen_string_literal: true
+load :rack, :self_signed_tls, :supervisor
+rack 'benchmark.local', :self_signed_tls

data/examples/csv/config.ru ADDED

@@ -0,0 +1,31 @@
+#!/usr/bin/env falcon --verbose serve -c
+# frozen_string_literal: true
+class MyApp
+	def initialize(app)
+		@app = app
+		@words = File.readlines('/usr/share/dict/words', chomp: true).each_slice(3).to_a
+	end
+	def call(env)
+		body = Async::HTTP::Body::Writable.new(queue: Async::LimitedQueue.new(8))
+		Async do |task|
+			@words.each do |words|
+				Async.logger.debug("Sending #{words.inspect}")
+				body.write(words.join(",") + "\n")
+				task.sleep(1)
+			end
+		ensure
+			body.close($!)
+		end
+		return [200, [], body]
+	end
+end
+# Build the middleware stack:
+use MyApp
+run lambda {|env| [404, {}, []]}

data/examples/google/falcon.rb ADDED

@@ -0,0 +1,14 @@
+#!/usr/bin/env falcon-host
+# frozen_string_literal: true
+load :proxy, :self_signed_tls, :supervisor
+supervisor
+proxy "google.localhost", :self_signed_tls do
+	url 'https://www.google.com'
+end
+proxy "codeotaku.localhost", :self_signed_tls do
+	url 'https://www.codeotaku.com'
+end

data/examples/hello/config.ru ADDED

@@ -0,0 +1,22 @@
+#!/usr/bin/env falcon --verbose serve -c
+# frozen_string_literal: true
+require 'async'
+class RequestLogger
+	def initialize(app)
+		@app = app
+	end
+	def call(env)
+		logger = Async.logger.with(level: :debug)
+		Async(logger: logger) do
+			@app.call(env)
+		end.wait
+	end
+end
+# use RequestLogger
+run lambda {|env| [200, {'cache-control' => 'max-age=10, public'}, ["Hello World"]]}

data/examples/hello/falcon.rb ADDED

@@ -0,0 +1,24 @@
+#!/usr/bin/env falcon-host
+# frozen_string_literal: true
+load :rack, :self_signed_tls, :supervisor
+supervisor
+rack 'hello.localhost', :self_signed_tls do
+	# scheme 'http'
+	# protocol {Async::HTTP::Protocol::HTTP1}
+	#
+	# endpoint do
+	# 	Async::HTTP::Endpoint.for(scheme, "localhost", port: 9292, protocol: protocol)
+	# end
+	append preload "preload.rb"
+	# Process will connect to supervisor to report statistics periodically, otherwise it would be killed.
+	# report :supervisor
+end
+# service 'jobs' do
+# 	shell ['rake', 'background:jobs:process']
+# end

data/examples/hello/preload.rb ADDED

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+if GC.respond_to?(:compact)
+	Async.logger.warn(self, "Compacting the mainframe...")
+	GC.compact
+	Async.logger.warn(self, "Compacting done...")
+end

data/examples/internet/config.ru ADDED

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require 'async'
+require 'async/http/internet'
+# Experimental.
+require 'kernel/sync'
+class Search
+	def initialize(app)
+		@internet = Async::HTTP::Internet.new
+		@app = app
+	end
+	# This method uses the `Async` method to create a reactor if required, and then executes the contained code without waiting for the result. So even if the search query takes a long time (e.g. 100ms), it won't hold up the request processing.
+	def async(close: !Async::Task.current?)
+		Async do
+			response = @internet.get("https://google.com/search?q=async+ruby")
+			puts response.inspect
+		ensure
+			response&.finish
+		end
+	end
+	# This method uses the experimental `Sync` method to create a reactor if required. If the code is already running in a reactor, it runs synchronously, otherwise it's effectively the same as `Async` and a blocking operation. This allow you to write efficient non-blocking code that works in both traditional web application servers, but gains additional scalability in `Async`-aware servers like Falcon.
+	# You can achieve a similar result by calling `Async{}.wait`, but this is less efficient as it will allocate a sub-task even thought it's not needed.
+	def sync(close: !Async::Task.current?)
+		Sync do
+			response = @internet.get("https://google.com/search?q=async+ruby")
+			puts response.inspect
+		ensure
+			response&.finish
+		end
+	end
+	# The only point of this is to invoke one of the above two methods.
+	def call(env)
+		case env['PATH_INFO']
+		when '/sync'
+			self.sync
+		when '/async'
+			self.async
+		end
+		return @app.call(env)
+	end
+end
+use Search
+run lambda{|env| [404, [], []]}

data/examples/memory/allocations.rb ADDED

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+class Allocations
+	def initialize(app)
+		@app = app
+	end
+	def allocations
+		counts = Hash.new{|h,k| h[k] = 0}
+		ObjectSpace.each_object do |object|
+			counts[object.class] += 1
+		end
+		return counts
+	end
+	def print_allocations(minimum = 100)
+		buffer = StringIO.new
+		total = allocations.values.sum
+		allocations.select{|k,v| v >= minimum}.sort_by{|k,v| -v}.each do |key, value|
+			buffer.puts "#{key}: #{value} allocations"
+		end
+		buffer.puts "** Total: #{total} allocations."
+		return buffer.string
+	end
+	def call(env)
+		if env["PATH_INFO"] == "/allocations"
+			return [200, [], [print_allocations]]
+		else
+			return @app.call(env)
+		end
+	end
+end

data/examples/memory/config.ru ADDED

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require_relative 'allocations'
+use Allocations
+run lambda{|env| [404, [], []]}
+# % curl --insecure https://localhost:9292/allocations
+# String: 32179 allocations
+# Array: 10228 allocations
+# Hash: 1299 allocations
+# Class: 1118 allocations
+# ** Total: 50162 allocations.

data/examples/push/client.rb ADDED

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require 'async'
+require 'async/http/endpoint'
+require 'async/http/client'
+Async do
+	endpoint = Async::HTTP::Endpoint.parse("https://localhost:9292")
+	client = Async::HTTP::Client.new(endpoint, Async::HTTP::Protocol::HTTP2::WithPush)
+	response = client.get("/index.html")
+	puts response.status
+	puts response.read
+	puts
+	while promise = response.promises.dequeue
+		promise.wait
+		puts "** Promise: #{promise.request.path} **"
+		puts promise.read
+		puts
+	end
+ensure
+	client.close
+end
+puts "Done"

data/examples/push/config.ru ADDED

@@ -0,0 +1,28 @@
+#!/usr/bin/env falcon --verbose serve --concurrency 1 --config
+# frozen_string_literal: true
+class EarlyHints
+	def initialize(app)
+		@app = app
+	end
+	def call(env)
+		path = env['PATH_INFO']
+		early_hints = early_hints = env['rack.early_hints']
+		Async.logger.debug("path: #{path} #{early_hints}")
+		if path == "/index.html" and early_hints
+			early_hints.push("/style.css")
+			early_hints.push("/script.js")
+		end
+		@app.call(env)
+	end
+end
+use EarlyHints
+use Rack::Static, :urls => [""], :root => __dir__, :index => 'index.html'
+run lambda{|env| [404, [], ["Not Found"]]}

data/examples/push/index.html ADDED

@@ -0,0 +1,14 @@
+<!doctype HTML>
+<html>
+	<head>
+		<title>Hello World</title>
+		<link rel="stylesheet" href="/style.css" />
+		<script type="text/javascript" src="script.js"></script>
+	</head>
+	<body>
+		<h1>Early Hints</h1>
+		<p>Check the developer tools to see if early hints worked!</p>
+	</body>
+</html>

data/examples/push/script.js ADDED

	@@ -0,0 +1,2 @@
1	+
2	+ console.log("Hello World")

data/examples/push/style.css ADDED

@@ -0,0 +1,4 @@
+html {
+	font-family: Helvetica;
+}