zeus 0.15.10 → 0.15.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f28b5877e1a9f2d864f994db8ec997e2bfd2e88
-  data.tar.gz: 7e71058d4c5171c6992f5074e5f1df204392019f
+  metadata.gz: d0b6652301511b13e06a1b60dbb808cc5e2161a2
+  data.tar.gz: 4898481f7b4acec5828dfa25a2351d31b5f166b0
 SHA512:
-  metadata.gz: 4c369f05160ce2dbbb0b631af280f73bc19bdfa524109e03d33c9ef0216f33b0c47e1289d248e7d7b462c275d7960da72acfee86f2dd2c05f47682278cc0a4da
-  data.tar.gz: 266f75f0595297687016d2af1d7d7319f62f83a45a8ed815c56c73a2385bd40e46b75478c5f3221dc358a752283b1e0455abb4fe00bbbaefcc64d567db136c73
+  metadata.gz: 187015a45fdb160f364da8c1ee05de7577642e79d114ca0982f5409cc582cb02bb764a0b0074750d72fa492dd52782ad1b77580691963c1fb83900d13d703345
+  data.tar.gz: c837a56c542b72057a3dbc324bf42dbc4f8cd75080f6b211e01f7e83053d3f9f15470eedfc40310d313e2399a3a53f8382d28c9ac38a95ab21c86602b3c90729

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zeus (0.15.10)
+    zeus (0.15.12)
       method_source (>= 0.6.7)
 
 GEM
@@ -10,24 +10,24 @@ GEM
     coderay (1.1.1)
     diff-lcs (1.2.5)
     method_source (0.8.2)
-    pry (0.10.3)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (11.1.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
     slop (3.6.0)
 
 PLATFORMS
@@ -41,4 +41,4 @@ DEPENDENCIES
   zeus!
 
 BUNDLED WITH
-   1.12.3
+   1.13.7

data/examples/custom_plan/cucumber_plan.rb

@@ -9,6 +9,7 @@ require 'zeus/rails'
 
 class CucumberPlan < Zeus::Rails         
   def cucumber_environment
+    ::Rails.env = ENV['RAILS_ENV'] = 'test'
     require 'cucumber/rspec/disable_option_parser'
     require 'cucumber/cli/main'
     @cucumber_runtime = Cucumber::Runtime.new

data/lib/zeus.rb

@@ -69,7 +69,9 @@ module Zeus
           local.send_io(feature_pipe_r)
           feature_pipe_r.close
 
-          run_action(local, identifier, feature_pipe_w)
+          Zeus::LoadTracking.set_feature_pipe(feature_pipe_w)
+
+          run_action(local, identifier)
 
           # We are now 'connected'. From this point, we may receive requests to fork.
           children = Set.new
@@ -97,10 +99,16 @@ module Zeus
               elsif code == "S"
                 # Child, supposed to start another step:
                 @parent_pid = forked_from
+
+                Zeus::LoadTracking.clear_feature_pipe
+
                 throw(:boot_step, ident.to_sym)
               else
                 # Child, supposed to run a command:
                 @parent_pid = forked_from
+
+                Zeus::LoadTracking.clear_feature_pipe
+
                 return [ident.to_sym, local]
               end
             end
@@ -176,12 +184,6 @@ module Zeus
       }
     end
 
-    def notify_features(pipe, features)
-      features.each do |t|
-        pipe.puts t
-      end
-    end
-
     def report_error_to_master(local, error)
       str = "R:"
       str << "#{error.backtrace[0]}: #{error.message} (#{error.class})\n"
@@ -192,28 +194,18 @@ module Zeus
       local.write str
     end
 
-    def run_action(socket, identifier, feature_pipe_w)
+    def run_action(socket, identifier)
       # Now we run the action and report its success/fail status to the master.
-      features, err = Zeus::LoadTracking.features_loaded_by do
-        plan.after_fork unless identifier == :boot
-        plan.send(identifier)
-      end
-
-      if err
-        # If we received an error, report features to the master syncronously.
-        # We need to do this before reporting the error to the master
-        # otherwise it will kill us before we can report features.
-        begin
-          notify_features(feature_pipe_w, features)
-          feature_pipe_w.close
-        ensure
-          report_error_to_master(socket, err)
+      begin
+        Zeus::LoadTracking.track_features_loaded_by do
+          plan.after_fork unless identifier == :boot
+          plan.send(identifier)
         end
-      else
-        # If we booted successfully, report features in a new thread
-        # so we can immediately begin listening for commands.
+
         socket.write "R:OK\0"
-        Thread.new { notify_features(feature_pipe_w, features) }
+      rescue => err
+        report_error_to_master(socket, err)
+        raise
       end
     end
   end

