expedite 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da93957645e66819877d4c8638d2d42eb4880c631d6b4f8f224a3a9502c45a36
-  data.tar.gz: 179e78a453744f0375f6b184ffa1a2cff321b7ab92deafc9be5297fb00c63c4b
+  metadata.gz: '0218f397835f80f748b0c255e8097aad9b8e8063122d15415a19f88e35546335'
+  data.tar.gz: 643e16d53333346a199595b2cb9fcab21116f53c606a505a40675d6ca074baaf
 SHA512:
-  metadata.gz: 8cf3e2d403eab2d5cb7960a1d5cc43a4f94c3d0495ce36b360d32ec77ad7e5f9887a0e7aca183afa2e441ac3ff23a555ec6254f8441d971783376bdfc84db471
-  data.tar.gz: 30f00102d8d8c6cc59f138841caa116421f3002871551dca20718dfc5100aec80f469e8bb31b1d1ee8158020852090b2c053bff5d5fd7c9c728fdc26e4c3c6d0
+  metadata.gz: c27ae0ac8775724ae0da4983e2f4ec04754e1cacd29bd632043c36f2c7634dd3914b92fc2e9d15f0b263418fdf0813e4d34aef7d4191fa0b14c368fed4993fb9
+  data.tar.gz: '09d8bdf813c976cffe6bfb3c2a6a31f14f1e0e1e6577a06a8e67e2be66271dc09a1180723bda57e1fa91a891f152f0316c5d893f795357d33ba090139782b6aa'

data/lib/expedite/client/base.rb

@@ -0,0 +1,165 @@
+require 'socket'
+
+require 'expedite/env'
+require 'expedite/errors'
+require 'expedite/protocol'
+
+module Expedite
+  module Client
+    class Base
+      CONNECT_TIMEOUT   = 1
+      BOOT_TIMEOUT      = 20
+
+      attr_reader :args, :env, :agent
+      attr_reader :server
+
+      def initialize(env: nil, agent: nil)
+        @env = env || Env.new
+        @agent = agent
+
+        @server_booted = false
+      end
+
+      def call(*args)
+        begin
+          connect
+        rescue Errno::ENOENT, Errno::ECONNRESET, Errno::ECONNREFUSED
+          boot_server
+          connect
+        end
+
+        perform(*args)
+      ensure
+        server.close if server
+      end
+
+      def perform(*args)
+        verify_server_version
+
+        agent, client = UNIXSocket.pair
+        connect_to_agent(client, args)
+        run_command(client, agent, args)
+      end
+
+      def verify_server_version
+        server_version = server.gets.chomp
+        raise ArgumentError, "Server mismatch. Expected #{env.version}, got #{server_version}." if server_version != env.version
+      end
+
+      def connect_to_agent(client, args)
+        server.send_io client
+
+        server.send_object({"args" => args, "agent" => agent}, env)
+
+        if IO.select([server], [], [], CONNECT_TIMEOUT)
+          server.gets or raise CommandNotFound
+        else
+          raise "Error connecting to Expedite server"
+        end
+      end
+
+      def run_command(client, agent, args)
+        log "sending command"
+
+        agent.send_io STDOUT
+        agent.send_io STDERR
+        agent.send_io STDIN
+
+        agent.send_object({
+          "args" => args,
+          "env" => ENV.to_hash,
+          "method" => run_command_method,
+        }, env)
+
+        pid = server.gets
+        pid = pid.chomp if pid
+
+        # We must not close the client socket until we are sure that the application has
+        # received the FD. Otherwise the FD can end up getting closed while it's in the server
+        # socket buffer on OS X. This doesn't happen on Linux.
+        client.close
+
+        if pid && !pid.empty?
+          log "got pid: #{pid}"
+
+          ## suspend_resume_on_tstp_cont(pid)
+
+          ## forward_signals(application)
+          result = agent.recv_object
+          if result.key?("exception")
+            e = result["exception"]
+            log "got exception #{e}"
+            raise e
+          end
+
+          ret = result["return"]
+          log "got return value #{ret}"
+          return ret
+        else
+          log "got no pid"
+          raise UnknownError, "got no pid"
+        end
+      ensure
+        agent.close
+      end
+
+      def boot_server
+        env.socket_path.unlink if env.socket_path.exist?
+
+        pid     = Process.spawn(gem_env, env.server_command, out: File::NULL)
+        timeout = Time.now + BOOT_TIMEOUT
+
+        @server_booted = true
+
+        until env.socket_path.exist?
+          _, status = Process.waitpid2(pid, Process::WNOHANG)
+
+          if status
+            # Server did not start
+            raise ArgumentError, "Server exited: #{status.exitstatus}"
+          elsif Time.now > timeout
+            $stderr.puts "Starting Expedite server with `#{env.server_command}` " \
+                         "timed out after #{BOOT_TIMEOUT} seconds"
+            exit 1
+          end
+
+          sleep 0.1
+        end
+      end
+
+      def server_booted?
+        @server_booted
+      end
+
+      def stop_server
+        server.close
+        @server = nil
+        env.stop
+      end
+
+      def log(message)
+        env.log "[client] #{message}"
+      end
+
+      def connect
+        @server = UNIXSocket.open(env.socket_path)
+      end
+
+      def gem_env
+        bundle = Bundler.bundle_path.to_s
+        paths  = Gem.path + ENV["GEM_PATH"].to_s.split(File::PATH_SEPARATOR)
+
+        {
+          "GEM_PATH" => [bundle, *paths].uniq.join(File::PATH_SEPARATOR),
+          "GEM_HOME" => bundle
+        }
+      end
+
+
+    protected
+      def run_command_method
+        raise NotImplementedError, "run_command_method must be overriden"
+      end
+    end
+  end
+end

