bitfab 0.58.4 → 0.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13b552211978874936f8b732245e948396758a5adf6d0485859cf98748bf4933
-  data.tar.gz: 612bbee201e37c8c425c5aa42bbcc6f713ca848e5cf43ad7eae5797beeefd660
+  metadata.gz: 0f71ead77c070efe05df2af12495ef411048fd0164655e0f1fbe11a5457b518c
+  data.tar.gz: 4e9a222f559e2977366ecf411f97429db22f89d1aca6b8b6de767b982594f8ce
 SHA512:
-  metadata.gz: 7150bd10acde90cfe101845b6b6da248ae4cfb57a3742d8a33ef8d045e93d0ebfa6eaf6672376304f957206801c4f0b6ae60707d881d7621dce2d61b887405d4
-  data.tar.gz: beb42456465d624c22fc12d2294011be076748011bfac9dfad6a6397083bcebf6902a2fd7f7fadbdfa2c8e88c2df6b862c3a1f1bff0afb3f947e45256c68cc28
+  metadata.gz: 406d7de1521d252c335432fa44c04fd7f3e11f0992281388d8939140ab05b5b055cb3cd5a4dc6bf30cfba15a40795f7c1f21782d989bbbebd1abeac62e5ff7fc
+  data.tar.gz: 9e80632bfc746766ffd6011ceb45848a2875590e29b2f9c983b4c4ed344b722c310a15a760b6d4bd99045357f9def49b08904bb53618ad0dedbf5b33c2c4cffe

data/lib/bitfab/datasets.rb

@@ -1,6 +1,17 @@
 # frozen_string_literal: true
 
 module Bitfab
+  class GraderRerunError < StandardError
+    attr_reader :run
+
+    def initialize(message, run:)
+      super(message)
+      @run = run
+    end
+  end
+
+  class GraderRerunTimeoutError < GraderRerunError; end
+
   # Dataset operations for the authenticated organization, reached as
   # `client.datasets`. A dataset is a named bucket of traces scoped to one
   # trace function. Experiments replay against it and its graders score its
@@ -8,7 +19,8 @@ module Bitfab
   # string keys matching the HTTP API ("traceCount", "addedTraceIds", ...).
   class Datasets
     DEFAULT_RERUN_TIMEOUT_SECONDS = 90
-    DEFAULT_RERUN_POLL_INTERVAL_SECONDS = 1
+    RERUN_POLL_INTERVAL_SECONDS = 1.0
+    private_constant :RERUN_POLL_INTERVAL_SECONDS
     TERMINAL_RERUN_STATUSES = ["completed", "errored"].freeze
 
     def initialize(http_client)
@@ -86,22 +98,21 @@ module Bitfab
     end
 
     # Re-run graders over every trace in the dataset. Defaults to every
-    # assigned grader, and an unassigned id is rejected. Waits for the run to
-    # finish (up to `timeout` seconds) unless `wait:` is false, and returns the
-    # last run state seen either way. A request matching an in-flight run
-    # joins it.
-    def rerun_graders(dataset_id, grader_ids: nil, wait: true,
-      timeout: DEFAULT_RERUN_TIMEOUT_SECONDS, poll_interval: DEFAULT_RERUN_POLL_INTERVAL_SECONDS)
+    # assigned grader, and an unassigned id is rejected. Blocks until the run
+    # completes and returns it. Raises GraderRerunError when the run errors and
+    # GraderRerunTimeoutError when it is still going after `timeout` seconds.
+    # The run keeps going on Bitfab after a timeout. A request matching an
+    # in-flight run joins it.
+    def rerun_graders(dataset_id, grader_ids: nil, timeout: DEFAULT_RERUN_TIMEOUT_SECONDS)
       payload = grader_ids.nil? ? {} : {"graderIds" => grader_ids}
       started = @http_client.request(dataset_path(dataset_id, "/rerunGraders"), payload)
-      return started unless wait
-
       deadline = monotonic_now + timeout
       run = started["run"]
       while !TERMINAL_RERUN_STATUSES.include?(run["status"]) && monotonic_now < deadline
-        sleep(poll_interval)
+        sleep(RERUN_POLL_INTERVAL_SECONDS)
         run = get_grader_rerun(dataset_id, run_id: run["id"]) || run
       end
+      settle_grader_rerun(dataset_id, run, timeout)
       {"run" => run, "joinedExisting" => started["joinedExisting"]}
     end
 
@@ -114,6 +125,24 @@ module Bitfab
 
     private
 
+    def settle_grader_rerun(dataset_id, run, timeout)
+      case run["status"]
+      when "completed"
+        nil
+      when "errored"
+        raise GraderRerunError.new(
+          "Grader re-run on dataset #{dataset_id} errored: #{run["error"] || "no reason recorded"}",
+          run:
+        )
+      else
+        raise GraderRerunTimeoutError.new(
+          "Grader re-run #{run["id"]} on dataset #{dataset_id} is still #{run["status"]} after #{timeout} seconds. " \
+          "It keeps going on Bitfab. Read it later with get_grader_rerun(#{dataset_id.inspect}, run_id: #{run["id"].inspect}).",
+          run:
+        )
+      end
+    end
+
     def dataset_path(dataset_id, suffix = "")
       "/api/sdk/datasets/#{URI.encode_www_form_component(dataset_id)}#{suffix}"
     end

data/lib/bitfab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bitfab
-  VERSION = "0.58.4"
+  VERSION = "0.59.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitfab
 version: !ruby/object:Gem::Version
-  version: 0.58.4
+  version: 0.59.0
 platform: ruby
 authors:
 - Harvest Team