beaneater 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f50f38f9e485e31b15278b6fdff9a8d74e13aa6fc3e0c9f0c366b5091f5b2d5
-  data.tar.gz: b16e2755db5a25f216a1b4577b925536edebfd304c5e497ea8189dbb8630cf6e
+  metadata.gz: 69fc39a3d9d9dc68b793a7b82db8ccac3226c1729c163a966016f49ddd85607a
+  data.tar.gz: 7112d6b2669da5a2971bee248e9321cb3717d1023289b5ec7bba0bdcdf37a12e
 SHA512:
-  metadata.gz: 07c0c6c6032c57630e23515ab53549379de75ba2e985449ac849003e57f5317663dda129aa1bb89f8b61e1fa535c7f385373a009e79043cd6cfb9cd00e3c7ac9
-  data.tar.gz: 04c2851609baa2d9b73057ad45567093bba58e1689ee418f967c547388be683193fa01a73a18a4b2e8401c632a6f0a49cceeaa56c352db8540e89aba764fd438
+  metadata.gz: 5669fb49b06d4714edbb3285991a8f184d7505681abc395f9bad064a9ed4984b1be06d64e76b002f88858916321ab6bc9885114cea9fe54e79151ab4a8f6b98c
+  data.tar.gz: 0ac491e1e6b02dbbc0a15c7b89439cbaa15f7cf191f39896336b87b02505a8414713063fdb752c885eed1dea4a6a823a5b160f11e509f2d999f132426ccf4cb7

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG for Beaneater
 
+## 1.3.1 (November 4 2026)
+
+* `jobs.process!` no longer checks with the server on a job it has just deleted, or released for another try, before moving on (the check sent `stats-job` and could never bury the job): a job whose handler finishes now takes 3 commands (`reserve`, `stats-job`, `delete`) instead of 4, and a retried job takes 2 fewer. A job whose handler raised and that isn't released is still buried as before (@nesquena)
+* `client.stats`, `tube.stats` and `job.stats` parse the server's reply with less work, so polling stats takes noticeably less CPU; the results are unchanged (@nesquena)
+
 ## 1.3.0 (November 1 2026)
 
 * Check tube names, job ids and numbers before writing them into a command. A tube name beanstalkd does not accept (up to 200 letters, digits and `-+/;.$_()`, not starting with a hyphen) raises `InvalidTubeName` from every tube command (`use`, `watch`, `ignore`, `put`, `peek`, `kick`, `stats`, `pause`, and restoring the watched tubes on reconnect); names such as `demo.test.foo`, `jobs(eu).mailers` and `MyApp.mailers` stay valid. `watch`'s `InvalidTubeName` message now reads "Tube cannot be named '<name>'", as `use`'s does, and `tubes.watch(:t)` and `tubes.ignore(:t)` return the names as Strings. A job id that is not a whole number (an Integer or a String of digits), a priority, delay, TTR or pause delay that is not a whole number from 0 to 4294967295 (the range beanstalkd reads), a reserve timeout or kick count that is neither a whole number nor a Float, and a peek state other than `ready`, `delayed` or `buried` raise `ArgumentError`. Such values used to be sent as given and fail on the server with `BadFormatError` or `UnknownCommandError`, or be misread. What to do: `tube.stats`, `tube.pause` and `tubes.ignore` with such a tube name now raise `InvalidTubeName` instead of `BadFormatError`, and the values above raise `ArgumentError` (`jobs.find("abc")`, `tube.put(body, :ttr => 1.5)`, `tube.peek(:reserved)`) instead of `BadFormatError` or `UnknownCommandError`, both `Beaneater::UnexpectedResponse`s; code that rescues `Beaneater::UnexpectedResponse` around these calls should also rescue `Beaneater::InvalidTubeName` and `ArgumentError` (@nesquena)

data/Rakefile

@@ -71,7 +71,8 @@ task "release:check", [:remote] do |_, args|
   if local_tag.nil? || remote_tag.nil?
     errors << "couldn't check for tag #{tag}"
   elsif !(local_tag.empty? && remote_tag.empty?)
-    errors << "tag #{tag} already exists (if only the gem push failed: gem push pkg/beaneater-#{version}.gem)"
+    page = args[:remote] ? "rake 'release:github[#{args[:remote]}]'" : "rake release:github"
+    errors << "tag #{tag} already exists (if only the gem push failed: gem push pkg/beaneater-#{version}.gem, then #{page})"
   end
 
   begin
