diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b270598..82e8048 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,7 +19,7 @@ jobs: container: php:${{ matrix.php_version }} strategy: matrix: - php_version: [8.1, 8.2,8.3,8.4] + php_version: [8.1, 8.2] services: redis: image: redis:7.0 diff --git a/CHANGELOG.md b/CHANGELOG.md index 276f6e3..7a67e6a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,21 +1,3 @@ -# 2.5.3 (2025-06-08) -- Update typing of Log() to support all psr\log versions - -- # 2.5.2 (2025-06-08) -- Update typing of Log() to support all psr\log versions - -# 2.5.1 (2025-06-08) -- Update psr/log version requirements - -# 2.5.0 (2025-06-08) -- Update packages - -# 2.4.0 (2024-12-11) -- Update packages (psr/log ^3.0.2) - -# 2.3.0 (2024-09-04) -- Update packages - # 2.2.0 (2023-03-20) - Update pacakges - Bump requirements to PHP >= 8.1 diff --git a/README.md b/README.md index c2d7234..552717c 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ On top of the original fork (chrisboulton/php-resque) I have added: ## Requirements ## -* PHP 8.1+ +* PHP 7.0+ * phpredis * Redis 2.2+ @@ -74,7 +74,7 @@ Resque::setBackend('redis:6379'); $args = ['name' => 'TestName']; -Resque::enqueue('default', '\App\MyJobClass', $args); +Resque::enqueue('default', 'My_Job', $args); ``` ### Defining Jobs ### @@ -82,9 +82,7 @@ Resque::enqueue('default', '\App\MyJobClass', $args); Each job should be in its own class, and include a `perform` method. ```php -namespace \App; - -class MyJobClass +class My_Job { public function perform() { @@ -107,9 +105,7 @@ The `tearDown` method, if defined, will be called after the job finishes. ```php -namespace App; - -class MyJobClass +class My_Job { public function setUp() { @@ -133,17 +129,17 @@ class MyJobClass This method can be used to conveniently remove a job from a queue. ```php -// Removes job class '\App\MyJobClass' of queue 'default' -Resque::dequeue('default', ['\App\MyJobClass']); +// Removes job class 'My_Job' of queue 'default' +Resque::dequeue('default', ['My_Job']); -// Removes job class '\App\MyJobClass' with Job ID '087df5819a790ac666c9608e2234b21e' of queue 'default' -Resque::dequeue('default', ['\App\MyJobClass' => '087df5819a790ac666c9608e2234b21e']); +// Removes job class 'My_Job' with Job ID '087df5819a790ac666c9608e2234b21e' of queue 'default' +Resque::dequeue('default', ['My_Job' => '087df5819a790ac666c9608e2234b21e']); -// Removes job class '\App\MyJobClass' with arguments of queue 'default' -Resque::dequeue('default', ['\App\MyJobClass' => ['foo' => 1, 'bar' => 2]]); +// Removes job class 'My_Job' with arguments of queue 'default' +Resque::dequeue('default', ['My_Job' => ['foo' => 1, 'bar' => 2]]); // Removes multiple jobs -Resque::dequeue('default', ['\App\MyJobClass', '\App\MyJobClass2']); +Resque::dequeue('default', ['My_Job', 'My_Job2']); ``` If no jobs are given, this method will dequeue all jobs matching the provided queue. @@ -164,7 +160,7 @@ To track the status of a job, pass `true` as the fourth argument to returned: ```php -$token = Resque::enqueue('default', '\App\MyJobClass', $args, true); +$token = Resque::enqueue('default', 'My_Job', $args, true); echo $token; ``` diff --git a/composer.json b/composer.json index 15199f0..b034547 100644 --- a/composer.json +++ b/composer.json @@ -17,7 +17,7 @@ ], "require": { "php": ">=8.1", - "psr/log": "^1.1 || ^2.0 || ^3.0", + "psr/log": "^1.1.0", "colinmollenhour/credis": "^1.14.0" }, "require-dev": { diff --git a/composer.lock b/composer.lock index bb2aed1..41cc09c 100644 --- a/composer.lock +++ b/composer.lock @@ -4,24 +4,24 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "d8e5313006d5c73b54ee6a410b1ad016", + "content-hash": "3e6f3671c2543806a8e045bb8386f9cd", "packages": [ { "name": "colinmollenhour/credis", - "version": "v1.17.0", + "version": "v1.16.0", "source": { "type": "git", "url": "https://github.com/colinmollenhour/credis.git", - "reference": "f4930b426f6b1238b687a1ffe6ee5af7f835b40a" + "reference": "5641140e14a9679f5a6f66c97268727f9558b881" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/colinmollenhour/credis/zipball/f4930b426f6b1238b687a1ffe6ee5af7f835b40a", - "reference": "f4930b426f6b1238b687a1ffe6ee5af7f835b40a", + "url": "https://api.github.com/repos/colinmollenhour/credis/zipball/5641140e14a9679f5a6f66c97268727f9558b881", + "reference": "5641140e14a9679f5a6f66c97268727f9558b881", "shasum": "" }, "require": { - "php": ">=7.4.0" + "php": ">=5.6.0" }, "suggest": { "ext-redis": "Improved performance for communicating with redis" @@ -49,36 +49,36 @@ "homepage": "https://github.com/colinmollenhour/credis", "support": { "issues": "https://github.com/colinmollenhour/credis/issues", - "source": "https://github.com/colinmollenhour/credis/tree/v1.17.0" + "source": "https://github.com/colinmollenhour/credis/tree/v1.16.0" }, - "time": "2025-02-10T18:58:46+00:00" + "time": "2023-10-26T17:02:51+00:00" }, { "name": "psr/log", - "version": "3.0.2", + "version": "1.1.4", "source": { "type": "git", "url": "https://github.com/php-fig/log.git", - "reference": "f16e1d5863e37f8d8c2a01719f5b34baa2b714d3" + "reference": "d49695b909c3b7628b6289db5479a1c204601f11" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/php-fig/log/zipball/f16e1d5863e37f8d8c2a01719f5b34baa2b714d3", - "reference": "f16e1d5863e37f8d8c2a01719f5b34baa2b714d3", + "url": "https://api.github.com/repos/php-fig/log/zipball/d49695b909c3b7628b6289db5479a1c204601f11", + "reference": "d49695b909c3b7628b6289db5479a1c204601f11", "shasum": "" }, "require": { - "php": ">=8.0.0" + "php": ">=5.3.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "3.x-dev" + "dev-master": "1.1.x-dev" } }, "autoload": { "psr-4": { - "Psr\\Log\\": "src" + "Psr\\Log\\": "Psr/Log/" } }, "notification-url": "https://packagist.org/downloads/", @@ -99,9 +99,9 @@ "psr-3" ], "support": { - "source": "https://github.com/php-fig/log/tree/3.0.2" + "source": "https://github.com/php-fig/log/tree/1.1.4" }, - "time": "2024-09-11T13:17:53+00:00" + "time": "2021-05-03T11:20:27+00:00" } ], "packages-dev": [ @@ -255,16 +255,16 @@ }, { "name": "myclabs/deep-copy", - "version": "1.13.1", + "version": "1.11.1", "source": { "type": "git", "url": "https://github.com/myclabs/DeepCopy.git", - "reference": "1720ddd719e16cf0db4eb1c6eca108031636d46c" + "reference": "7284c22080590fb39f2ffa3e9057f10a4ddd0e0c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/1720ddd719e16cf0db4eb1c6eca108031636d46c", - "reference": "1720ddd719e16cf0db4eb1c6eca108031636d46c", + "url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/7284c22080590fb39f2ffa3e9057f10a4ddd0e0c", + "reference": "7284c22080590fb39f2ffa3e9057f10a4ddd0e0c", "shasum": "" }, "require": { @@ -272,12 +272,11 @@ }, "conflict": { "doctrine/collections": "<1.6.8", - "doctrine/common": "<2.13.3 || >=3 <3.2.2" + "doctrine/common": "<2.13.3 || >=3,<3.2.2" }, "require-dev": { "doctrine/collections": "^1.6.8", "doctrine/common": "^2.13.3 || ^3.2.2", - "phpspec/prophecy": "^1.10", "phpunit/phpunit": "^7.5.20 || ^8.5.23 || ^9.5.13" }, "type": "library", @@ -303,7 +302,7 @@ ], "support": { "issues": "https://github.com/myclabs/DeepCopy/issues", - "source": "https://github.com/myclabs/DeepCopy/tree/1.13.1" + "source": "https://github.com/myclabs/DeepCopy/tree/1.11.1" }, "funding": [ { @@ -311,20 +310,20 @@ "type": "tidelift" } ], - "time": "2025-04-29T12:36:36+00:00" + "time": "2023-03-08T13:26:56+00:00" }, { "name": "nikic/php-parser", - "version": "v5.5.0", + "version": "v5.0.2", "source": { "type": "git", "url": "https://github.com/nikic/PHP-Parser.git", - "reference": "ae59794362fe85e051a58ad36b289443f57be7a9" + "reference": "139676794dc1e9231bf7bcd123cfc0c99182cb13" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/ae59794362fe85e051a58ad36b289443f57be7a9", - "reference": "ae59794362fe85e051a58ad36b289443f57be7a9", + "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/139676794dc1e9231bf7bcd123cfc0c99182cb13", + "reference": "139676794dc1e9231bf7bcd123cfc0c99182cb13", "shasum": "" }, "require": { @@ -335,7 +334,7 @@ }, "require-dev": { "ircmaxell/php-yacc": "^0.0.7", - "phpunit/phpunit": "^9.0" + "phpunit/phpunit": "^7.0 || ^8.0 || ^9.0" }, "bin": [ "bin/php-parse" @@ -367,9 +366,9 @@ ], "support": { "issues": "https://github.com/nikic/PHP-Parser/issues", - "source": "https://github.com/nikic/PHP-Parser/tree/v5.5.0" + "source": "https://github.com/nikic/PHP-Parser/tree/v5.0.2" }, - "time": "2025-05-31T08:24:38+00:00" + "time": "2024-03-05T20:51:40+00:00" }, { "name": "phar-io/manifest", @@ -553,35 +552,35 @@ }, { "name": "phpunit/php-code-coverage", - "version": "9.2.32", + "version": "9.2.31", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git", - "reference": "85402a822d1ecf1db1096959413d35e1c37cf1a5" + "reference": "48c34b5d8d983006bd2adc2d0de92963b9155965" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/85402a822d1ecf1db1096959413d35e1c37cf1a5", - "reference": "85402a822d1ecf1db1096959413d35e1c37cf1a5", + "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/48c34b5d8d983006bd2adc2d0de92963b9155965", + "reference": "48c34b5d8d983006bd2adc2d0de92963b9155965", "shasum": "" }, "require": { "ext-dom": "*", "ext-libxml": "*", "ext-xmlwriter": "*", - "nikic/php-parser": "^4.19.1 || ^5.1.0", + "nikic/php-parser": "^4.18 || ^5.0", "php": ">=7.3", - "phpunit/php-file-iterator": "^3.0.6", - "phpunit/php-text-template": "^2.0.4", - "sebastian/code-unit-reverse-lookup": "^2.0.3", - "sebastian/complexity": "^2.0.3", - "sebastian/environment": "^5.1.5", - "sebastian/lines-of-code": "^1.0.4", - "sebastian/version": "^3.0.2", - "theseer/tokenizer": "^1.2.3" + "phpunit/php-file-iterator": "^3.0.3", + "phpunit/php-text-template": "^2.0.2", + "sebastian/code-unit-reverse-lookup": "^2.0.2", + "sebastian/complexity": "^2.0", + "sebastian/environment": "^5.1.2", + "sebastian/lines-of-code": "^1.0.3", + "sebastian/version": "^3.0.1", + "theseer/tokenizer": "^1.2.0" }, "require-dev": { - "phpunit/phpunit": "^9.6" + "phpunit/phpunit": "^9.3" }, "suggest": { "ext-pcov": "PHP extension that provides line coverage", @@ -590,7 +589,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-main": "9.2.x-dev" + "dev-master": "9.2-dev" } }, "autoload": { @@ -619,7 +618,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", "security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy", - "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/9.2.32" + "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/9.2.31" }, "funding": [ { @@ -627,7 +626,7 @@ "type": "github" } ], - "time": "2024-08-22T04:23:01+00:00" + "time": "2024-03-02T06:37:42+00:00" }, { "name": "phpunit/php-file-iterator", @@ -872,45 +871,45 @@ }, { "name": "phpunit/phpunit", - "version": "9.6.23", + "version": "9.6.17", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "43d2cb18d0675c38bd44982a5d1d88f6d53d8d95" + "reference": "1a156980d78a6666721b7e8e8502fe210b587fcd" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/43d2cb18d0675c38bd44982a5d1d88f6d53d8d95", - "reference": "43d2cb18d0675c38bd44982a5d1d88f6d53d8d95", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/1a156980d78a6666721b7e8e8502fe210b587fcd", + "reference": "1a156980d78a6666721b7e8e8502fe210b587fcd", "shasum": "" }, "require": { - "doctrine/instantiator": "^1.5.0 || ^2", + "doctrine/instantiator": "^1.3.1 || ^2", "ext-dom": "*", "ext-json": "*", "ext-libxml": "*", "ext-mbstring": "*", "ext-xml": "*", "ext-xmlwriter": "*", - "myclabs/deep-copy": "^1.13.1", - "phar-io/manifest": "^2.0.4", - "phar-io/version": "^3.2.1", + "myclabs/deep-copy": "^1.10.1", + "phar-io/manifest": "^2.0.3", + "phar-io/version": "^3.0.2", "php": ">=7.3", - "phpunit/php-code-coverage": "^9.2.32", - "phpunit/php-file-iterator": "^3.0.6", + "phpunit/php-code-coverage": "^9.2.28", + "phpunit/php-file-iterator": "^3.0.5", "phpunit/php-invoker": "^3.1.1", - "phpunit/php-text-template": "^2.0.4", - "phpunit/php-timer": "^5.0.3", - "sebastian/cli-parser": "^1.0.2", - "sebastian/code-unit": "^1.0.8", + "phpunit/php-text-template": "^2.0.3", + "phpunit/php-timer": "^5.0.2", + "sebastian/cli-parser": "^1.0.1", + "sebastian/code-unit": "^1.0.6", "sebastian/comparator": "^4.0.8", - "sebastian/diff": "^4.0.6", - "sebastian/environment": "^5.1.5", - "sebastian/exporter": "^4.0.6", - "sebastian/global-state": "^5.0.7", - "sebastian/object-enumerator": "^4.0.4", - "sebastian/resource-operations": "^3.0.4", - "sebastian/type": "^3.2.1", + "sebastian/diff": "^4.0.3", + "sebastian/environment": "^5.1.3", + "sebastian/exporter": "^4.0.5", + "sebastian/global-state": "^5.0.1", + "sebastian/object-enumerator": "^4.0.3", + "sebastian/resource-operations": "^3.0.3", + "sebastian/type": "^3.2", "sebastian/version": "^3.0.2" }, "suggest": { @@ -955,7 +954,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/phpunit/issues", "security": "https://github.com/sebastianbergmann/phpunit/security/policy", - "source": "https://github.com/sebastianbergmann/phpunit/tree/9.6.23" + "source": "https://github.com/sebastianbergmann/phpunit/tree/9.6.17" }, "funding": [ { @@ -966,20 +965,12 @@ "url": "https://github.com/sebastianbergmann", "type": "github" }, - { - "url": "https://liberapay.com/sebastianbergmann", - "type": "liberapay" - }, - { - "url": "https://thanks.dev/u/gh/sebastianbergmann", - "type": "thanks_dev" - }, { "url": "https://tidelift.com/funding/github/packagist/phpunit/phpunit", "type": "tidelift" } ], - "time": "2025-05-02T06:40:34+00:00" + "time": "2024-02-23T13:14:51+00:00" }, { "name": "sebastian/cli-parser", @@ -1946,16 +1937,16 @@ }, { "name": "squizlabs/php_codesniffer", - "version": "3.13.0", + "version": "3.9.0", "source": { "type": "git", "url": "https://github.com/PHPCSStandards/PHP_CodeSniffer.git", - "reference": "65ff2489553b83b4597e89c3b8b721487011d186" + "reference": "d63cee4890a8afaf86a22e51ad4d97c91dd4579b" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/PHPCSStandards/PHP_CodeSniffer/zipball/65ff2489553b83b4597e89c3b8b721487011d186", - "reference": "65ff2489553b83b4597e89c3b8b721487011d186", + "url": "https://api.github.com/repos/PHPCSStandards/PHP_CodeSniffer/zipball/d63cee4890a8afaf86a22e51ad4d97c91dd4579b", + "reference": "d63cee4890a8afaf86a22e51ad4d97c91dd4579b", "shasum": "" }, "require": { @@ -2020,13 +2011,9 @@ { "url": "https://opencollective.com/php_codesniffer", "type": "open_collective" - }, - { - "url": "https://thanks.dev/u/gh/phpcsstandards", - "type": "thanks_dev" } ], - "time": "2025-05-11T03:36:00+00:00" + "time": "2024-02-16T15:06:51+00:00" }, { "name": "theseer/tokenizer", @@ -2081,12 +2068,12 @@ ], "aliases": [], "minimum-stability": "stable", - "stability-flags": {}, + "stability-flags": [], "prefer-stable": false, "prefer-lowest": false, "platform": { "php": ">=8.1" }, - "platform-dev": {}, + "platform-dev": [], "plugin-api-version": "2.6.0" } diff --git a/src/Resque/Event.php b/src/Resque/Event.php index f445375..7886640 100644 --- a/src/Resque/Event.php +++ b/src/Resque/Event.php @@ -22,7 +22,6 @@ class Event * * @param string $event Name of event to be raised. * @param mixed $data Optional, any data that should be passed to each callback. - * * @return true */ public static function trigger($event, $data = null) @@ -50,8 +49,7 @@ class Event * Listen in on a given event to have a specified callback fired. * * @param string $event Name of event to listen on. - * @param mixed $callback Any callback callable by call_user_func_array - * + * @param mixed $callback Any callback callable by call_user_func_array. * @return true */ public static function listen($event, $callback) @@ -69,7 +67,6 @@ class Event * * @param string $event Name of event. * @param mixed $callback The callback as defined when listen() was called. - * * @return true */ public static function stopListening($event, $callback) @@ -88,10 +85,8 @@ class Event /** * Call all registered listeners. - * - * @return void */ - public static function clearListeners(): void + public static function clearListeners() { self::$events = []; } diff --git a/src/Resque/Job/Factory.php b/src/Resque/Job/Factory.php index 9ee0b74..be04d8e 100644 --- a/src/Resque/Job/Factory.php +++ b/src/Resque/Job/Factory.php @@ -9,7 +9,6 @@ namespace Resque\Job; * @author Daniel Mason * @license http://www.opensource.org/licenses/mit-license.php */ - class Factory implements FactoryInterface { public ?Job $job; @@ -17,8 +16,6 @@ class Factory implements FactoryInterface public array $args; /** - * Create job factory - * * @param $className * @param array $args * @param $queue diff --git a/src/Resque/Job/Status.php b/src/Resque/Job/Status.php index 6387c2a..aaa29c3 100644 --- a/src/Resque/Job/Status.php +++ b/src/Resque/Job/Status.php @@ -62,7 +62,7 @@ class Status \Resque\Resque::redis()->set( 'job:' . $id . ':status', json_encode($statusPacket), - ['ex' => \Resque\Redis::DEFAULT_REDIS_TTL], + ['ex' => (86400 * 2)], ); } @@ -106,7 +106,7 @@ class Status \Resque\Resque::redis()->set( (string)$this, json_encode($statusPacket), - ['ex' => \Resque\Redis::DEFAULT_REDIS_TTL], + ['ex' => (86400 * 2)], ); } diff --git a/src/Resque/Log.php b/src/Resque/Log.php index 2608d87..e446a72 100644 --- a/src/Resque/Log.php +++ b/src/Resque/Log.php @@ -25,10 +25,9 @@ class Log extends \Psr\Log\AbstractLogger * @param mixed $level PSR-3 log level constant, or equivalent string * @param string $message Message to log, may contain a { placeholder } * @param array $context Variables to replace { placeholder } - * * @return null */ - public function log($level, $message, array $context = []): void + public function log($level, $message, array $context = []) { $logLevels = [ 'emergency', diff --git a/src/Resque/Redis.php b/src/Resque/Redis.php index 5537b55..f726feb 100644 --- a/src/Resque/Redis.php +++ b/src/Resque/Redis.php @@ -14,14 +14,12 @@ class Redis { /** * Redis Client - * * @var \Credis_Client */ private $driver; /** * Redis namespace - * * @var string */ private static $defaultNamespace = 'resque:'; @@ -41,11 +39,6 @@ class Redis */ public const DEFAULT_DATABASE = 0; - /** - * Default Redis TTL (2 days) - */ - public const DEFAULT_REDIS_TTL = 172800; - /** * @var array List of all commands in Redis that supply a key as their * first argument. Used to prefix keys with the Resque namespace. @@ -97,6 +90,17 @@ class Redis 'rename', 'rpoplpush' ]; + // sinterstore + // sunion + // sunionstore + // sdiff + // sdiffstore + // sinter + // smove + // mget + // msetnx + // mset + // renamenx /** * Set Redis namespace (prefix) default: resque @@ -110,7 +114,6 @@ class Redis if (substr($namespace, -1) !== ':' && $namespace != '') { $namespace .= ':'; } - self::$defaultNamespace = $namespace; } diff --git a/src/Resque/Resque.php b/src/Resque/Resque.php index f193e18..e4872f9 100644 --- a/src/Resque/Resque.php +++ b/src/Resque/Resque.php @@ -12,7 +12,7 @@ namespace Resque; class Resque { - public const VERSION = '2.5.3'; + public const VERSION = '2.1.0'; public const DEFAULT_INTERVAL = 5; diff --git a/src/Resque/Stat.php b/src/Resque/Stat.php index 6cfa6c1..6592aa8 100644 --- a/src/Resque/Stat.php +++ b/src/Resque/Stat.php @@ -38,7 +38,7 @@ class Stat $set = Resque::redis()->set( 'stat:' . $stat, $by, - ['ex' => Redis::DEFAULT_REDIS_TTL, 'nx'], + ['ex' => (86400 * 2), 'nx'], ); // If it already exists, return the incrby value diff --git a/src/Resque/Worker.php b/src/Resque/Worker.php index fc08303..a926364 100644 --- a/src/Resque/Worker.php +++ b/src/Resque/Worker.php @@ -83,7 +83,6 @@ class Worker /** * Return all workers known to Resque as instantiated instances. - * * @return array */ public static function all(): array @@ -97,17 +96,14 @@ class Worker foreach ($workers as $workerId) { $instances[] = self::find($workerId); } - return $instances; } /** * Given a worker ID, check if it is registered/valid. * - * @param string $workerId ID of the worker - * - * @return boolean True if the worker exists, false if not - * + * @param string $workerId ID of the worker. + * @return boolean True if the worker exists, false if not. * @throws Resque_RedisException */ public static function exists($workerId): bool @@ -118,10 +114,8 @@ class Worker /** * Given a worker ID, find it and return an instantiated worker class for it. * - * @param string $workerId The ID of the worker - * - * @return Resque_Worker|bool - * + * @param string $workerId The ID of the worker. + * @return bool|Resque_Worker * @throws Resque_RedisException */ public static function find($workerId) @@ -129,13 +123,11 @@ class Worker if (false === strpos($workerId, ":") || !self::exists($workerId)) { return false; } - /** @noinspection PhpUnusedLocalVariableInspection */ list($hostname, $pid, $queues) = explode(':', $workerId, 3); $queues = explode(',', $queues); $worker = new self($queues); $worker->setId($workerId); - return $worker; } @@ -143,10 +135,8 @@ class Worker * Set the ID of this worker to a given ID string. * * @param string $workerId ID for the worker. - * - * @return void */ - public function setId($workerId): void + public function setId($workerId) { $this->id = $workerId; } @@ -160,11 +150,9 @@ class Worker * @param int $interval How often to check for new jobs across the queues. * @param bool $blocking * - * @return void - * * @throws Resque_RedisException */ - public function work($interval = Resque::DEFAULT_INTERVAL, $blocking = false): void + public function work($interval = Resque::DEFAULT_INTERVAL, $blocking = false) { $this->updateProcLine('Starting'); $this->startup(); @@ -263,13 +251,11 @@ class Worker } /** - * Process a single job + * Process a single job. * - * @param \Resque\Job\Job $job The job to be processed - * - * @return void + * @param \Resque\Job\Job $job The job to be processed. */ - public function perform(\Resque\Job\Job $job): void + public function perform(\Resque\Job\Job $job) { try { Event::trigger('afterFork', $job); @@ -287,8 +273,7 @@ class Worker /** * @param bool $blocking * @param int $timeout - * - * @return object|boolean - Instance of \Resque\Job\Job if a job is found, false if not + * @return object|boolean Instance of \Resque\Job\Job if a job is found, false if not. */ public function reserve($blocking = false, $timeout = null) { @@ -319,17 +304,16 @@ class Worker /** * Return an array containing all of the queues that this worker should use - * when searching for jobs + * when searching for jobs. * * If * is found in the list of queues, every queue will be searched in * alphabetic order. (@param boolean $fetch If true, and the queue is set to *, will fetch - * all queue names from redis + * all queue names from redis. + * @return array Array of associated queues. + * @see $fetch) * - * @param boolean $fetch - * - * @return array Array of associated queues */ - public function queues(bool $fetch = true): array + public function queues($fetch = true) { if (!in_array('*', $this->queues) || $fetch == false) { return $this->queues; @@ -337,16 +321,13 @@ class Worker $queues = Resque::queues(); sort($queues); - return $queues; } /** - * Perform necessary actions to start a worker - * - * @return void + * Perform necessary actions to start a worker. */ - private function startup(): void + private function startup() { $this->registerSigHandlers(); $this->pruneDeadWorkers(); @@ -359,11 +340,9 @@ class Worker * the name of the currently running process to indicate the current state * of a worker. * - * @param string $status The updated process title - * - * @return void + * @param string $status The updated process title. */ - private function updateProcLine($status): void + private function updateProcLine($status) { $processTitle = 'resque-' . Resque::VERSION . ': ' . $status; if (function_exists('cli_set_process_title') && PHP_OS !== 'Darwin') { @@ -380,10 +359,8 @@ class Worker * INT: Shutdown immediately and stop processing jobs. * QUIT: Shutdown after the current job finishes processing. * USR1: Kill the forked child immediately and continue processing jobs. - * - * @return void */ - private function registerSigHandlers(): void + private function registerSigHandlers() { if (!function_exists('pcntl_signal')) { return; @@ -399,11 +376,9 @@ class Worker } /** - * Signal handler callback for USR2, pauses processing of new jobs - * - * @return void + * Signal handler callback for USR2, pauses processing of new jobs. */ - public function pauseProcessing(): void + public function pauseProcessing() { $this->logger->log(\Psr\Log\LogLevel::NOTICE, 'USR2 received; pausing job processing'); $this->paused = true; @@ -412,10 +387,8 @@ class Worker /** * Signal handler callback for CONT, resumes worker allowing it to pick * up new jobs. - * - * @return void */ - public function unPauseProcessing(): void + public function unPauseProcessing() { $this->logger->log(\Psr\Log\LogLevel::NOTICE, 'CONT received; resuming job processing'); $this->paused = false; @@ -424,10 +397,8 @@ class Worker /** * Schedule a worker for shutdown. Will finish processing the current job * and when the timeout interval is reached, the worker will shut down. - * - * @return void */ - public function shutdown(): void + public function shutdown() { $this->shutdown = true; $this->logger->log(\Psr\Log\LogLevel::NOTICE, 'Shutting down'); @@ -436,10 +407,8 @@ class Worker /** * Force an immediate shutdown of the worker, killing any child jobs * currently running. - * - * @return void */ - public function shutdownNow(): void + public function shutdownNow() { $this->shutdown(); $this->killChild(); @@ -448,10 +417,8 @@ class Worker /** * Kill a forked child job immediately. The job it is processing will not * be completed. - * - * @return void */ - public function killChild(): void + public function killChild() { if (!$this->child) { $this->logger->log(\Psr\Log\LogLevel::DEBUG, 'No child to kill.'); @@ -480,10 +447,8 @@ class Worker * This is a form of garbage collection to handle cases where the * server may have been killed and the Resque workers did not die gracefully * and therefore leave state information in Redis. - * - * @return void */ - public function pruneDeadWorkers(): void + public function pruneDeadWorkers() { $workerPids = $this->workerPids(); $workers = self::all(); @@ -509,7 +474,7 @@ class Worker * * @return array Array of Resque worker process IDs. */ - public function workerPids(): array + public function workerPids() { $pids = []; exec('ps -A -o pid,command | grep [r]esque', $cmdOutput); @@ -531,16 +496,14 @@ class Worker Resque::redis()->set( 'worker:' . (string)$this . ':started', date('D M d H:i:s T Y'), - ['ex' => Redis::DEFAULT_REDIS_TTL], + ['ex' => (86400 * 2)], ); } /** * Unregister this worker in Redis. (shutdown etc) - * - * @return void */ - public function unregisterWorker(): void + public function unregisterWorker() { if (is_object($this->currentJob)) { $this->currentJob->fail(new \Resque\Job\DirtyExitException()); @@ -555,15 +518,12 @@ class Worker } /** - * Tell Redis which job we're currently working on - * - * @param \Resque\Job\Job $job \Resque\Job\Job instance containing the job we're working on - * - * @return void + * Tell Redis which job we're currently working on. * + * @param \Resque\Job\Job $job \Resque\Job\Job instance containing the job we're working on. * @throws Resque_RedisException */ - public function workingOn(\Resque\Job\Job $job): void + public function workingOn(\Resque\Job\Job $job) { $job->worker = $this; $this->currentJob = $job; @@ -577,17 +537,15 @@ class Worker Resque::redis()->set( 'worker:' . $job->worker, $data, - ['ex' => Redis::DEFAULT_REDIS_TTL], + ['ex' => (86400 * 2)], ); } /** * Notify Redis that we've finished working on a job, clearing the working - * state and incrementing the job stats - * - * @return void + * state and incrementing the job stats. */ - public function doneWorking(): void + public function doneWorking() { $this->currentJob = null; Stat::incr('processed'); @@ -596,29 +554,28 @@ class Worker } /** - * Generate a string representation of this worker + * Generate a string representation of this worker. * - * @return string String identifier for this worker instance + * @return string String identifier for this worker instance. */ - public function __toString(): string + public function __toString() { - return (string) $this->id; + return $this->id; } /** - * Return an object describing the job this worker is currently working on + * Return an object describing the job this worker is currently working on. * - * @return array Array with details of current job + * @return array Array with details of current job. */ public function job(): array { $job = Resque::redis()->get('worker:' . $this); - return $job ? json_decode($job, true) : []; } /** - * Get a statistic belonging to this worker + * Get a statistic belonging to this worker. * * @param string $stat Statistic to fetch. * @@ -633,10 +590,8 @@ class Worker * Inject the logging object into the worker * * @param \Psr\Log\LoggerInterface $logger - * - * @return void */ - public function setLogger(\Psr\Log\LoggerInterface $logger): void + public function setLogger(\Psr\Log\LoggerInterface $logger) { $this->logger = $logger; } diff --git a/tests/Resque/Tests/RedisTest.php b/tests/Resque/Tests/RedisTest.php index b834f93..5717bf6 100644 --- a/tests/Resque/Tests/RedisTest.php +++ b/tests/Resque/Tests/RedisTest.php @@ -17,7 +17,7 @@ class RedisTest extends TestCase $this->redis->set( 'testKey', 24, - ['ex' => \Resque\Redis::DEFAULT_REDIS_TTL], + ['ex' => 3600], ); $val = $this->redis->get("testKey");