feat: add cause to queued command output

flarum · SychO9 · Dec 18, 2023 · Dec 7, 2023 · Dec 7, 2023 · Dec 8, 2023
commit ca816ae304959b8e9339bac1a16a29fbe89f3939
@@ -19,12 +19,22 @@ export default class TaskOutputModal<CustomAttrs extends TaskOutputModalAttrs =
     return (
       <div className="Modal-body">
         <div className="TaskOutputModal-data">
+          <div className="Form-group">
+            <label>{app.translator.trans('flarum-package-manager.admin.sections.queue.output_modal.guessed_cause')}</label>
+            <div className="FormControl TaskOutputModal-data-guessed-cause">
+              {(this.attrs.task.guessedCause() &&
+                app.translator.trans('flarum-package-manager.admin.exceptions.guessed_cause.' + this.attrs.task.guessedCause())) ||
+                app.translator.trans('flarum-package-manager.admin.sections.queue.output_modal.cause_unknown')}
+            </div>
+          </div>
+
           <div className="Form-group">
             <label>{app.translator.trans('flarum-package-manager.admin.sections.queue.output_modal.command')}</label>
             <div className="FormControl TaskOutputModal-data-command">
               <code>$ composer {this.attrs.task.command()}</code>
             </div>
           </div>
+
           <div className="Form-group">
             <label>{app.translator.trans('flarum-package-manager.admin.sections.queue.output_modal.output')}</label>
             <div className="FormControl TaskOutputModal-data-output">

@@ -18,6 +18,10 @@ app.initializers.add('flarum-package-manager', (app) => {
 
   app.packageManager = new PackageManagerState();
 
+  if (app.data['flarum-package-manager.using_sync_queue']) {
+    app.data.settings['flarum-package-manager.queue_jobs'] = '0';
+  }
+
   app.extensionData
     .for('flarum-package-manager')
     .registerSetting({
@@ -33,10 +37,8 @@ app.initializers.add('flarum-package-manager', (app) => {
           })
         )
       ),
-      default: false,
       type: 'boolean',
       disabled: app.data['flarum-package-manager.using_sync_queue'],
-      // @todo async to sync while setting is enabled
     })
     .registerSetting({
       setting: 'flarum-package-manager.task_retention_days',

@@ -32,6 +32,10 @@ export default class Task extends Model {
     return Model.attribute<string>('output').call(this);
   }
 
+  guessedCause() {
+    return Model.attribute<string>('guessedCause').call(this);
+  }
+
   createdAt() {
     return Model.attribute('createdAt', Model.transformDate).call(this);
   }

@@ -75,7 +75,9 @@ flarum-package-manager:
           update_minor: Minor update
           why_not: Analyze why a package cannot be updated
         output_modal:
+          cause_unknown: Unknown
           command: Composer Command
+          guessed_cause: Cause
           output: Output
         refresh: Refresh tasks list
         statuses:

@@ -0,0 +1,7 @@
+<?php
+
+use Flarum\Database\Migration;
+
+return Migration::addColumns('package_manager_tasks', [
+    'guessed_cause' => ['type' => 'string', 'length' => 255, 'nullable' => true, 'after' => 'output'],
+]);
@@ -40,6 +40,7 @@ protected function getDefaultAttributes($model)
             'command' => $model->command,
             'package' => $model->package,
             'output' => $model->output,
+            'guessedCause' => $model->guessed_cause,
             'createdAt' => $model->created_at,
             'startedAt' => $model->started_at,
             'finishedAt' => $model->finished_at,

@@ -96,6 +96,7 @@ public function handle(UpdateExtension $command)
             ]);
         }
 
+        // @todo: soft update and hard update instead of directly hard updating?
         $output = $this->composer->run(
             new StringInput("require $extension->name:*"),
             $command->task ?? null

@@ -12,6 +12,7 @@
 use Flarum\Bus\Dispatcher;
 use Flarum\PackageManager\Command\AbstractActionCommand;
 use Flarum\PackageManager\Composer\ComposerAdapter;
+use Flarum\PackageManager\Exception\ComposerCommandFailedException;
 use Flarum\Queue\AbstractJob;
 use Illuminate\Contracts\Queue\ShouldBeUnique;
 use Illuminate\Queue\Middleware\WithoutOverlapping;
@@ -56,12 +57,16 @@ public function abort(Throwable $exception)
             $this->command->task->output = $exception->getMessage();
         }
 
+        if ($exception instanceof ComposerCommandFailedException) {
+            $this->command->task->guessed_cause = $exception->guessCause();
+        }
+
         $this->command->task->end(false);
     }
 
     public function failed(Throwable $exception): void
     {
-        $this->command->task->end(false);
+        $this->abort($exception);
     }
 
     public function middleware(): array

@@ -19,6 +19,7 @@
  * @property string $command
  * @property string $package
  * @property string $output
+ * @property string|null $guessed_cause
  * @property Carbon $created_at
  * @property Carbon|null $started_at
  * @property Carbon|null $finished_at
@@ -50,7 +51,7 @@ class Task extends AbstractModel
 
     protected $table = 'package_manager_tasks';
 
-    protected $fillable = ['command', 'output'];
+    protected $guarded = ['id'];
 
     public $timestamps = true;