FuzeWorks/Async
FuzeWorks/Async
1
0
Fork 0
Code Issues 5 Pull Requests Releases 1 Activity

Implemented changes to binaries. Binaries now accept a 'bootstrap' argument, allowing the developer to load a custom bootstrap from the project they're working on.

Browse Source 
This allows Async to run in the same environment as the project it's part of.
This commit is contained in:
Abel Hoogeveen 2020-02-12 15:28:03 +01:00
parent d35f15114b
commit 974a381b5a
No known key found for this signature in database
GPG Key ID: 96C2234920BF4292
9 changed files with 184 additions and 166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
bin/supervisor
View File

@ -40,7 +40,9 @@ use FuzeWorks\Async\Tasks;
use FuzeWorks\Async\TasksException;
use FuzeWorks\Exception\InvalidArgumentException;
use FuzeWorks\Exception\LibraryException;
use FuzeWorks\Factory;
// First perform a PHP version check
if (version_compare('7.1.0', PHP_VERSION, '>')) {
fwrite(
STDERR,
@ -63,35 +65,56 @@ $autoloaders = [
];
foreach ($autoloaders as $file)
if (file_exists($file))
require($file);
require_once($file);
// If a bootstrap is provided, use that one
$arguments = getopt('', ['bootstrap:']);
if (!isset($arguments['bootstrap']) || empty($arguments['bootstrap']))
{
fwrite(STDERR, "Could not load supervisor. No bootstrap provided.");
die(1);
}
// Load the file. If it doesn't exist, fail.
$file = $arguments['bootstrap'];
if (!file_exists($file))
{
fwrite(STDERR, "Could not load supervisor. Provided bootstrap doesn't exist.");
die(1);
}
// Load the bootstrap
/** @var Factory $container */
$container = require($file);
// Check if container is a Factory
if (!$container instanceof Factory)
{
fwrite(STDERR, "Could not load supervisor. Provided bootstrap is not a valid bootstrap.");
die(1);
}
// Check if the Async library is already loaded. If not, load it.
// @todo: Better check in libraries for existing library
try {
// Open configurator
$configurator = new FuzeWorks\Configurator();
// Set up basic settings
$configurator->setTimeZone('Europe/Amsterdam');
$configurator->setTempDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'temp');
$configurator->setLogDirectory(dirname(__FILE__). DIRECTORY_SEPARATOR . 'log');
// Add Async library
$configurator->deferComponentClassMethod('libraries', 'addLibraryClass', null, 'async', '\FuzeWorks\Async\Tasks');
// Debug
$configurator->enableDebugMode()->setDebugAddress('ALL');
// Create container
$container = $configurator->createContainer();
// RUN THE APP
/** @var Tasks $lib */
$lib = $container->libraries->get('async');
} catch (LibraryException $e) {
$container->libraries->addLibraryClass('async', '\FuzeWorks\Async\Tasks');
/** @var Tasks $lib */
$lib = $container->libraries->get('async');
}
// And finally, run the supervisor
try {
$supervisor = $lib->getSuperVisor();
while ($supervisor->cycle() === SuperVisor::RUNNING) {
usleep(250000);
}
// Write results
fwrite(STDOUT, "SuperVisor finished scheduled tasks.");
} catch (InvalidArgumentException | TasksException | LibraryException $e) {
fwrite(STDERR, sprintf('FuzeWorks Async could not load.' . PHP_EOL .
'Exception: ' . $e->getMessage() . PHP_EOL)

125
bin/worker Normal file
View File

@ -0,0 +1,125 @@
#!/usr/bin/env php
<?php
/**
* FuzeWorks Async Library
*
* The FuzeWorks PHP FrameWork
*
* Copyright (C) 2013-2020 TechFuze
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* @author TechFuze
* @copyright Copyright (c) 2013 - 2020, TechFuze. (http://techfuze.net)
* @license https://opensource.org/licenses/MIT MIT License
*
* @link http://techfuze.net/fuzeworks
* @since Version 1.0.0
*
* @version Version 1.0.0
*/
use FuzeWorks\Async\Tasks;
use FuzeWorks\Async\TasksException;
use FuzeWorks\Exception\InvalidArgumentException;
use FuzeWorks\Exception\LibraryException;
use FuzeWorks\Factory;
// First perform a PHP version check
if (version_compare('7.1.0', PHP_VERSION, '>')) {
fwrite(
STDERR,
sprintf(
'FuzeWorks Async requires PHP 7.1 or higher.' . PHP_EOL .
'You are using PHP %s (%s).' . PHP_EOL,
PHP_VERSION,
PHP_BINARY
)
);
die(1);
}
// First load composer
$autoloaders = [
__DIR__ . '/../../autoload.php',
__DIR__ . '/../vendor/autoload.php',
__DIR__ . '/vendor/autoload.php'
];
foreach ($autoloaders as $file)
if (file_exists($file))
require_once($file);
// If a bootstrap is provided, use that one
$arguments = getopt('', ['bootstrap:']);
if (!isset($arguments['bootstrap']) || empty($arguments['bootstrap']))
{
fwrite(STDERR, "Could not load worker. No bootstrap provided.");
die(1);
}
// Load the file. If it doesn't exist, fail.
$file = $arguments['bootstrap'];
if (!file_exists($file))
{
fwrite(STDERR, "Could not load worker. Provided bootstrap doesn't exist.");
die(1);
}
// Load the bootstrap
/** @var Factory $container */
$container = require($file);
// Check if container is a Factory
if (!$container instanceof Factory)
{
fwrite(STDERR, "Could not load worker. Provided bootstrap is not a valid bootstrap.");
die(1);
}
// Check if the Async library is already loaded. If not, load it.
// @todo: Better check in libraries for existing library
try {
/** @var Tasks $lib */
$lib = $container->libraries->get('async');
} catch (LibraryException $e) {
$container->libraries->addLibraryClass('async', '\FuzeWorks\Async\Tasks');
/** @var Tasks $lib */
$lib = $container->libraries->get('async');
}
// Fetch arguments for the worker
$arguments = getopt("t:p::");
if (!isset($arguments['t']))
{
fwrite(STDERR, "Could not load worker. No taskID provided.");
die(1);
}
// Prepare arguments
$taskID = base64_decode($arguments['t']);
$post = isset($arguments['p']);
// RUN THE APP
$worker = $lib->getWorker();
$worker->run($taskID, $post);
fwrite(STDOUT,'Finished task \'' . $taskID . "'");
?>

2
composer.json
View File

@ -22,5 +22,5 @@
"FuzeWorks\\Async\\": "src/FuzeWorks/Async"
}
},
"bin": ["bin/supervisor"]
"bin": ["bin/supervisor", "bin/worker"]
}

