pg_pipeline 0.2.5 → 0.3.0

data/lib/pg_pipeline/runtime.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "timeout"
+
+require_relative "errors"
+
+module PgPipeline
+  module Runtime
+    class Cancel < Exception; end
+    class TimeoutError < Error; end
+
+    module_function
+
+    CURRENT_TASK_KEY = :pg_pipeline_current_task
+    WAITER_KEY = :pg_pipeline_waiter
+
+    def spawn(name: nil, &block)
+      Task.spawn(name: name, &block)
+    end
+
+    def scheduler!
+      Fiber.scheduler or raise Error, "operation requires an active Fiber scheduler"
+    end
+
+    def current_task
+      Thread.current[CURRENT_TASK_KEY]
+    end
+
+    def build_waiter(blocker)
+      waiter = Thread.current[WAITER_KEY] ||= {
+        fiber: nil, scheduler: nil, ready: false, blocker: nil
+      }
+
+      if waiter[:blocker]
+        raise Error, "waiter already parked on #{waiter[:blocker].class}; " \
+                     "a fiber may only park in one place at a time"
+      end
+
+      waiter[:fiber] = Fiber.current
+      waiter[:scheduler] = scheduler!
+      waiter[:ready] = false
+      waiter[:queued] = false
+      waiter[:blocker] = blocker
+      waiter
+    end
+
+    def park(blocker, waiter)
+      scheduler = waiter[:scheduler]
+      task = current_task
+      task&.enter_block(waiter)
+
+      until waiter[:ready] || yield
+        scheduler.block(blocker, nil)
+        task&.raise_if_cancelled!
+      end
+      nil
+    ensure
+      waiter[:blocker] = nil
+      task&.exit_block
+    end
+
+    def with_waiter(blocker, waiters)
+      waiter = build_waiter(blocker)
+      waiter[:queued] = true
+      waiters << waiter
+      yield waiter
+    ensure
+      waiters.delete(waiter) if waiter[:queued]
+    end
+
+    def wake_dequeued(waiter, blocker)
+      waiter[:queued] = false
+      wake(waiter, blocker)
+    end
+
+    def with_timeout(duration)
+      return yield if duration.nil?
+
+      timeout = Float(duration)
+      raise ArgumentError, "timeout must be non-negative and finite" unless timeout.finite? && timeout >= 0
+
+      ::Timeout.timeout(timeout, TimeoutError) { yield }
+    end
+
+    def wake(waiter, blocker)
+      waiter[:ready] = true
+      fiber = waiter[:fiber]
+      return unless fiber.alive?
+
+      waiter[:scheduler].unblock(blocker, fiber)
+    end
+  end
+end
+
+require_relative "runtime/notification"
+require_relative "runtime/queue"
+require_relative "runtime/semaphore"
+require_relative "runtime/task"

data/lib/pg_pipeline/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgPipeline
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

data/lib/pg_pipeline.rb

@@ -2,6 +2,7 @@
 
 require_relative "pg_pipeline/version"
 require_relative "pg_pipeline/errors"
+require_relative "pg_pipeline/runtime"
 require_relative "pg_pipeline/server_caps"
 require_relative "pg_pipeline/session_guard"
 require_relative "pg_pipeline/session"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Roman Hajdarov
@@ -9,20 +9,6 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: async
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.42'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.42'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +29,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.42'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -101,10 +101,12 @@ dependencies:
         version: '0.2'
 description: |
   A driver-adjacent Ruby control-plane over ruby-pg/libpq. It multiplexes
-  independent, session-neutral extended-protocol operations from many Async
-  fibers onto a small number of PostgreSQL connections while keeping explicit
+  independent, session-neutral extended-protocol operations from many fibers
+  onto a small number of PostgreSQL connections while keeping explicit
   transactions and session-changing work on exclusive pinned connections.
-  Control-plane only: all wire work stays in libpq. Zero lines of C.
+  Requires any Fiber::Scheduler host (Async::Scheduler, Itsi::Scheduler, …);
+  the gem does not depend on a particular reactor. Control-plane only: all
+  wire work stays in libpq.
 email:
 - romanhajdarov@gmail.com
 executables: []
@@ -123,6 +125,11 @@ files:
 - lib/pg_pipeline/pool.rb
 - lib/pg_pipeline/prepared_statement.rb
 - lib/pg_pipeline/request.rb
+- lib/pg_pipeline/runtime.rb
+- lib/pg_pipeline/runtime/notification.rb
+- lib/pg_pipeline/runtime/queue.rb
+- lib/pg_pipeline/runtime/semaphore.rb
+- lib/pg_pipeline/runtime/task.rb
 - lib/pg_pipeline/server_caps.rb
 - lib/pg_pipeline/session.rb
 - lib/pg_pipeline/session_guard.rb
@@ -152,5 +159,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: Async-native PostgreSQL pipeline multiplexing on top of ruby-pg
+summary: Fiber-scheduler PostgreSQL pipeline multiplexing on top of ruby-pg
 test_files: []