samagotchi 0.9.0 → 0.10.0

data/lib/samagotchi/worker.rb

@@ -2,6 +2,7 @@
 
 require "fileutils"
 
+require_relative "events"
 require_relative "session"
 require_relative "session_inbox"
 require_relative "turn_note"
@@ -43,7 +44,6 @@ module Samagotchi
     # How much of a command's output goes into its :command_ran.
     COMMAND_OUTPUT_LIMIT = 4096
     BUSY_OUTPUT = "busy: wait for the turn to end"
-    TURN_END_EVENTS = %i[turn_completed turn_canceled turn_failed].freeze
     DEFAULT_MAX_ITERATIONS = 100
     NO_INTERRUPT_MAX_ITERATIONS = 1000
 
@@ -95,8 +95,10 @@ module Samagotchi
     # What a new session starts on (and /model resets to); nil before #run.
     attr_reader :default_model
 
-    # @return [Symbol] :idle_exit, or :exit_requested when a client asked it
-    #   to exit (Bridge POST /exit)
+    # @return [Symbol] :idle_exit, :exit_requested when a client asked it
+    #   to exit (Bridge POST /exit), :stopped when the session was stopped
+    #   (chi stop), :crashed when the loop raised (the session is marked
+    #   errored); SessionManager.run_session_loop turns it into the exit
     def run
       @session = Session.load(@session_id, state_dir: @state_dir)
       drop_dead_question
@@ -113,7 +115,7 @@ module Samagotchi
       # queued while that turn ran.
       @turn_end_seq = 0
       @engine.subscribe(observer: lambda { |event|
-        @turn_end_seq = event[:event_seq] if TURN_END_EVENTS.include?(event[:type])
+        @turn_end_seq = event[:event_seq] if Events::TURN_END.include?(event[:type])
       })
       # /model's default is the config's, as in the REPL; the Engine started
       # on the session's model.
@@ -151,14 +153,17 @@ module Samagotchi
       begin
         # A session stopped before this worker took the lock (e.g. a stop
         # right after create) must not run its initial prompt.
-        exit(0) if stopped_on_disk?
+        return :stopped if stopped_on_disk?
         # Plugins' slow setup (chi.init: an MCP server's first start), in
         # the background, shown by the UIs; a turn waits only for the ones
         # that bring tools.
         @engine.start_init_tasks!
         loop do
-          # Check if the session was externally marked as stopped
-          exit(0) if Session.load(@session_id, state_dir: @state_dir).status == Session::STATUS_STOPPED
+          # Check if the session was externally marked as stopped. Not
+          # stopped_on_disk?, which reads a vanished file as "not stopped":
+          # a session file deleted under a running worker crashes it here
+          # instead of being saved back by its next turn.
+          return :stopped if Session.load(@session_id, state_dir: @state_dir).status == Session::STATUS_STOPPED
 
           # Commands queued before a prompt run first (a /continue sent
           # before a new prompt still answers the offer).
@@ -194,7 +199,7 @@ module Samagotchi
         # Its stderr is /dev/null: the log is the only trace of why.
         Log.exception(:worker, "crashed", e)
         Session.mark_error(@session_id, reason: e.message, state_dir: @state_dir)
-        exit(1)
+        :crashed
       ensure
         # The anytime commands finish and the plugins' services stop (a
         # server process), whatever the way out; the Bridge last, so a
@@ -297,28 +302,19 @@ module Samagotchi
     #   its continue turn
     # @param images [Array<Hash>] the prompt's image refs ({file:, name:})
     def run_prompt(prompt, origin, no_interrupt: false, images: [])
-      # Show the turn as running to readers of the file (the web's session
-      # list); the Engine resets it to idle when it ends.
-      @session.status = Session::STATUS_RUNNING
-      @session.save(state_dir: @state_dir)
       user_input(origin&.dig(:client_id))
       drop_continue_offer(origin)
       @turn_flow.before_prompt_turn
       @merged_this_turn = []
-      begin
-        result = @engine.run_turn(@session, prompt, pending_input: pending_input_drain, origin: origin,
-                                                    max_iterations: max_iterations(no_interrupt), images: images)
-      rescue StandardError => e
-        # The Engine announced :turn_failed (with the error's one line).
-        restore_failed_turn([[prompt, origin, images], *@merged_this_turn], error: e)
-        return
-      ensure
-        refuse_queued_commands
+      run_engine_turn(prompt, origin: origin, max_iterations: max_iterations(no_interrupt),
+                              images: images) do |result, error|
+        if error
+          # The Engine announced :turn_failed (with the error's one line).
+          restore_failed_turn([[prompt, origin, images], *@merged_this_turn], error: error)
+        else
+          after_turn(result, no_interrupt: no_interrupt)
+        end
       end
-      after_turn(result, no_interrupt: no_interrupt)
-      response = result.respond_to?(:output) ? result.output : nil
-      SessionInbox.write_output(@session_dir, response) unless response.nil? || response.strip.empty?
-      @session.save(state_dir: @state_dir) unless stopped_on_disk?
     end
 
     # A due reminder runs as a continue turn, as in the REPL: Engine#run_turn
@@ -333,23 +329,11 @@ module Samagotchi
       return false unless @engine.reminders_due?
 
       drop_continue_offer({ client_id: SessionManager::REMINDER_CLIENT_ID })
-      @session.status = Session::STATUS_RUNNING
-      @session.save(state_dir: @state_dir)
-      begin
-        result = @engine.run_turn(@session, nil, continue: true, pending_input: pending_input_drain,
-                                                 origin: { client_id: SessionManager::REMINDER_CLIENT_ID },
-                                                 max_iterations: DEFAULT_MAX_ITERATIONS)
-        response = result.respond_to?(:output) ? result.output : nil
-        SessionInbox.write_output(@session_dir, response) unless response.nil? || response.strip.empty?
-      rescue StandardError
-        nil # the Engine announced :turn_failed; there is no prompt to hand back
-      ensure
-        refuse_queued_commands
-      end
-      # The offer went before the turn (drop_continue_offer); the rollback
-      # window closes.
-      @turn_flow.after_reminder_turn
-      @session.save(state_dir: @state_dir) unless stopped_on_disk?
+      # A failure has no prompt to hand back (the Engine announced
+      # :turn_failed). The offer went before the turn
+      # (drop_continue_offer); either way the rollback window closes.
+      run_engine_turn(nil, continue: true, origin: { client_id: SessionManager::REMINDER_CLIENT_ID },
+                           max_iterations: DEFAULT_MAX_ITERATIONS) { @turn_flow.after_reminder_turn }
       true
     end
 
@@ -397,7 +381,7 @@ module Samagotchi
         announce_command(command, status: result.status.to_s, output: result.output, changed: Array(result.changed))
         shown.each { |event| @engine.announce(event) }
       end
-      @session.save(state_dir: @state_dir) unless Array(result.changed).empty? || stopped_on_disk?
+      save_session unless Array(result.changed).empty?
       user_input(command[:client_id]) if resolved
       # An offer answered without a turn ("no") is activity: the recap
       # written at the offer (it says the turn stopped) gets rewritten.
@@ -461,23 +445,38 @@ module Samagotchi
     def run_continue_turn(command)
       offer = @turn_flow.offer
       @turn_flow.before_continue_turn
+      run_engine_turn(nil, continue: true, origin: { client_id: command[:client_id] }.compact,
+                           max_iterations: max_iterations(offer[:no_interrupt])) do |result, error|
+        if error
+          @engine.announce(type: :continue_offered, context: offer[:context], no_interrupt: offer[:no_interrupt])
+        else
+          after_turn(result, continue: true, no_interrupt: offer[:no_interrupt])
+        end
+      end
+    end
+
+    # One Engine turn, the same for a prompt, a reminder and a continue:
+    # the session shows as running to readers of the file (the web's
+    # session list; the Engine resets it to idle when it ends), commands
+    # queued while it ran are refused, then the caller's block takes the
+    # result (or the error the Engine announced as :turn_failed), the
+    # answer goes to the output file and the session is saved.
+    # @yieldparam result [Object, nil] Engine#run_turn's, nil on a failure
+    # @yieldparam error [StandardError, nil]
+    def run_engine_turn(prompt, **turn_args)
       @session.status = Session::STATUS_RUNNING
       @session.save(state_dir: @state_dir)
       begin
