double_restraint 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 730e777e36c39bfc23ff335c32c5ed3afcc92f939496546a27e26c16cb755a7b
-  data.tar.gz: 68a039424903a839c46defb56535a33a793ab8e044ed62e986ff0b2fe5f4ffef
+  metadata.gz: 8f0ee8109419ddc8e93ea3685a0d2f32c3d8b96383afe4c4330bbc866d9ee566
+  data.tar.gz: 8c92f8eabaae7b7b4e0754d5e968d3fc1ecb045f5b4aa04c2d323f167551f467
 SHA512:
-  metadata.gz: fd3bd50d0e03ba15d9a043e54f877e3c1828d546d54b1f2751adfc5aac0f4c8da88eda18e7af4c7597bf6203272f7748b383e2c24ea548e56e72b3b9a83ac0d8
-  data.tar.gz: 597684fa2b5eefb6f6ae9c5de1fbdeb353846368a209ba606828a2b670a520398400ad3703ae5f0935445d21f3bb58bb62cb6454c045c347dc12b3a897cf5b5c
+  metadata.gz: a7e55a6862bfda0b56a445b37af3fe3d0b486cd2ffde2e4ab2246700496cbe3017f3c737e9c507d1ab3ede613d34fc2137c8679356345a74757bc257010f32a0
+  data.tar.gz: b80b29ec078b8fe3b48bbb4e5d549684a7e3f56157d29ab58d6fd09e2a20679513ebe250416238b871421f608146271ca07b66c461841a151f095479ce8231f3

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1]
+### Added
+- Methods to expose the pool limits, timeouts and current in use sizes.
+
 ## [1.0.0]
 ### Added
 - Everything!

data/README.md

@@ -77,6 +77,8 @@ However, you can also specify the Redis instance directly on the `DoubleRestrain
 restraint = DoubleRestraint.new("MyWebService", redis: Redis.new(url: redis_url)), timeout: 0.5, long_running_timeout: 5.0, long_running_limit: 5)
 ```
 
+You can peek at the current pool sizes as well if
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/double_restraint.rb

@@ -3,6 +3,8 @@
 require "restrainer"
 
 class DoubleRestraint
+  attr_reader :timeout, :long_running_timeout
+
   # @param name [String, Symbol] The name of the restraint.
   # @param timeout [Numeric] The first timeout that will be yielded to the block.
   # @param long_running_timeout [Numeric] The timeout that will be yielded to the block if
@@ -20,22 +22,20 @@ class DoubleRestraint
     @timeout = timeout
     @long_running_timeout = long_running_timeout
     @timeout_errors = Array(timeout_errors)
-    @restrainer = Restrainer.new("DoubleRestrainer(#{name})", limit: limit, redis: redis) if limit
+    limit = -1 if limit.to_i <= 0
+    @restrainer = Restrainer.new("DoubleRestrainer(#{name})", limit: limit, redis: redis)
     @long_running_restrainer = Restrainer.new("DoubleRestrainer(#{name}).long_running", limit: long_running_limit, redis: redis)
   end
 
   # Execute a block of code. The block will be yielded with the timeout value. If the block raises
   # a timeout error, then it will be called again with the long running timeout. The code in the block
   # must be idempotent since it can be run twice.
+  #
   # @yieldparam [Numeric] the timeout value to use in the block.
   # @raise [Restrainer::ThrottleError] if too many concurrent processes are trying to use the restraint.
-  def execute
+  def execute(&block)
     begin
-      if @restrainer
-        @restrainer.throttle do
-          yield @timeout
-        end
-      else
+      @restrainer.throttle do
         yield @timeout
       end
     rescue => e
@@ -48,4 +48,44 @@ class DoubleRestraint
       end
     end
   end
+
+  # Get the current size of the default pool. This can be useful in
+  # collecting realtime stats about how the pool is being utilized.
+  #
+  # @return [Integer]
+  def default_pool_size
+    @restrainer.current
+  end
+
+  # Get the current size of the long running pool. This can be useful in
+  # collecting realtime stats about how the pool is being utilized.
+  #
+  # @return [Integer]
+  def long_running_pool_size
+    @long_running_restrainer.current
+  end
+
+  # Get the limit for the default pool. This will return -1 if there
+  # is no limit set on that pool.
+  #
+  # @return [Integer]
+  def default_pool_limit
+    @restrainer.limit
+  end
+
+  # Get the limit for the long running pool.
+  #
+  # @return [Integer]
+  def long_running_pool_limit
+    @long_running_restrainer.limit
+  end
+
+  # Helper method to determine if a timeout represents the long running timeout.
+  # Note that the timeout and long running timeouts need to be different values
+  # in order for this to work.
+  #
+  # @return [Boolean]
+  def long_running?(timeout)
+    timeout.to_f.round(6) == @long_running_timeout.to_f.round(6)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: double_restraint
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brian Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-28 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: restrainer