samagotchi 0.60.0 → 0.61.0

data/lib/samagotchi/worker_signals.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Samagotchi
+  # TERM, HUP and INT in a worker process: the running turn stops as a Stop
+  # does (reason :signal), is saved, and the worker leaves (Worker#run
+  # returns :signal). SessionManager.run_session_loop installs the traps in
+  # a spawned worker only (WORKER_PROCESS_ENV), never in a process that runs
+  # the loop in-process (the specs, which fire #fire directly).
+  #
+  # A trap handler may take no lock (Mutex#lock raises ThreadError in trap
+  # context) and should do no IO: the trap only records the signal and
+  # starts a thread, which calls the worker's handler (#on_signal).
+  #
+  # Ruby's default for these signals raised SignalException in the main
+  # thread, mid-turn: the turn skipped every end-of-turn path and nothing of
+  # it reached the session file.
+  class WorkerSignals
+    SIGNALS = %w[TERM HUP INT].freeze
+
+    # Nothing trapped and nothing fires: Worker.new's default (specs, and
+    # any caller that isn't a spawned worker).
+    class None
+      def on_signal(&) = nil
+      def signal = nil
+      def count = 0
+      def hard_exit = nil
+      def restore! = nil
+    end
+    NONE = None.new.freeze
+
+    # @return [String, nil] the first signal received ("TERM"), nil before one
+    attr_reader :signal
+
+    # @param hard_exit [#call] the last resort when the worker hasn't left
+    #   long after the signal (exit! in a real worker)
+    def initialize(hard_exit: -> { Process.exit!(1) })
+      @signal = nil
+      @count = 0
+      @handler = nil
+      @hard_exit = hard_exit
+      @previous = {}
+    end
+
+    # How many signals came (a second one skips the grace).
+    attr_reader :count
+
+    # The worker's handler, called on a thread of its own with the signal
+    # name and the count, once per signal.
+    def on_signal(&handler)
+      @handler = handler
+    end
+
+    # Trap SIGNALS in this process (the previous handlers kept for #restore!).
+    # @return [self]
+    def install!
+      SIGNALS.each { |name| @previous[name] = Signal.trap(name) { fire(name) } }
+      self
+    end
+
+    # The handlers from before #install!.
+    def restore!
+      @previous.each { |name, handler| Signal.trap(name, handler || "DEFAULT") }
+      @previous.clear
+    end
+
+    # What a trap does (and what specs call): record +name+ and run the
+    # handler on its own thread. Safe in trap context: no lock, no IO.
+    # @return [Thread, nil] the handler's thread
+    def fire(name)
+      @signal ||= name
+      @count += 1
+      handler = @handler
+      count = @count
+      return nil unless handler
+
+      Thread.new { handler.call(name, count) }
+    end
+
+    def hard_exit = @hard_exit.call
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: samagotchi
 version: !ruby/object:Gem::Version
-  version: 0.60.0
+  version: 0.61.0
 platform: ruby
 authors:
 - Dmitry Dedov
@@ -150,6 +150,7 @@ files:
 - lib/samagotchi/analytics_file.rb
 - lib/samagotchi/answer_command.rb
 - lib/samagotchi/answer_display.rb
+- lib/samagotchi/answer_refs.rb
 - lib/samagotchi/answer_tail.rb
 - lib/samagotchi/archive_store.rb
 - lib/samagotchi/atomic_file.rb
@@ -308,6 +309,7 @@ files:
 - lib/samagotchi/image_store.rb
 - lib/samagotchi/installed_gem.rb
 - lib/samagotchi/installed_versions.rb
+- lib/samagotchi/interrupted_turn.rb
 - lib/samagotchi/iteration_limit.rb
 - lib/samagotchi/kernel_loop.rb
 - lib/samagotchi/last_turn.rb
@@ -507,6 +509,7 @@ files:
 - lib/samagotchi/tools/tool_path.rb
 - lib/samagotchi/tools/web_fetch.rb
 - lib/samagotchi/tools/write.rb
+- lib/samagotchi/turn_checkpoint.rb
 - lib/samagotchi/turn_flow.rb
 - lib/samagotchi/turn_note.rb
 - lib/samagotchi/turn_state.rb
@@ -530,6 +533,7 @@ files:
 - lib/samagotchi/web/public/annotate_bar.js
 - lib/samagotchi/web/public/annotate_presets.js
 - lib/samagotchi/web/public/annotations.js
+- lib/samagotchi/web/public/answer_refs.js
 - lib/samagotchi/web/public/app.js
 - lib/samagotchi/web/public/card.js
 - lib/samagotchi/web/public/chains.js
@@ -604,6 +608,7 @@ files:
 - lib/samagotchi/worker_idle_exit.rb
 - lib/samagotchi/worker_inbound.rb
 - lib/samagotchi/worker_sidecar.rb
+- lib/samagotchi/worker_signals.rb
 - lib/samagotchi/worker_wakes.rb
 - lib/samagotchi/yaml_lines.rb
 homepage: https://github.com/dm1try/samagotchi