2
config.tasks.php
View File

@ -48,6 +48,6 @@ return array(
'type' => 'ShellExecutor',
// For ShellExecutor, first parameter is the file location of the worker script
'parameters' => [dirname(__FILE__) . DS . 'worker.php']
'parameters' => [dirname(__FILE__) . DS . 'bin' . DS . 'worker']
]
);

4
src/FuzeWorks/Async/Executors/ShellExecutor.php
View File

@ -60,7 +60,7 @@ class ShellExecutor implements Executor
$this->binary = PHP_BINDIR . DS . 'php';
if (!file_exists($workerFile))
throw new TasksException("Could not construct ShellExecutor. Worker script does not exist.");
throw new TasksException("Could not construct ShellExecutor. ShellWorker script does not exist.");
$this->worker = $workerFile;
}
@ -77,7 +77,7 @@ class ShellExecutor implements Executor
public function startTask(Task $task, bool $post = false): Task
{
// First prepare the command used to spawn workers
$commandString = "$this->binary $this->worker %s ".($post ? 'post' : 'run')." $this->stdout $this->stderr & echo $!";
$commandString = "$this->binary $this->worker -t %s ".($post ? 'p' : '')." $this->stdout $this->stderr & echo $!";
// Then execute the command using the base64_encoded string of the taskID
$output = $this->shellExec($commandString, [base64_encode($task->getId())]);

12
src/FuzeWorks/Async/Worker.php → src/FuzeWorks/Async/ShellWorker.php
View File

@ -42,7 +42,7 @@ use FuzeWorks\Exception\EventException;
use FuzeWorks\Logger;
use FuzeWorks\Priority;
class Worker
class ShellWorker
{
/**
@ -75,7 +75,11 @@ class Worker
public function run(string $taskID, bool $post = false)
{
// First fetch the task
$task = $this->taskStorage->getTaskById($taskID);
try {
$task = $this->taskStorage->getTaskById($taskID);
} catch (TasksException $e) {
throw new TasksException("Could not run worker. Task not found.");
}
// Fire a taskHandleEvent
/** @var TaskHandleEvent $event */
@ -159,6 +163,10 @@ class Worker
$errors = $this->getErrors();
$this->output('', $errors);
// If no task is set yet, abort error logging to task
if (is_null($this->task))
return;
try {
// Write to TaskStorage
if (!$this->post)

6
src/FuzeWorks/Async/Tasks.php
View File

@ -94,12 +94,12 @@ class Tasks implements iLibrary
}
/**
* @return Worker
* @return ShellWorker
* @throws TasksException
*/
public function getWorker(): Worker
public function getWorker(): ShellWorker
{
return new Worker($this->getTaskStorage());
return new ShellWorker($this->getTaskStorage());
}
/**

70
supervisor.php
View File

@ -1,70 +0,0 @@
<?php
/**
* FuzeWorks Async Library
*
* The FuzeWorks PHP FrameWork
*
* Copyright (C) 2013-2020 TechFuze
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* @author TechFuze
* @copyright Copyright (c) 2013 - 2020, TechFuze. (http://techfuze.net)
* @license https://opensource.org/licenses/MIT MIT License
*
* @link http://techfuze.net/fuzeworks
* @since Version 1.0.0
*
* @version Version 1.0.0
*/
use FuzeWorks\Async\SuperVisor;
use FuzeWorks\Async\Tasks;
use FuzeWorks\Logger;
require_once('vendor/autoload.php');
// Open configurator
$configurator = new FuzeWorks\Configurator();
// Set up basic settings
$configurator->setTimeZone('Europe/Amsterdam');
$configurator->setTempDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'temp');
$configurator->setLogDirectory(dirname(__FILE__). DIRECTORY_SEPARATOR . 'log');
// Add Async library
$configurator->deferComponentClassMethod('libraries', 'addLibraryClass', null, 'async', '\FuzeWorks\Async\Tasks');
// Debug
$configurator->enableDebugMode()->setDebugAddress('ALL');
// Create container
$container = $configurator->createContainer();
// Add lib
Logger::enableScreenLog();
// RUN THE APP
/** @var Tasks $lib */
$lib = $container->libraries->get('async');
$supervisor = $lib->getSuperVisor();
while ($supervisor->cycle() === SuperVisor::RUNNING) {
usleep(250000);
}

68
worker.php
View File

@ -1,68 +0,0 @@
<?php
/**
* FuzeWorks Async Library
*
* The FuzeWorks PHP FrameWork
*
* Copyright (C) 2013-2020 TechFuze
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* @author TechFuze
* @copyright Copyright (c) 2013 - 2020, TechFuze. (http://techfuze.net)
* @license https://opensource.org/licenses/MIT MIT License
*
* @link http://techfuze.net/fuzeworks
* @since Version 1.0.0
*
* @version Version 1.0.0
*/
use FuzeWorks\Async\Tasks;
require_once('vendor/autoload.php');
// Open configurator
$configurator = new FuzeWorks\Configurator();
// Set up basic settings
$configurator->setTimeZone('Europe/Amsterdam');
$configurator->setTempDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'temp');
$configurator->setLogDirectory(dirname(__FILE__). DIRECTORY_SEPARATOR . 'log');
// Add Async library
$configurator->deferComponentClassMethod('libraries', 'addLibraryClass', null, 'async', '\FuzeWorks\Async\Tasks');
// Debug
$configurator->enableDebugMode()->setDebugAddress('ALL');
// Create container
$container = $configurator->createContainer();
// Prepare arguments
$script = array_shift($argv);
$taskID = array_shift($argv);
$taskID = base64_decode($taskID);
$mode = trim(array_shift($argv));
$post = ($mode === 'post' ? true : false);
// RUN THE APP
/** @var Tasks $lib */
$lib = $container->libraries->get('async');
$worker = $lib->getWorker();
$worker->run($taskID, $post);