iopromise 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb3b131c886899408dfd81fa4d0fdefca9491df9e1a53ddeb6c684ab6043d4fc
-  data.tar.gz: f0f42864a1860e8e30f01c2994e85bebf8d47828852a8990d973a74ebbe90410
+  metadata.gz: 1189b2ad73f76eff39b347922c03e2e40fc188ff95b7a6771da921d193c88ed5
+  data.tar.gz: 169d59659740616c94508bdd3fabfd8fd1850c2a593dade86fda7267efa03eb7
 SHA512:
-  metadata.gz: 6a68af080d98407fd8b6b1764e589dff42f6597e6c5118ca62c4d61387bd1cd475c01f5fe09ef3702d287da9c440c8811f22ff44379381e6477503400e0cf9b3
-  data.tar.gz: a07492017391dae8dba06b5b76b1bcb738845fc5e5d87a8a5a44f397bb9d1d2f8ee3586ed31a3fc35b7633bee45616744324dbd0133cd96b08521602a0e61c29
+  metadata.gz: 11f75193659f6f37295faf3d0ecea8166aa446da826da462cfc8ea5631eae2f107a65c1d093f1c082ae1e2690166f124244ea2ddf9bcc837ae3c6763e13ae063
+  data.tar.gz: d16beca1753c4c31994801787925b25713ac315599cc246dc19a92169fab7afe5948717454e9511be59735e542e8eea4805660c86c6c8de7a906a4e376848dc4

data/.github/workflows/main.yml

@@ -8,8 +8,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Install dependencies
-      run: sudo apt-get install libcurl4-openssl-dev libsasl2-dev
-    - uses: niden/actions-memcached@v7
+      run: sudo apt-get update && sudo apt-get install libcurl4-openssl-dev libsasl2-dev
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/Gemfile

@@ -10,17 +10,11 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 group :development, :test do
-  # faraday adapter
-  gem 'faraday'
-  gem 'typhoeus'
-
-  # memcached adapter
-  gem 'memcached', :git => 'https://github.com/theojulienne/memcached.git', :branch => 'continuable-get'
-
-  # dalli adapter
-  gem 'dalli', "= 2.7.11"
-
   # view_component extensions
   gem "rails"
   gem "view_component", require: "view_component/engine"
+
+  # benchmarking
+  gem "benchmark-ips"
+  gem "stackprof"
 end

data/Gemfile.lock

@@ -1,15 +1,9 @@
-GIT
-  remote: https://github.com/theojulienne/memcached.git
-  revision: 18c1da3708f3e7dca316b2f0143b4f05116f7672
-  branch: continuable-get
-  specs:
-    memcached (2.0.0.alpha)
-
 PATH
   remote: .
   specs:
-    iopromise (0.1.0)
-      promise.rb
+    iopromise (0.1.4)
+      nio4r
+      promise.rb (~> 0.7.4)
 
 GEM
   remote: https://rubygems.org/
@@ -73,24 +67,12 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    benchmark-ips (2.9.1)
     builder (3.2.4)
     concurrent-ruby (1.1.8)
     crass (1.0.6)
-    dalli (2.7.11)
     diff-lcs (1.4.4)
     erubi (1.10.0)
-    ethon (0.14.0)
-      ffi (>= 1.15.0)
-    faraday (1.4.1)
-      faraday-excon (~> 1.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords (>= 0.0.4)
-    faraday-excon (1.1.0)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.1.0)
-    ffi (1.15.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.8.10)
@@ -104,7 +86,6 @@ GEM
     method_source (1.0.0)
     mini_mime (1.0.3)
     minitest (5.14.4)
-    multipart-post (2.1.1)
     nio4r (2.5.7)
     nokogiri (1.11.3-x86_64-linux)
       racc (~> 1.4)
@@ -153,7 +134,6 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    ruby2_keywords (0.0.4)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -161,9 +141,8 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
+    stackprof (0.2.17)
     thor (1.1.0)
