Merged changed from main repository

Signed-off-by: Dmitry Mazurov <[email protected]>

Author: dima-bzz

.github/workflows/php-cs-fixer.yml

@@ -13,7 +13,7 @@ jobs:
             -   name: Fix style
                 uses: docker://oskarstark/php-cs-fixer-ga
                 with:
-                    args: --config=.php_cs --allow-risky=yes
+                    args: --config=.php_cs.php --allow-risky=yes
 
             -   name: Extract branch name
                 shell: bash

.github/workflows/run-tests.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest]
-        php: [7.4]
+        php: [7.4, 8.0]
         laravel: [8.*, 7.*]
         dependency-version: [prefer-lowest, prefer-stable]
         include:

CHANGELOG.md

@@ -2,6 +2,24 @@
 
 All notable changes to `laravel-short-schedule` will be documented in this file
 
+## 1.4.2 - 2021-06-11
+
+- allow spatie/temporary-directory 2.* (#35)
+
+
+## 1.4.1 - 2021-06-04
+
+- do not set a default lifetime for production
+
+
+## 1.4.0 - 2021-05-31
+
+- add lifetime option
+
+## 1.3.0 - 2020-12-24
+
+- add PHP8 support (#25)
+
 ## 1.2.2 - 2020-09-08
 
 - add support for Laravel 8

README.md

@@ -2,7 +2,6 @@
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/laravel-short-schedule.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-short-schedule)
 ![Tests](https://github.com/spatie/laravel-short-schedule/workflows/Tests/badge.svg)
-![Psalm](https://github.com/spatie/laravel-short-schedule/workflows/Psalm/badge.svg)
 [![Total Downloads](https://img.shields.io/packagist/dt/spatie/laravel-short-schedule.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-short-schedule)
 
 [Laravel's native scheduler](https://laravel.com/docs/master/scheduling) allows you to schedule Artisan commands to run every minute. 
@@ -59,6 +58,15 @@ php artisan short-schedule:run
 
 You should use a process monitor like [Supervisor](http://supervisord.org/index.html) to keep this task going at all times, and to automatically start it when your server boots. Whenever you change the schedule, you should restart this command.
 
+## Handle memory leaks
+
+To deal with commands that leak memory, you can set the lifetime in seconds of the short schedule worker:
+
+```bash
+php artisan short-schedule:run --lifetime=60 // after 1 minute the worker will be terminated
+```
+After the given amount of seconds, the worker and all it's child processes will be terminated, freeing all memory. Then supervisor (or similar watcher) will bring it back.
+
 ### Lumen
 
 Before you can run the `php artisan short-schedule:run` command in your Lumen project, you should make a copy of the `ShortScheduleRunCommand` into your `app/Commands` folder:
@@ -108,7 +116,7 @@ $shortSchedule->command('artisan-command')->everySeconds(0.5);
  Use `exec` to schedule a bash command.
 
 ```php
-$shortSchedule->bash('bash-command')->everySecond();
+$shortSchedule->exec('bash-command')->everySecond();
 ```
 
  ### Preventing overlaps

composer.json

@@ -16,17 +16,17 @@
         }
     ],
     "require": {
-        "php": "^7.4",
+        "php": "^7.4|^8.0",
         "illuminate/cache": "^7.0|^8.0",
         "react/event-loop": "^1.1",
-        "spatie/temporary-directory": "^1.2"
+        "spatie/temporary-directory": "^1.2|^2.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.16",
         "orchestra/testbench": "^5.0",
         "phpunit/phpunit": "^9.0",
         "spatie/test-time": "^1.2",
-        "vimeo/psalm": "^3.11"
+        "vimeo/psalm": "^4.3"
     },
     "autoload": {
         "psr-4": {

src/Commands/ShortScheduleRunCommand.php

@@ -8,14 +8,15 @@
 
 class ShortScheduleRunCommand extends Command
 {
-    protected $signature = 'short-schedule:run';
+    protected $signature = 'short-schedule:run {--lifetime=}';
 
-    protected $description = 'Run the short scheduled commands';
+    protected $description = 'Run the short scheduled commands
+                             {--lifetime= : The lifetime in seconds of worker}';
 
     public function handle()
     {
         $loop = Factory::create();
 
-        (new ShortSchedule($loop))->registerCommands()->run();
+        (new ShortSchedule($loop))->registerCommands()->run($this->option('lifetime'));
     }
 }

src/ShortSchedule.php

@@ -15,6 +15,8 @@ class ShortSchedule
 
     protected array $pendingCommands = [];
 
+    protected ?int $lifetime = null;
+
     public function __construct(LoopInterface $loop)
     {
         $this->loop = $loop;
@@ -61,12 +63,20 @@ public function pendingCommands()
             });
     }
 
-    public function run(): void
+    public function run(int $lifetime = null): void
     {
+        if (! is_null($lifetime)) {
+            $this->lifetime = $lifetime;
+        }
+
         $this->pendingCommands()->each(function (ShortScheduleCommand $command) {
             $this->addCommandToLoop($command, $this->loop);
         });
 
+        if (! is_null($this->lifetime)) {
+            $this->addLoopTerminationTimer($this->loop);
+        }
+
         $this->loop->run();
     }
 
@@ -80,4 +90,11 @@ protected function addCommandToLoop(ShortScheduleCommand $command, LoopInterface
             $command->run();
         });
     }
+
+    protected function addLoopTerminationTimer(LoopInterface $loop): void
+    {
+        $loop->addPeriodicTimer($this->lifetime,  function () use ($loop) {
+            $loop->stop();
+        });
+    }
 }

tests/Unit/RunConstraints/WhenConstraintTest.php

@@ -2,8 +2,8 @@
 
 namespace Spatie\ShortSchedule\Tests\Unit\RunConstraints;
 
-use PhpCsFixer\Tests\TestCase;
 use Spatie\ShortSchedule\RunConstraints\WhenConstraint;
+use Spatie\ShortSchedule\Tests\TestCase;
 
 class WhenConstraintTest extends TestCase
 {