data/lib/expedite/client/exec.rb

@@ -1,18 +1,10 @@
 
 # Based on https://github.com/rails/spring/blob/master/lib/spring/client/run.rb
-
-require 'bundler'
-require 'rbconfig'
-require 'socket'
-
-require 'expedite/client/invoke'
-require 'expedite/env'
-require 'expedite/errors'
-require 'expedite/protocol'
+require 'expedite/client/base'
 
 module Expedite
   module Client
-    class Exec < Invoke
+    class Exec < Base
       FORWARDED_SIGNALS = %w(INT QUIT USR1 USR2 INFO WINCH) & Signal.list.keys
 
       def initialize(env: nil, agent: nil)
@@ -128,6 +120,11 @@ module Expedite
         application.puts(sig)
         application.gets.to_i
       end
+
+    protected
+      def run_command_method
+        "exec"
+      end
     end
   end
 end

data/lib/expedite/client/invoke.rb

@@ -1,158 +1,13 @@
 require 'socket'
 
-require 'expedite/env'
-require 'expedite/errors'
-require 'expedite/protocol'
+require 'expedite/client/base'
 
 module Expedite
   module Client
-    class Invoke
-      CONNECT_TIMEOUT   = 1
-      BOOT_TIMEOUT      = 20
-
-      attr_reader :args, :env, :agent
-      attr_reader :server
-
-      def initialize(env: nil, agent: nil)
-        @env = env || Env.new
-        @agent = agent
-
-        @server_booted = false
-      end
-
-      def call(*args)
-        begin
-          connect
-        rescue Errno::ENOENT, Errno::ECONNRESET, Errno::ECONNREFUSED
-          boot_server
-          connect
-        end
-
-        perform(*args)
-      ensure
-        server.close if server
-      end
-
-      def perform(*args)
-        verify_server_version
-
-        agent, client = UNIXSocket.pair
-        connect_to_agent(client, args)
-        run_command(client, agent, args)
-      end
-
-      def verify_server_version
-        server_version = server.gets.chomp
-        raise ArgumentError, "Server mismatch. Expected #{env.version}, got #{server_version}." if server_version != env.version
-      end
-
-      def connect_to_agent(client, args)
-        server.send_io client
-
-        server.send_object({"args" => args, "agent" => agent}, env)
-
-        if IO.select([server], [], [], CONNECT_TIMEOUT)
-          server.gets or raise CommandNotFound
-        else
-          raise "Error connecting to Expedite server"
-        end
-      end
-
-      def run_command(client, agent, args)
-        log "sending command"
-
-        agent.send_io STDOUT
-        agent.send_io STDERR
-        agent.send_io STDIN
-
-        agent.send_object({
-          "args" => args,
-          "env" => ENV.to_hash,
-          "method" => "invoke"
-        }, env)
-
-        pid = server.gets
-        pid = pid.chomp if pid
-
-        # We must not close the client socket until we are sure that the application has
-        # received the FD. Otherwise the FD can end up getting closed while it's in the server
-        # socket buffer on OS X. This doesn't happen on Linux.
-        client.close
-
-        if pid && !pid.empty?
-          log "got pid: #{pid}"
-
-          ## suspend_resume_on_tstp_cont(pid)
-
-          ## forward_signals(application)
-          result = agent.recv_object
-          if result.key?("exception")
-            e = result["exception"]
-            log "got exception #{e}"
-            raise e
-          end
-
-          ret = result["return"]
-          log "got return value #{ret}"
-          return ret
-        else
-          log "got no pid"
-          raise UnknownError, "got no pid"
-        end
-      ensure
-        agent.close
-      end
-
-      def boot_server
-        env.socket_path.unlink if env.socket_path.exist?
-
-        pid     = Process.spawn(gem_env, env.server_command, out: File::NULL)
-        timeout = Time.now + BOOT_TIMEOUT
-
-        @server_booted = true
-
-        until env.socket_path.exist?
-          _, status = Process.waitpid2(pid, Process::WNOHANG)
-
-          if status
-            # Server did not start
-            raise ArgumentError, "Server exited: #{status.exitstatus}"
-          elsif Time.now > timeout
-            $stderr.puts "Starting Expedite server with `#{env.server_command}` " \
-                         "timed out after #{BOOT_TIMEOUT} seconds"
-            exit 1
-          end
-
-          sleep 0.1
-        end
-      end
-
-      def server_booted?
-        @server_booted
-      end
-
-      def stop_server
-        server.close
-        @server = nil
-        env.stop
-      end
-
-      def log(message)
-        env.log "[client] #{message}"
-      end
-
-      def connect
-        @server = UNIXSocket.open(env.socket_path)
-      end
-
-      def gem_env
-        bundle = Bundler.bundle_path.to_s
-        paths  = Gem.path + ENV["GEM_PATH"].to_s.split(File::PATH_SEPARATOR)
-
-        {
-          "GEM_PATH" => [bundle, *paths].uniq.join(File::PATH_SEPARATOR),
-          "GEM_HOME" => bundle
-        }
+    class Invoke < Base
+    protected
+      def run_command_method
+        "invoke"
       end
     end
   end

data/lib/expedite/server/agent.rb

@@ -141,6 +141,7 @@ module Expedite
         preload unless preloaded?
 
         args, env, method = client.recv_object.values_at("args", "env", "method")
+        log "serve #{args} using #{method}"
 
         exec_name = args.shift
         action    = Expedite::Actions.lookup(exec_name)
@@ -149,6 +150,7 @@ module Expedite
         connect_database # why are we connecting prior? is this for invoke?
         pid = case method
         when "invoke"
+          # TODO: Invoke in a worker process instead of the preloader
           serve_invoke(client, action, args, env)
         else
           serve_fork(client, action, args, env)

data/lib/expedite/version.rb

@@ -1,3 +1,3 @@
 module Expedite
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expedite
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Bing-Chang Lai
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2022-12-17 00:00:00.000000000 Z
 dependencies: []
 description: Manages Ruby processes that can be used to spawn child processes faster.
 email: johnny.lai@me.com
@@ -29,6 +29,7 @@ files:
 - lib/expedite/cli/server.rb
 - lib/expedite/cli/status.rb
 - lib/expedite/cli/stop.rb
+- lib/expedite/client/base.rb
 - lib/expedite/client/exec.rb
 - lib/expedite/client/invoke.rb
 - lib/expedite/env.rb