Test async timeout handlers are not wrongly triggered

Author: Vectorial1024

tests/AsyncTaskTest.php

@@ -6,6 +6,9 @@
 use RuntimeException;
 use Vectorial1024\LaravelProcessAsync\AsyncTask;
 use Vectorial1024\LaravelProcessAsync\Tests\Tasks\DummyAsyncTask;
+use Vectorial1024\LaravelProcessAsync\Tests\Tasks\TestTimeoutENoticeTask;
+use Vectorial1024\LaravelProcessAsync\Tests\Tasks\TestTimeoutErrorTask;
+use Vectorial1024\LaravelProcessAsync\Tests\Tasks\TestTimeoutNoOpTask;
 use Vectorial1024\LaravelProcessAsync\Tests\Tasks\TestTimeoutNormalTask;
 
 class AsyncTaskTest extends BaseTestCase
@@ -145,4 +148,49 @@ public function testAsyncTimeout()
         $this->assertStringEqualsFile($textFilePath, $message);
         $this->assertNoNohupFile();
     }
+    
+    public function testAsyncTimeoutIgnoreErrors()
+    {
+        // test that the async timeout handler is not triggered due to other fatal errors
+        $message = "timeout occured";
+        $textFilePath = $this->getStoragePath("testAsyncTimeoutIgnoreErrors.txt");
+        $timeoutTask = new TestTimeoutErrorTask($message, $textFilePath);
+        $task = new AsyncTask($timeoutTask);
+        $task->withTimeLimit(1)->start();
+        // we wait for it to timeout
+        $this->sleep(1);
+        // should have timed out
+        $this->assertFileDoesNotExist($textFilePath, "The async task timeout handler was inappropriately triggered (PHP fatal errors should not trigger timeouts).");
+        $this->assertNoNohupFile();
+    }
+
+    public function testAsyncTimeoutIgnoreNoProblem()
+    {
+        // test that the async timeout handler is not triggered when nothing happened
+        $message = "timeout occured";
+        $textFilePath = $this->getStoragePath("testAsyncTimeoutIgnoreNoProblem.txt");
+        $timeoutTask = new TestTimeoutNoOpTask($message, $textFilePath);
+        $task = new AsyncTask($timeoutTask);
+        $task->withTimeLimit(1)->start();
+        // we wait for it to timeout
+        $this->sleep(1);
+        // should have timed out
+        $this->assertFileDoesNotExist($textFilePath, "The async task timeout handler was inappropriately triggered (finishing a task before the time limit should not trigger timeouts).");
+        $this->assertNoNohupFile();
+    }
+    
+    public function testAsyncTimeoutIgnoreENotice()
+    {
+        // test that the async timeout handler is not triggered when there is an E_NOTICE error
+        $message = "timeout occured";
+        $textFilePath = $this->getStoragePath("testAsyncTimeoutIgnoreENotice.txt");
+        $timeoutTask = new TestTimeoutENoticeTask($message, $textFilePath);
+        $task = new AsyncTask($timeoutTask);
+        $task->withTimeLimit(1)->start();
+        // we wait for it to timeout
+        $this->sleep(1);
+        // should have timed out
+        $this->assertFileDoesNotExist($textFilePath, "The async task timeout handler was inappropriately triggered (E_NOTICE should not trigger timeouts).");
+        $this->assertNoNohupFile();
+    }
 }

tests/Tasks/TestTimeoutENoticeTask.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Vectorial1024\LaravelProcessAsync\Tests\Tasks;
+
+use Vectorial1024\LaravelProcessAsync\AsyncTaskInterface;
+
+class TestTimeoutENoticeTask implements AsyncTaskInterface
+{
+    // triggers an E_NOTICE error; the timeout handler should NOT trigger! this is because script execution can still continue (at least in PHP 8)
+
+    public function __construct(
+        private string $message,
+        private string $targetFilePath
+    ) {
+    }
+
+    public function execute(): void
+    {
+        // eh eh
+        $context;
+    }
+
+    public function handleTimeout(): void
+    {
+        $fp = fopen($this->targetFilePath, "w");
+        fwrite($fp, $this->message);
+        fflush($fp);
+        fclose($fp);
+    }
+}

tests/Tasks/TestTimeoutErrorTask.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Vectorial1024\LaravelProcessAsync\Tests\Tasks;
+
+use Vectorial1024\LaravelProcessAsync\AsyncTaskInterface;
+
+class TestTimeoutErrorTask implements AsyncTaskInterface
+{
+    // has a timeout handler, but throws a runtime exception (the timeout handler is not triggered)
+
+    public function __construct(
+        private string $message,
+        private string $targetFilePath
+    ) {
+    }
+
+    public function execute(): void
+    {
+        // boom!
+        1 / 0;
+    }
+
+    public function handleTimeout(): void
+    {
+        $fp = fopen($this->targetFilePath, "w");
+        fwrite($fp, $this->message);
+        fflush($fp);
+        fclose($fp);
+    }
+}

tests/Tasks/TestTimeoutNoOpTask.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Vectorial1024\LaravelProcessAsync\Tests\Tasks;
+
+use Vectorial1024\LaravelProcessAsync\AsyncTaskInterface;
+
+class TestTimeoutNoOpTask implements AsyncTaskInterface
+{
+    // quite literally does nothing; the timeout handler is therefore only for decoration
+
+    public function __construct(
+        private string $message,
+        private string $targetFilePath
+    ) {
+    }
+
+    public function execute(): void
+    {
+        // goodbye!
+        exit();
+    }
+
+    public function handleTimeout(): void
+    {
+        $fp = fopen($this->targetFilePath, "w");
+        fwrite($fp, $this->message);
+        fflush($fp);
+        fclose($fp);
+    }
+}