rhubarb_app environment setting support to allow background tasks to work in new environment

Author: NiallSmyth

CHANGELOG.md

@@ -5,10 +5,13 @@
 * TODO:     Windows support
 * TODO:     Restore PhpIdeConfig setting to allow debugging of running background tasks
 
+### 1.1.1
+* UPDATED:  rhubarb_app environment setting support to allow background tasks to work in new environment
+
 ### 1.1.0
 * UPDATED:	Stem 1.1 Support
 
 ### 1.0.0
 
 * ADDED:    Codeception instead of PHP unit
-* REMOVED:  Reference to the PhpIdeConfig - not in Rhubarb 1.0.0 any longer
+* REMOVED:  Reference to the PhpIdeConfig - not in Rhubarb 1.0.0 any longer

src/BackgroundTask.php

@@ -20,6 +20,7 @@
 
 use Rhubarb\Crown\Logging\Log;
 use Rhubarb\Scaffolds\BackgroundTasks\Models\BackgroundTaskStatus;
+use Rhubarb\Crown\Application;
 
 /**
  * Extend this class to create an executable BackgroundTask
@@ -34,9 +35,10 @@ abstract class BackgroundTask
     /**
      * Executes the long running code.
      *
+     * @param BackgroundTaskStatus $status
      * @return void
      */
-    public abstract function execute(BackgroundTaskStatus $status);
+    abstract public function execute(BackgroundTaskStatus $status);
 
     /**
      * If you need to provide additional arguments for the task runner (such as passing encrypted conenction
@@ -62,6 +64,8 @@ public static function setShellArguments($rawShellArguments)
     /**
      * Initiates execution of the background task.
      *
+     * @param array $settings Settings which will be passed to the execute method of the BackgroundTask (must be JSON serialisable)
+     *
      * @return BackgroundTaskStatus The status object for this task.
      */
     public static function initiate($settings = [])
@@ -79,12 +83,14 @@ public static function initiate($settings = [])
             $additionalArgumentString .= escapeshellarg($argument);
         }
 
-        $command = "/usr/bin/env php " . realpath(VENDOR_DIR."/rhubarbphp/rhubarb/platform/execute-cli.php") . " " . realpath(__DIR__ . "/Scripts/task-runner.php") . " " . escapeshellarg(get_called_class()) . " " . $task->BackgroundTaskStatusID . " " . $additionalArgumentString . " > /dev/null 2>&1 &";
+        $runningRhubarbAppClass = escapeshellarg(get_class(Application::current()));
+        $command = "rhubarb_app=$runningRhubarbAppClass /usr/bin/env php " . realpath(VENDOR_DIR . "/rhubarbphp/rhubarb/platform/execute-cli.php") . " " .
+            realpath(__DIR__ . "/Scripts/task-runner.php") . " " . escapeshellarg(get_called_class()) . " " . $task->BackgroundTaskStatusID . " " . $additionalArgumentString . " > /dev/null 2>&1 &";
 
         Log::debug("Launching background task " . $task->UniqueIdentifier, "BACKGROUND", $command);
 
         exec($command);
 
         return $task;
     }
-}
+}

src/Models/BackgroundTaskStatus.php

@@ -36,6 +36,7 @@
  * @property string $Message
  * @property string $TaskStatus The status of the task: Running, Complete or Failed
  * @property string $ExceptionDetails If the task failed, exception details will be contained here.
+ * @property \stdClass $TaskSettings Settings to be passed to the task, stored as JSON
  */
 class BackgroundTaskStatus extends Model
 {
@@ -53,13 +54,16 @@ protected function createSchema()
         $schema = new ModelSchema("tblBackgroundTaskStatus");
         $schema->addColumn(
             new AutoIncrementColumn("BackgroundTaskStatusID"),
-            new StringColumn( "TaskClass", 300 ),
-            new MySqlEnumColumn( "TaskStatus", self::TASK_STATUS_RUNNING,
-                [ self::TASK_STATUS_COMPLETE, self::TASK_STATUS_FAILED, self::TASK_STATUS_RUNNING ] ),
+            new StringColumn("TaskClass", 300),
+            new MySqlEnumColumn(
+                "TaskStatus",
+                self::TASK_STATUS_RUNNING,
+                [self::TASK_STATUS_COMPLETE, self::TASK_STATUS_FAILED, self::TASK_STATUS_RUNNING]
+            ),
             new DecimalColumn("PercentageComplete", 5, 2, 0),
-            new StringColumn("Message",200),
+            new StringColumn("Message", 200),
             new LongStringColumn("ExceptionDetails"),
-            new JsonColumn( "TaskSettings", null, true )
+            new JsonColumn("TaskSettings", null, true)
         );
 
         return $schema;
@@ -81,9 +85,9 @@ public function start()
             $task->execute($this);
 
             $this->TaskStatus = "Complete";
-        } catch ( RhubarbException $er ) {
+        } catch (RhubarbException $er) {
             $this->TaskStatus = "Failed";
-            $this->ExceptionDetails = $er->getMessage()."\r\n\r\n".$er->getTraceAsString();
+            $this->ExceptionDetails = $er->getMessage() . "\r\n\r\n" . $er->getTraceAsString();
         }
 
         $this->save();
@@ -95,4 +99,4 @@ public function isRunning()
 
         return $this->TaskStatus == "Running";
     }
-}
+}