expeditor 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2380a72a4938ad53fc206f4e155805d90568477f
-  data.tar.gz: e5ee71ae7e689318b764c47e969e16983330846a
+  metadata.gz: 5ee9877b9a720af63ec3a4163d680e43d734c4b7
+  data.tar.gz: 8707da47bb651151d0c9a2306dcbe237e165cfe5
 SHA512:
-  metadata.gz: 157aeae73bb32ab82848b7a97f8fa38a7c3a3f56419e59c3b2d71002c5194d5fcd2b7dce86ad7be4cad1406f2844dacf2c8f630ecf3f5e0245b018c6717beb7f
-  data.tar.gz: 575962fba75f61364cf1f998c01c7636d100a10e0e345d68488871c6a9735ee371251e332f33221c3780987719cd8fdf725454bac56d268f1405c562934864dd
+  metadata.gz: 7889e85b9081df0c1aecc1039e0b2193224effe67d5169c6c100027714909b4616cb5c913a02d808bdf0e21669cdfd36ea22829dea1eb4bdc09df8dc0a8e95b5
+  data.tar.gz: c36f0c9b174b2043de7da8628afa6379f655d38a57538d99669e5124e24eff5e067ed96ad209e0a25ddc70cdcdaf7171c3de21c9ffbcb99e85ef78c6015b3864

data/.travis.yml

@@ -2,7 +2,6 @@ language: ruby
 sudo: false
 cache: bundler
 rvm:
-  - 2.0.0
   - 2.1
   - 2.2
   - 2.3.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+<!-- ## Master (unreleased) -->
