zapp 0.1.0 → 0.2.2

data/lib/zapp/worker/request_processor.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Zapp
+  class Worker < Ractor
+    # Processes HTTP requests
+    class RequestProcessor
+      attr_reader(:socket_pipe_sender, :context_pipe)
+
+      def initialize(context_pipe:, socket_pipe:)
+        @socket_pipe_sender = Zapp::SocketPipe::Sender.new(pipe: socket_pipe)
+        @context_pipe = context_pipe
+      end
+
+      def loop
+        while (context = context_pipe.take)
+          if context == Zapp::WorkerPool::SIGNALS[:EXIT]
+            Zapp::Logger.trace("Received exit signal, shutting down")
+            shutdown
+            break
+          end
+
+          process = lambda {
+            process(context: context)
+          }
+
+          if Zapp.config.log_requests
+            log_request_time(context: context, &process)
+          else
+            process.call
+          end
+
+          # We send sockets that the client hasn't closed yet,
+          # back to the main ractor for HTTP request parsing again
+          socket_pipe_sender.push(context.socket) unless context.client_closed?
+        end
+      end
+
+      private
+
+      # Processes an HTTP request
+      def process(context:)
+        env = prepare_env(data: context.req.data, body: context.req.body, env: Zapp.config.env.dup)
+
+        status, headers, response_body_stream = Zapp.config.app.call(env)
+
+        response_body = body_stream_to_string(response_body_stream)
+
+        context.res.write(data: response_body, status: status, headers: headers)
+      rescue StandardError => e
+        context.res.write(data: "An unexpected error occurred", status: 500, headers: {})
+        Zapp::Logger.error("#{e}\n\n#{e.backtrace&.join(",\n")}") if Zapp.config.log_uncaught_errors
+      end
+
+      # Merges HTTP data and body into the env to be passed to the rack app
+      def prepare_env(data:, body:, env:)
+        data["QUERY_STRING"] = ""
+        data["SERVER_NAME"] = data["HTTP_HOST"] || ""
+        data["PATH_INFO"] = data["REQUEST_PATH"]
+        data["SCRIPT_NAME"] = ""
+
+        env.update(data)
+
+        env.update(Rack::RACK_INPUT => body)
+
+        env
+      end
+
+      def log_request_time(context:)
+        start = Time.now.to_f * 1000
+
+        yield
+
+        request_time = ((Time.now.to_f * 1000) - start).truncate(2)
+        method = context.req.data["REQUEST_METHOD"]
+        path = context.req.data["PATH_INFO"]
+        status = context.res.status
+
+        Zapp::Logger.info(
+          "#{method} #{path} - Completed in #{request_time}ms with status #{status}"
+        )
+      end
+
+      # Loops over a body stream and returns a single string
+      def body_stream_to_string(stream)
+        response_body = ""
+        stream.each do |s|
+          response_body += s
+        end
+
+        stream.close if stream.respond_to?(:close)
+
+        response_body
+      end
+
+      def shutdown
+        Zapp::Logger.flush
+        thread_pool.shutdown
+      end
+
+      def thread_pool
+        @thread_pool ||= Concurrent::ThreadPoolExecutor.new(
+          min_threads: Zapp.config.threads_per_worker,
+          max_threads: Zapp.config.threads_per_worker,
+          max_queue: 1000
+        )
+      end
+    end
+  end
+end

data/lib/zapp/worker.rb

@@ -1,87 +1,36 @@
 # frozen_string_literal: true
 
+require_relative("worker/request_processor")
+
 module Zapp
   # One worker processing requests in parallel
   class Worker < Ractor
     class << self
