tp2 0.4 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d8c8ee2edd1c72a68b21c3ea27dc208c0dbfcbb2a6d78d76abb3ec11f115977
-  data.tar.gz: 5fb43258443827cf5fa44fc1ddd4960740d8694d5469fac70875c46c54558c15
+  metadata.gz: 02dcea75056239e37b8cd92705737bf8516719723b63f6610667f657b9d42667
+  data.tar.gz: 22660d26e8e6c92c84b033b12f8a095e1eb35d5273067020bb9393dc2560581f
 SHA512:
-  metadata.gz: e6c54083c10368f84bd23a0bfd235f01aa74690f7d02667a54c539921e9dc601e7f513858d3a85eee17229d4f4f12a6482d219feb1c1820cd2622c7e70e0dfa9
-  data.tar.gz: 134a0b072495b5d23f02d1d19e86db66f4f78ffea81ce1e20b48660d77c61966bf83e4876f4870b33f8d63102274d3f3e3555e3166d02cfcaa0086aacdff2520
+  metadata.gz: '0783815bf52da7c2f1cb813022f2717adaa2cd6b169923d72c5817b255a1a4d2139b46e47b0f46ff085080af4b8fcf3c5065ac2d3b29a974f7417ce13f0cd1e6'
+  data.tar.gz: f9720342b6c7a9b78b70c45fadbd5f9dc95ed7720f0c40a60716a963e935acdeb01bc8d338b5cce759b81c4b76ee6e0361e37f519f89a9fca3e03a5b5395654a

data/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: [3.4, 'head']
+
+    name: >-
+      ${{matrix.os}}, ${{matrix.ruby}}
+
+    runs-on: ${{matrix.os}}
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true
+    - name: Run tests
+      run:  bundle exec rake test

data/.gitignore

@@ -45,7 +45,7 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Version 0.6 2025-05-05
+
+- Update UringMachine to 0.10
+
+# Version 0.5.2 2025-05-05
+
+- Update UringMachine to 0.8.2
+
+# Version 0.5 2025-05-05
+
+- Implement graceful shutdown
+
+# Version 0.4 2025-05-02
+
+- Add adapter and server tests
+- Remove http/parser dependency, use regexs to parse HTTP requests

data/README.md

@@ -1,5 +1,12 @@
-# tp2
+# TP2
 
 TP2 is an experimental HTTP server based on