data/lib/zeus/load_tracking.rb

@@ -1,8 +1,15 @@
 module Zeus
   class LoadTracking
     class << self
-      def features_loaded_by(&block)
-        old_features = all_features
+      def add_feature(file)
+        full_path = File.expand_path(file)
+        return unless File.exist?(full_path) && @feature_pipe
+        notify_features([full_path])
+      end
+
+      # Internal: This should only be called by Zeus code
+      def track_features_loaded_by
+        old_features = $LOADED_FEATURES.dup
 
         # Catch exceptions so we can determine the features
         # that were being loaded at the time of the exception.
@@ -14,48 +21,47 @@ module Zeus
           # the error is not in the backtrace, only the error message.
           match = /\A([^:]+):\d+: syntax error/.match(err.message)
           err_features << match[1] if match
-        rescue Exception => err
-          # Just capture this to add to the err_features list
-        end
+          raise
+        rescue ScriptError => err
+          raise
+        rescue => err
+          raise
+        ensure
+          if err && err.backtrace
+            err_features += err.backtrace.map { |b| b.split(':').first }
+                           .select { |f| f.start_with?('/') }
+                           .take_while { |f| f != __FILE__ }
+          end
 
-        if err && err.backtrace
-          err_features += err.backtrace.map { |b| b.split(':').first }
-                             .select { |f| f.start_with?('/') }
-                             .take_while { |f| f != __FILE__ }
+          notify_features(Set.new($LOADED_FEATURES) + err_features - old_features)
         end
-
-        new_features = all_features + err_features - old_features
-        new_features.uniq!
-
-        [new_features, err]
       end
 
-      # Check the load path first to see if the file getting loaded is already
-      # loaded. Otherwise, add the file to the $untracked_features array which
-      # then gets added to $LOADED_FEATURES array.
-      def add_feature(file)
-        full_path = File.expand_path(file)
-
-        if find_in_load_path(full_path) || File.exist?(full_path)
-          add_extra_feature(full_path)
-        end
+      # Internal: This should only be called by Zeus code
+      def set_feature_pipe(feature_pipe)
+        @feature_mutex = Mutex.new
+        @feature_pipe = feature_pipe
       end
 
-      # $LOADED_FEATURES global variable is used internally by Rubygems
-      def all_features
-        untracked = defined?($untracked_features) ? $untracked_features : []
-        $LOADED_FEATURES + untracked
+      # Internal: This should only be called by Zeus code
+      def clear_feature_pipe
+        @feature_pipe.close
+        @feature_pipe = nil
+        @feature_mutex = nil
       end
 
       private
 
-      def add_extra_feature(path)
-        $untracked_features ||= []
-        $untracked_features << path
-      end
+      def notify_features(features)
+        unless @feature_pipe
+          raise "Attempted to report features to Zeus when not running as part of a Zeus process"
+        end
 
-      def find_in_load_path(file_path)
-        $LOAD_PATH.detect { |path| path == file_path }
+        @feature_mutex.synchronize do
+          features.each do |t|
+            @feature_pipe.puts(t)
+          end
+        end
       end
     end
   end

data/lib/zeus/version.rb

@@ -1,3 +1,3 @@
 module Zeus
-  VERSION = "0.15.10"
+  VERSION = "0.15.12"
 end

data/man/build/zeus

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "ZEUS" "1" "January 2016" "" ""
+.TH "ZEUS" "1" "January 2017" "" ""
 .
 .SH "NAME"
 \fBzeus\fR \- boot rails in under a second

data/man/build/zeus-init

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "ZEUS\-INIT" "1" "January 2016" "" ""
+.TH "ZEUS\-INIT" "1" "January 2017" "" ""
 .
 .SH "NAME"
 \fBzeus\-init\fR \- Generate a template zeus\.json

data/man/build/zeus-init.txt

@@ -14,4 +14,4 @@ DESCRIPTION
 
 
 
-				 January 2016			  ZEUS-INIT(1)
+				 January 2017			  ZEUS-INIT(1)

data/man/build/zeus-start

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "ZEUS\-START" "1" "January 2016" "" ""
+.TH "ZEUS\-START" "1" "January 2017" "" ""
 .
 .SH "NAME"
 \fBzeus\-start\fR \- Start a zeus server

data/man/build/zeus-start.txt

@@ -15,4 +15,4 @@ DESCRIPTION
 
 
 
-				 January 2016			 ZEUS-START(1)
+				 January 2017			 ZEUS-START(1)

data/man/build/zeus.txt

@@ -75,4 +75,4 @@ BUILTIN COMMANDS
 
 
 
-				 January 2016			       ZEUS(1)
+				 January 2017			       ZEUS(1)

