headless 2.2.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef56937376649ddec958dd8ebb7115513e7d2519
-  data.tar.gz: 0af69d915022f127ce0f330cb85d5f8af3ee5cbd
+  metadata.gz: 93e191ea69ebabc46da9431bff74b33ccbf646c9
+  data.tar.gz: 68b29362c47b8e776153638f187c62f467fdd422
 SHA512:
-  metadata.gz: ff4dbb75ff3a1c1ee0d91d4a8f4d199302957b2c0a124dbf1617a5ddd7c4bf4076f25ea068241e93876864baeea80f4df288d836b538be5770674ed77d161974
-  data.tar.gz: 9f08e6ca9518a5eb39760739be39bdf1ab9a5063ce43e475607d87dc35da03b15b9a26a33f459d5f52f4a9b981f05b2fc1aa6a6937b007a73462502ce7981b82
+  metadata.gz: 757f8e09da108796a51bc6b823fe8b4ab67e8d4f900ff11dcdccbfe1434a0ca5bb5cda1a28c4cdc98a49664081512fbe5c57ca54ddc21e0a797b53b1b30eca40
+  data.tar.gz: cde1f7f928582f1f6c6f90a0b06a5c1389b2ca66f682ad78a141294bfbfa4df9666ee87c2df2be1283c9fdeb3d8a3fe2f0e7a6dceadb9638b206df5198c60b12

data/.travis.yml

@@ -6,4 +6,5 @@ rvm:
 before_install:
   - "sudo apt-get update"
   - "sudo apt-get install -y firefox xvfb libav-tools"
+  - "gem install bundler"
 script: "rspec"

data/CHANGELOG

@@ -1,3 +1,7 @@
+## 2.2.3 (2016-03-17)
+
+* Fix race condition when starting Xvfb [#75] (from @NfNitLoop)
+
 ## 2.2.2 (2016-02-08)
 
 * Fix file permissions issue with gem. No actual changes

data/headless.gemspec

@@ -1,9 +1,9 @@
-spec = Gem::Specification.new do |s|
+Gem::Specification.new do |s|
   s.author = 'Leonid Shevtsov'
   s.email = 'leonid@shevtsov.me'
 
   s.name = 'headless'
-  s.version = '2.2.2'
+  s.version = '2.2.3'
   s.summary = 'Ruby headless display interface'
   s.license = 'MIT'
 
@@ -16,6 +16,6 @@ spec = Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency "rspec", "~> 3"
-  s.add_development_dependency "selenium-webdriver"
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'selenium-webdriver'
 end

data/lib/headless.rb

@@ -83,6 +83,7 @@ class Headless
     @dimensions = options.fetch(:dimensions, DEFAULT_DISPLAY_DIMENSIONS)
     @video_capture_options = options.fetch(:video, {})
     @destroy_at_exit = options.fetch(:destroy_at_exit, true)
+    @pid = nil # the pid of the running Xvfb process
 
     # FIXME Xvfb launch should not happen inside the constructor
     attach_xvfb
@@ -176,16 +177,18 @@ private
 
   def launch_xvfb
     out_pipe, in_pipe = IO.pipe
-    pid = Process.spawn(
+    @pid = Process.spawn(
       CliUtil.path_to("Xvfb"), ":#{display}", "-screen", "0", dimensions, "-ac",
       err: in_pipe)
-    in_pipe.close
-    raise Headless::Exception.new("Xvfb did not launch - something's wrong") unless pid
-    ensure_xvfb_is_running(out_pipe)
-    return true
+    raise Headless::Exception.new("Xvfb did not launch - something's wrong") unless @pid
+    # According to docs, you should either wait or detach on spawned procs:
+    Process.detach @pid
+    return ensure_xvfb_launched(out_pipe)
+    ensure
+      in_pipe.close
   end
 
-  def ensure_xvfb_is_running(out_pipe)
+  def ensure_xvfb_launched(out_pipe)
     start_time = Time.now
     errors = ""
     begin
@@ -194,18 +197,30 @@ private
         if errors.include? "Cannot establish any listening sockets"
           raise Headless::Exception.new("Display socket is taken but lock file is missing - check the Headless troubleshooting guide")
         end
+        if errors.include? "Server is already active for display #{display}"
+          # This can happen if there is a race to grab the lock file.
+          # Not an exception, just return false to let pick_available_display choose another:
+          return false
+        end
       rescue IO::WaitReadable
         # will retry next cycle
       end
       sleep 0.01 # to avoid cpu hogging
       raise Headless::Exception.new("Xvfb launched but did not complete initialization") if (Time.now-start_time)>=@xvfb_launch_timeout
+    # Continue looping until Xvfb has written its pidfile:
     end while !xvfb_running?
+
+    # If for any reason the pid file doesn't match ours, we lost the race to
+    # get the file lock:
+    return @pid == read_xvfb_pid
   end
 
   def xvfb_mine?
     CliUtil.process_mine?(read_xvfb_pid)
   end
 
+  # Check whether an Xvfb process is running on @display.
+  # NOTE: This might be a process started by someone else!
   def xvfb_running?
     (pid = read_xvfb_pid) && CliUtil.process_running?(pid)
   end

data/spec/headless_spec.rb

@@ -8,7 +8,7 @@ describe Headless do
 
   describe 'launch options' do
     before do
-      allow_any_instance_of(Headless).to receive(:ensure_xvfb_is_running).and_return(true)
+      allow_any_instance_of(Headless).to receive(:ensure_xvfb_launched).and_return(true)
     end
 
     it "starts Xvfb" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headless
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Leonid Shevtsov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2016-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake