roast-ai 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e2c7eb637034ea1c7a97776161d901ddcce583600bb465fd1f403a4866203c4
-  data.tar.gz: 194f9efd30453dbf123f16abab80bce99cf713dee8077858c10fa3e80c53d7cb
+  metadata.gz: a1acd0533e7f7ca21ccb4d8fd27f00bd1e838953130a5e0dd779e8be4a61c15e
+  data.tar.gz: cf9cb0909d17aefdf6dd066422251565a13d9abc152e202f9143080eec2b8fdd
 SHA512:
-  metadata.gz: 92f4fc82409d7b59fed96a2ba31ac9c9c4dc9b9744a8645b934223c2fad8f09f5e960dcb8629963af619310516931391b90e0692162dbe42028553e311cb9eb9
-  data.tar.gz: 5d12e5e669c9acc5ac3372f621c2627735c0edaf96bf2c674c56ebbee458b69d3c1fc3dea30073045541e06b01c6ece526bcd597de184e5ea6b84fca8a67f2cb
+  metadata.gz: df929fe8cd3a22bdbb5d22660a0ebec7461c67cb6d9880b13862f8bbc059ccc3e964fb34d142a631bbcf0e5a3c3ea88e5c19eb2727486d5fc82c2832f7f79355
+  data.tar.gz: 8245dca9407394314434006628279cb26a74dd9c72b8819cc21ba4c45728a790d91f4ec95e10ba999f6958e576981a493fdb8a3d419dc067873d6b40c0764d64

data/CONTRIBUTING.md

@@ -1,7 +1,5 @@
 # How to contribute
 
-> **📢 Code Freeze Notice**: This project is currently under a limited code freeze while we work on an alternative frontend (a DSL). We are still accepting **bug fixes**, but **new features** will not be merged until the DSL is released. Thank you for your understanding!
-
 ## Things we will merge
 
 * Bugfixes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roast-ai (1.3.0)
+    roast-ai (1.4.0)
       activesupport (~> 8.0)
       async (>= 2.34)
       rainbow (>= 3.0.0)
@@ -317,7 +317,7 @@ CHECKSUMS
   regexp_parser (2.10.0) sha256=cb6f0ddde88772cd64bff1dbbf68df66d376043fe2e66a9ef77fcb1b0c548c61
   require-hooks (0.2.3) sha256=224be5b4be0fd2a47cb73286c500da366704a54ec195b6627366380c950efac8
   rexml (3.4.2) sha256=1384268554a37af5da5279431ca3f2f37d46f09ffdd6c95e17cc84c83ea7c417
-  roast-ai (1.3.0)
+  roast-ai (1.4.0)
   rubocop (1.77.0) sha256=1f360b4575ef7a124be27b0dfffa227a2b2d9420d22d4fd8bf179d702bcc88c0
   rubocop-ast (1.45.1) sha256=94042e49adc17f187ba037b33f941ba7398fede77cdf4bffafba95190a473a3e
   rubocop-shopify (2.17.1) sha256=03850eb1a9c4d1f9f0ac1d8d5aa51bb47a149e532cfb5e8d02ac6a90c8800a5f

data/examples/demo/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    roast-ai (1.3.0)
+    roast-ai (1.4.0)
       activesupport (~> 8.0)
       async (>= 2.34)
       rainbow (>= 3.0.0)

data/examples/plugin-gem-example/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    roast-ai (1.3.0)
+    roast-ai (1.4.0)
       activesupport (~> 8.0)
       async (>= 2.34)
       rainbow (>= 3.0.0)

data/lib/roast/cogs/agent/config.rb

@@ -554,6 +554,49 @@ module Roast
           Pathname.new(@values[:dump_raw_agent_messages_to]) if @values[:dump_raw_agent_messages_to]
         end
 
+        # Configure the cog to append a record of each agent run to a file, as one JSON object per line
+        #
+        # Each record holds the run's start and finish times, the cog's name and its path in the workflow,
+        # the provider and model, the prompts and any appended or replacement system prompt, the final
+        # response, the session identifier, the execution statistics, and the run's status (`succeeded`,
+        # `failed`, or `timed_out`) with the error class and message if it did not succeed.
+        #
+        # Records include the full prompts and response, so they may contain sensitive text.
+        # Disabled by default.
+        #
+        # #### See Also
+        # - `no_record_agent_runs!`
+        #
+        #: (String) -> void
+        def record_agent_runs_to(filename)
+          @values[:record_agent_runs_to] = filename
+        end
+
+        # Configure the cog __not__ to record its agent runs
+        #
+        # This is the default behaviour.
+        #
+        # #### See Also
+        # - `record_agent_runs_to`
+        #
+        #: () -> void
+        def no_record_agent_runs!
+          @values[:record_agent_runs_to] = nil
+        end
+
+        # Get the validated, configured path to which agent run records should be appended
+        #
+        # Returns `nil` if agent runs should not be recorded.
+        #
+        # #### See Also
+        # - `record_agent_runs_to`
+        # - `no_record_agent_runs!`
+        #
+        #: () -> Pathname?
+        def valid_record_agent_runs_to_path
+          Pathname.new(@values[:record_agent_runs_to]) if @values[:record_agent_runs_to].present?
+        end
+
         alias_method(:skip_permissions!, :no_apply_permissions!)
         alias_method(:no_skip_permissions!, :apply_permissions!)
         alias_method(:quiet!, :no_display!)

