concurrent_rails 0.1.5 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87ad625b78cf38b613761735ca3ca8ad7dbf12f16f807290082bf1a7081ad383
-  data.tar.gz: 723e320ec707747381e1d8b7f6b81f801c02643d2d18f4e714330041eeff49a5
+  metadata.gz: a0352c1516c930c65708383fa734cd7444b02b0a213c0ef1f794e5e31f8e1fdf
+  data.tar.gz: 33ec089c95b33ff31a4652a073feac356e8b23a8d7e30bd214ea0a0dbc4aedcb
 SHA512:
-  metadata.gz: 0fa50d7cfad90990b29f75bdcf3f6e15dc8252774259b4d65af62f37cd36a4ed46b0ff5b091a39a8f0e0f54625e90d5444489dd6d4ea13b44d9c474d783c56d2
-  data.tar.gz: 3a75c1ccd1f4821827359c672c991b0ef071a2dc41a274447c1117c51bc52bc9cc41fec35cde38ef6d79b31d4047b419240ae99775c415bff66240433b05f340
+  metadata.gz: a486a3ab777574962127795db050fd2615b69594d0bc88adb5114368c7d90492f2b51b237817f97118a31969396d53171bf66371240577051977a052d935148a
+  data.tar.gz: db095fe9e33e527a3ade62e8a40aec1866718bfce6b55ef519775cd1761d78b1eb1868d8c8b0ab799dcd05f78980ba16e31f5a7912b87ab3e2dd49d917dab004

data/README.md

