[EventLoop] Fix timers when using libevent-based loop.

Since a closure cannot destroy itself from inside its body, to prevent
PHP from raising the fatal error "Cannot destroy active lambda function"
when cancelling a periodic timer from inside its callback we previously
tried to postpone the call to event_free() on the affected libevent
timer resource at a later stage by queueing up timer resources to be
freed. This approach was quite awkward and eventually lead to complex
code, difficult to test and with other unexpected side effects such as
memory leaks in a couple of corner cases.

This new fix greatly reduces code complexity and makes it possible to
free up timer resources immediatly when cancelling a timer: we simply
keep a reference of our internal timer callback from inside itself so
that its refcount is still > 1 when calling event_free(), effectively
preventing PHP's garbage collector to kick in when the closure is
still active.

Author: nrk

src/React/EventLoop/LibEventLoop.php

@@ -10,7 +10,6 @@ class LibEventLoop implements LoopInterface
     private $callback;
 
     private $timers = array();
-    private $timersGc;
 
     private $events = array();
     private $flags = array();
@@ -21,8 +20,6 @@ public function __construct()
     {
         $this->base = event_base_new();
         $this->callback = $this->createLibeventCallback();
-        $this->timersGc = new \SplQueue();
-        $this->timersGc->setIteratorMode(\SplQueue::IT_MODE_DELETE);
     }
 
     protected function createLibeventCallback()
@@ -171,18 +168,13 @@ protected function addTimerInternal($interval, $callback, $periodic = false)
         );
 
         $timer->signature = spl_object_hash($timer);
-        $timersGc = $this->timersGc;
-
         $that = $this;
-        $callback = function () use ($timer, $timersGc, $that) {
-            foreach ($timersGc as $resource) {
-                event_free($resource);
-            }
 
+        $callback = function () use ($timer, $that, &$callback) {
             if ($timer->cancelled === false) {
                 call_user_func($timer->callback, $timer->signature, $timer->loop);
 
-                if ($timer->periodic === true) {
+                if ($timer->periodic === true && $timer->cancelled === false) {
                     event_add($timer->resource, $timer->interval);
                 } else {
                     $that->cancelTimer($timer->signature);
@@ -216,7 +208,7 @@ public function cancelTimer($signature)
 
             $timer->cancelled = true;
             event_del($timer->resource);
-            $this->timersGc->enqueue($timer->resource);
+            event_free($timer->resource);
             unset($this->timers[$signature]);
         }
     }

tests/React/Tests/EventLoop/Timer/LibEventTimerTest.php

@@ -14,9 +14,4 @@ public function createLoop()
 
         return new LibEventLoop();
     }
-
-    public function testAddPeriodicTimerCancelsItself()
-    {
-        $this->markTestSkipped('libevent timers are currently broken.');
-    }
 }