-        result = @engine.run_turn(@session, nil, continue: true, pending_input: pending_input_drain,
-                                                 origin: { client_id: command[:client_id] }.compact,
-                                                 max_iterations: max_iterations(offer[:no_interrupt]))
-      rescue StandardError
-        @engine.announce(type: :continue_offered, context: offer[:context], no_interrupt: offer[:no_interrupt])
-        @session.save(state_dir: @state_dir) unless stopped_on_disk?
-        return
+        result = @engine.run_turn(@session, prompt, pending_input: pending_input_drain, **turn_args)
+      rescue StandardError => e
+        error = e
       ensure
         refuse_queued_commands
       end
-      after_turn(result, continue: true, no_interrupt: offer[:no_interrupt])
+      yield result, error
       response = result.respond_to?(:output) ? result.output : nil
       SessionInbox.write_output(@session_dir, response) unless response.nil? || response.strip.empty?
-      @session.save(state_dir: @state_dir) unless stopped_on_disk?
+      save_session
     end
 
     # TurnFlow keeps the checkpoint (a cancelled turn's, for !rollback) and
@@ -513,6 +512,7 @@ module Samagotchi
     #   origin, images] (a web client gets its image chips back)
     # @param error [Exception, nil] what failed: its one line stays in the
     #   conversation as a turn note
+    # Not saved here: run_engine_turn saves after its block.
     def restore_failed_turn(prompts, error: nil)
       note = error && TurnNote.failed(error.respond_to?(:summary) ? error.summary : error.message, restored: true)
       @engine.synchronize_events do
@@ -523,7 +523,6 @@ module Samagotchi
           @engine.announce(restored)
         end
       end
-      @session.save(state_dir: @state_dir) unless stopped_on_disk?
     end
 
     # Shared mid-turn steering drain: claims any input files that arrive
@@ -657,5 +656,12 @@ module Samagotchi
     def stopped_on_disk?
       SessionManager.stopped_on_disk?(@session_id, state_dir: @state_dir)
     end
+
+    # Save the session unless it was stopped meanwhile: the stop (chi stop,
+    # from another process) saved its status, and this save would write
+    # the worker's over it.
+    def save_session
+      @session.save(state_dir: @state_dir) unless stopped_on_disk?
+    end
   end
 end

data/lib/samagotchi/worker_sidecar.rb

@@ -2,6 +2,7 @@
 
 require "json"
 require "fileutils"
+require "socket"
 require_relative "atomic_file"
 
 module Samagotchi
@@ -10,9 +11,11 @@ module Samagotchi
   # "worker" owner), the chi it runs (chi update) and the input-file format
   # it reads (SessionInbox::INPUT_FORMAT). The Bridge writes it on start
   # and removes it on stop; one a dead worker left stays until a client's
-  # probe finds its port closed (BridgeClient.sidecar_port).
+  # probe finds its port closed (.live with unlink: true).
   class WorkerSidecar < Data.define(:port, :bind, :session_id, :started_at, :version, :input_format)
     FILE = "bridge.json"
+    # Seconds a liveness probe waits for the port to take a connect.
+    PROBE_TIMEOUT = 0.2
 
     def self.path(session_dir) = File.join(session_dir, FILE)
 
@@ -29,6 +32,29 @@ module Samagotchi
       nil
     end
 
