fiber-scheduler 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7fa0c2f81a443cd6c852a51ad9c8d89d30ee080013980c94c2d16335aa074f1
-  data.tar.gz: 83b4f910992b1f5d44976095d51c822acac07b98eb795ed1208cfd41e935e320
+  metadata.gz: d6a375b6e9a2d17be96e9c118ac624bbcbea154f961a205a9e1b0fc560b96f5e
+  data.tar.gz: 54e447b2977cfeb14bb06db5286eb3b291e2645dd9f0cc92f5aca2f5a8081372
 SHA512:
-  metadata.gz: 41c1fed81c488cb5e4044688bc80b2b95136b5e8401260a35d3abdb8d05e8603ea40087d96f9f730417543783729cc713dbaafe46eaa3f7b5a8936cfd617857b
-  data.tar.gz: 7f712132eedc368609578b6f07073aa4be1d4db11305e6b70b9627807f8acee48fd41f1a6876f214062d7da5c1bdd881c2a65830a2fe84b5ea202dc2079ae969
+  metadata.gz: c5f13b97d884ae06d98cdd2cea421ea8df2294e04a4ba4bc5a508df36a35f089eafd83741b7d57a105169ba93efdb512f65590c0624b225f527a046fefd23042
+  data.tar.gz: e055549f62f5ffabf6470a6d2ec3069f3d4df7bfd02bcf43f4f6a82e094927fa09ff6604186182e5d4123a6893f04b7fe6fb2ebd3b14e8da2d06468f53d6c3ee

data/lib/fiber_scheduler/compatibility.rb

@@ -1,22 +1,26 @@
 class FiberScheduler
   module Compatibility
+    Close = Class.new(RuntimeError)
+
     def fiber(*args, **opts, &block)
       return super unless Compatibility.internal?
 
       # This is `Fiber.schedule` call inside `FiberScheduler { ... }` block.
-      if opts[:blocking]
+      type = args.first
+      case type
+      when :blocking
         Fiber.new(blocking: true) {
           Compatibility.set_internal!
           yield
         }.tap(&:resume)
 
-      elsif opts[:waiting]
+      when :waiting
         parent = Fiber.current
         finished = false # prevents races
         blocking = false # prevents #unblock-ing a fiber that never blocked
 
         # Don't pass *args and **opts to an unknown fiber scheduler class.
-        super() do
+        fiber = super() do
           Compatibility.set_internal!
           yield
         ensure
@@ -29,15 +33,58 @@ class FiberScheduler
           block(nil, nil)
         end
 
-      else
+        fiber
+
+      when :fleeting
+        # Transfer to current fiber some time after a fleeting fiber yields.
+        unblock(nil, Fiber.current)
+        # Alternative to #unblock: Fiber.scheduler.push(Fiber.current)
+
+        fiber = Fiber.new(blocking: false) do
+          Compatibility.set_internal!
+          yield
+        rescue Close
+          # Fiber scheduler is closing.
+        ensure
+          _fleeting.delete(Fiber.current)
+        end
+        _fleeting[fiber] = nil
+        fiber.tap(&:transfer)
+
+      when nil
         # Don't pass *args and **opts to an unknown fiber scheduler class.
         super() do
           Compatibility.set_internal!
           yield
         end
+
+      else
+        raise "Unknown type"
+      end
+    end
+
+    # #close and #_fleeting handle a complexity in Async::Scheduler#close, more
+    # specifically this line:
+    # https://github.com/socketry/async/blob/456df488d801572821eaf5ec2fda10e3b9744a5f/lib/async/scheduler.rb#L55
+    def close
+      super
+    rescue
+      if _fleeting.empty?
+        Kernel.raise
+      else
+        # #dup is used because #_fleeting is modified during iteration.
+        _fleeting.dup.each do |fiber, _|
+          fiber.raise(Close)
+        end
+
+        super # retry
       end
     end
 
