Merge pull request #1 from utopia-php/feat-new-loop-method

New loop method

Author: eldadfux

README.md

@@ -19,7 +19,7 @@ script.php
 ```php
 <?php
 
-require_once '../vendor/autoload.php';
+require_once './vendor/autoload.php';
 
 use Utopia\CLI\CLI;
 use Utopia\CLI\Console;
@@ -96,6 +96,22 @@ echo $stdout; // ''
 echo $stderr; // 'error'
 ```
 
+### Create a Daemon
+
+You can use the `Console::loop` command to create your PHP daemon. The `loop` method already handles CPU consumption using a configurable sleep function and calls the PHP garbage collector every 5 minutes.
+
+```php
+<?php
+
+use Utopia\CLI\Console;
+
+include './vendor/autoload.php';
+
+Console::loop(function() {
+    echo "Hello World\n";
+}, 200000 /* 200ms */);
+```
+
 ## System Requirements
 
 Utopia Framework requires PHP 7.3 or later. We recommend using the latest PHP version whenever possible.

src/CLI/Console.php

@@ -186,4 +186,31 @@ static public function isInteractive(): bool
     {
         return ('cli' === PHP_SAPI && defined('STDOUT'));
     }
+
+    /**
+     * @param callable $callback
+     * @param int $sleep in microseconds
+     */
+    static public function loop(callable $callback, $sleep = 100000 /* 100ms */): void
+    {
+        gc_enable();
+
+        $time = 0;
+        
+        while (!connection_aborted() || PHP_SAPI == "cli") {
+
+            $callback();
+
+            usleep($sleep);
+
+            $time = $time + $sleep;
+
+            if (PHP_SAPI == "cli") {
+                if($time >= (1000000 * 300)) { // Every 5 minutes
+                    $time = 0;
+                    gc_collect_cycles(); //Forces collection of any existing garbage cycles
+                }
+            }
+        }
+    }
 }

tests/CLI/ConsoleTest.php

@@ -114,4 +114,18 @@ public function testExecuteTimeout()
         $this->assertEquals('', $stdout);
         $this->assertEquals(1, $code);
     }
+
+    public function testLoop()
+    {
+        $file = __DIR__.'/../resources/loop.php';
+        $stdin = '';
+        $stdout = '';
+        $stderr = '';
+        $code = Console::execute('php '.$file, $stdin, $stdout, $stderr, 3);
+
+        $this->assertEquals('', $stderr);
+        $this->assertGreaterThan(30, count(explode("\n", $stdout)));
+        $this->assertLessThan(50, count(explode("\n", $stdout)));
+        $this->assertEquals(1, $code);
+    }
 }

tests/resources/loop.php

@@ -0,0 +1,9 @@
+<?php
+
+use Utopia\CLI\Console;
+
+include __DIR__.'/../../vendor/autoload.php';
+
+Console::loop(function() {
+    echo "Hello\n";
+});