+    # The sidecar of a worker whose Bridge takes a connect on its port, or
+    # nil. One whose port refuses (its worker died) is stale: +unlink+
+    # removes it (the clients that would talk to it), else it stays (a
+    # read-only look, like `chi update`'s).
+    # @return [WorkerSidecar, nil]
+    def self.live(session_dir, unlink:, host: "127.0.0.1", timeout: PROBE_TIMEOUT)
+      sidecar = read(session_dir)
+      return nil unless sidecar&.port&.positive?
+
+      begin
+        Socket.tcp(host, sidecar.port, connect_timeout: timeout).close
+        sidecar
+      rescue StandardError
+        FileUtils.rm_f(path(session_dir)) if unlink
+        nil
+      end
+    rescue StandardError
+      nil
+    end
+
+    # @return [Integer, nil] .live's port
+    def self.live_port(session_dir, unlink:, host: "127.0.0.1") = live(session_dir, unlink: unlink, host: host)&.port
+
     def initialize(port:, bind: nil, session_id: nil, started_at: nil, version: nil, input_format: nil) = super
 
     # Written whole or not at all; input_format only when it names one.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: samagotchi
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Dmitry Dedov
@@ -187,9 +187,12 @@ files:
 - lib/samagotchi/bundles/system/memory_guide.md
 - lib/samagotchi/bundles/system/self_map.md
 - lib/samagotchi/cancellation_controller.rb
+- lib/samagotchi/cli/command.rb
+- lib/samagotchi/cli/flags.rb
 - lib/samagotchi/client.rb
 - lib/samagotchi/commands/registry.rb
 - lib/samagotchi/config.rb
+- lib/samagotchi/config_text_edit.rb
 - lib/samagotchi/context_note.rb
 - lib/samagotchi/context_quote.rb
 - lib/samagotchi/context_status.rb
@@ -210,6 +213,7 @@ files:
 - lib/samagotchi/edit_preview.rb
 - lib/samagotchi/empty_answer_retry.rb
 - lib/samagotchi/engine.rb
+- lib/samagotchi/events.rb
 - lib/samagotchi/gem_update.rb
 - lib/samagotchi/guardrail_wiring.rb
 - lib/samagotchi/guardrails.rb
@@ -315,6 +319,7 @@ files:
 - lib/samagotchi/terminal_ui/attach_launcher.rb
 - lib/samagotchi/terminal_ui/attached_loop.rb
 - lib/samagotchi/terminal_ui/attached_view.rb
+- lib/samagotchi/terminal_ui/between_turns.rb
 - lib/samagotchi/terminal_ui/event_renderer.rb
 - lib/samagotchi/terminal_ui/formatting.rb
 - lib/samagotchi/terminal_ui/image_input.rb
@@ -341,6 +346,7 @@ files:
 - lib/samagotchi/tool_runner.rb
 - lib/samagotchi/tools/args.rb
 - lib/samagotchi/tools/ask_user_question.rb
+- lib/samagotchi/tools/builtin_calls.rb
 - lib/samagotchi/tools/builtins.rb
 - lib/samagotchi/tools/cancel_reminder.rb
 - lib/samagotchi/tools/delegate.rb
@@ -380,12 +386,14 @@ files:
 - lib/samagotchi/web/markdown_renderer.rb
 - lib/samagotchi/web/message_parts.rb
 - lib/samagotchi/web/public/activity.js
+- lib/samagotchi/web/public/annotate_bar.js
 - lib/samagotchi/web/public/annotate_presets.js
 - lib/samagotchi/web/public/annotations.js
 - lib/samagotchi/web/public/app.js
 - lib/samagotchi/web/public/card.js
 - lib/samagotchi/web/public/chunk_router.js
 - lib/samagotchi/web/public/command_complete.js
+- lib/samagotchi/web/public/command_list.js
 - lib/samagotchi/web/public/composer_size.js
 - lib/samagotchi/web/public/copy.js
 - lib/samagotchi/web/public/ctx.js
@@ -398,12 +406,15 @@ files:
 - lib/samagotchi/web/public/init_row.js
 - lib/samagotchi/web/public/model_pick.js
 - lib/samagotchi/web/public/model_picker.js
+- lib/samagotchi/web/public/notifications.js
 - lib/samagotchi/web/public/notify.js
 - lib/samagotchi/web/public/question_card.js
+- lib/samagotchi/web/public/question_cards.js
 - lib/samagotchi/web/public/route.js
 - lib/samagotchi/web/public/scope.js
 - lib/samagotchi/web/public/scroll.js
 - lib/samagotchi/web/public/sentences.js
+- lib/samagotchi/web/public/session_state.js
 - lib/samagotchi/web/public/sessions_list.js
 - lib/samagotchi/web/public/stage_model.js
 - lib/samagotchi/web/public/stage_view.js