Merge branch 'hotfix/remove-with-multiple-items-in-queue'

Close #27

Author: weierophinney

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
-## 2.7.3 - TBD
+## 2.7.3 - 2015-09-24
 
 ### Added
 
@@ -18,7 +18,9 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- Nothing.
+- [#27](https://github.com/zendframework/zend-stdlib/pull/27) fixes a race
+  condition in the `FastPriorityQueue::remove()` logic that occurs when removing
+  items iteratively from the same priority of a queue.
 
 ## 2.7.2 - 2015-09-23
 

src/FastPriorityQueue.php

@@ -135,7 +135,8 @@ public function remove($datum)
         $this->rewind();
         while ($this->valid()) {
             if (current($this->values[$this->maxPriority]) === $datum) {
-                unset($this->values[$this->maxPriority][$this->subIndex]);
+                $index = key($this->values[$this->maxPriority]);
+                unset($this->values[$this->maxPriority][$index]);
                 --$this->count;
                 return true;
             }

test/FastPriorityQueueTest.php

@@ -238,4 +238,51 @@ public function testRewindShouldNotRaiseErrorWhenQueueIsEmpty()
         $queue->rewind();
         restore_error_handler();
     }
+
+    public function testRemoveShouldFindItemEvenIfMultipleItemsAreInQueue()
+    {
+        $prototype = function ($e) {
+        };
+
+        $queue = new FastPriorityQueue();
+        $this->assertTrue($queue->isEmpty());
+
+        $listeners = [];
+        for ($i = 0; $i < 5; $i += 1) {
+            $listeners[] = $listener = clone $prototype;
+            $queue->insert($listener, 1);
+        }
+
+        $remove   = array_rand(array_keys($listeners));
+        $listener = $listeners[$remove];
+
+        $this->assertTrue($queue->contains($listener));
+        $this->assertTrue($queue->remove($listener));
+        $this->assertFalse($queue->contains($listener));
+    }
+
+    public function testIterativelyRemovingItemsShouldRemoveAllItems()
+    {
+        $prototype = function ($e) {
+        };
+
+        $queue = new FastPriorityQueue();
+        $this->assertTrue($queue->isEmpty());
+
+        $listeners = [];
+        for ($i = 0; $i < 5; $i += 1) {
+            $listeners[] = $listener = clone $prototype;
+            $queue->insert($listener, 1);
+        }
+
+        for ($i = 0; $i < 5; $i += 1) {
+            $listener = $listeners[$i];
+            $queue->remove($listener);
+        }
+
+        for ($i = 0; $i < 5; $i += 1) {
+            $listener = $listeners[$i];
+            $this->assertFalse($queue->contains($listener), sprintf('Listener %s remained in queue', $i));
+        }
+    }
 }