2020-02-01 14:32:36 +01:00
|
|
|
#!/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\SuperVisor;
|
|
|
|
use FuzeWorks\Async\Tasks;
|
|
|
|
use FuzeWorks\Async\TasksException;
|
|
|
|
use FuzeWorks\Exception\InvalidArgumentException;
|
|
|
|
use FuzeWorks\Exception\LibraryException;
|
2020-02-14 15:31:09 +01:00
|
|
|
use FuzeWorks\Factory;
|
2020-02-01 14:32:36 +01:00
|
|
|
|
2020-02-14 15:31:09 +01:00
|
|
|
// First perform a PHP version check
|
Release of RC1 (#7)
Finished ControllerHandler into a working state.
Merge remote-tracking branch 'origin/master' into 3-features
# Conflicts:
# Dockerfile
# bin/supervisor
# bin/worker
# composer.json
# src/FuzeWorks/Async/Executors/ShellExecutor.php
# src/FuzeWorks/Async/ShellWorker.php
# src/FuzeWorks/Async/Supervisors/ParallelSuperVisor.php
# src/FuzeWorks/Async/TaskStorage/RedisTaskStorage.php
# src/FuzeWorks/Async/Tasks.php
# test/bootstrap.php
# test/mock/Handlers/EmptyHandler.php
# test/mock/Handlers/TestStopTaskHandler.php
Started work on making tasks forcefully quit after a maximum time has expired.
Finished tasks are no longer loaded in SuperVisor.
By adding a parameter in TaskStorage, it is now possible to distinguish between finished and unfinished tasks.
Finished tasks are those tasks that have a status of Task::COMPLETED or Task::CANCELLED. Unfinished tasks are all others.
This allows the SuperVisor to not bother with the mountain of tasks that will be saved during large projects.
Implemented proper dependencies.
Dependencies can now pass output to each other using the DependentTaskHandler.
Also fixed some general problems in the Tasks class, for instance the Executor not starting correctly because of problematic parameters.
Also, SuperVisor now sets the output of a Task using the last output of the task, and not the first.
Return all output when providing attempt = 0.
When providing $attempt = 0 at readTaskOutput and readPostOutput, all output shall be returned.
This is the default return. Hence, a lot of tests had to be altered slightly.
Changed the way task output and post output is saved.
Redis now saves all output for a task within a hash. This hash contains individual tasks and all its output.
Attempts also start at 1, since that makes most sense for this context. When output is written, the TaskStorage must figure out at which attempt the Task is.
Implemented Parent Handlers.
Parent Handlers can be stacked to run in succession. Output is transfered as input into the child handler which can continue with it. If the parent Handler fails, all Child handlers also fail.
Made Handlers an object instead of a string reference.
Handlers should now be added as objects, adding some flexibility to the developer.
Developers are still cautioned to take great care that Handlers work approriately. Handlers can potentially crash the SuperVisor if not taken good care of.
Try with only Redis.
Made many changes. Fixed race-conditions in test code.
Now try while flushing a selected database.
Try again in the new environment.
Maybe Events are the problem?
Fixed DummyTaskStorage persisting outside of the storage.
Awkward how that could go wrong...
Added TaskModifyEvent.
Event gets fired when an Event is modified by sending it to TaskStorage::modifyEvent. This allows components to observe changes and report these to the user. Might also be useful to cancel unwanted changes.
Made the Docker image Alpine-based. Should work better when running Async in a Cron environment.
Also removed compatibility with PHP 7.2.
Implemented many unit tests.
Now with coverage
And remove the Redis debug again
Now?
Temporarily check if Redis works
Added separate environments for DummyTaskStorage and RedisTaskStorage.
System now uses environment variables imported through Docker. See test/config.tasks.php for all environment options available.
Now try with an added service
Attempt to run a PHPUnit batch
Try with a modified environment.
Try again
Started implementing Drone
ControllerHandler now works. Next up is a distinction between Task and Process status.
Started implementing ControllerHandler.
ControllerHandler is a standard utility handler for MVCR Controllers. This allows the user to create a task which is handled by a standardized controller.
Not finished yet! Needs some love.
Add 'addTasks' method to `Tasks` class
Implemented basic RedisTaskStorage.
- Fixed bug where worker is not provided with bootstrap by ShellExecutor.
- Added composer and Redis to Dockerfile
- Added more output to ParallelSuperVisor
Updated config format.
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.
This allows Async to run in the same environment as the project it's part of.
Co-authored-by: Abel Hoogeveen <abel@techfuze.net>
Reviewed-on: https://gitea.i15.nl/FuzeWorks/Async/pulls/7
2020-06-07 15:54:19 +02:00
|
|
|
if (version_compare('7.3.0', PHP_VERSION, '>')) {
|
2020-02-01 14:32:36 +01:00
|
|
|
fwrite(
|
|
|
|
STDERR,
|
|
|
|
sprintf(
|
Release of RC1 (#7)
Finished ControllerHandler into a working state.
Merge remote-tracking branch 'origin/master' into 3-features
# Conflicts:
# Dockerfile
# bin/supervisor
# bin/worker
# composer.json
# src/FuzeWorks/Async/Executors/ShellExecutor.php
# src/FuzeWorks/Async/ShellWorker.php
# src/FuzeWorks/Async/Supervisors/ParallelSuperVisor.php
# src/FuzeWorks/Async/TaskStorage/RedisTaskStorage.php
# src/FuzeWorks/Async/Tasks.php
# test/bootstrap.php
# test/mock/Handlers/EmptyHandler.php
# test/mock/Handlers/TestStopTaskHandler.php
Started work on making tasks forcefully quit after a maximum time has expired.
Finished tasks are no longer loaded in SuperVisor.
By adding a parameter in TaskStorage, it is now possible to distinguish between finished and unfinished tasks.
Finished tasks are those tasks that have a status of Task::COMPLETED or Task::CANCELLED. Unfinished tasks are all others.
This allows the SuperVisor to not bother with the mountain of tasks that will be saved during large projects.
Implemented proper dependencies.
Dependencies can now pass output to each other using the DependentTaskHandler.
Also fixed some general problems in the Tasks class, for instance the Executor not starting correctly because of problematic parameters.
Also, SuperVisor now sets the output of a Task using the last output of the task, and not the first.
Return all output when providing attempt = 0.
When providing $attempt = 0 at readTaskOutput and readPostOutput, all output shall be returned.
This is the default return. Hence, a lot of tests had to be altered slightly.
Changed the way task output and post output is saved.
Redis now saves all output for a task within a hash. This hash contains individual tasks and all its output.
Attempts also start at 1, since that makes most sense for this context. When output is written, the TaskStorage must figure out at which attempt the Task is.
Implemented Parent Handlers.
Parent Handlers can be stacked to run in succession. Output is transfered as input into the child handler which can continue with it. If the parent Handler fails, all Child handlers also fail.
Made Handlers an object instead of a string reference.
Handlers should now be added as objects, adding some flexibility to the developer.
Developers are still cautioned to take great care that Handlers work approriately. Handlers can potentially crash the SuperVisor if not taken good care of.
Try with only Redis.
Made many changes. Fixed race-conditions in test code.
Now try while flushing a selected database.
Try again in the new environment.
Maybe Events are the problem?
Fixed DummyTaskStorage persisting outside of the storage.
Awkward how that could go wrong...
Added TaskModifyEvent.
Event gets fired when an Event is modified by sending it to TaskStorage::modifyEvent. This allows components to observe changes and report these to the user. Might also be useful to cancel unwanted changes.
Made the Docker image Alpine-based. Should work better when running Async in a Cron environment.
Also removed compatibility with PHP 7.2.
Implemented many unit tests.
Now with coverage
And remove the Redis debug again
Now?
Temporarily check if Redis works
Added separate environments for DummyTaskStorage and RedisTaskStorage.
System now uses environment variables imported through Docker. See test/config.tasks.php for all environment options available.
Now try with an added service
Attempt to run a PHPUnit batch
Try with a modified environment.
Try again
Started implementing Drone
ControllerHandler now works. Next up is a distinction between Task and Process status.
Started implementing ControllerHandler.
ControllerHandler is a standard utility handler for MVCR Controllers. This allows the user to create a task which is handled by a standardized controller.
Not finished yet! Needs some love.
Add 'addTasks' method to `Tasks` class
Implemented basic RedisTaskStorage.
- Fixed bug where worker is not provided with bootstrap by ShellExecutor.
- Added composer and Redis to Dockerfile
- Added more output to ParallelSuperVisor
Updated config format.
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.
This allows Async to run in the same environment as the project it's part of.
Co-authored-by: Abel Hoogeveen <abel@techfuze.net>
Reviewed-on: https://gitea.i15.nl/FuzeWorks/Async/pulls/7
2020-06-07 15:54:19 +02:00
|
|
|
'FuzeWorks Async requires PHP 7.3 or higher.' . PHP_EOL .
|
2020-02-01 14:32:36 +01:00
|
|
|
'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))
|
2020-02-14 15:31:09 +01:00
|
|
|
require_once($file);
|
2020-02-01 14:32:36 +01:00
|
|
|
|
2020-02-14 15:31:09 +01:00
|
|
|
// 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);
|
|
|
|
}
|
2020-02-01 14:32:36 +01:00
|
|
|
|
|
|
|
|
2020-02-14 15:31:09 +01:00
|
|
|
// Load the file. If it doesn't exist, fail.
|
|
|
|
$bootstrap = $arguments['bootstrap'];
|
|
|
|
if (!file_exists($bootstrap))
|
|
|
|
{
|
|
|
|
fwrite(STDERR, "Could not load supervisor. Provided bootstrap doesn't exist.");
|
|
|
|
die(1);
|
|
|
|
}
|
2020-02-01 14:32:36 +01:00
|
|
|
|
2020-02-14 15:31:09 +01:00
|
|
|
// Load the bootstrap
|
|
|
|
/** @var Factory $container */
|
|
|
|
$container = require($bootstrap);
|
2020-02-01 14:32:36 +01:00
|
|
|
|
2020-02-14 15:31:09 +01:00
|
|
|
// 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);
|
|
|
|
}
|
2020-02-01 14:32:36 +01:00
|
|
|
|
2020-02-14 15:31:09 +01:00
|
|
|
// 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');
|
2020-02-01 14:32:36 +01:00
|
|
|
/** @var Tasks $lib */
|
|
|
|
$lib = $container->libraries->get('async');
|
2020-02-14 15:31:09 +01:00
|
|
|
}
|
2020-02-01 14:32:36 +01:00
|
|
|
|
2020-02-14 15:31:09 +01:00
|
|
|
// And finally, run the supervisor
|
|
|
|
try {
|
|
|
|
$supervisor = $lib->getSuperVisor($bootstrap);
|
2020-07-17 15:12:02 +02:00
|
|
|
$res = SuperVisor::RUNNING;
|
|
|
|
while ($res === SuperVisor::RUNNING) {
|
|
|
|
$res = $supervisor->cycle();
|
2020-02-01 14:32:36 +01:00
|
|
|
usleep(250000);
|
|
|
|
}
|
2020-02-14 15:31:09 +01:00
|
|
|
|
|
|
|
// Write results
|
2020-07-17 15:12:02 +02:00
|
|
|
if ($res === SuperVisor::CONSTRAINED)
|
|
|
|
fwrite(STDOUT, "SuperVisor finished due to constrained tasks." . PHP_EOL);
|
|
|
|
else
|
|
|
|
fwrite(STDOUT, "SuperVisor finished due to finishing all tasks." . PHP_EOL);
|
2020-02-01 14:32:36 +01:00
|
|
|
} catch (InvalidArgumentException | TasksException | LibraryException $e) {
|
|
|
|
fwrite(STDERR, sprintf('FuzeWorks Async could not load.' . PHP_EOL .
|
|
|
|
'Exception: ' . $e->getMessage() . PHP_EOL)
|
|
|
|
);
|
|
|
|
}
|