data/lib/roast/cogs/agent/providers/claude/message.rb

@@ -14,8 +14,10 @@ module Roast
             class << self
               #: (String, ?raw_dump_file: Pathname?) -> Message
               def from_json(json, raw_dump_file: nil)
-                raw_dump_file&.dirname&.mkpath
-                File.write("./tmp/claude-messages.log", "#{json}\n", mode: "a") if raw_dump_file
+                if raw_dump_file
+                  raw_dump_file.dirname.mkpath
+                  File.write(raw_dump_file.to_s, "#{json}\n", mode: "a")
+                end
                 from_hash(JSON.parse(json, symbolize_names: true))
               end
 

data/lib/roast/cogs/agent/stats.rb

@@ -100,6 +100,21 @@ module Roast
           lines.join("\n")
         end
 
+        # Get the statistics as a hash, with aggregate and per-model usage as nested hashes
+        #
+        # #### See Also
+        # - `Agent::Usage#to_h`
+        #
+        #: () -> Hash[Symbol, untyped]
+        def to_h
+          {
+            duration_ms:,
+            num_turns:,
+            usage: usage.to_h,
+            model_usage: model_usage.transform_values(&:to_h),
+          }
+        end
+
         private
 
         #: (Numeric?, Numeric?) -> Numeric?

data/lib/roast/cogs/agent/usage.rb

@@ -68,6 +68,13 @@ module Roast
           result
         end
 
+        # Get the token counts and cost as a hash
+        #
+        #: () -> Hash[Symbol, untyped]
+        def to_h
+          { input_tokens:, output_tokens:, cost_usd: }
+        end
+
         private
 
         #: (Numeric?, Numeric?) -> Numeric?

data/lib/roast/cogs/agent.rb

@@ -45,17 +45,70 @@ module Roast
       # The agent may make multiple turns (back-and-forth exchanges) during execution,
       # especially when using tools. Each turn is counted in the execution statistics.
       #
+      # If the cog is configured with `record_agent_runs_to`, a record of the run is appended to that file
+      # whether the run succeeds or fails.
+      #
       #: (Input) -> Output
       def execute(input)
-        output = provider.invoke(input)
-        if config.show_stats?
-          Event << { block: { header: "AGENT STATS", content: "#{output.stats}\nSession ID: #{output.session}" } }
+        started_at = Time.now
+        begin
+          output = provider.invoke(input)
+          if config.show_stats?
+            Event << { block: { header: "AGENT STATS", content: "#{output.stats}\nSession ID: #{output.session}" } }
+          end
+          output
+        rescue StandardError => e
+          error = e
+          raise
+        ensure
+          record_run(input, output, error, started_at) if config.valid_record_agent_runs_to_path
         end
-        output
       end
 
       private
 
+      #: (Input, Output?, StandardError?, Time) -> void
+      def record_run(input, output, error, started_at)
+        record = {
+          started_at: started_at.utc.iso8601(3),
+          finished_at: Time.now.utc.iso8601(3),
+          cog: { name: anonymous? ? nil : name, path: record_path },
+          provider: config.valid_provider!,
+          model: config.valid_model,
+          prompts: input.prompts,
+          system_prompt: { append: config.valid_append_system_prompt, replace: config.valid_replace_system_prompt },
+          status: run_status(output, error),
+          error: error && { class: error.class.name, message: error.message },
+          response: output&.response,
+          session: output&.session,
+          stats: output&.stats&.to_h,
+        }
+        path = config.valid_record_agent_runs_to_path.not_nil!
+        path.dirname.mkpath
+        File.write(path.to_s, "#{JSON.generate(record)}\n", mode: "a")
+      end
+
+      #: () -> Array[Hash[Symbol, untyped]]
+      def record_path
+        TaskContext.path.filter_map do |element|
+          cog = element.cog
+          execution_manager = element.execution_manager
+          if cog.present?
+            { cog: cog.type, name: cog.anonymous? ? nil : cog.name }
+          elsif execution_manager&.scope
+            { scope: execution_manager.scope, index: execution_manager.scope_index }
+          end
+        end
+      end
+
+      #: (Output?, StandardError?) -> String
+      def run_status(output, error)
+        return "timed_out" if error.is_a?(CommandRunner::TimeoutError)
+        return "failed" if error || output.nil?
+
+        "succeeded"
+      end
+
       #: () -> Provider
       def provider
         @provider ||= case config.valid_provider!

