Starting AsyncTask now returns a status object

Author: Vectorial1024

src/AsyncTask.php

@@ -7,6 +7,7 @@
 use Closure;
 use Illuminate\Process\InvokedProcess;
 use Illuminate\Support\Facades\Process;
+use Illuminate\Support\Str;
 use Laravel\SerializableClosure\SerializableClosure;
 use LogicException;
 use loophp\phposinfo\OsInfo;
@@ -159,10 +160,15 @@ public function run(): void
 
     /**
      * Starts this AsyncTask immediately in the background. A runner will then run this AsyncTask.
-     * @return void
+     * @return AsyncTaskStatus The status object for the started AsyncTask.
      */
-    public function start(): void
+    public function start(): AsyncTaskStatus
     {
+        // prepare the task details
+        // todo allow changing the task ID
+        $taskID = null ?? Str::ulid();
+        $taskStatus = new AsyncTaskStatus($taskID);
+
         // prepare the runner command
         $serializedTask = $this->toBase64Serial();
         $baseCommand = "php artisan async:run $serializedTask";
@@ -173,7 +179,7 @@ public function start(): void
             // but we require cmd (ps won't work here), so might as well force cmd like this
             // windows has real max time limit
             $this->runnerProcess = Process::quietly()->start("cmd >nul 2>nul /c start /b $baseCommand");
-            return;
+            return $taskStatus;
         }
         // assume anything not windows to be unix
         // unix use nohup
@@ -197,6 +203,7 @@ public function start(): void
             $timeoutClause = static::$timeoutCmdName . " -s 2 {$this->timeLimit}";
         }
         $this->runnerProcess = Process::quietly()->start("nohup $timeoutClause $baseCommand >/dev/null 2>&1");
+        return $taskStatus;
     }
 
     /**

src/AsyncTaskStatus.php

@@ -13,6 +13,12 @@
  */
 class AsyncTaskStatus
 {
+    /**
+     * The cached task ID for quick ID reusing. We will most probably reuse this ID many times.
+     * @var string|null
+     */
+    private string|null $encodedTaskID = null;
+
     /**
      * Constructs a status object.
      * @param string $taskID The task ID of the async task so to check its status.
@@ -25,4 +31,16 @@ public function __construct(
             throw new RuntimeException("AsyncTask IDs cannot be blank");
         }
     }
+
+    /**
+     * Returns the task ID encoded in base64, mainly for result checking.
+     * @return string The encoded task ID.
+     */
+    public function getEncodedTaskID(): string
+    {
+        if ($this->encodedTaskID === null) {
+            $this->encodedTaskID = base64_encode($this->taskID);
+        }
+        return $this->encodedTaskID;
+    }
 }