2.5.3 - Update LOG()

- Update pacakges
- Bump requirements to PHP >= 8.1

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+on: [push]
+jobs:
+  Linter:
+    runs-on: ubuntu-latest
+    container: php:8.2
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install composer
+      run: apt-get update -yq && apt-get install git wget procps unzip -y && pecl install -o -f redis && rm -rf /tmp/pear && docker-php-ext-enable redis && wget https://getcomposer.org/composer.phar && php composer.phar install --dev
+    - name: Validate composer.json and composer.lock
+      run: php composer.phar validate --strict
+    - name: Install dependencies
+      run: php composer.phar install --dev --prefer-dist --no-progress
+    - name: Run PHPCS Linter
+      run: php -d memory_limit=256M vendor/bin/phpcs -s --standard=ruleset.xml
+  PHPTest:
+    runs-on: ubuntu-latest
+    container: php:${{ matrix.php_version }}
+    strategy:
+      matrix:
+        php_version: [8.1, 8.2,8.3,8.4]
+    services:
+      redis:
+        image: redis:7.0
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install composer
+      run: apt-get update -yq && apt-get install git wget procps unzip -y && pecl install -o -f redis && rm -rf /tmp/pear && docker-php-ext-enable redis && wget https://getcomposer.org/composer.phar && php composer.phar install --dev
+    - name: Run PHP ${{ matrix.php_version }}} Unit Tests
+      run: php vendor/bin/phpunit --verbose --configuration phpunit.xml

CHANGELOG.md

@@ -1,3 +1,32 @@
+# 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
+
+# 2.1.3 (2023-11-15)
+- Resolved issue with SET EX TTL's using unix-timestamps
+
+# 2.1.2 (2023-03-22)
+- Update composer packages
+- Update git information (GitHub)
+
 # 2.1.1 (2023-03-20)
 - Changed setex to set with EX values
 - Added TTLs to missing keys

README.md

@@ -1,4 +1,4 @@
-php-resque: PHP Resque Worker (and Enqueue)
+php-resque: PHP Background (Resque) Worker
 ===========================================
 
 Resque is a Redis-backed library for creating background jobs, placing
@@ -42,7 +42,7 @@ On top of the original fork (chrisboulton/php-resque) I have added:
 
 ## Requirements ##
 
-* PHP 7.0+
+* PHP 8.1+
 * phpredis
 * Redis 2.2+
 
@@ -53,19 +53,9 @@ Composer package inside your project.
 
 If you're not familiar with Composer, please see <http://getcomposer.org/>.
 
-1. Add php-resque to your application's composer.json.
+1. Run `composer require idanoo/php-resque`.
 
-```json
+2. If you haven't already, add the Composer autoload to your project's
-{
-    "require": {
-        "idanoo/php-resque": "^2.0"
-    }
-}
-```
-
-2. Run `composer install`.
-
-3. If you haven't already, add the Composer autoload to your project's
    initialization file. (example)
 
 ```sh
@@ -84,7 +74,7 @@ Resque::setBackend('redis:6379');
 
 $args = ['name' => 'TestName'];
 
-Resque::enqueue('default', 'My_Job', $args);
+Resque::enqueue('default', '\App\MyJobClass', $args);
 ```
 
 ### Defining Jobs ###
@@ -92,7 +82,9 @@ Resque::enqueue('default', 'My_Job', $args);
 Each job should be in its own class, and include a `perform` method.
 
 ```php
-class My_Job
+namespace \App;
+
+class MyJobClass
 {
     public function perform()
     {
@@ -115,7 +107,9 @@ The `tearDown` method, if defined, will be called after the job finishes.
 
 
 ```php