@@ -87,4 +88,53 @@ end
 Rake::Task["release"].prerequisites.unshift("release:check")
 %w[release:source_control_push release:rubygem_push].each { |t| Rake::Task[t].enhance(["release:check"]) }
 
+# rake release:github (rake release runs it last, once the tag and the gem are pushed):
+# creates the GitHub release page for the tag through the gh CLI, on the github.com
+# repository the remote pushes to, with a link to the CHANGELOG and GitHub's generated
+# notes since the previous version's tag. It is marked Latest only when no higher version
+# is tagged, so a release from an X.Y-stable branch doesn't take that from a newer one.
+# If the page already exists it does nothing, so it can also be run by hand to finish a release.
+desc "Create the GitHub release page for v#{Beaneater::VERSION}"
+task "release:github", [:remote] do |_, args|
+  version = Gem::Version.new(Beaneater::VERSION)
+  tag = "v#{version}"
+  git = ->(*a) { out = IO.popen(["git", *a], err: File::NULL, &:read); out.strip if $?.success? }
+  branch = git.("rev-parse", "--abbrev-ref", "HEAD").to_s
+  remote = args[:remote] || git.("config", "--get", "branch.#{branch}.remote") || "origin"
+  url = git.("remote", "get-url", "--push", remote).to_s.split("\n").first.to_s
+  repo = url[%r{(?:\A|[@/.])github\.com[:/]([^/]+/[^/]+?)(?:\.git)?/?\z}i, 1] or abort "#{remote} isn't a GitHub repository"
+  # the push URL's tags, not the fetch URL's: the page goes to the repository the tag was pushed to
+  tags = git.("ls-remote", "--tags", url, "refs/tags/v*") or abort "Couldn't list the tags on #{remote}"
+  tagged = tags.split("\n").filter_map { |l| l[%r{\trefs/tags/v(\d+\.\d+\.\d+)\z}, 1] }.map { |v| Gem::Version.new(v) }
+  previous = tagged.select { |v| v < version }.max
+  options = ["--latest=#{tagged.none? { |v| v > version }}"]
+  options += ["--notes-start-tag", "v#{previous}"] if previous
+  # gh adds the generated notes after a single newline; the second one keeps them out of this paragraph
+  notes = "See [CHANGELOG.md](https://github.com/#{repo}/blob/#{tag}/CHANGELOG.md) for what changed, and what to do when upgrading.\n"
+  gh_repo = "github.com/#{repo}" # so an exported GH_HOST doesn't send it elsewhere
+
+  if system("gh", "release", "view", tag, "-R", gh_repo, out: File::NULL, err: File::NULL)
+    puts "GitHub release #{tag} already exists on #{repo}"
+  elsif system("gh", "release", "create", tag, "-R", gh_repo, "--verify-tag", "--title", tag, *options,
+               "--generate-notes", "--notes", notes)
+    puts "Created GitHub release #{tag} on #{repo}"
+  else
+    abort "Couldn't create GitHub release #{tag} on #{repo} (is gh installed and signed in?)"
+  end
+end
+# The gem is out by then, so a failure here only warns and says how to finish.
+Rake::Task["release"].enhance do |_, args|
+  if %w[n no nil false off 0].include?(ENV["gem_push"].to_s.downcase)
+    puts "gem_push is off, so no GitHub release page"
+    next
+  end
+  begin
+    Rake::Task["release:github"].invoke(args[:remote])
+  rescue SystemExit, StandardError => e
+    warn "#{e.class}: #{e.message} (#{e.backtrace&.first})" unless e.is_a?(SystemExit)
+    page = args[:remote] ? "rake 'release:github[#{args[:remote]}]'" : "rake release:github"
+    warn "The tag and the gem are pushed; only the GitHub release page is missing. Run: #{page}"
+  end
+end
+
 task :default => 'test:full'

data/lib/beaneater/connection.rb

@@ -414,9 +414,9 @@ class Beaneater
         value[1..-2]
       elsif text
         value
-      elsif value =~ /\A-?\d+\z/
+      elsif value.match?(/\A-?\d+\z/)
         value.to_i
-      elsif value =~ /\A-?\d+\.\d+\z/
+      elsif value.match?(/\A-?\d+\.\d+\z/)
         value.to_f
       elsif value == 'true' || value == 'false'
         value == 'true'

data/lib/beaneater/job/collection.rb

@@ -131,9 +131,11 @@ class Beaneater
           begin
             processor[:block].call(@current_job)
             @current_job.delete
+            @current_job = nil # deleted, so there is nothing for the ensure below to bury
           rescue *processor[:retry_on]
             if @current_job.stats.releases < processor[:max_retries]
               @current_job.release(:delay => release_delay)