+
+## 0.5.0
+
+- Add a `current_thread` option of `Expeditor::Command#start` method to execute a task on current thread [#13](https://github.com/cookpad/expeditor/pull/13)
+- Drop support for MRI 2.0.x [#15](https://github.com/cookpad/expeditor/pull/15)
+- Deprecate Expeditor::Command#with_fallback. Use `set_fallback` instead [#14](https://github.com/cookpad/expeditor/pull/14)
+- Do not allow set_fallback call after command is started. [#18](https://github.com/cookpad/expeditor/pull/18)
+
 ## 0.4.0
 - Add Expeditor::Service#current\_status [#9](https://github.com/cookpad/expeditor/issues/9)
 - Add Expeditor::Service#reset\_status! [#10](https://github.com/cookpad/expeditor/issues/10)

data/README.md

@@ -8,6 +8,8 @@ It is inspired by [Netflix/Hystrix](https://github.com/Netflix/Hystrix).
 
 ## Installation
 
+Expeditor currently supports Ruby 2.1 and higher.
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -68,7 +70,7 @@ command = Expeditor::Command.new do
 end
 
 # use fallback value if command is failed
-command_with_fallback = command.with_fallback do |e|
+command_with_fallback = command.set_fallback do |e|
   log(e)
   default_value
 end
@@ -145,6 +147,26 @@ command = Expeditor::Command.new(service: service) do
 end
 ```
 
+### synchronous execution
+
+Use `current_thread` option of `#start`, command executes synchronous on current thread.
+
+```ruby
+command1 = Expeditor::Command.new do
+  ...
+end
+
+command2 = Expeditor::Command.new do
+  ...
+end
+
+command1.start(current_thread: true) # blocking
+command2.start(current_thread: true) # blocking
+
+command1.get
+command2.get
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/examples/example.rb

@@ -24,7 +24,7 @@ command2 = Expeditor::Command.new(service: service, timeout: 0.5) do
   'command2'
 end
 # command2_d is command2 with fallback
-command2_d = command2.with_fallback do |e|
+command2_d = command2.set_fallback do |e|
   'command2 fallback'
 end
 
@@ -44,7 +44,7 @@ command4 = Expeditor::Command.new(
   sleep 0.3
   v2 + ', ' + v3
 end
-command4_d = command4.with_fallback do
+command4_d = command4.set_fallback do
   'command4 fallback'
 end
 

data/expeditor.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.1.0'
+
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0.0"
   spec.add_runtime_dependency "concurrent-ruby-ext", "~> 1.0.0"
   spec.add_runtime_dependency "retryable", "> 1.0"

data/lib/expeditor/command.rb

@@ -14,41 +14,49 @@ module Expeditor
       @service = opts.fetch(:service, Expeditor::Services.default)
       @timeout = opts[:timeout]
       @dependencies = opts.fetch(:dependencies, [])
-      @normal_future = initial_normal(&block)
-      @fallback_var = nil
+
+      @normal_future = nil
       @retryable_options = Concurrent::IVar.new
+      @normal_block = block
+      @fallback_block = nil
+      @ivar = Concurrent::IVar.new
     end
 
-    def start
-      if not started?
-        @dependencies.each(&:start)
+    # @param current_thread [Boolean] Execute the task on current thread(blocking)
+    def start(current_thread: false)
+      unless started?
+        if current_thread
+          prepare(Concurrent::ImmediateExecutor.new)
+        else
+          prepare
+        end
         @normal_future.safe_execute
       end
       self
     end
 
     # Equivalent to retryable gem options
-    def start_with_retry(retryable_options = {})
-      if not started?
+    def start_with_retry(current_thread: false, **retryable_options)
+      unless started?
         @retryable_options.set(retryable_options)
-        start
+        start(current_thread: current_thread)
       end
       self
     end
 
     def started?
-      @normal_future.executed?
+      @normal_future && @normal_future.executed?
     end
 
     def get
-      raise NotStartedError if not started?
+      raise NotStartedError unless started?
       @normal_future.get_or_else do
-        if @fallback_var && @service.fallback_enabled?
-          @fallback_var.wait
-          if @fallback_var.rejected?
-            raise @fallback_var.reason
+        if @fallback_block && @service.fallback_enabled?
+          @ivar.wait
+          if @ivar.rejected?
+            raise @ivar.reason
           else
-            @fallback_var.value
+            @ivar.value
           end
         else
           raise @normal_future.reason
@@ -56,16 +64,22 @@ module Expeditor
       end
     end
 
+    def set_fallback(&block)
+      if started?
+        raise AlreadyStartedError, "Do not allow set_fallback call after command is started"
+      end
+      reset_fallback(&block)
+      self
+    end
+
     def with_fallback(&block)
-      command = self.clone
-      command.reset_fallback(&block)
-      command
+      warn 'Expeditor::Command#with_fallback is deprecated. Please use set_fallback instead'
+      set_fallback(&block)
     end
 
     def wait
-      raise NotStartedError if not started?
-      @normal_future.wait
-      @fallback_var.wait if @fallback_var && @service.fallback_enabled?
+      raise NotStartedError unless started?
+      @ivar.wait
     end
 
     # command.on_complete do |success, value, reason|
@@ -109,25 +123,12 @@ module Expeditor
       Command.new(opts, &block).start
     end
 
-    protected
+    private
 
     def reset_fallback(&block)
-      @fallback_var = Concurrent::IVar.new
-      @normal_future.add_observer do |_, value, reason|
-        if reason != nil
-          future = RichFuture.new(executor: Concurrent.global_io_executor) do
-            success, val, reason = Concurrent::SafeTaskExecutor.new(block, rescue_exception: true).execute(reason)
-            @fallback_var.send(:complete, success, val, reason)
-          end
-          future.safe_execute
-        else
-          @fallback_var.send(:complete, true, value, nil)
-        end
-      end
+      @fallback_block = block
     end
 
-    private
-
     def breakable_block(args, &block)
       if @service.open?
         raise CircuitBreakError
@@ -181,8 +182,8 @@ module Expeditor
     #     end
     #   end
     # end
-    def initial_normal(&block)
-      future = RichFuture.new(executor: @service.executor) do
+    def initial_normal(executor, &block)
+      future = RichFuture.new(executor: executor) do
         args = wait_dependencies
         timeout_block(args, &block)
       end
@@ -224,18 +225,37 @@ module Expeditor
     end
 
     def on(&callback)
-      if @fallback_var
-        @fallback_var.add_observer(&callback)
-      else
-        @normal_future.add_observer(&callback)
+      @ivar.add_observer(&callback)
+    end
+
+    # set future
+    # set fallback future as an observer
+    # start dependencies
+    def prepare(executor = @service.executor)
+      @normal_future = initial_normal(executor, &@normal_block)
+      @normal_future.add_observer do |_, value, reason|
+        if reason # failure
+          if @fallback_block
+            future = RichFuture.new(executor: executor) do
+              success, value, reason = Concurrent::SafeTaskExecutor.new(@fallback_block, rescue_exception: true).execute(reason)
+              @ivar.send(:complete, success, value, reason)
+            end
+            future.safe_execute
+          else
+            @ivar.fail(reason)
+          end
+        else # success
+          @ivar.set(value)
+        end
       end
+
+      @dependencies.each(&:start)
     end
 
     class ConstCommand < Command
       def initialize(value)
-        @service = Expeditor::Services.default
-        @dependencies = []
-        @normal_future = RichFuture.new {}.set(value)
+        super(){ value }
+        self.start
       end
     end
   end

data/lib/expeditor/errors.rb

@@ -4,10 +4,15 @@ module Expeditor
   NotStartedError = Class.new(StandardError)
   RejectedExecutionError = Concurrent::RejectedExecutionError
   CircuitBreakError = Class.new(StandardError)
+  AlreadyStartedError = Class.new(StandardError)
   class DependencyError < StandardError
     attr :error
     def initialize(e)
       @error = e
     end
+
+    def message
+      @error.message
+    end
   end
 end

data/lib/expeditor/version.rb

@@ -1,3 +1,3 @@
 module Expeditor
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expeditor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - shohei-yasutake
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -135,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="