data/spec/assets/boot.rb

@@ -0,0 +1,2 @@
+# This is a single ruby file that doesn't do anything for testing Zeus
+# load tracking during boot.

data/spec/assets/boot_delayed.rb

@@ -0,0 +1,2 @@
+# This is a single ruby file that doesn't do anything for testing Zeus
+# load tracking after boot.

data/spec/load_tracking_spec.rb

@@ -6,55 +6,53 @@ describe "Zeus::LoadTracking" do
 
   class MyError < StandardError; end
 
-  describe '.add_feature' do
-    context 'already in load path' do
-      before do
-        # add the dir path of the tempfile to LOAD_PATH
-        $LOAD_PATH  << test_dirname
-      end
-
-      after { $LOAD_PATH.delete test_dirname }
-
-      it 'adds full filepath to $untracked_features' do
-        Zeus::LoadTracking.add_feature(test_filename)
+  def expect_to_load(expect_features, expect_err=NilClass)
+    buf = StringIO.new
+    Zeus::LoadTracking.set_feature_pipe(buf)
 
-        expect($untracked_features).to include(__dir__ + "/load_tracking_spec.rb")
+    begin
+      Zeus::LoadTracking.track_features_loaded_by do
+        yield
       end
+    rescue ScriptError => err
+    rescue => err
     end
 
-    context 'not in load path' do
-      it 'adds full filepath to $untracked_features' do
-        Zeus::LoadTracking.add_feature(test_filename)
+    expect(err).to be_instance_of(expect_err)
+    expect(buf.string.strip.split("\n").sort).to eq(expect_features.sort)
+  end
 
-        expect($untracked_features).to include(__dir__ + "/load_tracking_spec.rb")
-      end
-    end
+  def expand_asset_path(path)
+    File.join(__dir__, 'assets', path)
+  end
 
-    context '.features_loaded_by' do
-      it 'returns list of new files loaded when block executes' do
-        new_files, = Zeus::LoadTracking.features_loaded_by do
-          $untracked_features << "an_untracked_feature.rb"
-        end
+  describe '.add_feature' do
+    it 'tracks full filepath' do
+      relative_path = Pathname.new(test_filename).relative_path_from(Pathname.new(Dir.pwd)).to_s
 
-        expect(new_files).to eq(["an_untracked_feature.rb"])
+      expect_to_load([test_filename]) do
+        Zeus::LoadTracking.add_feature(relative_path)
       end
     end
-  end
 
-  describe '.features_loaded_by' do
-    def expect_to_load(expect_features, expect_err=NilClass)
-      new_files, err = Zeus::LoadTracking.features_loaded_by do
-        yield
-      end
+    it 'tracks loads' do
+      target = expand_asset_path('load.rb')
+
+      # The first `load` in Travis also pulls enc/trans/single_byte.so from the
+      # Ruby VM for some reason. Loading twice is harmless since this file is empty.
+      load(target)
 
-      expect(new_files.sort).to eq(expect_features.sort)
-      expect(err).to be_instance_of(expect_err)
+      expect_to_load([target]) do
+        load(target)
+      end
     end
 
-    def expand_asset_path(path)
-      File.join(__dir__, 'assets', path)
+    it 'does not error outside a tracking block without Zeus configured' do
+      Zeus::LoadTracking.add_feature(test_filename)
     end
+  end
 
+  describe '.track_features_loaded_by' do
     context 'loading valid code' do
       it 'tracks successful require_relative' do
         expect_to_load([expand_asset_path('require_relative.rb')]) do
@@ -67,35 +65,29 @@ describe "Zeus::LoadTracking" do
           require expand_asset_path('require')
         end
       end
-
-      it 'tracks loads' do
-        expect_to_load([expand_asset_path('load.rb')]) do
-          load expand_asset_path('load.rb')
-        end
-      end
     end
 
     context 'loading invalid code' do
       it 'tracks requires that raise a SyntaxError' do
-        expect_to_load([expand_asset_path('invalid_syntax.rb')], SyntaxError) do
+        files = [expand_asset_path('invalid_syntax.rb')]
+        # SyntaxError does not have a backtrace in 2.3+ (https://bugs.ruby-lang.org/issues/12811)
+        if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3.0')
+          files << test_filename
+        end
+
+        expect_to_load(files, SyntaxError) do
           require expand_asset_path('invalid_syntax')
         end
       end
 
       it 'tracks requires that raise a RuntimeError' do
-        expect_to_load([expand_asset_path('runtime_error.rb')], RuntimeError) do
+        expect_to_load([test_filename, expand_asset_path('runtime_error.rb')], RuntimeError) do
           require expand_asset_path('runtime_error')
         end
       end
 