@@ -2,19 +2,17 @@
 
 ![status](https://github.com/luizkowalski/concurrent_rails/actions/workflows/ruby.yml/badge.svg?branch=master)
 
-Multithread is hard. [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby) did an amazing job
-implementing the concepts of multithread in the Ruby world. The problem is that Rails doesn't play nice with it. Rails have a complex way of managing threads called Executor and concurrent-ruby (most specifically, [Future](https://github.com/ruby-concurrency/concurrent-ruby/blob/master/docs-source/future.md)) does not work seamlessly with it.
+Multithread is hard. [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby) did an amazing job implementing the concepts of multithread in the Ruby world. The problem is that Rails doesn't play nice with it. Rails have a complex way of managing threads called Executor and concurrent-ruby (most specifically, [Future](https://github.com/ruby-concurrency/concurrent-ruby/blob/master/docs-source/future.md)) does not work seamlessly with it.
 
 The goal of this gem is to provide a simple library that allows the developer to work with Futures without having to care about Rails's Executor and the whole pack of problems that come with it: autoload, thread pools, active record connections, etc.
 
 ## Usage
 
-This library provides three classes that will help you run tasks in parallel: `ConcurrentRails::Promises`,  `ConcurrentRails::Future` and `ConcurrentRails::Multi`
+This library provides three classes that will help you run tasks in parallel: `ConcurrentRails::Promises`,  `ConcurrentRails::Future` ([in process of being deprecated by concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby#deprecated)) and `ConcurrentRails::Multi`
 
 ### Promises
 
-`Promises` is the recommended way from `concurrent-ruby` to create `Future`s as `Concurrent::Future` will be deprecated at some point.
-Similar to other classes, all you have to do is call `.future` helper and pass a block:
+`Promises` is the recommended way from `concurrent-ruby` to create `Future`s as `Concurrent::Future` will be deprecated at some point. All you have to do is call `#future` and pass a block to be executed asynchronously:
 
 ```ruby
 irb(main):001:0> future = ConcurrentRails::Promises.future(5) { |v| sleep(v); 42 }
@@ -40,9 +38,52 @@ irb(main):002:0> future.value
 => 84
 ```
 
-### Future
+### Delayed futures
 
-`ConcurrentRails::Future` will execute your code in a separated thread and you can check the progress of it whenever you need it. When the task is ready, you can access the result with `#result` function:
+Delayed future is a future that is enqueued but not run until `#touch` or any other method that requires a resolution is called.
+
+```ruby
+irb(main):002:0> delay = ConcurrentRails::Promises.delay { 42 }
+=> #<ConcurrentRails::Promises:0x00007f8b55333d48 @executor=:io, @instan...
+
+irb(main):003:0> delay.state
+=> :pending
+
+irb(main):004:0> delay.touch
+=> #<Concurrent::Promises::Future:0x00007f8b553325b0 pending>
+
+irb(main):005:0> delay.state
+=> :fulfilled
+
+irb(main):006:0> delay.value
+=> 42
+```
+
+Three methods will trigger a resolution: `#touch`, `#value` and `#wait`: `#touch` will simply trigger the execution but won't block the main thread, while `#wait` and `#value` will block the main thread until a resolution is given.
+
+### Callbacks
+
+Delayed and regular futures can set a callback to be executed after the resolution of the future. There are three different callbacks:
+
+* `on_resolution`: runs after the future is resolved and yields three parameters to the callback in the following order: `true/false` for future's fulfillment, `value` as the result of the future execution, and `reason`, that will be `nil` if the future fulfilled or the error that the future triggered.
+
+* `on_fulfillment`: runs after the future is fulfilled and yields `value` to the callback
+
+* `on_rejection`: runs after the future is rejected and yields the `error` to the callback
+
+```ruby
+delay = ConcurrentRails::Promises.delay { complex_find_user_query }.
+        on_fulfillment { |user| user.update!(name: 'John Doe') }.
+        on_rejection { |reason| log_error(reason) }
+
+delay.touch
+```
+
+All of these callbacks have a bang version (e.g. `on_fulfillment!`). The bang version will execute the callback on the same thread pool that was initially set up and the version without bang will run asynchronously on a different executor.
+
+### (Deprecated) Future
+
+`ConcurrentRails::Future` will execute your code in a separate thread and you can check the progress of it whenever you need it. When the task is ready, you can access the result with `#result` function:
 
 ```ruby
 irb(main):001:0> future = ConcurrentRails::Future.new do
@@ -81,7 +122,7 @@ irb(main):005:0> future.reason
 => #<ZeroDivisionError: divided by 0>
 ```
 
-### Multi
+### (Deprecated) Multi
 
 `ConcurrentRails::Multi` will let you execute multiple tasks in parallel and aggregate the results of each task when they are done. `Multi` accepts an undefined number of `Proc`s.
 
@@ -132,6 +173,37 @@ irb(main):007:0> multi.errors
 
 It is worth mention that a failed proc will return `nil`.
 
+## Testing
+If you are using RSpec, you will notice that it might not play well with threads. ActiveRecord opens a database connection for every thread and since RSpec tests are wrapped in a transaction, by the time you promise tries to access something on the database, for example, a user, gems like Database Cleaner probably already triggered and deleted the user, resulting in `ActiveRecord::RecordNotFound` errors. You have a couple of solutions like disable transactional fixtures if you are using it or update the Database Cleaner strategy (that will result in much slower tests).
+Since none of these solutions were satisfactory to me, I created `ConcurrentRails::Testing` with two strategies: `immediate!` and `fake!`. When you wrap a Promise's `future` with `immediate!`, the executor gets replaced from `:io` to `:immediate`. It still returns a promise anyway. This is not the case with `fake!` strategy: it executes the task outside the `ConcurrentRails` engine and returns whatever `.value` would return:
+
+`immediate!` strategy:
+```ruby
+irb(main):001:1* result = ConcurrentRails::Testing.immediate! do
+irb(main):002:1*       ConcurrentRails::Promises.future { 42 }
+irb(main):003:0> end
+=>
+#<ConcurrentRails::Promises:0x000000013e5fc870 
+...
+irb(main):004:0> result.class
+=> ConcurrentRails::Promises # <-- Still a `ConcurrentRails::Promises` class
+irb(main):005:0> result.executor
+=> :immediate # <-- default executor (:io) gets replaced
+```
+
+`fake!` strategy:
+
+```ruby
+irb(main):001:1* result = ConcurrentRails::Testing.fake! do
+irb(main):002:1*       ConcurrentRails::Promises.future { 42 }
+irb(main):003:0> end
+=> 42 # <-- yields the task but does not return a Promise
+irb(main):004:0> result.class
+=> Integer
+```
+
+## Further reading
+
 For more information on how Futures work and how Rails handle multithread check these links:
 
 [Future documentation](https://github.com/ruby-concurrency/concurrent-ruby/blob/master/docs-source/future.md)
@@ -143,19 +215,19 @@ For more information on how Futures work and how Rails handle multithread check
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'concurrent_rails', '~> 0.1.5'
+gem 'concurrent_rails', '~> 0.2.1'
 ```
 
 And then execute:
 
 ```bash
-$ bundle
+bundle
 ```
 
 Or install it yourself as:
 
 ```bash
-$ gem install concurrent_rails
+gem install concurrent_rails
 ```
 
 ## Contributing

data/lib/concurrent_rails.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require 'concurrent_rails/version'
-require 'concurrent_rails/railtie'
 require 'concurrent_rails/future'
 require 'concurrent_rails/multi'
 require 'concurrent_rails/promises'
-
-module ConcurrentRails
-end
+require 'concurrent_rails/railtie'
+require 'concurrent_rails/testing'
+require 'concurrent_rails/version'

data/lib/concurrent_rails/adapters/delay.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ConcurrentRails::Adapters
+  module Delay
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def delay(*args, &task)
+        delay_on(:io, *args, &task)
+      end
+
+      def delay_on(executor, *args, &task)
+        new(executor).delay_on_rails(*args, &task)
+      end
+    end
+
+    def delay_on_rails(*args, &task)
+      @instance = rails_wrapped { delay_on(executor, *args, &task) }
+
+      self
+    end
+  end
+end

data/lib/concurrent_rails/adapters/future.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ConcurrentRails::Adapters
+  module Future
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def future(*args, &task)
+        future_on(:io, *args, &task)
+      end
+
+      def future_on(executor, *args, &task)
+        new(executor).future_on_rails(*args, &task)
+      end
+    end
+
+    def future_on_rails(*args, &task)
+      @instance = rails_wrapped { future_on(executor, *args, &task) }
+
+      self
+    end
+  end
+end

data/lib/concurrent_rails/future.rb

@@ -2,11 +2,10 @@
 
 module ConcurrentRails
   class Future
-    extend Forwardable
-
     def initialize(executor: :io, &block)
       @executor = executor
       @future   = run_on_rails(block)
+      ActiveSupport::Deprecation.warn('ConcurrentRails::Future is deprecated. See README for details')
     end
 
     def execute
@@ -17,30 +16,34 @@ module ConcurrentRails
 
     %i[value value!].each do |method_name|
       define_method method_name do
-        Rails.application.executor.wrap do
-          result = nil
-
-          ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
-            result = future.__send__(method_name)
-          end
-
-          result
+        permit_concurrent_loads do
+          future.__send__(method_name)
         end
       end
     end
 
-    def_delegators :@future, :state, :reason, :rejected?, :complete?, :add_observer
+    delegate :state, :reason, :rejected?, :complete?, :add_observer, to: :future
 
     private
 
     def run_on_rails(block)
-      @future = Rails.application.executor.wrap do
+      @future = rails_wrapped do
         Concurrent::Future.new(executor: executor) do
-          Rails.application.executor.wrap(&block)
+          rails_wrapped(&block)
         end
       end
     end
 
+    def rails_wrapped(&block)
+      Rails.application.executor.wrap(&block)
+    end
+
+    def permit_concurrent_loads(&block)
+      rails_wrapped do
+        ActiveSupport::Dependencies.interlock.permit_concurrent_loads(&block)
+      end
+    end
+
     attr_reader :executor, :future
   end
 end

data/lib/concurrent_rails/multi.rb

@@ -3,9 +3,7 @@
 module ConcurrentRails
   class Multi
     def self.enqueue(*actions, executor: :io)
-      unless actions.all? { |action| action.is_a?(Proc) }
-        raise ArgumentError, '#enqueue accepts `Proc`s only'
-      end
+      raise ArgumentError, '#enqueue accepts `Proc`s only' unless actions.all?(Proc)
 
       new(actions, executor).enqueue
     end
@@ -30,6 +28,10 @@ module ConcurrentRails
       futures.map(&:value)
     end
 
+    def compute!
+      futures.map(&:value!)
+    end
+
     def complete?
       futures.all?(&:complete?)
     end

data/lib/concurrent_rails/promises.rb

@@ -1,48 +1,83 @@
 # frozen_string_literal: true
 
+require 'concurrent_rails/adapters/future'
+require 'concurrent_rails/adapters/delay'
+
 module ConcurrentRails
   class Promises
     include Concurrent::Promises::FactoryMethods
-    extend Forwardable
+    include ConcurrentRails::Adapters::Delay
+    include ConcurrentRails::Adapters::Future
+
+    def initialize(executor)
+      @executor = executor
+    end
 
-    def self.future(*args, &task)
-      new.run_on_rails(*args, &task)
+    %i[value value!].each do |method_name|
+      define_method(method_name) do |timeout = nil, timeout_value = nil|
+        permit_concurrent_loads do
+          instance.__send__(method_name, timeout, timeout_value)
+        end
+      end
     end
 
-    def then(*args, &task)
-      @future_instance = Rails.application.executor.wrap do
-        future_instance.then(*args, &task)
+    %i[then chain].each do |chainable|
+      define_method(chainable) do |*args, &task|
+        method = "#{chainable}_on"
+        @instance = rails_wrapped do
+          instance.__send__(method, executor, *args, &task)
+        end
+
+        self
       end
+    end
+
+    def touch
+      @instance = rails_wrapped { instance.touch }
 
       self
     end
 
-    %i[value value!].each do |method_name|
-      define_method method_name do
-        Rails.application.executor.wrap do
-          result = nil
+    def wait(timeout = nil)
+      result = permit_concurrent_loads { instance.__send__(:wait_until_resolved, timeout) }
 
-          ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
-            result = future_instance.__send__(method_name)
-          end
+      timeout ? result : self
+    end
 
-          result
+    %i[on_fulfillment on_rejection on_resolution].each do |method|
+      define_method(method) do |*args, &callback_task|
+        rails_wrapped do
+          @instance = instance.__send__("#{method}_using", executor, *args, &callback_task)
         end
-      end
-    end
 
-    def run_on_rails(*args, &task)
-      @future_instance = Rails.application.executor.wrap do
-        future_on(default_executor, *args, &task)
+        self
       end
 
-      self
+      define_method("#{method}!") do |*args, &callback_task|
+        rails_wrapped do
+          @instance = instance.__send__(:add_callback, "callback_#{method}", args, callback_task)
+        end
+
+        self
+      end
     end
 
-    def_delegators :@future_instance, :state, :reason, :rejected?, :complete?
+    delegate :state, :reason, :rejected?, :resolved?, :fulfilled?, to: :instance
+
+    attr_reader :executor
 
     private
 
-    attr_reader :future_instance
+    def rails_wrapped(&block)
+      Rails.application.executor.wrap(&block)
+    end
+
+    def permit_concurrent_loads(&block)
+      rails_wrapped do
+        ActiveSupport::Dependencies.interlock.permit_concurrent_loads(&block)
+      end
+    end
+
+    attr_reader :instance
   end
 end

data/lib/concurrent_rails/testing.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ConcurrentRails
+  class Testing
+    class << self
+      attr_reader :execution_mode
+
+      %i[immediate fake].each do |exec_method|
+        define_method("#{exec_method}!") do |&task|
+          @execution_mode = exec_method
+          result = task.call
+          @execution_mode = :real
+
+          result
+        end
+
+        define_method("#{exec_method}?") do
+          execution_mode == exec_method
+        end
+      end
+
+      module TestingFuture
+        def future(*args, &task)
+          if ConcurrentRails::Testing.immediate?
+            future_on(:immediate, *args, &task)
+          elsif ConcurrentRails::Testing.fake?
+            yield
+          else
+            super
+          end
+        end
+      end
+
+      ConcurrentRails::Promises.extend(TestingFuture)
+    end
+  end
+end

data/lib/concurrent_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConcurrentRails
-  VERSION = '0.1.5'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concurrent_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.1
 platform: ruby
 authors:
 - Luiz Eduardo Kowalski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: Small library to make concurrent-ruby and Rails play nice together
 email:
 - luizeduardokowalski@gmail.com
@@ -63,12 +91,14 @@ files:
 - README.md
 - Rakefile
 - lib/concurrent_rails.rb
+- lib/concurrent_rails/adapters/delay.rb
+- lib/concurrent_rails/adapters/future.rb
 - lib/concurrent_rails/future.rb
 - lib/concurrent_rails/multi.rb
 - lib/concurrent_rails/promises.rb
 - lib/concurrent_rails/railtie.rb
+- lib/concurrent_rails/testing.rb
 - lib/concurrent_rails/version.rb
-- lib/tasks/concurrent_rails_tasks.rake
 homepage: https://github.com/luizkowalski/concurrent_rails
 licenses:
 - MIT
@@ -91,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.20
 signing_key:
 specification_version: 4
 summary: Multithread is hard

data/lib/tasks/concurrent_rails_tasks.rake

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-# desc "Explaining what the task does"
-# task :concurrent_rails do
-#   # Task goes here
-# end