-class My_Job
+namespace App;
+
+class MyJobClass
 {
     public function setUp()
     {
@@ -139,17 +133,17 @@ class My_Job
 This method can be used to conveniently remove a job from a queue.
 
 ```php
-// Removes job class 'My_Job' of queue 'default'
+// Removes job class '\App\MyJobClass' of queue 'default'
-Resque::dequeue('default', ['My_Job']);
+Resque::dequeue('default', ['\App\MyJobClass']);
 
-// Removes job class 'My_Job' with Job ID '087df5819a790ac666c9608e2234b21e' of queue 'default'
+// Removes job class '\App\MyJobClass' with Job ID '087df5819a790ac666c9608e2234b21e' of queue 'default'
-Resque::dequeue('default', ['My_Job' => '087df5819a790ac666c9608e2234b21e']);
+Resque::dequeue('default', ['\App\MyJobClass' => '087df5819a790ac666c9608e2234b21e']);
 
-// Removes job class 'My_Job' with arguments of queue 'default'
+// Removes job class '\App\MyJobClass' with arguments of queue 'default'
-Resque::dequeue('default', ['My_Job' => ['foo' => 1, 'bar' => 2]]);
+Resque::dequeue('default', ['\App\MyJobClass' => ['foo' => 1, 'bar' => 2]]);
 
 // Removes multiple jobs
-Resque::dequeue('default', ['My_Job', 'My_Job2']);
+Resque::dequeue('default', ['\App\MyJobClass', '\App\MyJobClass2']);
 ```
 
 If no jobs are given, this method will dequeue all jobs matching the provided queue.
@@ -170,7 +164,7 @@ To track the status of a job, pass `true` as the fourth argument to
 returned:
 
 ```php
-$token = Resque::enqueue('default', 'My_Job', $args, true);
+$token = Resque::enqueue('default', '\App\MyJobClass', $args, true);
 echo $token;
 ```
 

composer.json

@@ -7,7 +7,7 @@
 	},
 	"description": "Redis backed library for creating background jobs and processing them later. Based on resque for Ruby. Originally forked from chrisboulton/php-resque.",
 	"keywords": ["job", "background", "redis", "resque", "php"],
-	"homepage": "https://gitlab.com/idanoo/php-resque/",
+	"homepage": "https://github.com/idanoo/php-resque",
 	"license": "MIT",
 	"authors": [
 		{
@@ -16,9 +16,9 @@
 		}
 	],
 	"require": {
-		"php": ">7.4",
+		"php": ">=8.1",
-		"psr/log": "^1.1.0",
+		"psr/log": "^1.1 || ^2.0 || ^3.0",
-		"colinmollenhour/credis": "^1.13.0"
+		"colinmollenhour/credis": "^1.14.0"
 	},
 	"require-dev": {
 		"phpunit/phpunit": "^9",
@@ -40,8 +40,8 @@
 		}
 	},
 	"support": {
-		"issues": "https://gitlab.com/idanoo/php-resque/issues",
+		"issues": "https://github.com/idanoo/php-resque/issues",
-		"source": "https://gitlab.com/idanoo/php-resque"
+		"source": "https://github.com/idanoo/php-resque"
 	},
 	"config": {
 		"allow-plugins": {

src/Resque/Event.php

@@ -22,6 +22,7 @@ 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)
@@ -49,7 +50,8 @@ 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)
@@ -67,6 +69,7 @@ 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)
@@ -85,8 +88,10 @@ class Event
 
     /**
      * Call all registered listeners.
+     *
+     * @return void
      */
-    public static function clearListeners()
+    public static function clearListeners(): void
     {
         self::$events = [];
     }

src/Resque/Job/Factory.php

@@ -9,6 +9,7 @@ namespace Resque\Job;
  * @author         Daniel Mason <daniel@m2.nz>
  * @license        http://www.opensource.org/licenses/mit-license.php
  */
+
 class Factory implements FactoryInterface
 {
     public ?Job $job;
@@ -16,6 +17,8 @@ class Factory implements FactoryInterface
     public array $args;
 
     /**
+     * Create job factory
+     *
      * @param $className
      * @param array $args
      * @param $queue

src/Resque/Job/Status.php

@@ -62,7 +62,7 @@ class Status
         \Resque\Resque::redis()->set(
             'job:' . $id . ':status',
             json_encode($statusPacket),
-            ['ex' => time() + 86400],
+            ['ex' => \Resque\Redis::DEFAULT_REDIS_TTL],
         );
     }
 
@@ -106,7 +106,7 @@ class Status
         \Resque\Resque::redis()->set(
             (string)$this,
             json_encode($statusPacket),
-            ['ex' => time() + 86400],
+            ['ex' => \Resque\Redis::DEFAULT_REDIS_TTL],
         );
     }
 

src/Resque/Log.php

@@ -25,9 +25,10 @@ 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 = [])
+    public function log($level, $message, array $context = []): void
     {
         $logLevels = [
             'emergency',

src/Resque/Redis.php

@@ -14,12 +14,14 @@ class Redis
 {
     /**
      * Redis Client
+     *
      * @var \Credis_Client
      */
     private $driver;
 
     /**
      * Redis namespace
+     *
      * @var string
      */
     private static $defaultNamespace = 'resque:';
@@ -39,6 +41,11 @@ 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.
@@ -90,17 +97,6 @@ class Redis
         'rename',
         'rpoplpush'
     ];