-      def new(pipe_:, app_:, index:)
-        # Logger with the name as prefix
-        logger_ = Zapp.config.logger_class.new do |logger|
-          logger.prefix = name(index)
-        end
-
-        super(pipe_, app_, logger_, Zapp.config.dup, name: name(index)) do |pipe, app, logger, config|
-          logger.level = 0
-          while (context, shutdown = pipe.take)
-            break if shutdown
-
-            if config.log_requests
-              Zapp::Worker.log_request_time(logger: logger) do
-                Zapp::Worker.process(context: context, app: app, logger: logger, config: config)
-              end
-            else
-              Zapp::Worker.process(context: context, app: app, logger: logger, config: config)
-            end
-          end
+      def new(context_pipe:, socket_pipe:, index:)
+        super(
+          context_pipe,
+          socket_pipe,
+          Zapp.config.dup,
+          name: name(index)
+        ) do |context_pipe, socket_pipe, config|
+          Ractor.current[Zapp::RACTOR_CONFIG_KEY] = config
+
+          processor = Zapp::Worker::RequestProcessor.new(
+            socket_pipe: socket_pipe,
+            context_pipe: context_pipe
+          )
+
+          processor.loop
         end
       end
 
-      # Processes an HTTP request
-      def process(context:, app:, logger:, config:)
-        prepare_env(data: context.req.data, body: context.req.body, env: config.env)
-
-        status, headers, response_body_stream = app.call(config.env)
-
-        response_body = body_stream_to_string(response_body_stream)
-
-        context.res.write(data: response_body, status: status, headers: headers)
-      rescue StandardError => e
-        context.res.write(data: "An unexpected error occurred", status: 500, headers: {})
-        logger.error("#{e}\n\n#{e.backtrace&.join(",\n")}") if config.log_uncaught_errors
-      ensure
-        context.close
-      end
-
-      def log_request_time(logger:)
-        start = Time.now.to_f * 1000
-
-        yield
-      ensure
-        logger.info("Processed request in #{((Time.now.to_f * 1000) - start).truncate(2)}ms")
-      end
-
-      # Loops over a body stream and returns a single string
-      def body_stream_to_string(stream)
-        response_body = ""
-        stream.each do |s|
-          response_body += s
-        end
-
-        stream.close if stream.respond_to?(:close)
-
-        response_body
-      end
-
-      # Merges HTTP data and body into the env to be passed to the rack app
-      def prepare_env(data:, body:, env:)
-        data["QUERY_STRING"] = ""
-        data["SERVER_NAME"] = data["HTTP_HOST"] || ""
-        data["PATH_INFO"] = data["REQUEST_PATH"]
-        data["SCRIPT_NAME"] = ""
-
-        env.update(data)
-
-        env.update(Rack::RACK_INPUT => body)
-      end
-
       # Index based name of the worker
       def name(index)
-        "zap-http-#{index + 1}"
+        "zapp-http-#{index + 1}"
       end
     end
 
     def terminate
-      Zapp::Logger.debug("Terminating worker #{name}")
       take
     end
   end

data/lib/zapp/worker_pool.rb

@@ -3,38 +3,37 @@
 module Zapp
   # Manages and dispatches work to a pool of Zap::Worker's
   class WorkerPool
-    attr_reader(:pipe, :workers, :parallelism)
+    attr_reader(:context_pipe, :workers, :parallelism)
 
-    def initialize(app:)
-      @pipe = Ractor.new do
-        loop do
-          Ractor.yield(Ractor.receive)
-        end
-      end
+    SIGNALS = {
+      EXIT: :exit
+    }.freeze
 
+    def initialize(context_pipe:, socket_pipe:)
+      @context_pipe = context_pipe
       @workers = []
       Zapp.config.parallelism.times do |i|
         @workers << Worker.new(
-          pipe_: pipe,
-          app_: app,
+          context_pipe: context_pipe,
+          socket_pipe: socket_pipe,
           index: i
         )
       end
     end
 
-    # Sends data through the pipe to one of our workers,
-    # sends a tuple of [context, shutdown], if shutdown is true it breaks from its processing loop
-    # otherwise the worker processes the HTTP context
-    def process(context:, shutdown: false)
-      pipe.send([context.dup, shutdown], move: true)
+    # Sends a socket to one of our workers
+    def process(context:)
+      context_pipe.send(context)
     end
 
     # Finishes processing of all requests and shuts down workers
     def drain
