smart_proxy_dynflow 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8852c64e45de97691310f1c9fd17bef228a9ea87db2085377cee1cd404546752
-  data.tar.gz: 54afa19849d245f44f8d5e03c69d82e30015ff95978b266cad0db3919eb82195
+  metadata.gz: 6444ef5fcad649ae35d106b149f2832ea50c4cbbf9d6a1be7575332e9585fe8b
+  data.tar.gz: 587ed9c21c9c0dd3e320e29c28eb3cf76904aa3222c901979fc8e29023630f16
 SHA512:
-  metadata.gz: 4a1799f87c74aa10807ea642d217686f208fe2de5444b4a87c540a8685e419d4c88b272e03faa83a9756fa7ef4e996f3cd8195f730ae43e97800e4666fecae59
-  data.tar.gz: ab1dd31d7555502d566803ba4e87965e2431bb6d32c67cc6e0e39f7ac1c6c5369e22b1b6c7f6e3abb8cfdcccf6b4432029ba10b277171931f6a5fa05ed792d8d
+  metadata.gz: 4b27f6de4ae4353b6fdb45334b920b66bea2de0dce26af6c4f52855e9e28641acd9ec917e8d313b8aafb9c70f7077fa9223417d943e9ac2a30d6c05995d66e0a
+  data.tar.gz: e0877874c73541ab78d2957693202959bbffce5771ff71c9f1bee0664c5f78bf180addece3668206662e70cf08481d3586ff88f82eef3fc293d9a837ccfca75d

data/lib/smart_proxy_dynflow/api.rb

@@ -36,7 +36,8 @@ module Proxy
 
       post "/tasks/launch/?" do
         params = MultiJson.load(request.body.read)
-        launcher = launcher_class(params).new(world, callback_host(params, request), params.fetch('options', {}))
+        first_params = params['input']&.values&.first || {}
+        launcher = launcher_class(params).new(world, callback_host(first_params, request), params.fetch('options', {}))
         launcher.launch!(params['input'])
         launcher.results.to_json
       end
@@ -72,8 +73,13 @@ module Proxy
       private
 
       def callback_host(params, request)
-        params.fetch('action_input', {})['proxy_url'] ||
-          request.env.values_at('HTTP_X_FORWARDED_FOR', 'HTTP_HOST').compact.first
+        params.fetch('action_input', {})['proxy_url'] || callback_host_from_env(request)
+      end
+
+      def callback_host_from_env(request)
+        protocol = %w[yes on 1].include?(request.env['HTTPS'].to_s) ? 'https' : 'http'
+        host = request.env.values_at('HTTP_X_FORWARDED_FOR', 'HTTP_HOST').compact.first
+        "#{protocol}://#{host}"
       end
 
       def launcher_class(params)

data/lib/smart_proxy_dynflow/core.rb

@@ -28,8 +28,8 @@ module Proxy::Dynflow
 
       db_file = Settings.instance.database
       if db_file.nil? || db_file.empty?
-        Log.instance.warn "Could not open DB for dynflow at '#{db_file}', " \
-                          "will keep data in memory. Restart will drop all dynflow data."
+        Log.instance.info "Using in-memory database (default behaviour). Restart will drop all dynflow data. " \
+                          "To change this behaviour configure setting 'database'."
       else
         FileUtils.mkdir_p(File.dirname(db_file))
         db_conn_string += "/#{db_file}"

data/lib/smart_proxy_dynflow/process_manager.rb

@@ -76,12 +76,12 @@ module Proxy
         out_read, out_write = IO.pipe
         err_read, err_write = IO.pipe
 
-        @pid = spawn(*@command, :in => in_read, :out => out_write, :err => err_write)
-        [in_read, out_write, err_write].each(&:close)
-
         @stdin.io  = in_write
         @stdout.io = out_read
         @stderr.io = err_read
+
+        @pid = spawn(*@command, :in => in_read, :out => out_write, :err => err_write)
+        [in_read, out_write, err_write].each(&:close)
       rescue Errno::ENOENT => e
         [in_read, in_write, out_read, out_write, err_read, err_write].each(&:close)
         @pid = -1
@@ -158,8 +158,10 @@ module Proxy
       # @return [void]
       def finish
         close
-        _pid, status = Process.wait2(@pid)
-        @status = status.exitstatus
+        unless @pid == -1
+          _pid, status = Process.wait2(@pid)
+          @status = status.exitstatus
+        end
       end
     end
   end

data/lib/smart_proxy_dynflow/runner/command.rb

@@ -1,5 +1,18 @@
 module Proxy::Dynflow
   module Runner
+    # This module expects to be included into a Runner action, where it can be
+    # used to simplify handling of long-running processes. However it tracks the
+    # running process as a group of instance variables, which has served us
+    # reasonably well in the past, but can be rather error prone.
+    #
+    # A better alternative to this is
+    # {::Proxy::Dynflow::Runner::ProcessManagerCommand}. It tracks the whole
+    # execution of a process under a single instance variable and uses a more
+    # robust {::Proxy::Dynflow::ProcessManager} under the hood. It also
+    # maintains the same interface and can be used as a drop-in replacement.
+    #
+    # This module is now soft-deprecated and
+    # {::Proxy::Dynflow::Runner::ProcessManagerCommand} should be used instead.
     module Command
       def initialize_command(*command)
         @command_out, @command_in, @command_pid = PTY.spawn(*command)

data/lib/smart_proxy_dynflow/runner/command_runner.rb

@@ -4,6 +4,7 @@ require 'smart_proxy_dynflow/runner/command'
 
 module Proxy::Dynflow
   module Runner
+    # This class is now soft-deprecated, see {::Proxy::Dynflow::Runner::Command}
     class CommandRunner < Base
       include Command
     end

data/lib/smart_proxy_dynflow/runner/process_manager_command.rb

@@ -2,13 +2,21 @@ require 'smart_proxy_dynflow/process_manager'
 
 module Proxy::Dynflow
   module Runner
+    # A convenience module which should be included into a Runner action. It
+    # leverages {::Proxy::Dynflow::ProcessManager} to reliably keep track of
+    # an external process and collect its output.
+    #
+    # The only expectation from the Runner action is to call
+    # {#initialize_command} somewhere and pass the command to be run to it.
     module ProcessManagerCommand
       def initialize_command(*command)
         @process_manager = ProcessManager.new(command)
         set_process_manager_callbacks(@process_manager)
         @process_manager.start!
         if @process_manager.done? && @process_manager.status == 255
-          publish_exception("Error running command '#{command.join(' ')}'", @process_manager.stderr.to_s)
+          exception = RuntimeError.new(@process_manager.stderr.to_s)
+          exception.set_backtrace Thread.current.backtrace
+          publish_exception("Error running command '#{command.join(' ')}'", exception)
         end
       end
 
@@ -24,7 +32,7 @@ module Proxy::Dynflow
       end
 
       def refresh
-        @process_manager.process(timeout: 0.1)
+        @process_manager.process(timeout: 0.1) unless @process_manager.done?
         publish_exit_status(@process_manager.status) if @process_manager.done?
       end
 

data/lib/smart_proxy_dynflow/version.rb

@@ -1,5 +1,5 @@
 module Proxy
   module Dynflow
-    VERSION = '0.8.0'.freeze
+    VERSION = '0.8.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_dynflow
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-01 00:00:00.000000000 Z
+date: 2022-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.3.20
 signing_key:
 specification_version: 4
 summary: Dynflow runtime for Foreman smart proxy