vagrant-listen-server 0.0.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a30b9bb31559cff8314063a36ebbe2b42f041504
-  data.tar.gz: f19e8fe12f1e3700841cb95a4caf7ecbfe0334cc
+  metadata.gz: 2cdf2e1170398757ee77d0f77d7366215c800ac8
+  data.tar.gz: a9de6204420690db4cfe7a98ebc3827a43c75eaa
 SHA512:
-  metadata.gz: c1b0dda84cc0a2a0951f4f3b6810bdf8dc7ead5d5ab2b1c55939190c41a710198757d63e14550ebae86e612e640974c390d3ee8c0bb61719a2f7a5298f54ba86
-  data.tar.gz: 0c19dc5641435505ebfae14329a5dc0d30ebf20f8dd0e47b4e8edc82aa72b750f0af16a271af4cfa8b8bf2c2689db81b89126927aa42a24ccb96ea09b9e5eb77
+  metadata.gz: 996828c785f9869b42ff44040e1a690e3facf5ceeb7eba5309d243406136069c7e51fbec0be53573813aa40ba2b46407e647d13c123a849046bb45c096e4920f
+  data.tar.gz: 1bea636775f295df277e33ed412ba0b8ea118af011495f94b08d9e267a635fc0047f7939a7b33d912303ab529da20f4190c8a2ffc91bdd31f41124ea668cb35e

data/README.md

@@ -14,29 +14,56 @@ are impossible. Statting takes forever.
 Since polling implementations will probably rely on statting the file in some
 way, this creates a pretty awful experience.
 
-The best answer I've managed to find is forwarding filesystem events. The
-listen gem is already used by vagrant, (as part of rsync-auto) and allows
-forwarding of filesystem events over TCP, so that's what I've tried to stick
-with.
+I have tried to keep dependencies to a minimum and only rely on ruby stdlib and
+gems already required by vagrant. The listen gem is used by vagrant (as part
+of rsync-auto) so it is used for file system notifications.
 
 
 ## Clients
 
-The main reason I developed this was to allow filesystem events to be pushed
-to a broccoli build pipeline.
+Clients should run inside the virtual machine as part of your build process.
+Instead of listenting for filesystem events, they should listen on a tcp
+connection.
 
-Ideally, you can subscribe to the file changes and trigger builds / whatever in
-your app
+The message format is a newline separated, json encoded object with keys `type`
+and `data`. The two message types:
 
-You can also write a simple server that touches all files on the guest, however
-you'll have to be aware of loops created if filesystem notifications are passed
-back from the guest to the host.
+**listen**
+
+    {"type": "listen", "data": [modified, added, removed]}
+
+data is an array of 3 arrays containing the full path of the files that are
+    modified, added and removed (in that order).
+
+**ping**
+
+    {"type": "ping", "data": "message to be echoed"}
+
+response will be of type "pong". Data will be echoed back to the client.
+
+
+In many cases, a simple client that touches all modified files on the guest is
+sufficient, however you'll have to be aware of loops created if filesystem
+notifications are passed back from the guest to the host in any way. Listen
+coalesces events for us, so there is no need to do so in your client.
 
 See the [examples](/examples) section for some implementations. Currently there
 is solely my node based client, but if you're using this in any other
 languages, please add your client and submit a pull request!
 
 
+## Keepalives
+
+Ideally, the client and server sockets would both support keepalives. But we
+can't rely on that working on both guest and host - windows has spotty support,
+and many languages don't give control over socket flags (it's awkward in ruby).
+Instead, the client can send a ping message to check the connection is alive.
+
+A simple client can safely ignore keepalive messages.
+
+http://www.tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/
+
+
 ## Usage
 
 Install the plugin:
