Implement feature to auto clean of old results optionally (#70)

* Updated task edit/create form to allow setting auto clean up feature; Created migration to add needed fields; Updated executed event to call autoCleanup function; Added new function to Task model to perform auto clean up results

* Added new fields to import feature

Author: qschmick

database/migrations/2018_01_02_121533_alter_tasks_table_add_auto_cleanup_num_and_type_fields.php

@@ -0,0 +1,37 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class AlterTasksTableAddAutoCleanupNumAndTypeFields extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table(config('totem.table_prefix').'tasks', function (Blueprint $table) {
+            $table->integer('auto_cleanup_num')->default(0);
+            $table->string('auto_cleanup_type', 20)->nullable();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table(config('totem.table_prefix').'tasks', function (Blueprint $table) {
+            $table->dropColumn('auto_cleanup_num');
+        });
+
+        Schema::table(config('totem.table_prefix').'tasks', function (Blueprint $table) {
+            $table->dropColumn('auto_cleanup_type');
+        });
+    }
+}

resources/views/tasks/form.blade.php

@@ -212,6 +212,29 @@
             </div>
         </div>
     </div>
+    <hr class="uk-divider-icon">
+    <div class="uk-grid">
+        <div class="uk-width-1-1@s uk-width-1-3@m">
+            <div class="uk-form-label">Cleanup Options</div>
+            <ul class="uk-list uk-padding-remove">
+                <li class="uk-text-meta">Determine if an over-abundance of results will be removed after a set limit or age. Set non-zero value to enable.</li>
+            </ul>
+        </div>
+        <div class="uk-width-1-1@s uk-width-2-3@m uk-form-controls-text">
+            <label class="uk-margin">
+                Auto Cleanup results after
+                <br>
+                <input type="number" name="auto_cleanup_num" id="auto_cleanup_num" value="{{ old('auto_cleanup_num', $task->auto_cleanup_num) }}" />
+                <br>
+                <label>
+                    <input type="radio" name="auto_cleanup_type" value="days" {{old('auto_cleanup_type', $task->auto_cleanup_type) !== 'results' ? '' : 'checked'}}> Days
+                </label><br>
+                <label>
+                    <input type="radio" name="auto_cleanup_type" value="results" {{old('auto_cleanup_type', $task->auto_cleanup_type) === 'results' ? '' : 'checked'}}> Results
+                </label>
+            </label>
+        </div>
+    </div>
 @stop
 @section('main-panel-footer')
     <button class="uk-button uk-button-primary uk-button-small" type="submit">Save</button>

src/Events/Executed.php

@@ -30,6 +30,7 @@ public function __construct(Task $task, $started)
             unlink(storage_path($task->getMutexName()));
 
             $task->notify(new TaskCompleted($output));
+            $task->autoCleanup();
         }
     }
 }

src/Http/Controllers/TasksController.php

@@ -169,6 +169,8 @@ public function import()
                             'notification_email_address' => $record->notification_email_address,
                             'notification_phone_number' => $record->notification_phone_number,
                             'notification_slack_webhook' => $record->notification_slack_webhook,
+                            'auto_cleanup_num' => $record->auto_cleanup_num,
+                            'auto_cleanup_type' => $record->auto_cleanup_type,
                         ]);
 
                         if (! empty($record->frequencies)) {

src/Task.php

@@ -2,6 +2,7 @@
 
 namespace Studio\Totem;
 
+use Carbon\Carbon;
 use Cron\CronExpression;
 use Studio\Totem\Traits\HasFrequencies;
 use Illuminate\Notifications\Notifiable;
@@ -27,6 +28,8 @@ class Task extends TotemModel
         'notification_email_address',
         'notification_phone_number',
         'notification_slack_webhook',
+        'auto_cleanup_type',
+        'auto_cleanup_num',
     ];
 
     /**
@@ -63,6 +66,7 @@ public function getUpcomingAttribute()
      * Convert a string of command arguments and options to an array.
      *
      * @param bool $console if true will convert arguments to non associative array
+     *
      * @return array
      */
     public function compileParameters($console = false)
@@ -143,4 +147,27 @@ public function routeNotificationForSlack()
     {
         return $this->notification_slack_webhook;
     }
+
+    /**
+     * Attempt to perform clean on task results.
+     */
+    public function autoCleanup()
+    {
+        if ($this->auto_cleanup_num > 0) {
+            if ($this->auto_cleanup_type === 'results') {
+                $oldest_id = self::results()
+                    ->orderBy('ran_at', 'desc')
+                    ->limit($this->auto_cleanup_num)
+                    ->get()
+                    ->min('id');
+                self::results()
+                    ->where('id', '<', $oldest_id)
+                    ->delete();
+            } else {
+                self::results()
+                    ->where('ran_at', '<', Carbon::now()->subDays($this->auto_cleanup_num - 1))
+                    ->delete();
+            }
+        }
+    }
 }