fetch-api 0.3.5 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2ece1d340c0de1c25cf5ff54b2faa9282e457a398b1e02e8b1254c869643e63
-  data.tar.gz: af89501158b402c8b5a2d5ac6961a93546b5a6caa78c8f27492ff1b0fc4b5be4
+  metadata.gz: ff43ec8ec36d621acb463b7327146e89df97446714df7747626276bb51ff4c18
+  data.tar.gz: de99e42e871912c41df6a5afabb1200f662d5aeba7b6659a4483434c8ddca3c7
 SHA512:
-  metadata.gz: f42136117dc9ff72634fdd12774dd6bc270d3c7f58363a0b78c74e216f12b241d35f60329f3957219d79a3d6b81ffb1b73917a7788647252b42a5271056df5fb
-  data.tar.gz: 9902db054b692dc72bd645c7d7030ec7392369d41e70d3d27b64b19f871294749e065eae638604b23ab418133a16c0b13d444bb132aab96274327482c516ecff
+  metadata.gz: 7b56ad7b6ac2788343928c4686f48de71e1dc57491e9e13efa5cc479f4f7f57af9d4efad3e7a79cf75fd287d683bb21ec053b69de0c66cdd39a0aef571f86c7b
+  data.tar.gz: 8895b9835e6637a9d4cd845708e2a133b2f6239baab1729478f16ae9f25ea3df927d678c41ebfbcc26cb3482a43c5fb616779df89a21a8a1aa634f0e18ebe392

data/README.md

@@ -102,6 +102,19 @@ res = fetch('http://example.com', **{
 })
 ```
 
+## Connection pooling
+
+Fetch API automatically pools and reuses connections to the same origin. Connections are closed after a certain amount of time has passed since the last use, and a new connection is used the next time. Different connections are returned for different threads (in other words, Fetch API is thread-safe).
+
+These values (in seconds) can be configured as follows:
+
+``` ruby
+Fetch.configure do |config|
+  config.connection_max_idle_time = 10 # default
+  config.keep_alive_timeout       = 2  # default
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/fetch/client.rb

@@ -1,3 +1,4 @@
+require_relative 'connection_pool'
 require_relative 'errors'
 require_relative 'form_data'
 require_relative 'headers'
@@ -40,10 +41,8 @@ module Fetch
         req.body = body
       end
 
-      http = Net::HTTP.new(uri.hostname, uri.port) # steep:ignore ArgumentTypeMismatch
-      http.use_ssl = uri.scheme == 'https'
-
-      res = http.start { _1.request(req) }
+      # @type var uri: URI::HTTP
+      res = pool.with_connection(uri) { _1.request(req) }
 
       case res
       when Net::HTTPRedirection
@@ -64,6 +63,14 @@ module Fetch
 
     private
 