-      Zapp.config.parallelism.times { process(context: nil, shutdown: true) }
-      workers.map(&:terminate)
-    rescue Ractor::RemoteError
-      # Ignored
+      Zapp.config.parallelism.times { process(context: SIGNALS[:EXIT]) }
+      workers.map do |w|
+        w.terminate
+      rescue Ractor::ClosedError
+        # Ractor has already exited
+      end
     end
   end
 end

data/lib/zapp.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # External dependencies are loaded here
+require("irb")
 require("socket")
 require("concurrent")
 require("puma")
@@ -10,11 +11,14 @@ require("rack")
 module Zapp
   class ZappError < StandardError; end
 
+  # The hash key in Ractor.current that stores the global Zapp::Configuration instance
+  RACTOR_CONFIG_KEY = "ZAPP_CONFIG"
+
   class << self
     def config(reset: false)
-      @config = Zapp::Configuration.new if reset
+      Ractor.current[RACTOR_CONFIG_KEY] = Zapp::Configuration.new if reset
 
-      @config ||= Zapp::Configuration.new
+      Ractor.current[RACTOR_CONFIG_KEY] ||= Zapp::Configuration.new
     end
 
     def configure
@@ -23,12 +27,15 @@ module Zapp
   end
 end
 
-require("zapp/version")
-require("zapp/logger")
-require("zapp/configuration")
-require("zapp/input_stream")
-require("zapp/http_context/context")
-require("zapp/worker")
-require("zapp/worker_pool")
-require("zapp/server")
-require("zapp/cli")
+require_relative("zapp/version")
+require_relative("zapp/logger")
+require_relative("zapp/configuration")
+require_relative("zapp/input_stream")
+require_relative("zapp/http_context/context")
+require_relative("zapp/pipe")
+require_relative("zapp/socket_pipe/sender")
+require_relative("zapp/socket_pipe/receiver")
+require_relative("zapp/worker")
+require_relative("zapp/worker_pool")
+require_relative("zapp/server")
+require_relative("zapp/cli")

data/zapp.gemspec

@@ -31,6 +31,8 @@ Gem::Specification.new do |spec|
   # Use Puma's C-based HttpParser, it's fast as hell
   spec.add_dependency("puma", "~> 5.5.2")
 