@@ -46,19 +73,29 @@ Install the plugin:
 Then in your Vagrantfile:
 
 ```ruby
-  config.vm.synced_folder '/host/code', '/client/code'
-
-  # You have to specify a private network for the guest to connect to.
-  config.vm.network :private_network, ip: '172.16.172.16'
-
-  if Vagrant.has_plugin? 'vagrant-listen-server'
-    # The host will always be the same IP as the private network with the last
-    # octet as .1
-    config.listen_server.ip = '172.168.172.1'
-    config.listen_server.port = 4000
-    config.listen_server.folders = '/host/code'
-    config.listen_server.pid_file = '/tmp/servername.listen.pid'
-  end
+config.vm.synced_folder '/host/code', '/client/code'
+
+# You have to specify a private network for the guest to connect to.
+config.vm.network :private_network, ip: '172.16.172.16'
+
+if Vagrant.has_plugin? 'vagrant-listen-server'
+  # The host will always be the same IP as the private network with the last
+  # octet as .1
+  config.listen_server.ip = '172.168.172.1'
+  config.listen_server.port = 4000
+  config.listen_server.folders = '/host/code'
+  config.listen_server.pid_file = '/tmp/servername.listen.pid'
+end
+```
+
+Because sleep states of both the host and guest machines can mess with long
+connections in unexpected ways, you can use the command to control the listen
+server.
+
+```bash
+vagrant listen stop
+vagrant listen start
+vagrant listen status
 ```
 
 
@@ -78,7 +115,7 @@ Hasn't been updated to work with vagrant's new plugin system.
 To develop locally
 ```
 gem build vagrant-listen-server.gemspec
-vagrant plugin install vagrant-listen-server-0.0.1.gem
+vagrant plugin install vagrant-listen-server-*.gem
 ```
 
 Other good vagrant plugins used for reference:

data/examples/node-client.js

@@ -1,48 +1,36 @@
 var net = require('net');
 
-
 // Assuming the existence of some `build` method that returns a promise.
 var sequence = build();
 
-
-// gathers rapid changes as one build
-var timeout = null;
-var scheduleBuild = function() {
-  if (timeout) { return; }
-
-  // we want the timeout to start now before we wait for the current build
-  var timeoutPromise = new Promise(function(resolve) {
-    timeout = setTimeout(resolve, 100);
-  });
-
-  var timeoutThenBuild = function() {
-    timeoutPromise.then(function() {
-      timeout = null
-      return build();
-    });
-  };
-
-  // we want the current promise to be waiting for the current build
-  // regardless if it fails or not.
-  sequence = sequence.then(timeoutThenBuild, timeoutThenBuild);
-};
-
-
 var port = 4000;
 var host = '172.16.172.1';
 var client = new net.Socket();