-    typhoeus (1.4.0)
-      ethon (>= 0.9.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     view_component (2.31.1)
@@ -177,14 +156,12 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  dalli (= 2.7.11)
-  faraday
+  benchmark-ips
   iopromise!
-  memcached!
   rails
   rake (~> 13.0)
   rspec (~> 3.0)
-  typhoeus
+  stackprof
   view_component
 
 BUNDLED WITH

data/README.md

@@ -1,6 +1,23 @@
-# iopromise
+# IOPromise
 
-This **experimental pre-release** gem extends promise.rb promises to support an extremely simple pattern for \"continuing\" execution of all pending promises in an asynchronous non-blocking way.
+IOPromise is a pattern that allows parallel execution of IO-bound requests (data store and RPCs) behind the abstraction of promises, without needing to introduce the complexity of threading. It uses [promise.rb](https://github.com/lgierth/promise.rb) for promises, and [nio4r](https://github.com/socketry/nio4r) to implement the IO loop.
+
+A simple example of this behaviour is using [iopromise-faraday](https://github.com/iopromise-ruby/iopromise-faraday) to perform concurrent HTTP requests:
+```ruby
+require 'iopromise/faraday'
+
+conn = IOPromise::Faraday.new('https://github.com/')
+
+promises = (1..3).map do
+  conn.get('/status')
+end
+
+Promise.all(promises).then do |responses|
+  responses.each_with_index do |response, i|
+    puts "#{i}: #{response.body.strip} #{response.headers["x-github-request-id"]}"
+  end
+end.sync
+```
 
 ## Installation
 
@@ -20,7 +37,10 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+IOPromise itself is a base library that makes it easy to wrap other IO-based workloads inside a promise-based API that back to an event loop. To use IOPromise, look at the following gems:
+
+ * [iopromise-faraday](https://github.com/iopromise-ruby/iopromise-faraday) supports [faraday](https://github.com/lostisland/faraday) HTTP requests, backed by libcurl/ethon/typhoeus.
+ * [iopromise-dalli](https://github.com/iopromise-ruby/iopromise-dalli) supports [dalli](https://github.com/petergoldstein/dalli) memcached requests.
 
 ## Development
 

data/bin/setup

@@ -4,6 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# bring up a memcached for testing
-docker run -d -p 11211:11211 memcached:alpine

data/iopromise.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'promise.rb', '~> 0.7.4'
+  spec.add_dependency 'nio4r'
 end

data/lib/iopromise.rb

@@ -4,6 +4,7 @@ require "promise"
 
 require_relative "iopromise/version"
 
+require_relative "iopromise/cancel_context"
 require_relative "iopromise/executor_context"
 require_relative "iopromise/executor_pool/base"
 require_relative "iopromise/executor_pool/batch"
@@ -11,44 +12,72 @@ require_relative "iopromise/executor_pool/sequential"
 
 module IOPromise
   class Error < StandardError; end
+  class CancelledError < Error; end
 
   class Base < ::Promise
-    def initialize(*)
-      @instrument_begin = []
-      @instrument_end = []
-      @started_executing = false
-      
-      super
-    end
-
     def instrument(begin_cb = nil, end_cb = nil)
-      raise ::IOPromise::Error.new("Instrumentation called after promise already started executing") if @started_executing
-      @instrument_begin << begin_cb unless begin_cb.nil?
-      @instrument_end << end_cb unless end_cb.nil?
+      raise ::IOPromise::Error.new("Instrumentation called after promise already started executing") if started_executing?
+      unless begin_cb.nil?
+        @instrument_begin ||= []
+        @instrument_begin << begin_cb
+      end
+      unless end_cb.nil?
+        @instrument_end ||= []
+        @instrument_end << end_cb
+      end
     end
 
     def beginning
-      @instrument_begin.each { |cb| cb.call(self) }
+      @instrument_begin&.each { |cb| cb.call(self) }
+      @instrument_begin&.clear
       @started_executing = true
     end
 
     def started_executing?
-      @started_executing
+      !!@started_executing
     end
 
-    def notify_completion
-      @instrument_end.each { |cb| cb.call(self) }
-      @instrument_end = []
+    def notify_completion(value: nil, reason: nil)
+      @instrument_end&.each { |cb| cb.call(self, value: value, reason: reason) }
+      @instrument_end&.clear
     end
 
     def fulfill(value)
-      notify_completion
+      return if cancelled?
+      notify_completion(value: value)
       super(value)
     end
 
     def reject(reason)
-      notify_completion
+      return if cancelled?
+      notify_completion(reason: reason)
       super(reason)
     end
+
+    def wait
+      raise IOPromise::CancelledError if cancelled?
+      super
+    end
+
+    # Subclasses are expected to implement 'execute_pool' to return an IOPromise::ExecutorPool
+    # that is responsible for completing the given promise.
+    def execute_pool
+      raise NotImplementedError
+    end
+
+    # makes this promise inert, ensuring that promise chains do not continue
+    # propegation once this promise has been cancelled.
+    def cancel
+      return unless pending?
+      
+      @cancelled = true
+      @observers = []
+
+      execute_pool.promise_cancelled(self)
+    end
+
+    def cancelled?
+      !!defined?(@cancelled)
+    end
   end
 end

data/lib/iopromise/cancel_context.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module IOPromise
+  class CancelContext
+    class << self
+      def context_stack
+        Thread.current[:iopromise_context_stack] ||= []
+      end
+
+      def current
+        context_stack.last
+      end
+
+      def push
+        new_ctx = CancelContext.new(current)
+        context_stack.push(new_ctx)
+        new_ctx
+      end
+
+      def pop
+        ctx = context_stack.pop
+        ctx.cancel
+        ctx
+      end
+
+      def with_new_context
+        ctx = push
+        yield ctx
+      ensure
+        pop
+      end
+    end
+
+    def initialize(parent)
+      parent.subscribe(self) unless parent.nil?
+    end
+
+    def subscribe(observer)
+      @observers ||= []
+      @observers.push observer
+    end
+
+    def cancel
+      return unless defined?(@observers)
+      @observers.each do |o|
+        o.cancel
+      end
+      @observers = []
+    end
+  end
+end

data/lib/iopromise/data_loader.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module IOPromise
+  module DataLoader
+    module ClassMethods
+      def attr_promised_data(*args)
+        @promised_data_keys ||= []
+        @promised_data_keys.concat(args)
+
+        args.each do |arg|
+          self.class_eval("def #{arg};@#{arg}.sync;end")
+        end
+      end
+  
+      def promised_data_keys
+        @promised_data_keys ||= []
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def data_promises
+      self.class.promised_data_keys.flat_map do |k|
+        p = instance_variable_get('@' + k.to_s)
+        case p
+        when ::IOPromise::DataLoader
+          # greedily, recursively preload all nested data that we know about immediately
+          p.data_promises
+        when ::Promise
+          # allow nesting of dataloaders chained behind other promises
+          resolved = p.then do |result|
+            if result.is_a?(::IOPromise::DataLoader)
+              # likewise, if we resolved a promise that we can recurse, load that data too.
+              result.data_as_promise
+            else
+              result
+            end
+          end
+
+          [resolved]
+        else
+          raise TypeError.new("Instance variable #{k.to_s} used with attr_promised_data but was not a promise or a IOPromise::DataLoader.")
+        end
+      end
+    end
+
+    def data_as_promise
+      @data_as_promise ||= Promise.all(data_promises)
+    end
+
+    def sync
+      data_as_promise.sync
+      self
+    end
+  end
+end

data/lib/iopromise/deferred.rb

@@ -5,8 +5,8 @@ require_relative 'deferred/promise'
 module IOPromise
   module Deferred
     class << self
-      def new(&block)
-        ::IOPromise::Deferred::DeferredPromise.new(&block)
+      def new(*args, **kwargs, &block)
+        ::IOPromise::Deferred::DeferredPromise.new(*args, **kwargs, &block)
       end
     end
   end

data/lib/iopromise/deferred/executor_pool.rb

@@ -3,26 +3,42 @@
 module IOPromise
   module Deferred
     class DeferredExecutorPool < ::IOPromise::ExecutorPool::Batch
-      def execute_continue(ready_readers, ready_writers, ready_exceptions)
+      def initialize(*)
+        super
+
+        # register a dummy reader that never fires, to indicate to the event loop that
+        # there is a valid, active ExecutorPool.
+        @pipe_rd, @pipe_wr = IO.pipe
+        @iop_monitor = ::IOPromise::ExecutorContext.current.register_observer_io(self, @pipe_rd, :r)
+      end
+
+      def execute_continue
         if @current_batch.empty?
           next_batch
         end
 
-        until @current_batch.empty?
-          # we are just running this in the sync cycle, in a blocking way.
-          @current_batch.each do |promise|
+        # we are just running this in the sync cycle, in a blocking way.
+        timeouts = []
+        @current_batch.each do |promise|
+          time_until_execution = promise.time_until_execution
+          if time_until_execution <= 0
             begin_executing(promise)
             promise.run_deferred
-            complete(promise)
+          else
+            timeouts << time_until_execution
           end
+        end
 
-          @current_batch = []
-
-          next_batch
+        if timeouts.empty?
+          @select_timeout = nil
+        else
+          # ensure we get back to this loop not too long after 
+          @select_timeout = timeouts.min
         end
 
-        # we always fully complete each cycle
-        return [[], [], [], nil]
+        # we reset the batch - the promises that are not completed will still be
+        # pending and will be available next time we are called.
+        @current_batch = []
       end
     end
   end