+  spec.add_dependency("webrick")
+
   # Concurrent ruby for managing Thread pools
   spec.add_dependency("concurrent-ruby", "~> 1.1.9")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zapp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Mathias H Steffensen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-21 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.5.2
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -98,104 +112,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - bin/zapp
-- examples/rails-app/.browserslistrc
-- examples/rails-app/.gitattributes
-- examples/rails-app/.gitignore
-- examples/rails-app/.ruby-version
-- examples/rails-app/Gemfile
-- examples/rails-app/Gemfile.lock
-- examples/rails-app/Rakefile
-- examples/rails-app/app/assets/config/manifest.js
-- examples/rails-app/app/assets/images/.keep
-- examples/rails-app/app/assets/stylesheets/application.css
-- examples/rails-app/app/channels/application_cable/channel.rb
-- examples/rails-app/app/channels/application_cable/connection.rb
-- examples/rails-app/app/controllers/application_controller.rb
-- examples/rails-app/app/controllers/concerns/.keep
-- examples/rails-app/app/helpers/application_helper.rb
-- examples/rails-app/app/javascript/channels/consumer.js
-- examples/rails-app/app/javascript/channels/index.js
-- examples/rails-app/app/javascript/packs/application.js
-- examples/rails-app/app/jobs/application_job.rb
-- examples/rails-app/app/mailers/application_mailer.rb
-- examples/rails-app/app/models/application_record.rb
-- examples/rails-app/app/models/concerns/.keep
-- examples/rails-app/app/views/layouts/application.html.erb
-- examples/rails-app/app/views/layouts/mailer.html.erb
-- examples/rails-app/app/views/layouts/mailer.text.erb
-- examples/rails-app/babel.config.js
-- examples/rails-app/bin/bundle
-- examples/rails-app/bin/rails
-- examples/rails-app/bin/rake
-- examples/rails-app/bin/setup
-- examples/rails-app/bin/spring
-- examples/rails-app/bin/webpack
-- examples/rails-app/bin/webpack-dev-server
-- examples/rails-app/bin/yarn
-- examples/rails-app/bin/zapp
-- examples/rails-app/config.ru
-- examples/rails-app/config/application.rb
-- examples/rails-app/config/boot.rb
-- examples/rails-app/config/cable.yml
-- examples/rails-app/config/credentials.yml.enc
-- examples/rails-app/config/database.yml
-- examples/rails-app/config/environment.rb
-- examples/rails-app/config/environments/development.rb
-- examples/rails-app/config/environments/production.rb
-- examples/rails-app/config/environments/test.rb
-- examples/rails-app/config/initializers/application_controller_renderer.rb
-- examples/rails-app/config/initializers/assets.rb
-- examples/rails-app/config/initializers/backtrace_silencers.rb
-- examples/rails-app/config/initializers/content_security_policy.rb
-- examples/rails-app/config/initializers/cookies_serializer.rb
-- examples/rails-app/config/initializers/filter_parameter_logging.rb
-- examples/rails-app/config/initializers/inflections.rb
-- examples/rails-app/config/initializers/mime_types.rb
-- examples/rails-app/config/initializers/permissions_policy.rb
-- examples/rails-app/config/initializers/wrap_parameters.rb
-- examples/rails-app/config/locales/en.yml
-- examples/rails-app/config/puma.rb
-- examples/rails-app/config/routes.rb
-- examples/rails-app/config/spring.rb
-- examples/rails-app/config/storage.yml
-- examples/rails-app/config/webpack/development.js
-- examples/rails-app/config/webpack/environment.js
-- examples/rails-app/config/webpack/production.js
-- examples/rails-app/config/webpack/test.js
-- examples/rails-app/config/webpacker.yml
-- examples/rails-app/config/zapp.rb
-- examples/rails-app/db/seeds.rb
-- examples/rails-app/lib/assets/.keep
-- examples/rails-app/lib/tasks/.keep
-- examples/rails-app/log/.keep
-- examples/rails-app/package.json
-- examples/rails-app/postcss.config.js
-- examples/rails-app/public/404.html
-- examples/rails-app/public/422.html
-- examples/rails-app/public/500.html
-- examples/rails-app/public/apple-touch-icon-precomposed.png
-- examples/rails-app/public/apple-touch-icon.png
-- examples/rails-app/public/favicon.ico
-- examples/rails-app/public/robots.txt
-- examples/rails-app/storage/.keep
-- examples/rails-app/test/application_system_test_case.rb
-- examples/rails-app/test/channels/application_cable/connection_test.rb
-- examples/rails-app/test/controllers/.keep
-- examples/rails-app/test/fixtures/files/.keep
-- examples/rails-app/test/helpers/.keep
-- examples/rails-app/test/integration/.keep
-- examples/rails-app/test/mailers/.keep
-- examples/rails-app/test/models/.keep
-- examples/rails-app/test/system/.keep
-- examples/rails-app/test/test_helper.rb
-- examples/rails-app/tmp/.keep
-- examples/rails-app/tmp/pids/.keep
-- examples/rails-app/vendor/.keep
-- examples/rails-app/yarn.lock
-- lib/rack/handler/zap.rb
+- examples/config/app.rb
+- examples/config/puma.rb
+- examples/config/zapp.rb
+- lib/rack/handler/zapp.rb
 - lib/zapp.rb
 - lib/zapp/cli.rb
 - lib/zapp/configuration.rb
@@ -204,10 +125,15 @@ files:
 - lib/zapp/http_context/response.rb
 - lib/zapp/input_stream.rb
 - lib/zapp/logger.rb
+- lib/zapp/logger/base.rb
 - lib/zapp/parser.rb
+- lib/zapp/pipe.rb
 - lib/zapp/server.rb