+              @current_job = nil # released for another try, so no longer ours to bury
             end
           end
         rescue AbortProcessingError

data/lib/beaneater/stats/stat_struct.rb

@@ -13,10 +13,19 @@ class Beaneater
     #
     def self.from_hash(hash)
       return unless hash.is_a?(Hash)
-      underscore_hash = hash.inject({}) { |r, (k, v)| r[k.to_s.gsub(/-/, '_')] = v; r }
+      underscore_hash = hash.inject({}) { |r, (k, v)| r[underscore(k)] = v; r }
       self.new(underscore_hash)
     end
 
+    # The key as a String with its hyphens turned into underscores, with String#tr for speed. A key
+    # in an encoding that isn't ASCII-compatible (UTF-16, say) takes gsub, so that the
+    # Encoding::CompatibilityError it raises keeps gsub's message.
+    def self.underscore(key)
+      key = key.to_s
+      key.encoding.ascii_compatible? ? key.tr('-', '_') : key.gsub(/-/, '_')
+    end
+    private_class_method :underscore
+
     # Access value for stat with specified key.
     #
     # Keys are stored underscored (see {.from_hash}), so hyphenated beanstalkd
@@ -30,7 +39,7 @@ class Beaneater
     #  @stats['current-jobs-ready'] # => 5
     #
     def [](key)
-      name = key.to_s.gsub(/-/, '_')
+      name = self.class.send(:underscore, key)
       @hash.fetch(name) { @hash[name.to_sym] }
     end
 

data/lib/beaneater/version.rb

@@ -2,5 +2,5 @@
 
 class Beaneater
   # Current version of gem.
-  VERSION = "1.3.0"
+  VERSION = "1.3.1"
 end

data/test/jobs_test.rb

@@ -118,6 +118,54 @@ describe Beaneater::Jobs do
     end
   end # for_process!
 
+  describe "for process! when it deletes or releases a job" do
+    before do
+      $ran = []
+      cleanup_tubes!(['tube_done', 'tube_retry'])
+      @sent = []
+      sent = @sent
+      @beanstalk.connection.define_singleton_method(:transmit) do |command, **options|
+        sent << command.to_s
+        super(command, **options)
+      end
+      @jobs.register('tube_retry', :retry_on => [Timeout::Error], :max_retries => 1) do |job|
+        $ran << job.id
+        raise Timeout::Error
+      end
+      @jobs.register('tube_done') { |job| $ran << job.id; @jobs.stop! if $ran.size == 4 }
+      @retry_id = @beanstalk.tubes.find('tube_retry').put("retry", :pri => 1)[:id]
+      @done_ids = 2.times.map { |i| @beanstalk.tubes.find('tube_done').put("done #{i}", :pri => 2)[:id] }
+      Timeout.timeout(10) { @jobs.process!(:release_delay => 0, :reserve_timeout => 1) }
+    end
+
+    after do
+      connection = @beanstalk.connection
+      connection.singleton_class.send(:remove_method, :transmit) if connection.singleton_methods(false).include?(:transmit)
+    end
+
+    # The commands naming job id after the given command, up to the next reserve
+    def sent_about(id, command)
+      start = @sent.index(command)
+      refute_nil start, "#{command.inspect} was not sent: #{@sent.inspect}"
+      @sent.drop(start + 1).take_while { |c| !c.start_with?('reserve') }.select { |c| c.split(' ')[1] == id.to_s }
+    end
+
+    it "sends nothing more about a job it deleted" do
+      @done_ids.each do |id|
+        assert_empty sent_about(id, "delete #{id}"), "sent after deleting job #{id}: #{@sent.inspect}"
+      end
+      stats = @beanstalk.tubes.find('tube_done').stats
+      assert_equal [0, 0, 0], [stats.current_jobs_ready, stats.current_jobs_reserved, stats.current_jobs_buried]
+    end
+
+    it "sends nothing more about a job it released, and buries it when it runs out of retries" do
+      assert_empty sent_about(@retry_id, "release #{@retry_id} 1 0"), "sent after releasing job #{@retry_id}: #{@sent.inspect}"
+      assert_equal [@retry_id, @retry_id], $ran.first(2)
+      job = @beanstalk.jobs.find(@retry_id)
+      assert_equal ['buried', 1], [job.stats.state, job.stats.releases]
+    end
+  end # process! when it deletes or releases a job
+
   describe "for process! with a dashed tube name" do
     before do
       $ran = []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaneater
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Nico Taing
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-11-01 00:00:00.000000000 Z
+date: 2026-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest