add support for run in background (#263)

* add support for run in background

Co-authored-by: Jay Fletcher <[email protected]>

Author: jayjfletcher

database/migrations/2020_12_10_120000_alter_tasks_table_add_run_in_background_support.php

@@ -0,0 +1,34 @@
+<?php
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Studio\Totem\Database\TotemMigration;
+
+class AlterTasksTableAddRunInBackgroundSupport extends TotemMigration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::connection(TOTEM_DATABASE_CONNECTION)
+            ->table(TOTEM_TABLE_PREFIX.'tasks', function (Blueprint $table) {
+                $table->boolean('run_in_background')->default(false);
+            });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::connection(TOTEM_DATABASE_CONNECTION)
+            ->table(TOTEM_TABLE_PREFIX.'tasks', function (Blueprint $table) {
+                $table->dropColumn('run_in_background');
+            });
+    }
+}

resources/views/tasks/form.blade.php

@@ -190,6 +190,7 @@
                 <li class="uk-text-meta">Decide whether multiple instances of same task should overlap each other or not.</li>
                 <li class="uk-text-meta">Decide whether the task should be executed while the app is in maintenance mode.</li>
                 <li class="uk-text-meta">Decide whether the task should be executed on a single server.</li>
+                <li class="uk-text-meta">Decide whether the task should be executed in the background.</li>
             </ul>
         </div>
         <div class="uk-width-1-1@s uk-width-2-3@m uk-form-controls-text">
@@ -213,6 +214,13 @@
                     Run on a single server
                 </label>
             </div>
+            <div class="uk-margin">
+                <label class="uk-margin">
+                    <input type="hidden" name="run_in_background" id="run_in_background" value="0" {{old('run_in_background', $task->run_in_background) ? '' : 'checked'}}>
+                    <input type="checkbox" name="run_in_background" id="run_in_background" value="1" {{old('run_in_background', $task->run_in_background) ? 'checked' : ''}}>
+                    Run in the background
+                </label>
+            </div>
         </div>
     </div>
     <hr class="uk-divider-icon">

resources/views/tasks/view.blade.php

@@ -76,6 +76,11 @@
                 <span class="uk-float-left">Runs on a single server</span>
             </li>
         @endif
+        @if($task->run_in_background)
+            <li>
+                <span class="uk-float-left">Runs in the background</span>
+            </li>
+        @endif
     </ul>
 @stop
 @section('main-panel-footer')

src/Console/Commands/ListSchedule.php

@@ -60,11 +60,12 @@ public function handle()
                     'overlaps'      => $event->withoutOverlapping ? 'No' : 'Yes',
                     'maintenance'   => $event->evenInMaintenanceMode ? 'Yes' : 'No',
                     'one_server'   => $event->onOneServer ? 'Yes' : 'No',
+                    'in_background'   => $event->runInBackground ? 'Yes' : 'No',
                 ];
             });
 
             $this->table(
-                ['Description', 'Command', 'Schedule', 'Upcoming', 'Timezone', 'Overlaps?', 'In Maintenance?', 'One Server?'],
+                ['Description', 'Command', 'Schedule', 'Upcoming', 'Timezone', 'Overlaps?', 'In Maintenance?', 'One Server?', 'In Background?'],
                 $events
             );
         } else {

src/Providers/ConsoleServiceProvider.php

@@ -53,6 +53,9 @@ public function schedule(Schedule $schedule)
             if ($task->run_on_one_server && in_array(config('cache.default'), ['memcached', 'redis'])) {
                 $event->onOneServer();
             }
+            if ($task->run_in_background) {
+                $event->runInBackground();
+            }
         });
     }
 }

src/Task.php

@@ -36,6 +36,7 @@ class Task extends TotemModel
         'auto_cleanup_type',
         'auto_cleanup_num',
         'run_on_one_server',
+        'run_in_background',
     ];
 
     /**