+    def pool
+      if pool = Thread.current.thread_variable_get(:fetch_connection_pool)
+        pool
+      else
+        Thread.current.thread_variable_set :fetch_connection_pool, ConnectionPool.new
+      end
+    end
+
     def to_response(url, res, redirected)
       Response.new(
         url:        url.to_str,

data/lib/fetch/config.rb

@@ -0,0 +1,3 @@
+module Fetch
+  Config = Struct.new(:connection_max_idle_time, :keep_alive_timeout)
+end

data/lib/fetch/connection_pool.rb

@@ -0,0 +1,82 @@
+require_relative '../fetch'
+
+require 'thread'
+
+module Fetch
+  class ConnectionPool
+    Entry = Struct.new(:connection, :in_use, :last_used, keyword_init: true)
+
+    def initialize
+      @connections = {}
+      @mutex       = Mutex.new
+
+      @sweeper = Thread.new {
+        loop do
+          sleep 1
+
+          sweep
+
+          Thread.stop if @connections.empty?
+        end
+      }
+    end
+
+    def with_connection(uri, &block)
+      conn = acquire(uri)
+
+      begin
+        block.call(conn)
+      ensure
+        release uri
+      end
+    end
+
+    private
+
+    def acquire(uri)
+      @mutex.synchronize {
+        entry = @connections[uri.origin]
+
+        if entry
+          entry.in_use = true
+
+          entry.connection
+        else
+          Net::HTTP.new(uri.host, uri.port).tap {|http| # steep:ignore ArgumentTypeMismatch
+            http.use_ssl            = uri.scheme == 'https'
+            http.keep_alive_timeout = Fetch.config.keep_alive_timeout
+
+            @connections[uri.origin] = Entry.new(connection: http, in_use: true)
+
+            http.start
+          }
+        end
+      }.tap {
+        @sweeper.wakeup
+      }
+    end
+
+    def release(uri)
+      @mutex.synchronize do
+        if entry = @connections[uri.origin]
+          entry.in_use    = false
+          entry.last_used = Time.now
+        end
+      end
+    end
+
+    def sweep
+      @mutex.synchronize do
+        @connections.each do |origin, entry|
+          next if entry.in_use
+
+          if entry.last_used + Fetch.config.connection_max_idle_time < Time.now
+            entry.connection.finish
+
+            @connections.delete origin
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fetch/form_data.rb

@@ -1,7 +1,13 @@
+require 'forwardable'
+
 module Fetch
   class FormData
     include Enumerable
 
+    extend Forwardable
+
+    def_delegators :entries, :each
+
     def self.build(enumerable)
       data = FormData.new
 
@@ -19,7 +25,7 @@ module Fetch
     attr_reader :entries
 
     def append(key, value)
-      @entries.push [key.to_s, value.is_a?(File) ? value : value.to_s]
+      @entries.push [key.to_s, File === value ? value : value.to_s]
     end
 
     def delete(key)
@@ -50,9 +56,5 @@ module Fetch
     def values
       @entries.map(&:last)
     end
-
-    def each(&)
-      @entries.each(&)
-    end
   end
 end

data/lib/fetch/headers.rb

@@ -1,7 +1,13 @@
+require 'forwardable'
+
 module Fetch
   class Headers
     include Enumerable
 
+    extend Forwardable
+
+    def_delegators :entries, :each
+
     def initialize(init = [])
       @data = {}
 
@@ -41,9 +47,5 @@ module Fetch
     def values
       @data.values.map { _1.join(', ') }
     end
-
-    def each(&)
-      entries.each(&)
-    end
   end
 end

data/lib/fetch/url_search_params.rb

@@ -1,9 +1,14 @@
+require 'forwardable'
 require 'uri'
 
 module Fetch
   class URLSearchParams
     include Enumerable
 
+    extend Forwardable
+
+    def_delegators :entries, :each
+
     def initialize(options = [])
       @entries = []
 
@@ -61,9 +66,5 @@ module Fetch
     def values
       @entries.map(&:last)
     end
-
-    def each(&)
-      @entries.each(&)
-    end
   end
 end

data/lib/fetch/version.rb

@@ -1,3 +1,3 @@
 module Fetch
-  VERSION = '0.3.5'
+  VERSION = '0.4.1'
 end

data/lib/fetch.rb

@@ -0,0 +1,16 @@
+require_relative 'fetch/config'
+
+module Fetch
+  singleton_class.attr_accessor :config
+
+  self.config = Config.new
+
+  def self.configure(&block)
+    block.call(config)
+  end
+
+  configure do |config|
+    config.connection_max_idle_time = 10
+    config.keep_alive_timeout       = 2
+  end
+end

data/sig/fetch/api.rbs

@@ -1,9 +1,9 @@
 module Fetch
   class API
     def self?.fetch: (
-      _StringLike,
+      string,
       ?method: String | Symbol,
-      ?headers: Enumerable[[Object, Object]],
+      ?headers: _Each[[_ToS, _ToS]],
       ?body: (String | FormData | URLSearchParams)?,
       ?redirect: 'follow' | 'error' | 'manual' | :follow | :error | :manual,
     ) -> Response

data/sig/fetch/client.rbs

@@ -3,9 +3,9 @@ module Fetch
     include Singleton
 
     def fetch: (
-      _StringLike,
+      string,
       ?method: String | Symbol,
-      ?headers: Enumerable[[Object, Object]],
+      ?headers: _Each[[_ToS, _ToS]],
       ?body: (String | FormData | URLSearchParams)?,
       ?redirect: 'follow' | 'error' | 'manual' | :follow | :error | :manual,
       ?_redirected: bool
@@ -13,6 +13,8 @@ module Fetch
 
     private
 
-    def to_response: (_StringLike, Net::HTTPResponse, bool) -> Response
+    def initialize: () -> void
+    def pool: () -> ConnectionPool
+    def to_response: (string, Net::HTTPResponse, bool) -> Response
   end
 end

data/sig/fetch/config.rbs

@@ -0,0 +1,6 @@
+module Fetch
+  class Config
+    attr_accessor connection_max_idle_time: Integer
+    attr_accessor keep_alive_timeout: Integer
+  end
+end

data/sig/fetch/connection_pool.rbs

@@ -0,0 +1,20 @@
+module Fetch
+  class ConnectionPool
+    class Entry
+      attr_accessor connection: Net::HTTP
+      attr_accessor in_use: bool
+      attr_accessor last_used: Time
+
+      def initialize: (connection: Net::HTTP, in_use: bool, ?last_used: Time) -> void
+    end
+
+    def initialize: () -> void
+    def with_connection: [T] (URI::HTTP) { (Net::HTTP) -> T } -> T
+
+    private
+
+    def acquire: (URI::HTTP) -> Net::HTTP
+    def release: (URI::HTTP) -> void
+    def sweep: () -> void
+  end
+end

data/sig/fetch/form_data.rbs

@@ -1,22 +1,24 @@
 module Fetch
   class FormData
-    type value = String | File
+    include Enumerable[[String, String | File]]
 
-    include Enumerable[[String, value]]
+    extend Forwardable
 
-    attr_reader entries: Array[[String, value]]
+    attr_reader entries: Array[[String, String | File]]
 
-    def self.build: (Enumerable[[Object, Object]]) -> FormData
+    def self.build: (_Each[[_ToS, _ToS | File]]) -> FormData
 
     def initialize: () -> void
-    def append: (Object, Object) -> void
-    def delete: (Object) -> void
-    def get: (Object) -> value?
-    def get_all: (Object) -> Array[value]
-    def has: (Object) -> bool
+    def append: (_ToS, _ToS | File) -> void
+    def delete: (_ToS) -> void
+    def get: (_ToS) -> (String | File)?
+    def get_all: (_ToS) -> Array[String | File]
+    def has: (_ToS) -> bool
     def keys: -> Array[String]
-    def set: (Object, Object) -> void
-    def values: () -> Array[value]
-    def each: () { ([String, value]) -> void } -> Array[[String, value]]
+    def set: (_ToS, _ToS | File) -> void
+    def values: () -> Array[String | File]
+
+    def each: () { ([String, String | File]) -> void } -> Array[[String, String | File]]
+            | () -> Enumerator[[String, String | File], Array[[String, String | File]]]
   end
 end

data/sig/fetch/headers.rbs

@@ -2,15 +2,19 @@ module Fetch
   class Headers
     include Enumerable[[String, String]]
 
-    def initialize: (Enumerable[[Object, Object]]) -> void
-    def append: (Object, Object) -> void
-    def delete: (Object) -> void
+    extend Forwardable
+
+    def initialize: (_Each[[_ToS, _ToS]]) -> void
+    def append: (_ToS, _ToS) -> void
+    def delete: (_ToS) -> void
     def entries: () -> Array[[String, String]]
-    def get: (Object) -> String?
-    def has: (Object) -> bool
+    def get: (_ToS) -> String?
+    def has: (_ToS) -> bool
     def keys: -> Array[String]
-    def set: (Object, Object) -> void
+    def set: (_ToS, _ToS) -> void
     def values: () -> Array[String]
+
     def each: () { ([String, String]) -> void } -> Array[[String, String]]
+            | () -> Enumerator[[String, String], Array[[String, String]]]
   end
 end

data/sig/fetch/response.rbs

@@ -1,7 +1,5 @@
 module Fetch
   class Response
-    include Data::_DataClass
-
     attr_reader url: String
     attr_reader status: Integer
     attr_reader headers: Headers
@@ -11,6 +9,6 @@ module Fetch
     def initialize: (url: String, status: Integer, headers: Headers, body: String?, redirected: bool) -> void
     def ok: () -> bool
     def status_text: () -> String
-    def json: (json_options) -> Object?
+    def json: (json_options) -> untyped
   end
 end

data/sig/fetch/url_search_params.rbs

@@ -2,19 +2,23 @@ module Fetch
   class URLSearchParams
     include Enumerable[[String, String]]
 
+    extend Forwardable
+
     attr_reader entries: Array[[String, String]]
 
-    def self.build: (Enumerable[[Object, Object]]) -> FormData
+    def self.build: (_Each[[_ToS, _ToS]]) -> FormData
 
-    def initialize: (String | Enumerable[[Object, Object]]) -> void
-    def append: (Object, Object) -> void
-    def delete: (Object) -> void
-    def get: (Object) -> String?
-    def get_all: (Object) -> Array[String]
-    def has: (Object) -> bool
+    def initialize: (String | _Each[[_ToS, _ToS]]) -> void
+    def append: (_ToS, _ToS) -> void
+    def delete: (_ToS) -> void
+    def get: (_ToS) -> String?
+    def get_all: (_ToS) -> Array[String]
+    def has: (_ToS) -> bool
     def keys: -> Array[String]
-    def set: (Object, Object) -> void
+    def set: (_ToS, _ToS) -> void
     def values: () -> Array[String]
+
     def each: () { ([String, String]) -> void } -> Array[[String, String]]
+            | () -> Enumerator[[String, String], Array[[String, String]]]
   end
 end

data/sig/fetch.rbs

@@ -1,7 +1,7 @@
 module Fetch
-  interface _StringLike
-    def to_str: () -> String
-  end
-
   VERSION: String
+
+  attr_accessor self.config: Config
+
+  def self.configure: () { (Config) -> void } -> void
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fetch-api
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.1
 platform: ruby
 authors:
 - Keita Urashima
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-07 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: forwardable
+  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: json
   requirement: !ruby/object:Gem::Requirement
@@ -104,8 +118,11 @@ files:
 - LICENSE.txt
 - README.md
 - lib/fetch-api.rb
+- lib/fetch.rb
 - lib/fetch/api.rb
 - lib/fetch/client.rb
+- lib/fetch/config.rb
+- lib/fetch/connection_pool.rb
 - lib/fetch/errors.rb
 - lib/fetch/form_data.rb
 - lib/fetch/headers.rb
@@ -115,6 +132,8 @@ files:
 - sig/fetch.rbs
 - sig/fetch/api.rbs
 - sig/fetch/client.rbs
+- sig/fetch/config.rbs
+- sig/fetch/connection_pool.rbs
 - sig/fetch/errors.rbs
 - sig/fetch/form_data.rbs
 - sig/fetch/headers.rbs