Merge pull request #2 from stackkit/development

Development

Author: marickvantuil

README.md

@@ -1,5 +1,3 @@
-<h3 style="color:red">This is a WIP package</h3>
-
 <p align="center">
   <img src="/logo.png" width="400">
 </p>
@@ -19,6 +17,10 @@ It only supports Artisan commands at this time due to security concerns.
 
 Cloud Tasks will make a HTTP call to your application. This package adds an endpoint to your application that accepts the HTTP call and its payload (an Artisan command) and executes the command.
 
+#### withoutOverlapping, before, after, onSuccess, thenPing, etc
+
+All these features are supported. This package scans your console kernel (`app/Console/Kernel.php`) to see if the scheduled command in Cloud Scheduler is also scheduled in the console kernel, If it is, it will respect all configured events/hooks associated with the command. (such as withoutOverlapping) 
+
 # Requirements
 
 This package requires Laravel 5.6 or higher.
@@ -59,10 +61,6 @@ These are the most important settings:
 
 <img src="/example.png">
 
-# Planned features
-
-Laravel's console kernel allows to execute actions after the command has finished running (such as ping a service) and prevent overlapping. This package does not support those features at this time. The goal is to eventually read the configured settings for a command (as defined in the console kernel) and execute the command exacty as defined there  so that methods like `thenPing` and `withoutOverlapping` work out of the box without the need to configure anything.
-
 # Security
 
 The job handler requires each request to have an OpenID token. Cloud Scheduler will generate an OpenID token and send it along with the job payload to the handler.

composer.json

@@ -17,7 +17,9 @@
     },
     "require-dev": {
         "mockery/mockery": "^1.2",
-        "symfony/console": "^4.4|^5.0"
+        "orchestra/testbench": "^3.5 || ^3.6 || ^3.7 || ^3.8 || ^4.0 || ^5.0",
+        "symfony/console": "^4.4|^5.0",
+        "timacdonald/log-fake": "^1.6"
     },
     "autoload": {
         "psr-4": {

src/TaskHandler.php

@@ -2,6 +2,9 @@
 
 namespace Stackkit\LaravelGoogleCloudScheduler;
 
+use Illuminate\Console\Scheduling\Schedule;
+use Illuminate\Container\Container;
+use Illuminate\Contracts\Console\Kernel;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Artisan;
 
@@ -10,12 +13,24 @@ class TaskHandler
     private $command;
     private $request;
     private $openId;
+    private $kernel;
+    private $schedule;
+    private $container;
 
-    public function __construct(Command $command, Request $request, OpenIdVerificator $openId)
-    {
+    public function __construct(
+        Command $command,
+        Request $request,
+        OpenIdVerificator $openId,
+        Kernel $kernel,
+        Schedule $schedule,
+        Container $container
+    ) {
         $this->command = $command;
         $this->request = $request;
         $this->openId = $openId;
+        $this->kernel = $kernel;
+        $this->schedule = $schedule;
+        $this->container = $container;
     }
 
     /**
@@ -27,9 +42,7 @@ public function handle()
 
         set_time_limit(0);
 
-        Artisan::call($this->command->captureWithoutArtisan());
-
-        $output = Artisan::output();
+        $output = $this->runCommand($this->command->captureWithoutArtisan());
 
         return $this->cleanOutput($output);
     }
@@ -50,6 +63,54 @@ private function authorizeRequest()
         $this->openId->guardAgainstInvalidOpenIdToken($decodedToken);
     }
 
+    private function runCommand($command)
+    {
+        if ($this->isScheduledCommand($command)) {
+            $scheduledCommand = $this->getScheduledCommand($command);
+
+            if ($scheduledCommand->withoutOverlapping && ! $scheduledCommand->mutex->create($scheduledCommand)) {
+                return null;
+            }
+
+            $scheduledCommand->callBeforeCallbacks($this->container);
+
+            Artisan::call($command);
+
+            $scheduledCommand->callAfterCallbacks($this->container);
+        } else {
+            Artisan::call($command);
+        }
+
+        return Artisan::output();
+    }
+
+    private function isScheduledCommand($command)
+    {
+        return !is_null($this->getScheduledCommand($command));
+    }
+
+    private function getScheduledCommand($command)
+    {
+        $events = $this->schedule->events();
+
+        foreach ($events as $event) {
+            $eventCommand = $this->commandWithoutArtisan($event->command);
+
+            if ($command === $eventCommand) {
+                return $event;
+            }
+        }
+
+        return null;
+    }
+
+    private function commandWithoutArtisan($command)
+    {
+        $parts = explode('artisan', $command);
+
+        return substr($parts[1], 2, strlen($parts[1]));
+    }
+
     private function cleanOutput($output)
     {
         return trim($output);

tests/Support/Kernel.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Tests\Support;
+
+use Illuminate\Console\Scheduling\Schedule;
+use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+use Illuminate\Support\Facades\Log;
+
+class Kernel extends ConsoleKernel
+{
+    protected $commands = [
+        TestCommand::class,
+        TestCommand2::class,
+    ];
+
+    protected function schedule(Schedule $schedule)
+    {
+        $schedule->command('test:command')->withoutOverlapping();
+        $schedule->command('test:command2')->before(function () {
+            Log::info('log after');
+        })->after(function () {
+            Log::warning('log before');
+        });
+    }
+}

tests/Support/TestCommand.php

@@ -3,40 +3,15 @@
 namespace Tests\Support;
 
 use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Log;
 
 class TestCommand extends Command
 {
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
     protected $signature = 'test:command';
-
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Do some testy stuff';
 
-    /**
-     * Create a new command instance.
-     *
-     * @return void
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-    /**
-     * Execute the console command.
-     *
-     * @return mixed
-     */
     public function handle()
     {
-        logger('did something testy');
+        Log::debug('did something testy');
     }
 }

tests/Support/TestCommand2.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Tests\Support;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Log;
+
+class TestCommand2 extends Command
+{
+    protected $signature = 'test:command2';
+
+    protected $description = 'Do some testy stuff';
+
+    public function handle()
+    {
+        Log::debug('did something testy');
+    }
+}

tests/TaskHandlerTest.php

@@ -3,14 +3,18 @@
 namespace Tests;
 
 use Firebase\JWT\JWT;
+use Illuminate\Console\Application as ConsoleApplication;
 use Illuminate\Console\Scheduling\Schedule;
+use Illuminate\Container\Container;
+use Illuminate\Contracts\Console\Kernel;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Log;
 use Stackkit\LaravelGoogleCloudScheduler\CloudSchedulerException;
 use Stackkit\LaravelGoogleCloudScheduler\Command;
 use Stackkit\LaravelGoogleCloudScheduler\OpenIdVerificator;
 use Stackkit\LaravelGoogleCloudScheduler\TaskHandler;
 use Throwable;
+use TiMacDonald\Log\LogFake;
 
 class TaskHandlerTest extends TestCase
 {
@@ -35,7 +39,9 @@ public function setUp(): void
             $this->fakeCommand,
             $this->request,
             $this->openId,
-            app(JWT::class)
+            app(Kernel::class),
+            app(Schedule::class),
+            Container::getInstance()
         );
     }
 
@@ -132,4 +138,46 @@ public function the_aud_claim_must_be_the_same_as_the_app_id()
 
         $this->taskHandler->handle();
     }