-[UringMachine](https://github.com/digital-fabric/uringmachine) and [Qeweney](https://github.com/digital-fabric/qeweney). 
+[UringMachine](https://github.com/digital-fabric/uringmachine) and [Qeweney](https://github.com/digital-fabric/qeweney).
 
+## Features
+
+- HTTP/1.1
+- Support for streaming requests and responses
+- Automatic chunked transfer encoding
+- Fast, native HTTP protocol parsing (no dependency)
+- Graceful shutdown

data/Rakefile

@@ -12,7 +12,7 @@ end
 task :release do
   require_relative './lib/tp2/version'
   version = TP2::VERSION
-  
+
   puts 'Building tp2...'
   `gem build tp2.gemspec`
 

data/examples/simple.rb

@@ -16,12 +16,19 @@ machine = UM.new
 server = TP2::Server.new(machine, '0.0.0.0', 1234, &app)
 puts "Listening on port 1234..."
 
-machine.spin { server.run }
+server_fiber = machine.spin { server.run }
 
-main = Fiber.current
-trap('SIGINT') { machine.schedule(main, nil) }
+sig_queue = UM::Queue.new
+trap('SIGINT') { machine.push(sig_queue, :SIGINT) }
 
 puts "Running... (pid: #{Process.pid})"
 STDOUT.flush
-machine.yield # wait for termination
+
+# wait for signal
+sig = machine.shift(sig_queue)
+
+puts "Got signal (#{sig}), shutting down gracefully..."
+machine.schedule(server_fiber, UM::Terminate.new)
+machine.join(server_fiber)
+
 puts

data/lib/tp2/http1_adapter.rb

@@ -20,8 +20,10 @@ module TP2
         persist = serve_request
         break if !persist
       end
+    rescue UM::Terminate
+      # do nothing
     rescue => e
-      puts '*' * 40
+      puts '!' * 40
       p e
       puts e.backtrace.join("\n")
       exit!
@@ -66,7 +68,7 @@ module TP2
 
       return nil if headers[':body-done-reading']
 
-      # if content-length is not specified, we read to EOF, up to max 1MB size      
+      # if content-length is not specified, we read to EOF, up to max 1MB size
       chunk = read(1 << 20, nil, false)
       headers[':body-done-reading'] = true
       chunk
@@ -160,17 +162,17 @@ module TP2
     def parse_headers
       headers = get_request_line
       return nil if !headers
-    
+
       while true
         line = get_line
         break if line.nil? || line.empty?
 
         m = line.match(RE_HEADER_LINE)
         raise ProtocolError, 'Invalid header' if !m
-      
+
         headers[m[1].downcase] = m[2]
       end
-    
+
       headers
     end
 
@@ -178,7 +180,7 @@ module TP2
       while true
         line = @sio.gets(chomp: true)
         return line if line
-      
+
         res = @machine.read(@fd, @buffer, 65536, -1)
         return nil if res == 0
       end
@@ -187,10 +189,10 @@ module TP2
     def get_request_line
       line = get_line
       return nil if !line
-    
+
       m = line.match(RE_REQUEST_LINE)
       raise ProtocolError, 'Invalid request line' if !m
-    
+
       {
         ':method'   => m[1].downcase,
         ':path'     => m[2],
@@ -227,7 +229,7 @@ module TP2
 
           return buf
         end
-        
+
 
         left -= res
       end
@@ -237,7 +239,7 @@ module TP2
     def read_chunk(headers, buf)
       chunk_size = get_line
       return nil if !chunk_size
-      
+
       chunk_size = chunk_size.to_i(16)
       if chunk_size == 0
         headers[':body-done-reading'] = true

data/lib/tp2/request_extensions.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-p "request_extensions"
-
 class Qeweney::Request
   def serve_io(io, opts)
     # TODO: implement using UM

data/lib/tp2/server.rb

@@ -5,6 +5,9 @@ require 'tp2/request_extensions'
 
 module TP2
   class Server
+    PENDING_REQUESTS_GRACE_PERIOD = 0.1
+    PENDING_REQUESTS_TIMEOUT_PERIOD = 5
+
     def initialize(machine, hostname, port, &app)
       @machine = machine
       @hostname = hostname
@@ -12,21 +15,61 @@ module TP2
       @app = app
     end
 
+    def run
+      setup
+      accept_incoming
+    rescue UM::Terminate
+      graceful_shutdown
+    end
+
+    private
+
     def setup
       @server_fd = @machine.socket(UM::AF_INET, UM::SOCK_STREAM, 0, 0)
       @machine.setsockopt(@server_fd, UM::SOL_SOCKET, UM::SO_REUSEADDR, true)
       @machine.bind(@server_fd, @hostname, @port)
       @machine.listen(@server_fd, UM::SOMAXCONN)
 
+      # map fibers
+      @fiber_map = {}
+
       # puts "Listening on #{@hostname}:#{@port}"
     end
 
-    def run
-      setup
+    def accept_incoming
       @machine.accept_each(@server_fd) do |fd|
         conn = HTTP1Adapter.new(@machine, fd, &@app)
-        @machine.spin(conn) { it.run }
+        f = @machine.spin(conn) do
+          it.run
+        ensure
+          @fiber_map.delete(f)
+        end
+        @fiber_map[f] = true
+      end
+    end
+
+    def graceful_shutdown
+      # stop listening
+      @machine.close(@server_fd)
+
+      return if @fiber_map.empty?
+
+      # sleep for a bit, let requests finish
+      @machine.sleep(PENDING_REQUESTS_GRACE_PERIOD)
+      return if @fiber_map.empty?
+
+      # terminate pending fibers
+      pending = @fiber_map.keys
+      signal = UM::Terminate.new
+      pending.each { @machine.schedule(it, signal) }
+
+      @machine.timeout(PENDING_REQUESTS_TIMEOUT_PERIOD, UM::Terminate) do
+        @machine.join(*@fiber_map.keys)
+      rescue UM::Terminate
+        # timeout on waiting for adapters to finish running, do nothing
       end
+    ensure
+      @machine.close(@server_fd)
     end
   end
 end

data/lib/tp2/version.rb

@@ -1,3 +1,3 @@
 module TP2
-  VERSION = '0.4'
+  VERSION = '0.6'
 end

data/test/test_http1_adapter.rb

@@ -452,23 +452,6 @@ class HTTP1AdapterTest < Minitest::Test
       p e.backtrace.join("\n")
     end
 
-    opts = {
-      upgrade: {
-        echo: lambda do |adapter, _headers|
-          conn = adapter.conn
-          conn << <<~HTTP.crlf_lines
-            HTTP/1.1 101 Switching Protocols
-            Upgrade: echo
-            Connection: Upgrade
-
-          HTTP
-
-          conn.read_loop { |data| conn << data }
-          done = true
-        end
-      }
-    }
-
     msg = "GET / HTTP/1.1\r\nUpgrade: echo\r\nConnection: upgrade\r\n\r\n"
     write_http_request(msg, false)
     @machine.spin { @adapter.serve_request rescue nil }

data/test/test_server.rb

@@ -85,6 +85,26 @@ class ServerTest < Minitest::Test
     assert_equal(expected, response)
   end
 
+  def test_graceful_shutdown
+    @app = ->(req) do
+      @machine.sleep(1)
+      req.respond('Hello, world!', {})
+    rescue UM::Terminate
+      req.respond('Terminated!', {})
+      raise
+    end
+
+    write_http_request "GET /foo HTTP/1.1\r\nServer: foo.com\r\n\r\nSCHMET /bar HTTP/1.1\r\n\r\n"
+
+    @machine.sleep(0.01)
+    @machine.schedule(@f_server, UM::Terminate.new)
+    @machine.snooze
+
+    response = read_client_side
+    expected = "HTTP/1.1 200\r\nContent-Length: 11\r\n\r\nTerminated!"
+    assert_equal(expected, response)
+  end
+
   def test_pipelined_requests_with_body
     skip
 

data/tp2.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.required_ruby_version = '>= 3.4'
 
-  s.add_dependency 'uringmachine',    '0.7'
+  s.add_dependency 'uringmachine',    '0.10'
   s.add_dependency 'qeweney',         '0.21'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tp2
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.6'
 platform: ruby
 authors:
 - Sharon Rosner
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: qeweney
   requirement: !ruby/object:Gem::Requirement
@@ -43,9 +43,10 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - TODO.md

data/Gemfile.lock

@@ -1,62 +0,0 @@
-PATH
-  remote: .
-  specs:
-    tp2 (0.4)
-      qeweney (= 0.21)
-      uringmachine (= 0.7)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    docile (1.4.1)
-    escape_utils (1.3.0)
-    ffi (1.17.2-aarch64-linux-gnu)
-    ffi (1.17.2-aarch64-linux-musl)
-    ffi (1.17.2-arm-linux-gnu)
-    ffi (1.17.2-arm-linux-musl)
-    ffi (1.17.2-arm64-darwin)
-    ffi (1.17.2-x86_64-darwin)
-    ffi (1.17.2-x86_64-linux-gnu)
-    ffi (1.17.2-x86_64-linux-musl)
-    listen (3.9.0)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    minitest (5.25.4)
-    qeweney (0.21)
-      escape_utils (= 1.3.0)
-    rake (13.2.1)
-    rake-compiler (1.2.9)
-      rake
-    rb-fsevent (0.11.2)
-    rb-inotify (0.11.1)
-      ffi (~> 1.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.1)
-    simplecov_json_formatter (0.1.4)
-    uringmachine (0.7)
-    yard (0.9.37)
-
-PLATFORMS
-  aarch64-linux-gnu
-  aarch64-linux-musl
-  arm-linux-gnu
-  arm-linux-musl
-  arm64-darwin
-  x86_64-darwin
-  x86_64-linux-gnu
-  x86_64-linux-musl
-
-DEPENDENCIES
-  listen (= 3.9.0)
-  minitest (= 5.25.4)
-  rake (= 13.2.1)
-  rake-compiler (= 1.2.9)
-  simplecov (= 0.22.0)
-  tp2!
-  yard (= 0.9.37)
-
-BUNDLED WITH
-   2.6.2