+    def _fleeting
+      @_fleeting ||= {}
+    end
+
     def self.set_internal!
       Thread.current[:_fiber_scheduler] = true # Sets a FIBER local var!
     end

data/lib/fiber_scheduler/version.rb

@@ -1,3 +1,3 @@
 class FiberScheduler
-  VERSION = "0.10.0".freeze
+  VERSION = "0.12.0".freeze
 end

data/lib/fiber_scheduler.rb

@@ -10,14 +10,12 @@ rescue LoadError
 end
 
 module Kernel
-  def FiberScheduler(blocking: false, waiting: true, &block)
+  def FiberScheduler(type = nil, &block)
     if Fiber.scheduler.nil?
-      scheduler = FiberScheduler.new
-      Fiber.set_scheduler(scheduler)
+      Fiber.set_scheduler(FiberScheduler.new)
 
       begin
         yield
-        scheduler.close
       ensure
         Fiber.set_scheduler(nil)
       end
@@ -28,26 +26,27 @@ module Kernel
       if scheduler.is_a?(FiberScheduler)
         # The default waiting is 'true' as that is the most intuitive behavior
         # for a nested FiberScheduler call.
-        Fiber.schedule(blocking: blocking, waiting: waiting, &block)
+        Fiber.schedule(type, &block)
 
         # Unknown fiber scheduler class; can't just pass options to
         # Fiber.schedule, handle each option separately.
       else
         scheduler.singleton_class.prepend(FiberScheduler::Compatibility)
 
-        if blocking
+        case type
+        when :blocking
           fiber = Fiber.new(blocking: true) do
             FiberScheduler::Compatibility.set_internal!
             yield
           end
           fiber.tap(&:resume)
 
-        elsif waiting
+        when :waiting
           parent = Fiber.current
           finished = false # prevents races
           blocking = false # prevents #unblock-ing a fiber that never blocked
 
-          Fiber.schedule do
+          fiber = Fiber.schedule do
             FiberScheduler::Compatibility.set_internal!
             yield
           ensure
@@ -67,11 +66,30 @@ module Kernel
             scheduler.block(nil, nil)
           end
 
-        else
+          fiber
+
+        when :fleeting
+          scheduler.unblock(nil, Fiber.current)
+
+          fiber = Fiber.new(blocking: false) do
+            FiberScheduler::Compatibility.set_internal!
+            yield
+          rescue FiberScheduler::Compatibility::Close
+            # Fiber scheduler is closing.
+          ensure
+            scheduler._fleeting.delete(Fiber.current)
+          end
+          scheduler._fleeting[fiber] = nil
+          fiber.tap(&:transfer)
+
+        when nil
           Fiber.schedule do
             FiberScheduler::Compatibility.set_internal!
             yield
           end
+
+        else
+          raise "Unknown type"
         end
       end
     end
@@ -170,13 +188,14 @@ class FiberScheduler
     @timeouts.timeout(duration, exception, message, &block)
   end
 
-  def fiber(blocking: false, waiting: false, &block)
+  def fiber(type = nil, &block)
     current = Fiber.current
 
-    if blocking
-      # All fibers wait on a blocking fiber, so 'waiting' option is ignored.
+    case type
+    when :blocking
       Fiber.new(blocking: true, &block).tap(&:resume)
-    elsif waiting
+
+    when :waiting
       finished = false # prevents races
       fiber = Fiber.new(blocking: false) do
         @count += 1
@@ -201,7 +220,16 @@ class FiberScheduler
       end
 
       fiber
-    else
+
+    when :fleeting
+      if current != @fiber
+        # nested Fiber.schedule
+        @nested << current
+      end
+
+      Fiber.new(blocking: false, &block).tap(&:transfer)
+
+    when nil
       if current != @fiber
         # nested Fiber.schedule
         @nested << current
@@ -214,6 +242,9 @@ class FiberScheduler
         @count -= 1
       end
       fiber.tap(&:transfer)
+
+    else
+      raise "Unknown type"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fiber-scheduler
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Bruno Sutic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-15 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement