bitfab 0.62.3 → 0.62.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ea9a0439252adacbe50f5c2bc210b5a9708eb772b9998c3660008b10e14dd95
-  data.tar.gz: 0cd4bfab124dac3a35d3653f2fbef02c6b7e6671bbab36fa9f3b583652ed8339
+  metadata.gz: 17cb4215f2940d7b31473b2de0b4e5c1a0f87cc9eaed67050cb78f866ea1a24d
+  data.tar.gz: cab44aa11d1bb5f8a30cbfc38f2507dfc53e230821d0851279ace1ed24a19dff
 SHA512:
-  metadata.gz: 4e191d599d446e776599c9b01014768e95710f23e9ca27f2c8618008eb3b454718d629f2533d242b412520e6c309a5a390ff65e66d1bd10a23a865b6c0d53654
-  data.tar.gz: 74f6a2fa1301b226afca67d30490b5ed0095a28cae9aa8513d89291a7b06e7f95303028fe104ff672a79e57efcdc3c8bfd491e643a1ec7fe33f5a478936160d7
+  metadata.gz: 7f2c5073f314c9afe5b9dccb6c101476803a00602467089d618fe0131be631c97f2768bd240ae31728875953605f508517bfcb041339b43795dacba6bd50f695
+  data.tar.gz: cb1933586e1b8aeaf0233b7c163abb10cbe6805b156d26489c596cbbdba972984614ac5245aab38d0e35ad0333ae09fd7edc27f42b1ae9d826fef05aaa44c09b

data/lib/bitfab/client.rb

@@ -37,7 +37,7 @@ module Bitfab
 
     attr_reader :service_url
 
-    attr_reader :datasets, :assertion_categories, :organization_members, :traces, :labels, :graders
+    attr_reader :datasets, :assertion_categories, :organization_members, :traces, :labels, :graders, :experiments
 
     def initialize(api_key: nil, service_url: nil, capture_enabled: nil, enabled: nil, strict: false, simulation_plan: true, timeout: 120, trace_across_threads: nil, env_vars: nil, baml_client: nil, db_snapshot: nil)
       @db_snapshot = DbSnapshot.normalize_config(db_snapshot)
@@ -59,6 +59,7 @@ module Bitfab
       @traces = Traces.new(@http_client)
       @labels = Labels.new(@http_client)
       @graders = Graders.new(@http_client)
+      @experiments = Experiments.new(@http_client)
       # Mock overrides registered via register_mock_override, applied to every
       # replay on this client (after any per-call mock_override). Instance
       # state, no global; clear_mock_overrides resets it.