-    // sinterstore
-    // sunion
-    // sunionstore
-    // sdiff
-    // sdiffstore
-    // sinter
-    // smove
-    // mget
-    // msetnx
-    // mset
-    // renamenx
 
     /**
      * Set Redis namespace (prefix) default: resque
@@ -114,6 +110,7 @@ class Redis
         if (substr($namespace, -1) !== ':' && $namespace != '') {
             $namespace .= ':';
         }
+
         self::$defaultNamespace = $namespace;
     }
 

src/Resque/Resque.php

@@ -12,7 +12,7 @@ namespace Resque;
 
 class Resque
 {
-    public const VERSION = '2.1.0';
+    public const VERSION = '2.5.3';
 
     public const DEFAULT_INTERVAL = 5;
 

src/Resque/Stat.php

@@ -38,7 +38,7 @@ class Stat
         $set = Resque::redis()->set(
             'stat:' . $stat,
             $by,
-            ['ex' => time() + 86400, 'nx'],
+            ['ex' => Redis::DEFAULT_REDIS_TTL,  'nx'],
         );
 
         // If it already exists, return the incrby value

src/Resque/Worker.php

@@ -83,6 +83,7 @@ class Worker
 
     /**
      * Return all workers known to Resque as instantiated instances.
+     *
      * @return array
      */
     public static function all(): array
@@ -96,14 +97,17 @@ 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.
+     * @param string $workerId ID of the worker
-     * @return boolean True if the worker exists, false if not.
+     *
+     * @return boolean True if the worker exists, false if not
+     *
      * @throws Resque_RedisException
      */
     public static function exists($workerId): bool
@@ -114,8 +118,10 @@ class Worker
     /**
      * Given a worker ID, find it and return an instantiated worker class for it.
      *
-     * @param string $workerId The ID of the worker.
+     * @param string $workerId The ID of the worker
-     * @return bool|Resque_Worker
+     *
+     * @return Resque_Worker|bool
+     *
      * @throws Resque_RedisException
      */
     public static function find($workerId)
@@ -123,11 +129,13 @@ 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;
     }
 
@@ -135,8 +143,10 @@ 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)
+    public function setId($workerId): void
     {
         $this->id = $workerId;
     }
@@ -150,9 +160,11 @@ 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)
+    public function work($interval = Resque::DEFAULT_INTERVAL, $blocking = false): void
     {
         $this->updateProcLine('Starting');
         $this->startup();
@@ -251,11 +263,13 @@ class Worker
     }
 
     /**
-     * Process a single job.
+     * Process a single job
      *
-     * @param \Resque\Job\Job $job The job to be processed.
+     * @param \Resque\Job\Job $job The job to be processed
+     *
+     * @return void
      */