+
+    /** @test */
+    public function it_prevents_overlapping_if_the_command_is_scheduled_without_overlapping()
+    {
+        $this->fakeCommand->shouldReceive('capture')->andReturn('test:command');
+        $this->openId->shouldReceive('guardAgainstInvalidOpenIdToken')->andReturnNull();
+        $this->openId->shouldReceive('decodeToken')->andReturnNull();
+
+        cache()->clear();
+
+        Log::shouldReceive('debug')->twice();
+
+        $this->taskHandler->handle();
+
+        $expression = '* * * * *';
+        $command = ConsoleApplication::formatCommandString('test:command');
+        $mutex = 'framework'.DIRECTORY_SEPARATOR.'schedule-'.sha1($expression.$command);
+
+        cache()->add($mutex, true, 60);
+
+        $this->taskHandler->handle();
+
+        cache()->delete($mutex);
+
+        $this->taskHandler->handle();
+    }
+
+    /** @test */
+    public function it_runs_the_before_and_after_callbacks()
+    {
+        $this->fakeCommand->shouldReceive('capture')->andReturn('test:command2');
+        $this->openId->shouldReceive('guardAgainstInvalidOpenIdToken')->andReturnNull();
+        $this->openId->shouldReceive('decodeToken')->andReturnNull();
+
+        Log::swap(new LogFake());
+
+        $this->taskHandler->handle();
+
+        Log::assertLoggedMessage('info', 'log after');
+        Log::assertLoggedMessage('warning', 'log before');
+        Log::assertLoggedMessage('debug', 'did something testy');
+    }
 }

tests/TestCase.php

@@ -2,6 +2,10 @@
 
 namespace Tests;
 
+use Illuminate\Console\Scheduling\Schedule;
+use Tests\Support\Kernel;
+use Tests\Support\TestCommand;
+
 class TestCase extends \Orchestra\Testbench\TestCase
 {
     /**
@@ -29,6 +33,9 @@ protected function getPackageProviders($app)
      */
     protected function getEnvironmentSetUp($app)
     {
-        //
+        $app->singleton(
+            \Illuminate\Contracts\Console\Kernel::class,
+            Kernel::class
+        );
     }
 }