funl 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbb42a88d076acb7f545c98acbeeae62d94accae
-  data.tar.gz: f78b9b4f60684598d01b387fb56d57e4320d3c1c
+  metadata.gz: 6ac4ecb6a3ca14c04c14cc5af85e34ba3d421123
+  data.tar.gz: a9a6a618dfb48a4baed545c71767b5ac544cba98
 SHA512:
-  metadata.gz: 6735b03e0e9a8833dcfbad3ef8ad1ad139b06b12483d3d525b50fd24df4c0ec42f5f8c198eaf19e0f16d3a4bdba1958a72a1bae3279717bebcad68ecd2bfe085
-  data.tar.gz: 71d767408b0eaa9e1d1f818cf45271d23e8a44ab262bd0f70a413de35cbb17cf229b4d480abb3d6c9996cfae3b9a3cb76bfa08a09aa0c8673fc4aa843a37656f
+  metadata.gz: 1794536193b70a6a965357d64c9d53b58f7c168d1e3c4a17a8b588d1b2e5550fae9b3bccbe5fb2393be397a1482e088b0784dd6aff5dfc4b5fd2ba00989864f0
+  data.tar.gz: abadb9d061fba91923f6781b2132526468943ba848ddb01477008ae77cbc56a2af12cbfe709de9700ac3630177a2211e8e8bc7ad4577361a508dc96ad091cf3e

data/lib/funl/client.rb

@@ -2,6 +2,7 @@ require 'logger'
 require 'funl/stream'
 require 'funl/message'
 require 'funl/blobber'
+require 'funl/subscription-tracker'
 
 module Funl
   # Generic client base class. Manages the setup and handshake on the streams
@@ -33,6 +34,8 @@ module Funl
       @seq = client_stream_for(seq)
       @cseq = client_stream_for(cseq)
       @arcio = arc
+      
+      @sub_tracker = SubscriptionTracker.new(self)
     end
 
     # Handshake with both cseq and seq. Does not start any threads--that is left
@@ -43,25 +46,54 @@ module Funl
       yield if block_given?
       seq_read_greeting
     end
+    
+    def subscribed_all
+      @sub_tracker.subscribed_all
+    end
+
+    def subscribed_tags
+      @sub_tracker.subscribed_tags
+    end
 
+    # Send a subscribe message registering interest in +tags+. Seq will respond
+    # with an ack message containing the tick on which subscription took effect.
+    # Waits for the specified +tags+ to be subscribed (assuming #handle_ack is
+    # called regularly, such as in worker thread).
     def subscribe tags
-      seq << Message.control(SUBSCRIBE, tags)
-      ## wait for ack which has tick, ask arc for older messages
+      @sub_tracker.subscribe tags
     end
 
+    # Send a subscribe message registering interest in all messages. Seq will
+    # respond with an ack message containing the tick on which subscription took
+    # effect. Waits for the subscription to start (assuming #handle_ack is
+    # called regularly).
     def subscribe_all
-      seq << Message.control(SUBSCRIBE_ALL)
-      ## wait for ack which has tick, ask arc for older messages
+      @sub_tracker.subscribe_all
     end
 
+    # Unsubscribe from +tags+. Seq will respond with an ack message containing
+    # the tick on which subscription ended. Waits for the subscription to end
+    # (assuming #handle_ack is called regularly).
     def unsubscribe tags
-      seq << Message.control(UNSUBSCRIBE, tags)
+      @sub_tracker.unsubscribe tags
     end
 
+    # Unsubscribe from all messages. Any tag subscriptions remain in effect. Seq
+    # will respond with an ack message containing the tick on which subscription
+    # ended. Waits for the subscription to end (assuming #handle_ack is called
+    # regularly).
     def unsubscribe_all
-      seq << Message.control(UNSUBSCRIBE_ALL)
+      @sub_tracker.unsubscribe_all
     end
-
+    
+    # Maintain subscription status. Must be called by the user (or subclass)
+    # of this class, most likely in the thread created by #start.
+    def handle_ack ack
+      raise ArgumentError unless ack.control?
+      op_type, tags = ack.control_op
+      @sub_tracker.update op_type, tags
+    end
+    
     def cseq_read_client_id
       log.debug "getting client_id from cseq"
       @client_id = cseq.read["client_id"]

data/lib/funl/message-sequencer.rb

@@ -125,18 +125,12 @@ module Funl
       case op_type
       when SUBSCRIBE_ALL
         @subscribers_to_all += [stream]
-        ack = Message.control(op_type)
-        ack.global_tick = tick
-        write_succeeds?(ack, stream)
       
       when SUBSCRIBE
         tags.each do |tag|
           @subscribers[tag] += [stream]
         end
         @tags[stream] += tags
-        ack = Message.control(op_type, tags)
-        ack.global_tick = tick
-        write_succeeds?(ack, stream)
 
       when UNSUBSCRIBE_ALL
         @subscribers_to_all.delete stream
@@ -151,6 +145,10 @@ module Funl
         log.error "bad operation: #{op_type.inspect}"
         return
       end
+
+      ack = Message.control(op_type, tags)
+      ack.global_tick = tick
+      write_succeeds?(ack, stream)
     end
 
     def handle_message msg
@@ -183,17 +181,17 @@ module Funl
       false
     end
     private :write_succeeds?
-  end
 
-  def reject_stream stream
-    stream.close unless stream.closed?
-    if streams.include? stream
-      streams.delete stream
-      @subscribers_to_all.delete stream
-      tags = @tags.delete stream
-      if tags
-        tags.each do |tag|
-          @subscribers[tag].delete stream
+    def reject_stream stream
+      stream.close unless stream.closed?
+      if streams.include? stream
+        streams.delete stream
+        @subscribers_to_all.delete stream
+        tags = @tags.delete stream
+        if tags
+          tags.each do |tag|
+            @subscribers[tag].delete stream
+          end
         end
       end
     end

data/lib/funl/subscription-tracker.rb

@@ -0,0 +1,93 @@
+require 'thread'
+require 'funl/message'
+
+module Funl
+  # Threadsafe manager for a client's subscriptions.
+  class SubscriptionTracker
+    attr_reader :client
+    attr_reader :subscribed_all
+    
+    def subscribed_tags
+      @subscribed_tags.dup
+    end
+
+    def initialize client
+      @client = client
+
+      @subscribed_tags = []
+      @subscribed_all = false
+
+      @waiters = []
+      @mon = Monitor.new
+      @cvar = @mon.new_cond
+    end
+
+    def subscribe tags
+      @mon.synchronize do
+        if (tags - @subscribed_tags).empty?
+          return false
+        else
+          client.seq << Message.control(SUBSCRIBE, tags)
+          wait {(tags - @subscribed_tags).empty?}
+          return true
+        end
+      end
+    end
+
+    def subscribe_all
+      @mon.synchronize do
+        if @subscribed_all
+          return false
+        else
+          client.seq << Message.control(SUBSCRIBE_ALL)
+          wait {@subscribed_all}
+          return true
+        end
+      end
+    end
+
+    def unsubscribe tags
+      @mon.synchronize do
+        if (tags & @subscribed_tags).empty?
+          return false
+        else
+          client.seq << Message.control(UNSUBSCRIBE, tags)
+          wait {(tags & @subscribed_tags).empty?}
+          return true
+        end
+      end
+    end
+
+    def unsubscribe_all
+      @mon.synchronize do
+        if !@subscribed_all
+          return false
+        else
+          client.seq << Message.control(UNSUBSCRIBE_ALL)
+          wait {!@subscribed_all}
+          return true
+        end
+      end
+    end
+
+    def update op_type, tags=nil
+      @mon.synchronize do
+        case op_type
+        when SUBSCRIBE;       @subscribed_tags |= tags
+        when SUBSCRIBE_ALL;   @subscribed_all = true
+        when UNSUBSCRIBE;     @subscribed_tags -= tags
+        when UNSUBSCRIBE_ALL; @subscribed_all = false
+        else raise ArgumentError
+        end
+
+        @cvar.broadcast
+      end
+    end
+
+    def wait
+      until yield
+        @cvar.wait ## timeout?
+      end
+    end
+  end
+end

data/lib/funl/version.rb

@@ -1,3 +1,3 @@
 module Funl
-  VERSION = "0.3"
+  VERSION = "0.4"
 end

data/test/test-client.rb

@@ -10,7 +10,7 @@ include Funl
 require 'minitest/autorun'
 
 class TestClient < Minitest::Test
-  attr_reader :log
+  attr_reader :log, :client
 
   def setup
     @dir = Dir.mktmpdir "funl-test-client-"
@@ -18,33 +18,85 @@ class TestClient < Minitest::Test
     @seq_path = File.join(@dir, "seq")
     @log = Logger.new($stderr)
     log.level = Logger::WARN
+
+    @cseq_sock = UNIXServer.new(@cseq_path)
+    @cseq = ClientSequencer.new @cseq_sock, log: log
+    @cseq.start
+    
+    @seq_sock = UNIXServer.new(@seq_path)
+    @seq = MessageSequencer.new @seq_sock, log: log
+    @seq.start
+    
+    @client = Client.new(
+      seq: UNIXSocket.new(@seq_path),
+      cseq: UNIXSocket.new(@cseq_path),
+      log: log)
+    
+    @client.start
   end
   
   def teardown
+    cseq.stop rescue nil
+    seq.stop rescue nil
     FileUtils.remove_entry @dir
   end
   
-  def test_client
-    cseq_sock = UNIXServer.new(@cseq_path)
-    cseq = ClientSequencer.new cseq_sock, log: log
-    cseq.start
+  def test_client_state_at_start
+    assert_equal(0, client.client_id)
+    assert_equal(0, client.start_tick)
+    assert_equal(Funl::Blobber::MSGPACK_TYPE, client.blob_type)
+  end
+  
+  def test_subscription_tracking
+    Thread.new do
+      client.subscribe ["foo"]
+    end ## Fiber?
+
+    ack = client.seq.read
+    assert ack.control?
+    assert_equal 0, ack.global_tick
     
-    seq_sock = UNIXServer.new(@seq_path)
-    seq = MessageSequencer.new  seq_sock, log: log
-    seq.start
+    assert_equal [], client.subscribed_tags
+    client.handle_ack ack
+    Thread.pass
+    assert_equal ["foo"], client.subscribed_tags
+
+    Thread.new do
+      client.unsubscribe ["foo"]
+    end
+
+    ack = client.seq.read
+    assert ack.control?
+    assert_equal 0, ack.global_tick
     
-    client = Client.new(
-      seq: UNIXSocket.new(@seq_path),
-      cseq: UNIXSocket.new(@cseq_path),
-      log: log)
+    assert_equal ["foo"], client.subscribed_tags
+    client.handle_ack ack
+    Thread.pass
+    assert_equal [], client.subscribed_tags
+
+    Thread.new do
+      client.subscribe_all
+    end
+
+    ack = client.seq.read
+    assert ack.control?
+    assert_equal 0, ack.global_tick
     
-    client.start
+    assert_equal false, client.subscribed_all
+    client.handle_ack ack
+    Thread.pass
+    assert_equal true, client.subscribed_all
+
+    Thread.new do
+      client.unsubscribe_all
+    end
+    ack = client.seq.read
+    assert ack.control?
+    assert_equal 0, ack.global_tick
     
-    assert_equal(0, client.client_id)
-    assert_equal(0, client.start_tick)
-    assert_equal(Funl::Blobber::MSGPACK_TYPE, client.blob_type)
-  ensure
-    cseq.stop rescue nil
-    seq.stop rescue nil
+    assert_equal true, client.subscribed_all
+    client.handle_ack ack
+    Thread.pass
+    assert_equal false, client.subscribed_all
   end
 end

data/test/test-subscribe.rb

@@ -63,6 +63,7 @@ class TestSubscribe < Minitest::Test
     ack = rcv.read
     assert ack.control?
     assert_equal 0, ack.global_tick
+    assert_equal ["foo", "bar"], ack.control_op[1]
     
     snd << Message[
       client: 0, local: 0, global: 0, delta: 1,
@@ -86,6 +87,7 @@ class TestSubscribe < Minitest::Test
       ack = stream.read
       assert ack.control?
       assert_equal 0, ack.global_tick
+      assert_equal ["foo"], ack.control_op[1]
     end
     
     snd << Message[
@@ -105,6 +107,7 @@ class TestSubscribe < Minitest::Test
     ack = rcv.read
     assert ack.control?
     assert_equal 0, ack.global_tick
+    assert_equal ["foo"], ack.control_op[1]
     
     snd << Message[
       client: 0, local: 0, global: 0, delta: 1,
@@ -115,17 +118,21 @@ class TestSubscribe < Minitest::Test
     assert_equal ["foo"], m.tags
 
     rcv << Message.control(UNSUBSCRIBE, ["foo"])
+    ack = rcv.read
+    assert ack.control?
+    assert_equal 1, ack.global_tick
+    assert_equal ["foo"], ack.control_op[1]
     
     snd << Message[
       client: 0, local: 0, global: 0, delta: 1,
       tags: ["foo"], blob: ""]
-    
-    sleep 0.2
+    Thread.pass
     
     rcv << Message.control(SUBSCRIBE, ["foo"])
     ack = rcv.read
     assert ack.control?
     assert_equal 2, ack.global_tick
+    assert_equal ["foo"], ack.control_op[1]
     
     snd << Message[
       client: 0, local: 0, global: 0, delta: 1,
@@ -142,6 +149,7 @@ class TestSubscribe < Minitest::Test
     ack = rcv.read
     assert ack.control?
     assert_equal 0, ack.global_tick
+    assert_equal nil, ack.control_op[1]
     
     snd << Message[
       client: 0, local: 0, global: 0, delta: 1,
@@ -152,17 +160,21 @@ class TestSubscribe < Minitest::Test
     assert_equal ["foo"], m.tags
 
     rcv << Message.control(UNSUBSCRIBE_ALL)
+    ack = rcv.read
+    assert ack.control?
+    assert_equal 1, ack.global_tick
+    assert_equal nil, ack.control_op[1]
     
     snd << Message[
       client: 0, local: 0, global: 0, delta: 1,
       tags: ["foo"], blob: ""]
-    
-    sleep 0.2
+    Thread.pass
     
     rcv << Message.control(SUBSCRIBE_ALL)
     ack = rcv.read
     assert ack.control?
     assert_equal 2, ack.global_tick
+    assert_equal nil, ack.control_op[1]
     
     snd << Message[
       client: 0, local: 0, global: 0, delta: 1,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: funl
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Joel VanderWerf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2013-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: object-stream
@@ -37,6 +37,7 @@ files:
 - Rakefile
 - lib/funl/stream.rb
 - lib/funl/blobber.rb
+- lib/funl/subscription-tracker.rb
 - lib/funl/history-client.rb
 - lib/funl/history-worker.rb
 - lib/funl/client.rb