+- lib/zapp/socket_pipe/receiver.rb
+- lib/zapp/socket_pipe/sender.rb
 - lib/zapp/version.rb
 - lib/zapp/worker.rb
+- lib/zapp/worker/request_processor.rb
 - lib/zapp/worker_pool.rb
 - zapp.gemspec
 homepage: https://github.com/mathiashsteffensen/zapp
@@ -232,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A Web Server based on Ractors, for Rack-based Ruby applications

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require("bundler/setup")
-require("zapp")
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require("irb")
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/examples/rails-app/.browserslistrc

@@ -1 +0,0 @@
-defaults

data/examples/rails-app/.gitattributes

@@ -1,10 +0,0 @@
-# See https://git-scm.com/docs/gitattributes for more about git attribute files.
-
-# Mark the database schema as having been generated.
-db/schema.rb linguist-generated
-
-# Mark the yarn lockfile as having been generated.
-yarn.lock linguist-generated
-
-# Mark any vendored files as having been vendored.
-vendor/* linguist-vendored

data/examples/rails-app/.gitignore

@@ -1,40 +0,0 @@
-# See https://help.github.com/articles/ignoring-files for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore the default SQLite database.
-/db/*.sqlite3
-/db/*.sqlite3-*
-
-# Ignore all logfiles and tempfiles.
-/log/*
-/tmp/*
-!/log/.keep
-!/tmp/.keep
-
-# Ignore pidfiles, but keep the directory.
-/tmp/pids/*
-!/tmp/pids/
-!/tmp/pids/.keep
-
-# Ignore uploaded files in development.
-/storage/*
-!/storage/.keep
-
-/public/assets
-.byebug_history
-
-# Ignore master key for decrypting credentials and more.
-/config/master.key
-
-/public/packs
-/public/packs-test
-/node_modules
-/yarn-error.log
-yarn-debug.log*
-.yarn-integrity

data/examples/rails-app/.ruby-version

@@ -1 +0,0 @@
-3.0.0

data/examples/rails-app/Gemfile

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-source("https://rubygems.org")
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-ruby("3.0.0")
-
-# Bundle edge Rails instead: gem 'rails', github: 'rails/rails', branch: 'main'
-gem("rails", "~> 6.1.4", ">= 6.1.4.1")
-# Use sqlite3 as the database for Active Record
-gem("sqlite3", "~> 1.4")
-# Use Zapp as the app server
-gem("zapp", path: "../..")
-# Use SCSS for stylesheets
-gem("sass-rails", ">= 6")
-# Transpile app-like JavaScript. Read more: https://github.com/rails/webpacker
-gem("webpacker", "~> 5.0")
-# Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
-gem("turbolinks", "~> 5")
-# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
-gem("jbuilder", "~> 2.7")
-# Use Redis adapter to run Action Cable in production
-# gem 'redis', '~> 4.0'
-# Use Active Model has_secure_password
-# gem 'bcrypt', '~> 3.1.7'
-
-# Use Active Storage variant
-# gem 'image_processing', '~> 1.2'
-
-# Reduces boot times through caching; required in config/boot.rb
-gem("bootsnap", ">= 1.4.4", require: false)
-
-group(:development, :test) do
-  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
-  gem("byebug", platforms: %i[mri mingw x64_mingw])
-end
-
-group(:development) do
-  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
-  gem("web-console", ">= 4.1.0")
-  # Display performance information such as SQL time and flame graphs for each request in your browser.
-  # Can be configured to work on production as well see: https://github.com/MiniProfiler/rack-mini-profiler/blob/master/README.md
-  gem("listen", "~> 3.3")
-  gem("rack-mini-profiler", "~> 2.0")
-  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
-  gem("spring")
-end
-
-group(:test) do
-  # Adds support for Capybara system testing and selenium driver
-  gem("capybara", ">= 3.26")
-  gem("selenium-webdriver")
-  # Easy installation and use of web drivers to run system tests with browsers
-  gem("webdrivers")
-end
-
-# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem("tzinfo-data", platforms: %i[mingw mswin x64_mingw jruby])