data/lib/roast/cogs/cmd.rb

@@ -168,6 +168,40 @@ module Roast
           show_stdout? || show_stderr?
         end
 
+        # Configure the cog to run the command with these environment variables set
+        #
+        # Variables not named here are inherited from Roast's own environment. A `nil` value unsets
+        # the variable for the command.
+        #
+        # #### See Also
+        # - `no_env!`
+        #
+        #: (Hash[String | Symbol, String?]) -> void
+        def env(vars)
+          @values[:env] = vars
+        end
+
+        # Configure the cog to run the command with Roast's own environment, unchanged (the default)
+        #
+        # #### See Also
+        # - `env`
+        #
+        #: () -> void
+        def no_env!
+          @values[:env] = nil
+        end
+
+        # Get the validated environment variables the command will be run with, keyed by name
+        #
+        # #### See Also
+        # - `env`
+        # - `no_env!`
+        #
+        #: () -> Hash[String, String?]
+        def valid_env
+          (@values[:env] || {}).to_h { |name, value| [name.to_s, value&.to_s] }
+        end
+
         alias_method(:quiet!, :no_display!)
       end
 
@@ -281,6 +315,7 @@ module Roast
           .execute(
             [input.command] + input.args,
             working_directory: config.valid_working_directory,
+            env: config.valid_env,
             stdin_content: input.stdin,
             stdout_handler: stdout_handler,
             stderr_handler: stderr_handler,

data/lib/roast/command_runner.rb

@@ -45,6 +45,7 @@ module Roast
       #: (
       #|  Array[String],
       #|  ?working_directory: (Pathname | String)?,
+      #|  ?env: Hash[String, String?],
       #|  ?timeout: (Integer | Float)?,
       #|  ?stdin_content: String?,
       #|  ?stdout_handler: (^(String) -> void)?,
@@ -53,6 +54,7 @@ module Roast
       def execute(
         args,
         working_directory: nil,
+        env: {},
         timeout: nil,
         stdin_content: nil,
         stdout_handler: nil,
@@ -69,7 +71,7 @@ module Roast
         stdin, stdout, stderr, wait_thread = Bundler.with_unbundled_env do
           Open3 #: as untyped
             .popen3(
-              env_overrides.merge({ "PWD" => working_directory&.to_s }).compact,
+              env.merge(env_overrides, { "PWD" => working_directory&.to_s }.compact),
               *args.map(&:to_s),
               { chdir: working_directory }.compact,
             )

data/lib/roast/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Roast
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/sorbet/rbi/shims/lib/roast/config_context.rbi

@@ -184,6 +184,10 @@ module Roast
     # #### Configure debugging
     # - `dump_raw_agent_messages_to(filename)` - Dump raw agent messages to a file for debugging
     #
+    # #### Configure run records
+    # - `record_agent_runs_to(filename)` - Append a JSON record of each agent run (prompts, response, session, stats, status) to a file
+    # - `no_record_agent_runs!` - Don't record agent runs (default)
+    #
     # #### Configure asynchronous execution
     # - `async!` - Run the cog asynchronously in the background
     # - `no_async!` (alias `sync!`) - Run the cog synchronously (default)
@@ -273,6 +277,10 @@ module Roast
     # - `fail_on_error!` - Consider the cog failed if the command returns a non-zero exit status (default)
     # - `no_fail_on_error!` - Don't fail the cog on non-zero exit status (exit status still available in output)
     #
+    # #### Configure the environment
+    # - `env(hash)` - Set environment variables for the command (a `nil` value unsets one)
+    # - `no_env!` - Run the command with Roast's own environment, unchanged (default)
+    #
     # #### Configure display output
     # - `show_stdout!` - Write STDOUT to the console
     # - `no_show_stdout!` - Don't write STDOUT to the console (default)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roast-ai
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Shopify
@@ -408,7 +408,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.21
+rubygems_version: 4.0.22
 specification_version: 4
 summary: A framework for executing structured AI workflows in Ruby
 test_files: []