+var interval = null;
 
 client.connect(port, host, function() {
   console.log('Connected to listen server: ', host, port);
+
+  interval = setInterval(function() {
+    message = JSON.stringify({type: 'ping', message: 'listen-watcher'});
+    client.write(message + '\n');
+  , 1000);
 });
 
 client.on('data', function(data) {
   // message is [modified, added, removed]
   console.log('Data received', data)
   var message = JSON.parse(data.toString().trim())
-  scheduleBuild();
+
+  if (message.type === 'pong') { return; }
+  if (message.type !== 'listen') { throw Error('Unknown message type'); }
+
+  // We want the current promise to be waiting for the current build
+  // regardless if it fails or not.
+  sequence = sequence.then(build, build);
 });
 
 client.on('close', function() {
   console.log('Connection closed');
+  interval && clearInterval(interval);
 });

data/lib/vagrant-listen-server.rb

@@ -1,5 +1,6 @@
 require 'vagrant-listen-server/version'
 require 'vagrant-listen-server/plugin'
+require 'vagrant-listen-server/command'
 
 module VagrantPlugins
   module ListenServer

data/lib/vagrant-listen-server/action.rb

@@ -2,18 +2,6 @@ require 'listen'
 require 'socket'
 require 'json'
 
-# No ActiveSupport in vagrant
-def array_wrap object
-  if object.nil?
-    []
-  elsif object.respond_to?(:to_ary)
-    object.to_ary || [object]
-  else
-    [object]
-  end
-end
-
-
 module VagrantPlugins
   module ListenServer
     module Action
@@ -23,95 +11,10 @@ module VagrantPlugins
         end
 
         def call(env)
-          @env = env
-          @ui = env[:ui]
-          @machine = env[:machine]
-
-          config = @machine.config.listen_server
-          folders = array_wrap config.folders
-
-          @ui.info "Starting listen server - #{config.ip}:#{config.port}"
-
-          # Check whether the daemon is already running.
-          if File.exists? config.pid_file
-            pid = File.read config.pid_file
-            begin
-              Process.getpgid pid.to_i
-              @ui.info 'Warning - listen server already running'
-              return @app.call(env)
-            rescue Errno::ESRCH
-              @ui.info "Warning - stale PID: #{pid}"
-            end
-          end
-
           out = @app.call(env)
-
-          # Vagrant-notify uses fork here, but that doesn't work on windows:
-          #  https://github.com/fgrehm/vagrant-notify/blob/master/lib/vagrant-notify/server.rb
-          # Only real option is to switch to Process.spawn? I need a windows
-          # machine to test it out on...
-          pid = fork do
-            $0 = "vagrant-listen-server - #{@machine.name}"
-
-            clients = []
-            server = TCPServer.new config.ip, config.port
-
-            callback = Proc.new do |modified, added, removed|
-              bad_clients = []
-              # @ui.info "Listen fired - #{clients.count} clients.\n  #{modified}\n  #{added}\n  #{removed}"
-              clients.each do |client|
-                begin
-                  client.puts [modified, added, removed].to_json
-                rescue Errno::EPIPE
-                  @ui.info "Connection broke! #{client}"
-                  # Don't want to change the list of threads as we iterate.
-                  bad_clients.push client
-                end
-              end
-
-              bad_clients.each do |client|
-                clients.delete client
-              end
-            end
-            listener = Listen.to(*folders, &callback)
-            listener.start
-
-            # server.accept blocks - we need it in its own thread so we can
-            # continue to have listener callbacks fired, and so we can sleep
-            # and catch any interrupts from vagrant.
-            Thread.new do
-              loop do
-                Thread.fork(server.accept) do |client|
-                  @ui.info "New connection - #{client}"
-                  clients.push client
-                end
-              end
-            end
-
-            # TODO: this error won't happen on the listen anymore - it will
-            # happen somewhere on the tcp call. Not sure where.
-            #
-            # begin
-            #   listener.start
-            # rescue Errno::EADDRNOTAVAIL
-            #   @ui.info "Can't start server - Port in use"
-            #   exit
-            # end
-
-            # Uhh... this needs work. Vagrant steals the interrupt from us and
-            # there's no way to get it back
-            #  * https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/action/runner.rb#L49
-            # Is there a way to register more callbacks to the busy block?
-            #  * https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/util/busy.rb
-            while not env[:interrupted]
-              sleep 1
-            end
-            @ui.info "Listen sleep finished"
-          end
-
-          Process.detach pid
-          File.write config.pid_file, pid
-          @ui.info "Listen server started on PID #{pid}"
+          # config = env[:machine].config.listen_server
+          vm = env[:machine]
+          Daemon.start vm
 
           out
         end
@@ -123,22 +26,11 @@ module VagrantPlugins
         end
 
         def call(env)
-          @ui = env[:ui]
-          config = env[:machine].config.listen_server
-          @ui.info 'Killing listen server'
-          if File.exists? config.pid_file
-            pid = File.read config.pid_file
-            begin
-              Process.kill 'INT', pid.to_i
-            rescue Errno::ESRCH
-              @ui.info 'Stale PID file - no server found'
-            end
-            File.delete config.pid_file
-          else
-            @ui.info 'No listen server found'
-          end
+          out = @app.call env
+          vm = env[:machine]
+          Daemon.stop vm
 
-          @app.call(env)
+          out
         end
       end
     end

data/lib/vagrant-listen-server/command.rb

@@ -0,0 +1,35 @@
+module VagrantPlugins
+  module ListenServer
+    class Command < Vagrant.plugin('2', :command)
+      def self.synopsis
+        "Check the status of the vagrant-listen server"
+      end
+
+      def execute
+        opts = OptionParser.new do |o|
+          o.banner = 'Usage: vagrant listen [start|stop|status]'
+        end
+
+        command = @argv.shift
+        argv = parse_options opts
+
+        with_target_vms nil, single_target: true do |vm|
+          # puts "ENV #{vm.env.inspect}"
+          # puts "CONFIG #{vm.config.inspect}"
+          # puts "LISTEN #{vm.config.listen_server.inspect}"
+
+          case command
+          when 'status' then Daemon.status vm.config.listen_server
+          when 'stop' then Daemon.stop vm
+          when 'start' then Daemon.start vm
+          else
+            puts 'Unknown command'
+            exit 1
+          end
+        end
+
+        0
+      end
+    end
+  end
+end

data/lib/vagrant-listen-server/daemon.rb

@@ -0,0 +1,201 @@
+def array_wrap object
+  if object.nil?
+    []
+  elsif object.respond_to?(:to_ary)
+    object.to_ary || [object]
+  else
+    [object]
+  end
+end
+
+
+# TODO: pre-fork use vagrant logging, post fork use puts.
+def log message
+  puts message
+end
+
+
+module Daemon
+  def self.status_code config
+    return :stopped unless File.exists? config.pid_file
+
+    pid = File.read config.pid_file
+    begin
+      Process.getpgid pid.to_i
+      return pid.to_i
+    rescue Errno::ESRCH
+      return :stale
+    end
+    :stopped
+  end
+
+  def self.status config
+    code = self.status_code config
+    case code
+    when Fixnum then log "Running - PID: #{code}"
+    when :stopped then log 'Stopped'
+    when :stale then log 'Stopped. Stale PID file.'
+    else
+      log "Unknown status - #{code}"
+    end
+  end
+
+  # Wasted way too long trying to use Process.daemon. Doing it by hand. Code
+  # courtesy of:
+  # https://gist.github.com/mynameisrufus/1372491/b76b60fb1842bf0507f47869ab19ad50a045b214
+  # See also:
+  #  * http://stackoverflow.com/questions/1740308/create-a-daemon-with-double-fork-in-ruby
+  #  * http://allenlsy.com/working-with-unix-process-in-ruby/
+  #
+  # Related: Process.detach isn't what you think. It creates a process to
+  # monitor the child so that this can exit without creating a zombie. Because
+  # we want to remove parents, this actually makes life harder than just doing
+  # a double fork.
+  #
+  # Vagrant-notify uses fork as well, but that doesn't work on windows:
+  #  https://github.com/fgrehm/vagrant-notify/blob/master/lib/vagrant-notify/server.rb
+  # Only real option is to switch to Process.spawn? I need a windows
+  # machine to test it out on... Vagrant::Util::Subprocess allows spawning an
+  # executable, but I don't know how to make that launch the included ruby
+  # binary and make sure it's running the right file.
+  def self.daemonize! out='/dev/null', err='/dev/null'
+    raise 'First fork failed' if (pid = fork) == -1
+    return nil unless pid.nil?
+    Process.setsid
+    raise 'Second fork failed' if (pid = fork) == -1
+    exit unless pid.nil?
+
+    # Dir.chdir '/'
+    # File.umask 0000
+
+    $stdin.reopen '/dev/null'
+    $stdout.reopen File.new(out, "a")
+    $stderr.reopen File.new(err, "a")
+    $stdout.sync = $stderr.sync = true
+
+    Process.pid
+  end
+
+
+  def self.start vm
+    config = vm.config.listen_server
+    log "Starting listen server - #{config.ip}:#{config.port}"
+
+    status = self.status_code config
+    if status == :running
+      log 'Server already running.'
+      return 1
+    end
+
+    File.delete config.pid_file if status == :stale
+
+    # TODO: use machine name in log file name.
+    # TODO: use machine name in PID file and drop it from config.
+    pid = daemonize! '/tmp/listen.log', '/tmp/listen.log'
+    # Usually a daemon wants the parent to exit here, but we need vagrant to
+    # keep going with its init process.
+    return unless pid
+
+    $0 = "vagrant-listen-server - #{vm.name}"
+
+    File.write config.pid_file, pid
+
+    log "Listen server started on PID #{pid}"
+
+    clients = []
+    begin
+      server = TCPServer.new config.ip, config.port
+    rescue Errno::EADDRINUSE
+      log "Can't start server - Port in use"
+      exit 1
+    end
+
+    send_to_clients = Proc.new do |type, data|
+      bad_clients = []
+      log "Sending #{type} to #{clients.count} clients."
+
+      clients.each do |client|
+        begin
+          client.puts ({type: type, data: data}).to_json
+        rescue Errno::EPIPE
+          log "Connection broke! #{client}"
+          # Don't want to change the list of threads as we iterate.
+          bad_clients.push client
+        end
+      end
+
+      bad_clients.each do |client|
+        clients.delete client
+      end
+    end
+
+    callback = Proc.new do |modified, added, removed|
+      log "Listen fired"
+      send_to_clients.call :listen, [modified, added, removed]
+    end
+
+    folders = array_wrap config.folders
+
+    # There is a recurring bug that keeps popping up in listen where only the
+    # first directory is watched. Create a new listen object for each folder as
+    # a workaround.
+    # https://github.com/guard/listen/issues/243
+    listeners = folders.map do |folder|
+      Listen.to(folder, &callback)
+    end
+
+    listeners.each &:start
+
+    # server.accept is blocking - we need it in its own thread so we can
+    # continue to have listener callbacks fired, and so we can sleep and catch
+    # any interrupts.
+    Thread.new do
+      loop do
+        Thread.fork(server.accept) do |client|
+          log "New connection - #{client}"
+          clients.push client
+
+          loop do
+            line = client.gets.chomp
+            # Currently, the only message type is a ping. Don't bother checking
+            # type for now.
+            data = JSON.parse line
+            log 'ping received'
+            client.puts ({type: 'pong', data: data['message']}).to_json
+          end
+        end
+      end
+    end
+
+    exiting = false
+    Signal.trap 'INT' do
+      log 'SIGINT caught'
+      exiting = true
+    end
+
+    while not exiting
+      # Original idea was to have the server ping. This requires more work on
+      # the client for a basic implementation though, so now the client pings.
+      # send_to_clients.call :echo, 'ping'
+      sleep 0.5
+    end
+
+    listeners.each &:stop
+    log "Listen sleep finished"
+  end
+
+
+  def self.stop vm
+    log 'Killing listen server'
+    config = vm.config.listen_server
+    status = self.status_code config
+    unless status.is_a? Fixnum
+      log 'Server is not running.'
+      return 1
+    end
+
+    pid = File.read config.pid_file
+    Process.kill 'INT', pid.to_i
+    File.delete config.pid_file
+  end
+end

data/lib/vagrant-listen-server/plugin.rb

@@ -1,4 +1,5 @@
 require_relative 'action'
+require_relative 'daemon'
 
 require 'rbconfig'
 os = RbConfig::CONFIG['target_os']
@@ -23,6 +24,11 @@ module VagrantPlugins
         Config
       end
 
+      command :listen do
+        require_relative 'command'
+        Command
+      end
+
       action_hook(:listen_server, :machine_action_up) do |hook|
         hook.append(Action::StartServer)
       end

data/lib/vagrant-listen-server/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module ListenServer
-    VERSION = '0.0.5'
+    VERSION = '0.2.0'
   end
 end

data/vagrant-listen-server.gemspec

@@ -17,9 +17,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  # Shouldn't have to do this, but we want to make sure not to tie to an old
+  # version of listen and accidentally pull in the celluloid dependency.
+  spec.add_runtime_dependency 'listen', '~> 3.0', '>= 3.0.2'
+
+  spec.add_dependency 'rb-kqueue', '~> 0.2', '>= 0.2.3'
   spec.add_dependency 'rb-inotify', '~> 0.9', '>= 0.9.5'
   spec.add_dependency 'rb-fsevent', '~> 0.9', '>= 0.9.4'
-  spec.add_dependency 'rb-kqueue', '~> 0.2', '>= 0.2.3'
   # wdm is already included in the vagrant gem spec.
   # spec.add_runtime_dependency 'wdm', '~> 0.10', '>= 0.10.0'
 

metadata

@@ -1,37 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-listen-server
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.2.0
 platform: ruby
 authors:
 - David Kelso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rb-inotify
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 3.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 3.0.2
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: rb-kqueue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -39,7 +59,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: 0.9.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,27 +69,27 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: 0.9.5
 - !ruby/object:Gem::Dependency
-  name: rb-kqueue
+  name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.9.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.9.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +133,9 @@ files:
 - examples/node-client.js
 - lib/vagrant-listen-server.rb
 - lib/vagrant-listen-server/action.rb
+- lib/vagrant-listen-server/command.rb
 - lib/vagrant-listen-server/config.rb
+- lib/vagrant-listen-server/daemon.rb
 - lib/vagrant-listen-server/plugin.rb
 - lib/vagrant-listen-server/version.rb
 - vagrant-listen-server.gemspec