rundoc 4.1.3 → 4.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b65a04eca7d7099223b2a626c47eb78e14a8e102266cf880cddc747a0d9fc4a5
-  data.tar.gz: 840585e8f0c6b3cddbb1d15354f4fdf862d2440b20054cd1b5344c026adb23d9
+  metadata.gz: 83fd435266e63543e96c3e24fc4d116cd043f2c89e396b8839d283eace07248a
+  data.tar.gz: 9818843a327f3ed3c4a46548db1dc8e9b2c706824716749d7a173563a752d6ae
 SHA512:
-  metadata.gz: 99661d14543918c21a988bd1c4cffc1d5c9d73a852a95c16b0905b5ddde312dc986d970b4082921752cd2eac4d786a0ae37f42f3577fdea2df54c6de50376810
-  data.tar.gz: 6819d3babc4cb2a7ad1f76386e3d7e7f28886a989e6a31ef052ea87b3b226a6979cc1c2092653fa7aadadd34d3f8af9b268464c2a14c70f385b559ee8a13ca9a
+  metadata.gz: f5972a3213f3700659aa2d9ca602821f0cb443e9e56120b5e43485da6b0240a4b7b998dea1b0637b470ac098d0fab5c7ee7922b056eebfd08575c0177bc312d9
+  data.tar.gz: c58f0fdf37e46817eb28871e1136811b0dd2c2a12925948e461f286b47de8c2b3bae1ba06345956908ac09c859ad0d1fe284d10a2c2a019516ba07a134103d07

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## HEAD
 
