Allow processing of documentation through queued job

Author: bennothommo

console/DocsProcess.php

@@ -2,7 +2,9 @@
 
 namespace Winter\Docs\Console;
 
+use Illuminate\Support\Facades\Queue;
 use Winter\Docs\Classes\DocsManager;
+use Winter\Docs\Jobs\ProcessDoc;
 use Winter\Storm\Console\Command;
 
 class DocsProcess extends Command
@@ -19,6 +21,7 @@ class DocsProcess extends Command
      */
     protected $signature = 'docs:process
         {id? : The identifier of the documentation to process}
+        {--j|queue= : Add as a job to the queue}
         {--t|token= : An authorization token to use when downloading the documentation}
         {--m|memory-limit= : The memory limit to use when processing documentation}';
 
@@ -58,50 +61,23 @@ public function handle()
             }
         }
 
-        foreach ($ids as $id) {
-            $this->processDoc($id);
-        }
-    }
-
-    public function processDoc(string $id)
-    {
-        $docsManager = DocsManager::instance();
-        $doc = $docsManager->getDocumentation($id);
-
-        $this->line('');
-
-        if (is_null($doc)) {
-            $this->error('No documentation by the given ID exists.');
-            return;
-        }
-
-        $this->info('Processing ' . $id);
-
-        // Download documentation
-        if ($doc->isRemote()) {
-            $this->line(' - Downloading documentation');
-            $doc->download($this->option('token'));
-
-            $this->line(' - Extracting documentation');
-            $doc->extract();
+        if (is_null($this->option('queue'))) {
+            $queue = false;
         } else {
-            $this->line(' - Documentation is locally available, skipping download');
+            $queue = $this->option('queue') ?: 'default';
         }
 
-        // Process documentation
-        $this->line(' - Processing documentation');
-        $doc->process();
-        $doc->resetState();
-
-        $pageList = $doc->getPageList();
-        $this->line(' - Processed ' . count($pageList) . ' page(s)');
-
-        if ($pageList->isSearchable()) {
-            $this->line(' - Indexing documentation');
-            $pageList->index();
+        foreach ($ids as $id) {
+            if ($queue === false) {
+                (new ProcessDoc())->processDoc($id, $this->option('token'), $this);
+            } else {
+                Queue::push(ProcessDoc::class, [
+                    'id' => $id,
+                    'token' => $this->option('token'),
+                    'memory_limit' => $this->option('memory-limit'),
+                ], $queue);
+                $this->info('- Added documentation processing to queue "' . $queue . '": ' . $id);
+            }
         }
-
-        $this->line(' - Clean up downloaded files');
-        $doc->cleanupDownload();
     }
 }

jobs/ProcessDoc.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Winter\Docs\Jobs;
+
+use Winter\Docs\Classes\DocsManager;
+use Winter\Storm\Console\Command;
+use Winter\Storm\Exception\ApplicationException;
+
+class ProcessDoc
+{
+    /**
+     * The command instance, if run through the console.
+     */
+    protected ?Command $command = null;
+
+    /**
+     * Execute the job.
+     */
+    public function fire($job, $data)
+    {
+        if ($data['memory_limit']) {
+            ini_set('memory_limit', $data['memory_limit']);
+        }
+
+        $this->processDoc($data['id'], $data['token']);
+        $job->delete();
+    }
+
+    /**
+     * Processes a documentation by the given ID.
+     *
+     * You may optionally provide a token to use when downloading the documentation as the second argument.
+     *
+     * This can either be run through the `docs:process` command, or as a queued job. If run through the command, the
+     * command instance should be passed as the third argument.
+     */
+    public function processDoc(string $id, ?string $token = null, ?Command $command = null)
+    {
+        $this->command = $command;
+
+        $docsManager = DocsManager::instance();
+        $doc = $docsManager->getDocumentation($id);
+
+        $this->line('');
+
+        if (is_null($doc)) {
+            $this->error('No documentation by the given ID exists.');
+            return;
+        }
+
+        $this->info('Processing ' . $id);
+
+        // Download documentation
+        if ($doc->isRemote()) {
+            $this->line(' - Downloading documentation');
+            $doc->download($token);
+
+            $this->line(' - Extracting documentation');
+            $doc->extract();
+        } else {
+            $this->line(' - Documentation is locally available, skipping download');
+        }
+
+        // Process documentation
+        $this->line(' - Processing documentation');
+        $doc->process();
+        $doc->resetState();
+
+        $pageList = $doc->getPageList();
+        $this->line(' - Processed ' . count($pageList) . ' page(s)');
+
+        if ($pageList->isSearchable()) {
+            $this->line(' - Indexing documentation');
+            $pageList->index();
+        }
+
+        $this->line(' - Clean up downloaded files');
+        $doc->cleanupDownload();
+    }
+
+    protected function line($string): void
+    {
+        if ($this->command) {
+            $this->command->line($string);
+        }
+    }
+
+    protected function info($string): void
+    {
+        if ($this->command) {
+            $this->command->info($string);
+        }
+    }
+
+    protected function error($string): void
+    {
+        if ($this->command) {
+            $this->command->error($string);
+        } else {
+            throw new ApplicationException($string);
+        }
+    }
+}

updates/version.yaml

@@ -1 +1,2 @@
 "1.0.0": Initial version of the Winter Docs plugin.
+"1.0.1": Allow processing of documentation through job queue.