-    public function perform(\Resque\Job\Job $job)
+    public function perform(\Resque\Job\Job $job): void
     {
         try {
             Event::trigger('afterFork', $job);
@@ -273,7 +287,8 @@ 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)
     {
@@ -304,16 +319,17 @@ 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($fetch = true)
+    public function queues(bool $fetch = true): array
     {
         if (!in_array('*', $this->queues) || $fetch == false) {
             return $this->queues;
@@ -321,13 +337,16 @@ class Worker
 
         $queues = Resque::queues();
         sort($queues);
+
         return $queues;
     }
 
     /**
-     * Perform necessary actions to start a worker.
+     * Perform necessary actions to start a worker
+     *
+     * @return void
      */
-    private function startup()
+    private function startup(): void
     {
         $this->registerSigHandlers();
         $this->pruneDeadWorkers();
@@ -340,9 +359,11 @@ class Worker
      * the name of the currently running process to indicate the current state
      * of a worker.
      *
-     * @param string $status The updated process title.
+     * @param string $status The updated process title
+     *
+     * @return void
      */
-    private function updateProcLine($status)
+    private function updateProcLine($status): void
     {
         $processTitle = 'resque-' . Resque::VERSION . ': ' . $status;
         if (function_exists('cli_set_process_title') && PHP_OS !== 'Darwin') {
@@ -359,8 +380,10 @@ 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()
+    private function registerSigHandlers(): void
     {
         if (!function_exists('pcntl_signal')) {
             return;
@@ -376,9 +399,11 @@ class Worker
     }
 
     /**
-     * Signal handler callback for USR2, pauses processing of new jobs.
+     * Signal handler callback for USR2, pauses processing of new jobs
+     *
+     * @return void
      */
-    public function pauseProcessing()
+    public function pauseProcessing(): void
     {
         $this->logger->log(\Psr\Log\LogLevel::NOTICE, 'USR2 received; pausing job processing');
         $this->paused = true;
@@ -387,8 +412,10 @@ class Worker
     /**
      * Signal handler callback for CONT, resumes worker allowing it to pick
      * up new jobs.
+     *
+     * @return void
      */
-    public function unPauseProcessing()
+    public function unPauseProcessing(): void
     {
         $this->logger->log(\Psr\Log\LogLevel::NOTICE, 'CONT received; resuming job processing');
         $this->paused = false;
@@ -397,8 +424,10 @@ 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()
+    public function shutdown(): void
     {
         $this->shutdown = true;
         $this->logger->log(\Psr\Log\LogLevel::NOTICE, 'Shutting down');
@@ -407,8 +436,10 @@ class Worker
     /**
      * Force an immediate shutdown of the worker, killing any child jobs
      * currently running.
+     *
+     * @return void
      */
-    public function shutdownNow()
+    public function shutdownNow(): void
     {
         $this->shutdown();
         $this->killChild();
@@ -417,8 +448,10 @@ class Worker
     /**
      * Kill a forked child job immediately. The job it is processing will not
      * be completed.
+     *
+     * @return void
      */
-    public function killChild()
+    public function killChild(): void
     {
         if (!$this->child) {
             $this->logger->log(\Psr\Log\LogLevel::DEBUG, 'No child to kill.');
@@ -447,8 +480,10 @@ 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()
+    public function pruneDeadWorkers(): void
     {
         $workerPids = $this->workerPids();
         $workers = self::all();
@@ -474,7 +509,7 @@ class Worker
      *
      * @return array Array of Resque worker process IDs.
      */
-    public function workerPids()
+    public function workerPids(): array
     {
         $pids = [];
         exec('ps -A -o pid,command | grep [r]esque', $cmdOutput);
@@ -486,22 +521,26 @@ class Worker
 
     /**
      * Register this worker in Redis.
-     * 48 hour TTL so we don't pollute the db on server termination.
+     * 48 hour TTL so we don't pollute the redis db on server termination.
+     *
+     * @return void
      */
-    public function registerWorker()
+    public function registerWorker(): void
     {
         Resque::redis()->sadd('workers', (string)$this);
         Resque::redis()->set(
             'worker:' . (string)$this . ':started',
             date('D M d H:i:s T Y'),
-            ['ex' => time() + 86400],
+            ['ex' => Redis::DEFAULT_REDIS_TTL],
         );
     }
 
     /**
      * Unregister this worker in Redis. (shutdown etc)
+     *
+     * @return void
      */
-    public function unregisterWorker()
+    public function unregisterWorker(): void
     {
         if (is_object($this->currentJob)) {
             $this->currentJob->fail(new \Resque\Job\DirtyExitException());
@@ -516,12 +555,15 @@ class Worker
     }
 
     /**
-     * Tell Redis which job we're currently working on.
+     * 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
      *
-     * @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)
+    public function workingOn(\Resque\Job\Job $job): void
     {
         $job->worker = $this;
         $this->currentJob = $job;
@@ -535,15 +577,17 @@ class Worker
         Resque::redis()->set(
             'worker:' . $job->worker,
             $data,
-            ['ex' => time() + 86400],
+            ['ex' => Redis::DEFAULT_REDIS_TTL],
         );
     }
 
     /**
      * Notify Redis that we've finished working on a job, clearing the working
-     * state and incrementing the job stats.
+     * state and incrementing the job stats
+     *
+     * @return void
      */
-    public function doneWorking()
+    public function doneWorking(): void
     {
         $this->currentJob = null;
         Stat::incr('processed');
@@ -552,28 +596,29 @@ 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()
+    public function __toString(): string
     {
-        return $this->id;
+        return (string) $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.
      *
@@ -588,8 +633,10 @@ class Worker
      * Inject the logging object into the worker
      *
      * @param \Psr\Log\LoggerInterface $logger
+     *
+     * @return void
      */
-    public function setLogger(\Psr\Log\LoggerInterface $logger)
+    public function setLogger(\Psr\Log\LoggerInterface $logger): void
     {
         $this->logger = $logger;
     }

tests/Resque/Tests/RedisTest.php

@@ -17,7 +17,7 @@ class RedisTest extends TestCase
         $this->redis->set(
             'testKey',
             24,
-            ['ex' => time() + 3600],
+            ['ex' => \Resque\Redis::DEFAULT_REDIS_TTL],
         );
 
         $val = $this->redis->get("testKey");