+## 4.1.4
+
+- Fix: Net::ReadTimeout errors on `website.visit` are now retried by default (https://github.com/zombocom/rundoc/pull/103)
+- Fix: When a background process (`background.start`) does not exit cleanly, print its logs for help with debugging. (https://github.com/zombocom/rundoc/pull/104)
+
 ## 4.1.3
 
 - Fix: Internal error in `background.wait` introduced in 4.1.2 (https://github.com/zombocom/rundoc/pull/97)

data/lib/rundoc/cli.rb

@@ -176,8 +176,8 @@ module Rundoc
       Rundoc::CodeCommand::Background::ProcessSpawn.tasks.each do |name, task|
         next unless task.alive?
 
-        io.puts "Warning background task is still running, cleaning up: name: #{name}"
-        task.stop
+        io.puts "Warning background task is still running, cleaning up: `#{name}`"
+        task.stop(print_io: io)
       end
 
       if execution_context.output_dir.exist?

data/lib/rundoc/code_command/background/process_spawn.rb

@@ -45,16 +45,16 @@ class Rundoc::CodeCommand::Background
     attr_reader :log, :pid, :command
 
     def initialize(command, timeout: 5, log: Tempfile.new("log"), out: "2>&1")
-      @command = command
+      @original_command = command
       @timeout_value = timeout
-      @log_reference = log # https://twitter.com/schneems/status/1285289971083907075
+      @log_reference = log # Need to keep a reference to `Tempfile` or it will be deleted. Pathname does not retain the passed in reference
 
       @log = Pathname.new(log)
       @log.dirname.mkpath
       FileUtils.touch(@log)
       @pipe_output, @pipe_input = IO.pipe
 
-      @command = "/usr/bin/env bash -c #{@command.shellescape} >> #{@log} #{out}"
+      @command = "/usr/bin/env bash -c #{@original_command.shellescape} >> #{@log} #{out}"
       @pid = nil
     end
 
@@ -120,13 +120,15 @@ class Rundoc::CodeCommand::Background
       contents
     end
 
-    def stop
+    def stop(print_io: nil)
       return unless alive?
       @pipe_input.close
       Process.kill("TERM", -Process.getpgid(@pid))
       Process.wait(@pid)
     rescue Errno::ESRCH => e
       puts "Error stopping process (command: #{command}): #{e}"
+    ensure
+      print_io&.puts "Log contents for `#{command}`:\n#{@log.read}"
     end
 
     def check_alive!

data/lib/rundoc/code_command/website/driver.rb

@@ -6,7 +6,8 @@ class Rundoc::CodeCommand::Website
   class Driver
     attr_reader :session
 
-    def initialize(name:, url:, width: 1024, height: 720, visible: false)
+    def initialize(name:, url:, width: 1024, height: 720, visible: false, io: $stdout, read_timeout: 60)
+      @io = io
       browser_options = ::Selenium::WebDriver::Chrome::Options.new
       browser_options.args << "--headless" unless visible
       browser_options.args << "--disable-gpu" if Gem.win_platform?
@@ -15,7 +16,10 @@ class Rundoc::CodeCommand::Website
       @width = width
       @height = height
 
-      @driver = Capybara::Selenium::Driver.new(nil, browser: :chrome, options: browser_options)
+      client = Selenium::WebDriver::Remote::Http::Default.new
+      client.read_timeout = read_timeout
+
+      @driver = Capybara::Selenium::Driver.new(nil, browser: :chrome, options: browser_options, http_client: client)
       driver_name = :"rundoc_driver_#{name}"
       Capybara.register_driver(driver_name) do |app|
         @driver
@@ -24,8 +28,20 @@ class Rundoc::CodeCommand::Website
       @session = Capybara::Session.new(driver_name)
     end
 
-    def visit(url)
-      @session.visit(url)
+    def visit(url, max_attempts: 3, delay: 1)
+      attempts = 0
+      begin
+        @session.visit(url)
+      rescue ::Net::ReadTimeout => e
+        attempts += 1
+        if attempts > max_attempts
+          raise e
+        else
+          @io.puts "Error visiting url (#{attempts}/#{max_attempts}) `#{url}`:\n#{e}"
+          sleep delay
+          retry
+        end
+      end
     end
 
     def timestamp
@@ -54,7 +70,7 @@ class Rundoc::CodeCommand::Website
       msg = +""
       msg << "Error running code #{code.inspect} at #{current_url.inspect}\n"
       msg << "saving a screenshot to: `tmp/error.png`"
-      puts msg
+      @io.puts msg
       error_path = env[:context].screenshots_dir.join("error.png")
       session.save_screenshot(error_path)
       raise e
@@ -66,13 +82,13 @@ class Rundoc::CodeCommand::Website
       file_name = self.class.next_screenshot_name
       file_path = screenshots_dir.join(file_name)
       session.save_screenshot(file_path)
-      puts "Screenshot saved to #{file_path}"
+      @io.puts "Screenshot saved to #{file_path}"
 
       return file_path unless upload
 
       case upload
       when "s3", "aws"
-        puts "Uploading screenshot to S3"
+        @io.puts "Uploading screenshot to S3"
         require "aws-sdk-s3"
         ENV.fetch("AWS_ACCESS_KEY_ID")
         s3 = Aws::S3::Resource.new(region: ENV.fetch("AWS_REGION"))

data/lib/rundoc/code_command/website/visit.rb

@@ -2,13 +2,14 @@
 
 class Rundoc::CodeCommand::Website
   class Visit < Rundoc::CodeCommand
-    def initialize(name:, url: nil, scroll: nil, height: 720, width: 1024, visible: false)
+    def initialize(name:, url: nil, scroll: nil, height: 720, width: 1024, visible: false, max_attempts: 3)
       @name = name
       @url = url
       @scroll = scroll
       @height = height
       @width = width
       @visible = visible
+      @max_attempts = max_attempts
     end
 
     def driver
@@ -33,7 +34,7 @@ class Rundoc::CodeCommand::Website
 
       puts message
 
-      driver.visit(@url) if @url
+      driver.visit(@url, max_attempts: @max_attempts) if @url
       driver.scroll(@scroll) if @scroll
 
       return "" if contents.nil? || contents.empty?

data/lib/rundoc/version.rb

@@ -1,3 +1,3 @@
 module Rundoc
-  VERSION = "4.1.3"
+  VERSION = "4.1.4"
 end

data/test/integration/background_stdin_test.rb

@@ -6,21 +6,7 @@ class BackgroundStdinTest < Minitest::Test
       Dir.chdir(dir) do
         dir = Pathname(dir)
         script = dir.join("script.rb")
-        script.write <<~'EOF'
-          $stdout.sync = true
-
-          print "> "
-          while line = gets
-            puts line
-            if line.strip == "exit"
-              puts "Bye"
-              return
-            else
-              puts "You said: #{line}"
-            end
-            print "> "
-          end
-        EOF
+        script.write loop_script
 
         source_path = dir.join("RUNDOC.md")
         source_path.write <<~EOF
@@ -54,4 +40,68 @@ class BackgroundStdinTest < Minitest::Test
       end
     end
   end
+
+  def test_print_output_on_exit
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        dir = Pathname(dir)
+        script = dir.join("script.rb")
+        script.write loop_script
+
+        source_path = dir.join("RUNDOC.md")
+        source_path.write <<~EOF
+          ```
+          :::-- background.start("ruby #{script}",
+            name: "background_ungraceful_exit",
+            wait: ">",
+            timeout: 15
+          )
+          :::-- background.stdin_write("hello", name: "background_ungraceful_exit", wait: "hello")
+          ```
+        EOF
+
+        io = StringIO.new
+        Rundoc::CLI.new(
+          io: io,
+          source_path: source_path,
+          on_success_dir: dir.join(SUCCESS_DIRNAME)
+        ).call
+
+        logs = io.string
+
+        match_after = partition_match_after(actual: logs, include_str: "Warning background task is still running, cleaning up: `background_ungraceful_exit`")
+        match_after = partition_match_after(actual: match_after, include_str: "Log contents for `/usr/bin/env bash -c")
+        partition_match_after(actual: match_after, include_str: "> hello")
+      end
+    end
+  end
+
+  # Finds the include_str if it exists or raises an error
+  # Returns the contents of that string and everything after it
+  #
+  # Used to handle the case where output might be in the logs twice and we want to verify the order
+  def partition_match_after(actual:, include_str:)
+    _before, match, after = actual.partition(include_str)
+    found = match && !match.empty?
+    assert found, "Expected to find `#{include_str}` in output, but did not. Output:\n#{actual}"
+    [match, after].join
+  end
+
+  def loop_script
+    <<~'EOF'
+      $stdout.sync = true
+
+      print "> "
+      while line = gets
+        puts line
+        if line.strip == "exit"
+          puts "Bye"
+          return
+        else
+          puts "You said: #{line}"
+        end
+        print "> "
+      end
+    EOF
+  end
 end

data/test/integration/website_test.rb

@@ -34,4 +34,23 @@ class IntegrationWebsiteTest < Minitest::Test
       end
     end
   end
+
+  def test_retry_client_closed_early
+    tcp_unexpected_exit do |port|
+      io = StringIO.new
+      driver = Rundoc::CodeCommand::Website::Driver.new(name: SecureRandom.hex, url: nil, read_timeout: 0.1, io: io)
+      assert_raises(Net::ReadTimeout) do
+        driver.visit("http://localhost:#{port}", max_attempts: 3, delay: 0)
+      end
+
+      logs = io.string
+      assert_logs_include(logs: logs, include_str: "Error visiting url (1/3)")
+      assert_logs_include(logs: logs, include_str: "Error visiting url (2/3)")
+      assert_logs_include(logs: logs, include_str: "Error visiting url (3/3)")
+    end
+  end
+
+  def assert_logs_include(logs:, include_str:)
+    assert logs.include?(include_str), "Expected logs to include #{include_str} but they didnt. Logs:\n#{logs}"
+  end
 end

data/test/rundoc/code_commands/background_test.rb

@@ -88,6 +88,8 @@ class BackgroundTest < Minitest::Test
 
         run!("echo 'bar' >> #{file}")
 
+        background_start.background.wait("bar")
+
         log_read = Rundoc::CodeCommand::Background::Log::Read.new(name: "tail")
         output = log_read.call
 

data/test/test_helper.rb

@@ -9,6 +9,8 @@ require "rundoc"
 require "minitest/autorun"
 require "mocha/minitest"
 require "tmpdir"
+require "socket"
+require "timeout"
 
 class Minitest::Test
   SUCCESS_DIRNAME = Rundoc::CLI::DEFAULTS::ON_SUCCESS_DIR
@@ -81,4 +83,30 @@ class Minitest::Test
 
     attr_reader :value
   end
+
+  # Yields port, exits unexpectedly
+  def tcp_unexpected_exit(timeout: 30)
+    Timeout.timeout(timeout) do
+      threads = []
+      server = TCPServer.new("127.0.0.1", 0)
+      port = server.addr[1]
+      threads << Thread.new do
+        # Accept one connection, then raise an error to simulate unexpected close
+        server.accept
+        raise "Unexpected server error!"
+      rescue
+        # Simulate crash, but let ensure run
+      end.tap { |t| t.abort_on_exception = false }
+
+      threads << Thread.new do
+        yield port
+      end
+
+      while threads.all?(&:alive?)
+        sleep 0.1
+      end
+    ensure
+      server.close if server && !server.closed?
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rundoc
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.1.4
 platform: ruby
 authors:
 - Richard Schneeman
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -288,7 +287,6 @@ homepage: https://github.com/schneems/rundoc
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -303,8 +301,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: RunDOC generates runable code from docs
 test_files: []