cutoff 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e27bb02cc23dc725a4bcd3b9585159723e3fa4d3c88f98ec207ff2b91cf438d4
-  data.tar.gz: 8ab5a3a462bbbb2a32837e69de70d55ac59b3e347ead1db889d374f2be5b9224
+  metadata.gz: 64171df8b5550b99b603ba4bae4874174cc5e4bcce2632318be777ecc932dce3
+  data.tar.gz: 39ee62f1f743fdce6d9dd3e873bd3acf4d7efd09907d0f9e265e98c786cb7dc9
 SHA512:
-  metadata.gz: c957634f0bc03f9fa8fb058080338978322adb54fce2c2c952c7b684ea3a979165f076abdc29878e416a084acd7b904ad6e8d637f0c1b90091ffa179fdb6076d
-  data.tar.gz: b9ac92d37812b341fba24c6a3feb5c0f1f4c9265f1995aa5266b85e3d46e27c48e80fd4801ecc4f46d9a22b5195e0b1dfc35bc9c74449e2ac35c11ace28a5f15
+  metadata.gz: bb41605b534178706b45f3e6921aad80ff0ff50606038d95d9d50267910a590df59969cb77b1c7879d0b2cd429c60205a418e1ff590b1dd7b4e7f4394b0f4f3c
+  data.tar.gz: 713d75df722a2f82414373d482d4a981e9a579069de55262afe12004287abdd5b6f2e7e09052130a3b0ce875658e8177ce519bdadb549dbb92dc8970f9cd0813

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2021-07-22
+
+### Added
+
+- Net::HTTP patch
+
 ## [0.1.0] - 2021-07-19
 
 ### Added
@@ -14,4 +20,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Cutoff class
 - Mysql2 patch
 
+[Unreleased]: https://github.com/justinhoward/cutoff/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/justinhoward/cutoff/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/justinhoward/cutoff/releases/tag/v0.1.0

data/README.md

@@ -20,8 +20,8 @@ Cutoff.wrap(5) do
 end
 ```
 
-It has a built-in patch for Mysql2 to auto-insert checkpoints and timeout query
-hints.
+It has built-in patches for Mysql2 and Net::HTTP to auto-insert checkpoints and
+timeouts.
 
 ```ruby
 require 'cutoff/patch/mysql2'
@@ -50,7 +50,7 @@ single query will take longer than 3 seconds. However, imagine a bad controller
 action or background job executes 100 slow queries. In that case, the queries
 add up to 300 seconds, much too long.
 
-Deadlines keep track of the total elapsed time in a request of job and interrupt
+Deadlines keep track of the total elapsed time in a request or job and interrupt
 it if it takes too long.
 
 Installation
@@ -138,8 +138,11 @@ Patches
 -------------
 
 Cutoff is in early stages, but it aims to provide patches for common networked
-dependencies. The first of these is the `mysql2` patch. It is not loaded by
-default, so you need to require it manually.
+dependencies. Patches automatically insert useful checkpoints and timeouts. The
+patches so far are for `mysql2` and `Net::HTTP`. They are not loaded by default,
+so you need to require them manually.
+
+For example, to load the Mysql2 patch:
 
 ```ruby
 # In your Gemfile
@@ -152,10 +155,14 @@ require 'cutoff'
 require 'cutoff/patch/mysql2'
 ```
 
-Once it is enabled, any `Mysql2::Client` object will respect the current cutoff
-if one is set.
+### Mysql2
+
+Once it is enabled, any `Mysql2::Client` object will respect the current
+class-level cutoff if one is set.
 
 ```ruby
+require 'cutoff/patch/mysql2'
+
 client = Mysql2::Client.new
 Cutoff.wrap(3) do
   sleep(4)
@@ -183,6 +190,33 @@ Cutoff.wrap(3) do
 end
 ```
 
+### Net::HTTP
+
+Once it is enabled, any `Net::HTTP` requests will respect the current
+class-level cutoff if one is set.
+
+```ruby
+require 'cutoff/patch/net_http'
+
+Cutoff.wrap(3) do
+  sleep(5)
+
+  # The cutoff is expired, so this hits a checkpoint and will not be executed
+  Net::HTTP.get(URI.parse('http://example.com'))
+end
+
+Cutoff.wrap(3) do
+  sleep(1.5)
+
+  # The cutoff has 1.5 seconds left, so this request will be executed
+  # open_timeout, read_timeout, and write_timeout (Ruby >= 2.6) will each
+  # be set to 1.5
+  # This means the overall time can be > 1.5 since the combined phases can take
+  # up to 4.5 seconds
+  Net::HTTP.get(URI.parse('http://example.com'))
+end
+```
+
 Timing a Rails Controller
 ---------------------------
 
@@ -360,10 +394,9 @@ never interrupt a running program unless:
 - `checkpoint!` is called
 - a network timeout is exceeded
 
-Patches such as the current Mysql2 patch are designed to ease the burden on
-developers to manually call `checkpoint!` or configure network timeouts. The
-ruby `Timeout` class is not used. See Julia Evans' post on [Why Ruby's Timeout
-is dangerous][julia_evans].
+Patches are designed to ease the burden on developers to manually call
+`checkpoint!` or configure network timeouts. The ruby `Timeout` class is not
+used. See Julia Evans' post on [Why Ruby's Timeout is dangerous][julia_evans].
 
 Patches are only applied by explicit opt-in, and Cutoff can always be used as a
 standalone library.

data/lib/cutoff/patch/net_http.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal:true
+
+require 'net/http'
+
+class Cutoff
+  module Patch
+    # Adds a checkpoint for starting HTTP requests and sets network timeouts
+    # to the remaining time
+    module NetHttp
+      # Construct a {Net::HTTP}, but with the timeouts set to the remaining
+      # cutoff time if one is active
+      def initialize(address, port = nil)
+        super
+        return unless (cutoff = Cutoff.current)
+
+        @open_timeout = cutoff.seconds_remaining
+        @read_timeout = cutoff.seconds_remaining
+        @write_timeout = cutoff.seconds_remaining
+      end
+
+      # Same as the original start, but with a cutoff checkpoint
+      #
+      # @see {Net::HTTP#start}
+      def start
+        Cutoff.checkpoint!
+        super
+      end
+    end
+  end
+end
+
+Net::HTTP.prepend(Cutoff::Patch::NetHttp)

data/lib/cutoff/version.rb

@@ -3,6 +3,6 @@
 class Cutoff
   # @return [Gem::Version] The current version of the cutoff gem
   def self.version
-    Gem::Version.new('0.1.0')
+    Gem::Version.new('0.2.0')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cutoff
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-20 00:00:00.000000000 Z
+date: 2021-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -87,13 +87,14 @@ files:
 - lib/cutoff/error.rb
 - lib/cutoff/patch.rb
 - lib/cutoff/patch/mysql2.rb
+- lib/cutoff/patch/net_http.rb
 - lib/cutoff/version.rb
 homepage: https://github.com/justinhoward/cutoff
 licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/justinhoward/cutoff/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/cutoff/0.1.0
+  documentation_uri: https://www.rubydoc.info/gems/cutoff/0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: