pq-wsm 0.0.1

data/spec/queue_spec.rb

@@ -0,0 +1,494 @@
+require './spec/spec_helper'
+require './spec/support/redis_helpers'
+require './spec/support/time'
+require './spec/support/queue_helpers'
+
+describe PcQueues::Queue do
+
+  before :each do
+    PcQueues.redis { |r| r.flushall }
+
+    @company = Company.create :name => "ProctorCam"
+    @company.create_hr_queue
+    @company.it_queues.create
+    @company.it_queues.create
+
+    @people = {
+      :john => Person.create(:name => "John", :age => 42, :is_female => false),
+      :sally => Person.create(:name => "Sally", :age => 29, :is_female => true),
+      :mildred => Person.create(:name => "Mildred", :age => 67, :is_female => true),
+      :lars => Person.create(:name => "Lars", :age => 34, :is_female => false)
+    }
+  end
+
+  after :each do
+    Time.reset # reset any stubbed time values
+
+    @company.hr_queue.destroy
+    @company.it_queues.destroy
+    @company.destroy
+  end
+
+  describe "when not empty" do
+
+    before :each do
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.enqueue @people[:sally]
+    end
+
+    it "should have an accurately reflected length in the database" do
+      expect(@company.hr_queue.length).to eq(2)
+    end
+
+    it "should have an accurately reflected length in Redis" do
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(2)
+    end
+
+    it "should not allow the same enqueable item to be enqueued multiple times" do
+      result = @company.hr_queue.enqueue @people[:john]
+      expect(result).to eq(nil)
+      expect(@company.hr_queue.length).to eq(2)
+    end
+
+  end
+
+  describe "when empty" do
+
+    it "should have an accurately reflected length in the database" do
+      expect(@company.hr_queue.length).to eq(0)
+    end
+
+    it "should have an accurately reflected length in Redis" do
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(0)
+    end
+
+    it "should dequeue nothing" do
+      expect(@company.hr_queue.dequeue).to eq(nil)
+    end
+
+  end
+
+  describe "when enqueuing" do
+
+    it "should publish accurate updates to any redis subscribers" do
+      # seed 2 values
+      Time.travel_to 1.minute.ago
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.enqueue @people[:sally]
+
+      channel = "#{@company.hr_queue.class.name}.#{@company.hr_queue.id}"
+
+      on_msg = Proc.new { |message|
+        data = JSON.parse message
+        expect(data['longest_queue_wait']).to eq(60)
+        expect(data['rate']).to eq(0) # 0 queue slots per second (nothing has been dequeued yet)
+        expect(data['length']).to eq(3)
+      }
+
+      RedisHelpers::Subscription.subscribe_to_and_publish channel, on_msg do |subscriptions|
+        Time.reset
+        @company.hr_queue.enqueue @people[:mildred]
+      end
+    end
+
+    it "should increase the length of the queue by one in the database" do
+      expect(@company.hr_queue.length).to eq(0)
+      @company.hr_queue.enqueue @people[:john]
+      expect(@company.hr_queue.length).to eq(1)
+    end
+
+    it "should increase the length of the queue by one in Redis" do
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(0)
+
+      @company.hr_queue.enqueue @people[:john]
+
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(1)
+    end
+
+  end
+
+  describe "when dequeuing" do
+
+    it "should publish accurate updates to any redis subscribers" do
+      Time.travel_to 1.minute.ago
+
+      # seed 2 values
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.enqueue @people[:sally]
+
+      channel = "#{@company.hr_queue.class.name}.#{@company.hr_queue.id}"
+
+      on_msg = Proc.new { |message|
+        data = JSON.parse message
+        expect(data['longest_queue_wait']).to eq(60)
+        expect(data['rate']).to be_within(1.0/120).of(1.0/60) # 1 queue slot per minute (± 0.5 %)
+        expect(data['length']).to eq(1)
+      }
+
+      RedisHelpers::Subscription.subscribe_to_and_publish channel, on_msg do |subscriptions|
+        Time.reset
+        @company.hr_queue.dequeue
+      end
+    end
+
+    it "should decrease the length of the queue by one in the database" do
+      @company.hr_queue.enqueue @people[:john]
+      expect(@company.hr_queue.length).to eq(1)
+      @company.hr_queue.dequeue
+      expect(@company.hr_queue.length).to eq(0)
+    end
+
+    it "should increase the length of the queue by one in Redis" do
+      @company.hr_queue.enqueue @people[:john]
+
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(1)
+
+      @company.hr_queue.dequeue
+      
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(0)
+    end
+
+    it "should dequeue the element first element added (FIFO) when there are no priority queue elements" do
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.enqueue @people[:mildred]
+
+      expect(@company.hr_queue.dequeue).to eq(@people[:john])
+    end
+
+    it "should give preferential treatment to those priority queue elements if they exist" do
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.priority_enqueue @people[:mildred]
+
+      expect(@company.hr_queue.dequeue).to eq(@people[:mildred])
+    end
+
+    it "should dequeue priority queue elements in FIFO order" do
+      @company.hr_queue.priority_enqueue @people[:john]
+      @company.hr_queue.priority_enqueue @people[:mildred]
+
+      expect(@company.hr_queue.dequeue).to eq(@people[:john])
+    end
+
+  end
+
+  describe "analytics behavior" do
+
+    it "should accurately describe rate (Ruby)" do
+      Time.travel_to 1.minute.ago
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.enqueue @people[:mildred]
+
+      Time.reset
+
+      @company.hr_queue.dequeue
+      expect(@company.hr_queue.rate).to be_within(1.0/120).of(1.0/60)
+    end
+
+    it "should accurately describe rate (Redis)" do
+      Time.travel_to 1.minute.ago
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.enqueue @people[:mildred]
+      
+      channel = "#{@company.hr_queue.class.name}.#{@company.hr_queue.id}"
+
+      on_msg = Proc.new { |message|
+        data = JSON.parse message
+        expect(data['rate']).to be_within(1.0/120).of(1.0/60) # 1 queue slot per second
+      }
+
+      RedisHelpers::Subscription.subscribe_to_and_publish channel, on_msg do |subscriptions|
+        Time.reset
+        @company.hr_queue.dequeue
+      end
+    end
+
+    it "should accurately describe wait_time (Ruby) for queues with non-zero length" do
+      Time.travel_to 1.minute.ago
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.enqueue @people[:mildred]
+
+      Time.reset
+      expect(@company.hr_queue.wait_time).to eq(60)
+    end
+
+    it "should accurately describe longest_queue_wait (Redis) for queues with non-zero length" do
+      Time.travel_to 1.minute.ago
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.enqueue @people[:mildred]
+      
+      channel = "#{@company.hr_queue.class.name}.#{@company.hr_queue.id}"
+
+      on_msg = Proc.new { |message|
+        data = JSON.parse message
+        expect(data['longest_queue_wait']).to eq(60) # 1 queue slot per 60 seconds
+      }
+
+      RedisHelpers::Subscription.subscribe_to_and_publish channel, on_msg do |subscriptions|
+        Time.reset
+        @company.hr_queue.dequeue
+      end
+    end
+
+    it "should cache stats" do
+      Time.travel_to 1.hour.ago
+      @company.hr_queue.enqueue @people[:mildred]
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.dequeue
+      stats = @company.hr_queue.stats
+
+      Time.reset # move back to now -- shows that its getting the value
+                 # from Redis, not recalculating it on the Ruby side
+
+      expect(@company.hr_queue.stats).to eq(stats)
+
+    end
+
+  end
+
+  describe "when using queue rules" do
+
+    describe "with is_any queue rule set to true" do
+
+      before :each do
+        rule_set = @company.hr_queue.queue_rule_sets.create :is_any => true
+        rule_set.queue_rules.create(IsOverAgeQueueRule.options({
+            :value => 30
+          })
+        )
+
+        rule_set.queue_rules.create(NameMatchQueueRule.options({
+            :name => 'john'
+          })
+        )
+      end
+
+      it "should enqueue when all rules in the set pass" do
+        @company.hr_queue.enqueue_if_passes @people[:john]
+        expect(@company.hr_queue.length).to eq(1)
+      end
+
+      it "should enqueue when any rule in the set passes" do
+        @company.hr_queue.enqueue_if_passes @people[:mildred]
+        expect(@company.hr_queue.length).to eq(1)
+      end
+
+      it "should not enqueue when all rules in the set fail" do
+        @company.hr_queue.enqueue_if_passes @people[:sally]
+        expect(@company.hr_queue.length).to eq(0)
+      end
+
+    end
+
+    describe "with is_any queue rule set to false (is all)" do
+
+      before :each do
+        rule_set = @company.hr_queue.queue_rule_sets.create :is_any => false
+        rule_set.queue_rules.create(IsOverAgeQueueRule.options({
+            :value => 30
+          })
+        )
+
+        rule_set.queue_rules.create(NameMatchQueueRule.options({
+            :name => 'john'
+          })
+        )
+      end
+
+      it "should enqueue when all rules in the set pass" do
+        @company.hr_queue.enqueue_if_passes @people[:john]
+        expect(@company.hr_queue.length).to eq(1)
+      end
+
+      it "should not enqueue when any rule in the set fails" do
+        @company.hr_queue.enqueue_if_passes @people[:mildred]
+        expect(@company.hr_queue.length).to eq(0)
+      end
+
+      it "should not enqueue when all rules in the set fail" do
+        @company.hr_queue.enqueue_if_passes @people[:sally]
+        expect(@company.hr_queue.length).to eq(0)
+      end
+
+    end
+
+    describe "with multiple queue rule sets" do
+
+      before :each do
+        rule_set = @company.hr_queue.queue_rule_sets.create
+        rule_set.queue_rules.create(IsOverAgeQueueRule.options({
+            :value => 30
+          })
+        )
+
+        rule_set = @company.hr_queue.queue_rule_sets.create
+        rule_set.queue_rules.create(NameMatchQueueRule.options({
+            :name => 'john'
+          })
+        )
+      end
+
+      it "should enqueue when all rule sets pass" do
+        @company.hr_queue.enqueue_if_passes @people[:john]
+        expect(@company.hr_queue.length).to eq(1)
+      end
+
+      it "should not enqueue if any of the rule sets fail" do
+        @company.hr_queue.enqueue_if_passes @people[:mildred]
+        expect(@company.hr_queue.length).to eq(0)
+      end
+
+      it "should not enqueue if none of the rule sets pass" do
+        @company.hr_queue.enqueue_if_passes @people[:sally]
+        expect(@company.hr_queue.length).to eq(0)
+      end
+
+    end
+
+
+  end
+
+  describe "when working with active queues" do
+
+    it "publishes active queues (non-zero length with subscribers)" do
+      @company.hr_queue.enqueue @people[:john]
+      channel = "#{@company.hr_queue.class.name}.#{@company.hr_queue.id}"
+
+      on_msg = Proc.new { |message|
+        data = JSON.parse message
+        expect(data['length']).to eq(1)
+      }
+
+      RedisHelpers::Subscription.subscribe_to_and_publish channel, on_msg do |subscriptions|
+        PcQueues::Queue.publish_active_queues
+      end
+    end
+
+    it "does not publish inactive queues (zero length)" do
+      channel = "#{@company.hr_queue.class.name}.#{@company.hr_queue.id}"
+      
+      fake_data = {'published' => false}
+
+      on_msg = Proc.new { |message|
+        data = JSON.parse message
+        expect(data).to eq(fake_data)
+      }
+
+      RedisHelpers::Subscription.subscribe_to_and_publish channel, on_msg do |subscriptions|
+        t = Thread.new {
+          sleep 1 # assumption: 1 second is long enough for redis to have published what it was supposed to
+          PcQueues.redis{|r| r.publish "#{PcQueues.namespace}:#{channel}", fake_data.to_json }
+        }
+        PcQueues::Queue.publish_active_queues
+        t.join
+      end
+    end
+
+  end
+
+  describe "when publishing position updates" do
+
+    it "serializes and publishes a package for each item in the queue" do
+      Time.travel_to 1.minute.ago
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.enqueue @people[:mildred]
+
+      Time.reset
+      @company.hr_queue.dequeue
+
+      channel = "#{@company.hr_queue.class.name}.#{@company.hr_queue.id}.#{@people[:mildred].id}"
+
+      on_msg = Proc.new { |message|
+        data = JSON.parse message
+        expect(data['position']).to eq(1)
+        expect(data['estimated_time_left']).to eq(60)
+      }
+
+      RedisHelpers::Subscription.subscribe_to_and_publish channel, on_msg do |subscriptions|
+        @company.hr_queue.publish_positions
+      end
+    end
+
+  end
+
+  describe "cold-starting" do
+
+    before :each do
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.enqueue @people[:mildred]
+    end
+
+    it "clears Redis and repopulates it with every queue item" do
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(2)
+
+      @company.hr_queue.cold_start
+
+      expect(length).to eq(2)
+
+      redis_queue_items = QueueHelpers.get_queue_items(@company.hr_queue)
+      expect(redis_queue_items).to eq(@company.hr_queue.enqueables)
+    end
+
+    it "cold starts whenever redis gets out of sync on an enqueue event" do
+      # fake a redis dequeue -- puts this out of sync
+      Wolverine.queues.dequeue [], [ Time.now.to_i, @company.hr_queue.class.name, @company.hr_queue.id ]
+
+      @company.hr_queue.enqueue @people[:sally]
+
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(3)
+    end
+
+    it "cold starts whenever redis gets out of sync on a priority_enqueue event" do
+      # fake a redis dequeue -- puts this out of sync
+      Wolverine.queues.dequeue [], [ Time.now.to_i, @company.hr_queue.class.name, @company.hr_queue.id ]
+
+      @company.hr_queue.priority_enqueue @people[:sally]
+
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(3)
+    end
+
+    it "cold starts whenever redis gets out of sync on a dequeue event" do
+      # fake a redis dequeue -- puts this out of sync
+      Wolverine.queues.dequeue [], [ Time.now.to_i, @company.hr_queue.class.name, @company.hr_queue.id ]
+
+      @company.hr_queue.dequeue
+
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(2)
+    end
+
+    it "cold starts whenever redis gets out of sync on a remove event" do
+      # fake a redis dequeue -- puts this out of sync
+      Wolverine.queues.dequeue [], [ Time.now.to_i, @company.hr_queue.class.name, @company.hr_queue.id ]
+
+      @company.hr_queue.remove @people[:mildred]
+
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(2)
+    end
+
+  end
+
+  describe "after clearing redis" do
+
+    it "should have nothing left in it (redis)" do
+      @company.hr_queue.enqueue @people[:john]
+      @company.hr_queue.enqueue @people[:mildred]
+
+      @company.hr_queue.clear
+
+      length = QueueHelpers.get_redis_length(@company.hr_queue)
+      expect(length).to eq(0)
+    end
+
+  end
+  
+end