@@ -197,7 +198,7 @@ module Bitfab
     # @return [Hash] with :items, :experiment_id, :experiment_url, and the
     #   deprecated aliases :test_run_id and :test_run_url carrying the same values
     def replay(receiver, method_name = nil, trace_function_key:, limit: nil, trace_ids: nil, concurrency: nil, max_concurrency: ReplayConcurrency::UNSET,
-      name: nil, notes: nil, code_change_description: Replay::CODE_CHANGE_UNSET, code_change_files: Replay::CODE_CHANGE_UNSET, experiment_group_id: nil, dataset_id: nil, dataset_ids: nil, grader_ids: nil, mock: "marked", attempts: ReplayConcurrency::UNSET, only_with_assertions: false, judge_assertions: false, dry_run: false,
+      name: nil, notes: nil, metadata: nil, code_change_description: Replay::CODE_CHANGE_UNSET, code_change_files: Replay::CODE_CHANGE_UNSET, experiment_group_id: nil, dataset_id: nil, dataset_ids: nil, grader_ids: nil, mock: "marked", attempts: ReplayConcurrency::UNSET, only_with_assertions: false, judge_assertions: false, dry_run: false,
       adapt_inputs: nil, mock_override: nil, db_branch: nil, on_item_start: nil, on_item_finish: nil, on_progress: nil,
       on_experiment_start: nil, experimental_selective_replay: nil)
       Replay.run(
@@ -209,6 +210,7 @@ module Bitfab
         trace_ids:,
         name:,
         notes:,
+        metadata:,
         concurrency:,
         max_concurrency:,
         attempts:,

data/lib/bitfab/experiments.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "json"
+require "time"
+require "uri"
+
+module Bitfab
+  class Experiments
+    PATH = "/api/sdk/experiments"
+    private_constant :PATH
+
+    def initialize(http_client)
+      @http_client = http_client
+    end
+
+    def list(dataset_id: nil, trace_function_key: nil, git_branch: nil, experiment_group_id: nil, status: nil,
+      metadata: nil, created_after: nil, created_before: nil, cursor: nil, limit: nil)
+      params = {}
+      params["datasetId"] = dataset_id unless dataset_id.nil?
+      params["traceFunctionKey"] = trace_function_key unless trace_function_key.nil?
+      params["gitBranch"] = git_branch unless git_branch.nil?
+      params["experimentGroupId"] = experiment_group_id unless experiment_group_id.nil?
+      params["status"] = status unless status.nil?
+      params["metadata"] = JSON.generate(metadata) unless metadata.nil?
+      params["createdAfter"] = iso8601(created_after) unless created_after.nil?
+      params["createdBefore"] = iso8601(created_before) unless created_before.nil?
+      params["cursor"] = cursor unless cursor.nil?
+      params["limit"] = limit unless limit.nil?
+      query = URI.encode_www_form(params)
+      @http_client.get(query.empty? ? PATH : "#{PATH}?#{query}")
+    end
+
+    def get(id)
+      @http_client.get("#{PATH}/#{encode(id)}")["experiment"]
+    end
+
+    def get_rollup(id)
+      @http_client.get("#{PATH}/#{encode(id)}/rollup")
+    end
+
+    def get_rollup_all(ids)
+      return [] if ids.empty?
+
+      query = URI.encode_www_form("experimentIds" => ids.join(","))
+      @http_client.get("#{PATH}/rollups?#{query}")["rollups"]
+    end
+
+    private
+
+    def iso8601(value)
+      value.respond_to?(:iso8601) ? value.iso8601 : value.to_s
+    end
+
+    def encode(value)
+      URI.encode_www_form_component(value).gsub("+", "%20")
+    end
+  end
+end

data/lib/bitfab/http_client.rb

@@ -261,7 +261,7 @@ module Bitfab
     #   runnable graders at completion; each must be an active/live grader in the
     #   same org and trace function or the server rejects the replay
     def start_replay(trace_function_key, limit, trace_ids: nil, code_change_description: nil,
-      code_change_files: nil, experiment_group_id: nil, name: nil, notes: nil, include_db_branch_lease: false, dataset_ids: nil,
+      code_change_files: nil, experiment_group_id: nil, name: nil, notes: nil, metadata: nil, include_db_branch_lease: false, dataset_ids: nil,
       grader_ids: nil, db_branch_settings: nil, attempts: 1, only_with_assertions: false, judge_assertions: false, include_original_metadata: false, experimental_selective_replay: nil)
       payload = {
         "traceFunctionKey" => trace_function_key
@@ -272,6 +272,7 @@ module Bitfab
       payload["traceIds"] = trace_ids if trace_ids
       payload["name"] = name unless name.nil?
       payload["notes"] = notes unless notes.nil?
+      payload["metadata"] = metadata unless metadata.nil?
       payload["codeChangeDescription"] = code_change_description unless code_change_description.nil?
       payload["codeChangeFiles"] = normalize_code_change_files(code_change_files) unless code_change_files.nil?
       payload["experimentGroupId"] = experiment_group_id unless experiment_group_id.nil?

data/lib/bitfab/replay.rb

@@ -280,7 +280,7 @@ module Bitfab
     #   crashes the run.
     # @return [Hash] with :items, :experiment_id, :experiment_url, and the
     #   deprecated aliases :test_run_id and :test_run_url carrying the same values
-    def run(client, receiver, method_name, trace_function_key:, limit: nil, trace_ids: nil, name: nil, notes: nil,
+    def run(client, receiver, method_name, trace_function_key:, limit: nil, trace_ids: nil, name: nil, notes: nil, metadata: nil,
       concurrency: nil, max_concurrency: ReplayConcurrency::UNSET, code_change_description: CODE_CHANGE_UNSET, code_change_files: CODE_CHANGE_UNSET, experiment_group_id: nil,
       dataset_id: nil, dataset_ids: nil, grader_ids: nil, mock: "marked", attempts: ReplayConcurrency::UNSET, only_with_assertions: false, judge_assertions: false, dry_run: false,
       adapt_inputs: nil, mock_override: nil, db_branch: nil, on_item_start: nil, on_item_finish: nil, on_progress: nil,
@@ -378,6 +378,7 @@ module Bitfab
         trace_ids:,
         name:,
         notes:,
+        metadata:,
         code_change_description:,
         code_change_files:,
         experiment_group_id:,

data/lib/bitfab/replay_registry.rb

@@ -19,7 +19,7 @@ module Bitfab
   # Project-owned registry of production replay roots.
   class ReplayRegistry
     OPTION_NAMES = %i[
-      limit trace_ids name notes concurrency max_concurrency code_change_description
+      limit trace_ids name notes metadata concurrency max_concurrency code_change_description
       code_change_files experiment_group_id dataset_id dataset_ids grader_ids mock
       mock_override adapt_inputs db_branch attempts only_with_assertions judge_assertions dry_run on_item_finish
     ].freeze
@@ -186,7 +186,7 @@ module Bitfab
         options[:limit] = bound || 10
       end
 
-      %i[name notes max_concurrency experiment_group_id dataset_ids grader_ids mock attempts only_with_assertions judge_assertions dry_run].each do |key|
+      %i[name notes metadata max_concurrency experiment_group_id dataset_ids grader_ids mock attempts only_with_assertions judge_assertions dry_run].each do |key|
         options[key] = args[key] unless args[key].nil?
       end
 
@@ -291,6 +291,15 @@ module Bitfab
         options.on("--notes TEXT",
           "Run conditions Bitfab cannot see on its own, such as an environment override or a forced feature flag. " \
             "Kept on the experiment next to its name.") { |value| args[:notes] = value }
+        options.on("--metadata KEY=VALUE",
+          "A key and value stored on the experiment, such as schedule=eod. Repeat the flag for more pairs. " \
+            "Filter later runs on it with client.experiments.list(metadata: {...}).") do |value|
+          key, pair_value = value.split("=", 2)
+          if key.to_s.empty? || pair_value.nil?
+            raise OptionParser::InvalidArgument, "--metadata expects KEY=VALUE, got '#{value}'"
+          end
+          (args[:metadata] ||= {})[key] = pair_value
+        end
         options.on("--concurrency N", Integer) do |value|
           args[:max_concurrency] = positive_integer("--concurrency", value)
         end

data/lib/bitfab/version.rb

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

data/lib/bitfab.rb

@@ -21,6 +21,7 @@ require_relative "bitfab/traces"
 require_relative "bitfab/assertions"
 require_relative "bitfab/labels"
 require_relative "bitfab/graders"
+require_relative "bitfab/experiments"
 require_relative "bitfab/mock_override"
 require_relative "bitfab/replay"
 require_relative "bitfab/replay_branch"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitfab
 version: !ruby/object:Gem::Version
-  version: 0.62.3
+  version: 0.62.4
 platform: ruby
 authors:
 - Harvest Team
@@ -170,6 +170,7 @@ files:
 - lib/bitfab/detached_trace.rb
 - lib/bitfab/env.rb
 - lib/bitfab/experiment_id.rb
+- lib/bitfab/experiments.rb
 - lib/bitfab/git_command.rb
 - lib/bitfab/git_state.rb
 - lib/bitfab/graders.rb