-      it 'tracks requires that exit' do
-        expect_to_load([expand_asset_path('exit.rb')], SystemExit) do
-          require expand_asset_path('exit')
-        end
-      end
-
       it 'tracks requires that throw in a method call' do
-        expect_to_load([expand_asset_path('raise.rb')], MyError) do
+        expect_to_load([test_filename, expand_asset_path('raise.rb')], MyError) do
           require expand_asset_path('raise')
           raise_it(MyError)
         end

data/spec/zeus_spec.rb

@@ -0,0 +1,85 @@
+require 'zeus'
+
+describe Zeus do
+  class MyTestPlan < Zeus::Plan
+    def self.mutex
+      @mutex ||= Mutex.new
+    end
+
+    def self.boot
+      require_relative 'assets/boot'
+      Thread.new do
+        mutex.synchronize do
+          Zeus::LoadTracking.add_feature(File.join(__dir__, 'assets', 'boot_delayed.rb'))
+        end
+      end
+    end
+  end
+
+  Zeus.plan = MyTestPlan
+
+  before do
+    MyTestPlan.mutex.lock
+  end
+
+  after do
+    MyTestPlan.mutex.unlock if MyTestPlan.mutex.locked?
+  end
+
+  context 'booting' do
+    before do
+      # Don't reopen STDOUT
+      Zeus.dummy_tty = true
+    end
+
+    it 'boots and tracks features' do
+      master_r, master_w = UNIXSocket.pair(Socket::SOCK_STREAM)
+      ENV['ZEUS_MASTER_FD'] = master_w.to_i.to_s
+
+      thr = Thread.new do
+        begin
+          Zeus.go
+        rescue Interrupt
+          return
+        rescue => e
+          STDERR.puts "Zeus terminated with exception: #{e.message}"
+          STDERR.puts e.backtrace.map {|line| " #{line}"}
+        end
+      end
+
+      begin
+        # Receive the control IO and start message
+        ctrl_io = master_r.recv_io(UNIXSocket)
+        begin
+          # We use recv instead of readline on the UNIXSocket to avoid
+          # converting it to a buffered reader. That seems to interact
+          # badly with passing file descriptors around on Linux.
+          proc_msg = "P:#{Process.pid}:0:boot\0"
+          expect(ctrl_io.recv(proc_msg.length)).to eq(proc_msg)
+
+          feature_io = ctrl_io.recv_io
+
+          ready_msg = "R:OK\0"
+          expect(ctrl_io.recv(ready_msg.length)).to eq(ready_msg)
+          begin
+            # We should receive the synchronously required feature immediately
+            expect(feature_io.readline).to eq(File.join(__dir__, 'assets', 'boot.rb') + "\n")
+
+            # We should receive the delayed feature after unlocking its mutex
+            MyTestPlan.mutex.unlock
+            expect(feature_io.readline).to eq(File.join(__dir__, 'assets', 'boot_delayed.rb') + "\n")
+          ensure
+            feature_io.close
+          end
+        ensure
+          ctrl_io.close
+        end
+      ensure
+        thr.raise(Interrupt.new)
+      end
+    end
+
+    it 'tracks features after booting has completed' do
+    end
+  end
+end

data/zeus.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["burke@libbey.me"]
   gem.description   = %q{Boot any rails app in under a second}
   gem.summary       = %q{Zeus is an intelligent preloader for ruby applications. It allows normal development tasks to be run in a fraction of a second.}
-  gem.homepage      = "http://zeus.is"
+  gem.homepage      = "https://github.com/burke/zeus"
 
   gem.files         = files
   gem.extensions    = []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeus
 version: !ruby/object:Gem::Version
-  version: 0.15.10
+  version: 0.15.12
 platform: ruby
 authors:
 - Burke Libbey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -75,7 +75,8 @@ files:
 - man/build/zeus-start
 - man/build/zeus-start.txt
 - man/build/zeus.txt
-- spec/assets/exit.rb
+- spec/assets/boot.rb
+- spec/assets/boot_delayed.rb
 - spec/assets/invalid_syntax.rb
 - spec/assets/load.rb
 - spec/assets/raise.rb
@@ -87,8 +88,9 @@ files:
 - spec/load_tracking_spec.rb
 - spec/m_spec.rb
 - spec/rails_spec.rb
+- spec/zeus_spec.rb
 - zeus.gemspec
-homepage: http://zeus.is
+homepage: https://github.com/burke/zeus
 licenses:
 - MIT
 metadata: {}
@@ -108,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Zeus is an intelligent preloader for ruby applications. It allows normal

data/spec/assets/exit.rb

@@ -1 +0,0 @@
-exit(1)