cool.io 1.10.1 → 1.11.0

data/spec/kqueue_stat_watcher_spec.rb

@@ -0,0 +1,339 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'tmpdir'
+require 'fileutils'
+require 'rbconfig'
+require 'timeout'
+
+describe 'kqueue notification-backed StatWatcher', :if => RUBY_PLATFORM =~ /darwin/ do
+  before do
+    @directory = Dir.mktmpdir('coolio-kq-notify-')
+    @loop = Coolio::Loop.new
+    @watchers = []
+    @threads = []
+  end
+
+  after do
+    @threads.each(&:join)
+    @watchers.each { |watcher| watcher.detach if watcher.attached? }
+    FileUtils.remove_entry(@directory)
+    @loop = nil
+    @watchers = nil
+    GC.start # exercise cleanup of unreachable loops and watchers
+  end
+
+  # Most tests use a 60-second interval so native notifications must deliver
+  # changes before their deadlines. Recovery tests can override the interval.
+  def watch(path, interval = 60)
+    watcher = Coolio::StatWatcher.new(path, interval)
+    watcher.attach(@loop)
+    @watchers << watcher
+    watcher
+  end
+
+  def await_change(watcher, size: nil, exists: nil, timeout: 2, &mutation)
+    change = nil
+    first_previous = nil
+    reactor = @loop
+    stopped = false
+    stop = -> do
+      unless stopped
+        stopped = true
+        reactor.stop
+      end
+    end
+    watcher.define_singleton_method(:on_change) do |previous, current|
+      first_previous ||= previous
+      if (size.nil? || current.size == size) && (exists.nil? || (current.nlink != 0) == exists)
+        change = [first_previous, current]
+        stop.call
+      end
+    end
+    deadline = Coolio::TimerWatcher.new(timeout, false)
+    deadline.on_timer { stop.call }
+    deadline.attach(@loop)
+    @threads << Thread.new { sleep 0.1; mutation.call }
+    @loop.run
+    expect(change).not_to be_nil
+    change
+  ensure
+    deadline.detach if deadline && deadline.attached?
+    @threads.each(&:join)
+  end
+
+  def in_child
+    pid = fork do
+      begin
+        yield
+        exit! 0
+      rescue Exception => error
+        warn error.full_message
+        exit! 1
+      end
+    end
+    begin
+      _, status = Timeout.timeout(10) { Process.wait2(pid) }
+    rescue Timeout::Error
+      Process.kill('KILL', pid)
+      Process.wait(pid)
+      raise 'forked watcher test timed out'
+    end
+    expect(status.success?).to eq(true)
+  end
+
+  it 'wakes a blocked loop for a file size change without waiting for polling' do
+    path = File.join(@directory, 'file')
+    File.write(path, 'a')
+    previous, current = await_change(watch(path), size: 6) { File.write(path, 'longer') }
+    expect(previous.size).to eq(1)
+    expect(current.size).to eq(6)
+  end
+
+  it 'notifies for a truncation' do
+    path = File.join(@directory, 'file')
+    File.write(path, 'x' * 40)
+    await_change(watch(path), size: 0) { File.truncate(path, 0) }
+  end
+
+  it 'notifies for creation, deletion, and recreation of a watched file' do
+    directory = File.join(@directory, 'missing')
+    path = File.join(directory, 'file')
+    watcher = watch(path)
+    previous, current = await_change(watcher, size: 7, exists: true) do
+      Dir.mkdir(directory)
+      File.write(path, 'created')
+    end
+    expect(previous.nlink).to eq(0)
+    expect(current.nlink).not_to eq(0)
+    _, current = await_change(watcher, exists: false) { File.delete(path) }
+    expect(current.nlink).to eq(0)
+    _, current = await_change(watcher, size: 9, exists: true) { File.write(path, 'recreated') }
+    expect(current.size).to eq(9)
+  end
+
+  it 'notifies when a watched file is renamed away (log rotation)' do
+    path = File.join(@directory, 'file')
+    File.write(path, 'a')
+    _, current = await_change(watch(path)) { File.rename(path, "#{path}.old") }
+    expect(current.nlink).to eq(0)
+  end
+
+  it 'notifies when a watched file is replaced under the same name' do
+    path = File.join(@directory, 'file')
+    File.write(path, 'a')
+    watcher = watch(path)
+    _, current = await_change(watcher, size: 6, exists: true) do
+      File.rename(path, "#{path}.old")
+      File.write(path, 'longer')
+    end
+    expect(current.size).to eq(6)
+  end
+
+  it 'notifies for atomic replacement and subsequent changes' do
+    path = File.join(@directory, 'file')
+    replacement = File.join(@directory, 'replacement')
+    File.write(path, 'a')
+    File.write(replacement, 'longer')
+    watcher = watch(path)
+    await_change(watcher, size: 6) { File.rename(replacement, path) }
+    await_change(watcher, size: 7) { File.write(path, 'changed') }
+  end
+
+  it 'uses parent hints when a symlink is replaced' do
+    path = File.join(@directory, 'link')
+    File.symlink('missing', path)
+    watcher = watch(path)
+    _, current = await_change(watcher, size: 22, exists: true) do
+      File.unlink(path)
+      File.symlink('another-missing-target', path)
+    end
+    expect(current.mode & 0o170000).to eq(0o120000)
+    expect(current.size).to eq('another-missing-target'.bytesize)
+  end
+
+  it 'attaches without blocking for a FIFO or a path below it' do
+    in_child do
+      path = File.join(@directory, 'fifo')
+      File.mkfifo(path)
+      fifo = watch(path, 0.1)
+      watch(File.join(path, 'missing'), 0.1)
+      await_change(fifo, exists: false) { File.unlink(path) }
+    end
+  end
+
+  it 'does not wake a FIFO writer when attaching or retrying registration' do
+    in_child do
+      path = File.join(@directory, 'fifo')
+      File.mkfifo(path)
+      reader, ready = IO.pipe
+      writer = fork do
+        reader.close
+        ready.write('ready')
+        File.open(path, File::WRONLY) { ready.write('opened') }
+        exit! 0
+      end
+      ready.close
+      begin
+        expect(reader.read(5)).to eq('ready')
+        expect(IO.select([reader], nil, nil, 0.1)).to be_nil
+        watch(path, 0.1)
+        watch(File.join(path, 'missing'), 0.1)
+        deadline = Coolio::TimerWatcher.new(0.35, false)
+        deadline.on_timer { @loop.stop }
+        deadline.attach(@loop)
+        @loop.run
+        expect(IO.select([reader], nil, nil, 0)).to be_nil
+      ensure
+        deadline.detach if deadline && deadline.attached?
+        Process.kill('KILL', writer)
+        Process.wait(writer)
+        reader.close
+      end
+    end
+  end
+
+  it 'continues polling in a child without fork checking' do
+    path = File.join(@directory, 'file')
+    File.write(path, 'a')
+    watcher = watch(path, 0.1)
+    in_child do
+      await_change(watcher, size: 6) { File.write(path, 'longer') }
+    end
+  end
+
+  it 'notifies when a child is added to a watched directory' do
+    directory = File.join(@directory, 'sub')
+    Dir.mkdir(directory)
+    await_change(watch(directory)) { File.write(File.join(directory, 'child'), 'a') }
+  end
+
+  it 'notifies for a metadata-only change' do
+    path = File.join(@directory, 'file')
+    File.write(path, 'a')
+    mode = (File.stat(path).mode & 0o777) ^ 0o100
+    await_change(watch(path)) { File.chmod(mode, path) }
+  end
+
+  it 're-registers when the watched directory itself is recreated' do
+    directory = File.join(@directory, 'sub')
+    Dir.mkdir(directory)
+    watcher = watch(directory)
+    await_change(watcher, exists: false) { FileUtils.remove_entry(directory) }
+    await_change(watcher, exists: true) { Dir.mkdir(directory) }
+    await_change(watcher, timeout: 5) { File.write(File.join(directory, 'child'), 'a' * 6) }
+  end
+
+  it 're-registers when a parent of the watched file is recreated under the same name' do
+    sub = File.join(@directory, 'sub')
+    Dir.mkdir(sub)
+    path = File.join(sub, 'file')
+    File.write(path, 'a')
+    watcher = watch(path)
+    await_change(watcher, exists: false) { FileUtils.remove_entry(sub) }
+    await_change(watcher, size: 6, exists: true, timeout: 5) do
+      Dir.mkdir(sub)
+      File.write(path, 'longer')
+    end
+  end
+
+  it 'transfers notification monitoring to another loop' do
+    path = File.join(@directory, 'file')
+    File.write(path, 'a')
+    watcher = watch(path)
+    old_loop = @loop
+    @loop = Coolio::Loop.new
+    watcher.attach(@loop)
+    old_loop.run_nonblock
+    _, current = await_change(watcher, size: 6) { File.write(path, 'longer') }
+    expect(current.size).to eq(6)
+  end
+
+  it 'recovers when an ancestor is renamed and the original path is recreated' do
+    sub = File.join(@directory, 'sub')
+    Dir.mkdir(sub)
+    path = File.join(sub, 'file')
+    File.write(path, 'a')
+    watcher = watch(path, 0)
+
+    await_change(watcher, size: 6, exists: true, timeout: 8) do
+      File.rename(sub, "#{sub}.old")
+      Dir.mkdir(sub)
+      File.write(path, 'longer')
+    end
+    # The polling backstop must also transfer native monitoring to the new file.
+    await_change(watcher, size: 10) { File.write(path, 'evenlonger') }
+  end
+
+  [false, true].each do |missing|
+    it "does not inherit #{missing ? 'parent hint' : 'file'} descriptors across exec" do
+      path = File.join(@directory, 'file')
+      File.write(path, 'a') unless missing
+      target = missing ? @directory : path
+      watch(path)
+
+      script = <<~'RUBY'
+        target = File.stat(ARGV.fetch(0))
+        leaked = Dir.children('/dev/fd').any? do |fd|
+          begin
+            stat = IO.for_fd(Integer(fd), autoclose: false).stat
+            stat.dev == target.dev && stat.ino == target.ino
+          rescue Errno::EBADF, ArgumentError
+            false
+          end
+        end
+        puts leaked
+      RUBY
+      inherited = IO.popen([RbConfig.ruby, '-e', script, target], close_others: false, &:read)
+      expect(inherited.strip).to eq('false')
+    end
+  end
+
+  it 'keeps monitoring when another watcher on the same path detaches' do
+    path = File.join(@directory, 'file')
+    File.write(path, 'a')
+    first = watch(path)
+    second = watch(path)
+    await_change(first, size: 6) { File.write(path, 'b' * 6) }
+    first.detach
+    await_change(second, size: 7) { File.write(path, 'c' * 7) }
+  end
+
+  it 'notifies every watcher of many watched files within one burst' do
+    # Exceed the native event batch size without requiring hundreds of fds.
+    paths = (1..64).map do |i|
+      path = File.join(@directory, "file#{i}")
+      File.write(path, 'a')
+      watch(path)
+    end
+    notified = 0
+    reactor = @loop
+    paths.each do |watcher|
+      watcher.define_singleton_method(:on_change) do |_previous, current|
+        if current.size == 2
+          notified += 1
+          reactor.stop if notified == paths.size
+        end
+      end
+    end
+    deadline = Coolio::TimerWatcher.new(5, false)
+    deadline.on_timer { @loop.stop }
+    deadline.attach(@loop)
+    paths.each { |watcher| File.open(watcher.path, 'a') { |file| file.write 'b' } }
+    @loop.run
+    deadline.detach if deadline.attached?
+    expect(notified).to eq(paths.size)
+  end
+
+  it 're-registers inherited watchers after fork without changing the parent loop' do
+    @loop = Coolio::Loop.new(fork_check: true)
+    path = File.join(@directory, 'file')
+    File.write(path, 'a')
+    watcher = watch(path)
+
+    in_child do
+      await_change(watcher, size: 6) { File.write(path, 'longer') }
+      watcher.detach
+    end
+    await_change(watcher, size: 10) { File.write(path, 'evenlonger') }
+  end
+
+end

data/spec/stat_watcher_spec.rb

@@ -19,10 +19,10 @@ class MyStatWatcher < Cool.io::StatWatcher
   end
 end
 
-def run_with_file_change(path, compact: false)
+def run_with_file_change(path, watcher_class: MyStatWatcher, compact: false)
   reactor = Cool.io::Loop.new
 
-  sw = MyStatWatcher.new(path)
+  sw = watcher_class.new(path)
   sw.attach(reactor)
 
   # libev retains the path pointer passed to ev_stat_init() for the lifetime of
@@ -155,12 +155,11 @@ describe Cool.io::StatWatcher do
   end
 
   it "should raise when the handler does not take 2 parameters" do
-    class MyStatWatcher < Cool.io::StatWatcher
-      remove_method :on_change
+    watcher_class = Class.new(MyStatWatcher) do
       def on_change
       end
     end
-    expect { watcher.accessed }.to raise_error(ArgumentError)
+    expect { run_with_file_change(TEMP_FILE_PATH, watcher_class: watcher_class) }.to raise_error(ArgumentError)
   end
 
 end

data/spec/timer_watcher_spec.rb

@@ -53,7 +53,16 @@ describe Cool.io::TimerWatcher do
     expect(nr).to eq(:foo)
   end
 
+  it "reports whether it is attached" do
+    @watcher = Cool.io::TimerWatcher.new(interval, true)
+    expect(@watcher.attached?).to eq(false)
+    @watcher.attach(loop)
+    expect(@watcher.attached?).to eq(true)
+    @watcher.detach
+    expect(@watcher.attached?).to eq(false)
+  end
+
   after :each do
-    @watcher.detach if defined?(@watcher)
+    @watcher.detach if defined?(@watcher) && @watcher.attached?
   end
 end

data/spec/windows_stat_native_spec.rb

@@ -7,7 +7,7 @@ describe 'Windows stat notification internals', :if => RUBY_PLATFORM =~ /mingw|m
   before(:context) do
     @build = Dir.mktmpdir('coolio-stat-native-')
     source = File.expand_path('fixtures/windows_stat_native.c', __dir__)
-    libev = File.expand_path('../ext/libev', __dir__)
+    coolio = File.expand_path('../ext/cool.io', __dir__)
     FileUtils.cp(source, @build)
     File.write(File.join(@build, 'extconf.rb'), <<~RUBY)
       begin
@@ -16,7 +16,7 @@ describe 'Windows stat notification internals', :if => RUBY_PLATFORM =~ /mingw|m
         # Other Windows toolchains can provide the compiler through PATH.
       end
       require 'mkmf'
-      $INCFLAGS << ' -I"#{libev}"'
+      $INCFLAGS << ' -I"#{coolio}"'
       abort 'ws2_32 is required' unless have_library('ws2_32')
       create_makefile('coolio_stat_native')
     RUBY

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cool.io
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.0
 platform: ruby
 authors:
 - Tony Arcieri
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler-dock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +70,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- appveyor.yml
 - cool.io.gemspec
 - examples/callbacked_echo_server.rb
 - examples/dslified_echo_client.rb
 - examples/dslified_echo_server.rb
 - examples/echo_client.rb
 - examples/echo_server.rb
-- examples/google.rb
 - ext/cool.io/.gitignore
 - ext/cool.io/buffer.c
 - ext/cool.io/cool.io.h
@@ -114,6 +98,7 @@ files:
 - ext/libev/ev.h
 - ext/libev/ev_epoll.c
 - ext/libev/ev_kqueue.c
+- ext/libev/ev_kqueue_stat.c
 - ext/libev/ev_poll.c
 - ext/libev/ev_port.c
 - ext/libev/ev_select.c
@@ -144,8 +129,11 @@ files:
 - spec/async_watcher_spec.rb
 - spec/detach_race_condition_spec.rb
 - spec/dns_spec.rb
+- spec/fixtures/kqueue_stat_native.c
 - spec/fixtures/windows_stat_native.c
 - spec/iobuffer_spec.rb
+- spec/kqueue_stat_native_spec.rb
+- spec/kqueue_stat_watcher_spec.rb
 - spec/loop_spec.rb
 - spec/spec_helper.rb
 - spec/stat_watcher_spec.rb
@@ -161,7 +149,11 @@ files:
 homepage: https://github.com/socketry/cool.io
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/socketry/cool.io/issues
+  changelog_uri: https://github.com/socketry/cool.io/blob/main/CHANGES.md
+  source_code_uri: https://github.com/socketry/cool.io.git
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -169,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -183,8 +175,11 @@ test_files:
 - spec/async_watcher_spec.rb
 - spec/detach_race_condition_spec.rb
 - spec/dns_spec.rb
+- spec/fixtures/kqueue_stat_native.c
 - spec/fixtures/windows_stat_native.c
 - spec/iobuffer_spec.rb
+- spec/kqueue_stat_native_spec.rb
+- spec/kqueue_stat_watcher_spec.rb
 - spec/loop_spec.rb
 - spec/spec_helper.rb
 - spec/stat_watcher_spec.rb

data/appveyor.yml

@@ -1,18 +0,0 @@
----
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - ruby --version
-  - gem --version
-  - bundle install
-build: off
-test_script:
-  - bundle exec rake -rdevkit
-
-environment:
-  matrix:
-    - ruby_version: "200"
-    - ruby_version: "200-x64"
-    - ruby_version: "21"
-    - ruby_version: "21-x64"
-    - ruby_version: "22"
-    - ruby_version: "22-x64"

data/examples/google.rb

@@ -1,9 +0,0 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-
-require 'rubygems'
-require 'cool.io'
-
-l = Coolio::Loop.default
-c = Coolio::HttpClient.connect("www.google.com", 80).attach(l)
-c.request('GET', '/search', :query => { :q => 'feces'})
-l.run