FOUR-8217: Automate Default Template Creations

ProcessMaker/Console/Commands/SyncDefaultTemplates.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace ProcessMaker\Console\Commands;
+
+use Illuminate\Console\Command;
+use ProcessMaker\Jobs\SyncDefaultTemplates as Job;
+
+class SyncDefaultTemplates extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'processmaker:sync-default-templates
+                            {--queue : Queue this command to run asynchronously}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Synchronize default templates from a central repository';
+
+    /**
+     * Create a new command instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        if ($this->option('queue')) {
+            $randomDelay = random_int(10, 120);
+            Job::dispatch()->delay(now()->addMinutes($randomDelay));
+        } else {
+            Job::dispatchNow();
+        }
+
+        return 0;
+    }
+}

ProcessMaker/Console/Kernel.php

@@ -4,6 +4,8 @@
 
 use Illuminate\Console\Scheduling\Schedule;
 use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+use Illuminate\Support\Facades\Artisan;
+use ProcessMaker\Jobs\SyncDefaultTemplates;
 
 class Kernel extends ConsoleKernel
 {
@@ -30,6 +32,8 @@ protected function schedule(Schedule $schedule)
 
         $schedule->command('package-data-sources:delete-logs')
             ->weekly();
+
+        $schedule->command('processmaker:sync-default-templates --queue')->daily();
     }
 
     /**

ProcessMaker/Events/AuthClientCreated.php

@@ -49,7 +49,7 @@ public function getData(): array
     public function getChanges(): array
     {
         return [
-            'id' => $this->data['id']
+            'id' => $this->data['id'],
         ];
     }
 

ProcessMaker/Events/AuthClientUpdated.php

@@ -13,8 +13,11 @@ class AuthClientUpdated implements SecurityLogEventInterface
     use FormatSecurityLogChanges;
 
     private array $original;
+
     private array $changes;
+
     private string $clientId;
+
     private string $clientName;
 
     /**

ProcessMaker/Events/CustomizeUiUpdated.php

@@ -43,10 +43,10 @@ public function buildData()
         if (isset($this->changes['variables'])) {
             $varChanges = [];
             $varOriginal = [];
-            foreach ((array)json_decode($this->changes['variables'], true) as $variable) {
+            foreach ((array) json_decode($this->changes['variables'], true) as $variable) {
                 $varChanges[$variable['title']] = $variable['value'];
             }
-            foreach ((array)json_decode($this->original['variables'], true) as $variable) {
+            foreach ((array) json_decode($this->original['variables'], true) as $variable) {
                 $varOriginal[$variable['title']] = $variable['value'];
             }
             $varChanges = array_diff($varChanges, $varOriginal);
@@ -60,7 +60,7 @@ public function buildData()
                     'label' => 'Customize Ui',
                     'link' => route('customize-ui.edit'),
                 ],
-                'last_modified' => Carbon::now()
+                'last_modified' => Carbon::now(),
             ],
             $this->formatChanges($this->changes, $this->original)
         );

ProcessMaker/Events/PermissionUpdated.php

@@ -76,7 +76,7 @@ public function getData(): array
                     'label' => $userData->getAttribute('username'),
                     'link' => route('users.edit', $this->userId) . '#nav-profile',
                 ],
-                'last_modified' => $userData->getAttribute('updated_at')
+                'last_modified' => $userData->getAttribute('updated_at'),
             ], $this->arrayPermissions);
         }
     }

ProcessMaker/Events/ScreenUpdated.php

@@ -22,7 +22,7 @@ class ScreenUpdated implements SecurityLogEventInterface
 
     public const REMOVE_KEYS = [
         'screen_category_id',
-        'tmp_screen_category_id'
+        'tmp_screen_category_id',
     ];
 
     /**

ProcessMaker/Events/ScriptCreated.php

@@ -14,6 +14,7 @@ class ScriptCreated implements SecurityLogEventInterface
     use FormatSecurityLogChanges;
 
     private array $changes;
+
     private string $categoryName = '';
 
     private Script $script;

ProcessMaker/Events/ScriptExecutorUpdated.php

@@ -13,7 +13,9 @@ class ScriptExecutorUpdated implements SecurityLogEventInterface
     use FormatSecurityLogChanges;
 
     private array $changes;
+
     private array $original;
+
     private int $scriptId;
 
     /**

ProcessMaker/Events/ScriptUpdated.php

@@ -22,7 +22,7 @@ class ScriptUpdated implements SecurityLogEventInterface
 
     public const REMOVE_KEYS = [
         'script_category_id',
-        'tmp_script_category_id'
+        'tmp_script_category_id',
     ];
 
     /**

ProcessMaker/Events/SignalUpdated.php

@@ -14,6 +14,7 @@ class SignalUpdated implements SecurityLogEventInterface
     use FormatSecurityLogChanges;
 
     private array $changes;
+
     private array $original;
 
     /**
@@ -37,7 +38,7 @@ public function getData(): array
                 'label' => $this->changes['name'],
                 'link' => route('signals.edit', ['signalId' => $this->changes['id']]),
             ],
-            'last_modified' => Carbon::now()
+            'last_modified' => Carbon::now(),
         ], ArrayHelper::getArrayDifferencesWithFormat($this->changes, $this->original));
     }
 

ProcessMaker/Events/TemplateUpdated.php

@@ -15,7 +15,9 @@ class TemplateUpdated implements SecurityLogEventInterface
     use FormatSecurityLogChanges;
 
     private array $changes;
+
     private array $original;
+
     private bool $processType;
 
     /**

ProcessMaker/Events/TokenDeleted.php

@@ -11,6 +11,7 @@ class TokenDeleted implements SecurityLogEventInterface
     use Dispatchable;
 
     private array $data;
+
     private array $changes;
 
     /**

ProcessMaker/Events/UserUpdated.php

@@ -51,7 +51,7 @@ public function getData(): array
                 'link' => route('users.edit', $this->user->getAttribute('id')) . '#nav-home',
             ],
             'user_name' => $this->user->getAttribute('username'),
-            'last_modified' => $this->user->getAttribute('updated_at')
+            'last_modified' => $this->user->getAttribute('updated_at'),
         ], ArrayHelper::getArrayDifferencesWithFormat($this->changes, $this->original));
     }
 

ProcessMaker/Facades/MessageBrokerService.php

@@ -8,7 +8,7 @@
 /**
  * @see \ProcessMaker\Nayra\MessageBrokers\ServiceKafka
  * @see \ProcessMaker\Nayra\MessageBrokers\ServiceRabbitMq
- * 
+ *
  * @method static void connect()
  * @method static void disconnect()
  * @method static void sendMessage(string $subject, string $collaborationId, mixed $body)

ProcessMaker/Helpers/ArrayHelper.php

@@ -48,11 +48,13 @@ public static function getArrayDifferencesWithFormat(array $changedArray, array
      * @param string $newKey
      * @return array
      */
-    public static function replaceKeyInArray(array $array, string $oldKey, string $newKey) {
+    public static function replaceKeyInArray(array $array, string $oldKey, string $newKey)
+    {
         if (array_key_exists($oldKey, $array)) {
             $array[$newKey] = $array[$oldKey];
             unset($array[$oldKey]);
         }
+
         return $array;
     }
 }

ProcessMaker/Http/Controllers/Api/SignalController.php

@@ -233,7 +233,7 @@ public function store(Request $request)
         SignalCreated::dispatch([
             'id' => $newSignal->getId(),
             'name' => $newSignal->getName(),
-            'detail' => $request->input('detail', '')
+            'detail' => $request->input('detail', ''),
         ]);
 
         return response(['id' => $newSignal->getId(), 'name' => $newSignal->getName()], 200);
@@ -355,7 +355,7 @@ function ($carry, $process) {
             // Register the Event
             SignalDeleted::dispatch([
                 'id' => $signal->getId(),
-                'name' => $signal->getName()
+                'name' => $signal->getName(),
             ]);
         }
 

ProcessMaker/Http/Controllers/Api/TemplateController.php

@@ -70,6 +70,7 @@ public function store(string $type, Request $request)
         $request->validate(Template::rules($request->id, $this->types[$type][4]));
         $storeTemplate = $this->template->store($type, $request);
         TemplatePublished::dispatch($request->request->all());
+
         return $storeTemplate;
     }
 

ProcessMaker/Jobs/RunNayraServiceTask.php

@@ -21,7 +21,7 @@ class RunNayraServiceTask implements ShouldQueue
     public $tokenId;
 
     public $attemptNum = 1;
-    
+
     /**
      * Create a new job instance.
      *

ProcessMaker/Jobs/SyncDefaultTemplates.php

@@ -0,0 +1,102 @@
+<?php
+
+namespace ProcessMaker\Jobs;
+
+use Exception;
+use Facades\ProcessMaker\JsonColumnIndex;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldBeUnique;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Http;
+use ProcessMaker\ImportExport\Importer;
+use ProcessMaker\ImportExport\Options;
+use ProcessMaker\Models\ProcessCategory;
+use ProcessMaker\Models\ProcessTemplates;
+
+class SyncDefaultTemplates implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    /**
+     * Create a new job instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        //
+    }
+
+    /**
+     * Execute the job.
+     * Function to handle the execution of this job when it is run.
+     * Here the function fetches default templates list from Github and saves them to the database.
+     * @return void
+     */
+    public function handle()
+    {
+        $config = config('services.github');
+        $url = $config['base_url'] . $config['template_repo'] . '/' . $config['template_branch'] . '/index.json';
+
+        // If there are multiple categories of templates defined in the .env then separate them into an array.
+        $categories = (strpos($config['template_categories'], ',') !== false) ? explode(',', $config['template_categories']) : [$config['template_categories']];
+
+        $processCategoryId = ProcessCategory::firstOrCreate(
+            ['name' => 'Default Templates'],
+            [
+                'name' => 'Default Templates',
+                'status' => 'ACTIVE',
+                'is_system' => 0,
+            ]
+        )->getKey();
+
+        // Get the default template list from Github.
+        $response = Http::get($url);
+
+        if (!$response->successful()) {
+            throw new Exception('Unable to fetch default template list.');
+        }
+
+        // Extract the json data from the response and iterate over the categories and templates to retrieve them.
+        $data = $response->json();
+        foreach ($data as $templateCategory => $templates) {
+            if (!in_array($templateCategory, $categories) && !in_array('all', $categories)) {
+                continue;
+            }
+            foreach ($templates as $template) {
+                $existingTemplate = ProcessTemplates::where('uuid', $template['uuid'])->first();
+                // If the template already exists in the database with a user then skip it, since we don't want to overwrite their changes.
+                if (!is_null($existingTemplate) && !is_null($existingTemplate->user_id)) {
+                    continue;
+                }
+
+                $url = $config['base_url'] . $config['template_repo'] . '/' . $config['template_branch'] . '/' . $template['relative_path'];
+                $response = Http::get($url);
+                if (!$response->successful()) {
+                    throw new Exception("Unable to fetch default template {$template['name']}.");
+                }
+                $payload = $response->json();
+                data_set($payload, 'export.' . $payload['root'] . '.attributes.process_category_id', $processCategoryId);
+                $options = new Options([
+                    'mode' => 'update',
+                    'isTemplate' => true,
+                    'saveAssetsMode' => 'saveAllAssets',
+                ]);
+                $importer = new Importer($payload, $options);
+                $manifest = $importer->doImport();
+
+                $template = ProcessTemplates::where('uuid', $template['uuid'])->first();
+                $template->setRawAttributes([
+                    'key' => 'default_templates',
+                    'process_id' => null,
+                    'user_id' => null,
+                    'process_category_id' => $processCategoryId,
+                ]);
+                $template->save();
+            }
+        }
+    }
+}

ProcessMaker/Models/EnvironmentVariable.php

@@ -64,6 +64,7 @@ public function getValueAttribute()
                 "\n" . $e->getMessage() .
                 "\n" . $e->getTraceAsString()
             );
+
             return null;
         }
     }

ProcessMaker/Nayra/Managers/WorkflowManagerRabbitMq.php

@@ -344,9 +344,7 @@ public function handleServiceTask(ProcessRequestToken $token, RunNayraServiceTas
                 'output' => $exception->getMessageForData($token),
             ];
             $this->dispatchActionForServiceTask($version, $token, $response, $state, $userId);
-
         } catch (Throwable $exception) {
-
             $thisWasFinalAttempt = true;
             if (isset($errorHandling)) {
                 $thisWasFinalAttempt = ($errorHandling->retryAttempts() === 0) || ($job->attemptNum >= $errorHandling->retryAttempts());
@@ -366,7 +364,7 @@ public function handleServiceTask(ProcessRequestToken $token, RunNayraServiceTas
             Log::error($exception->getTraceAsString());
 
             if ($thisWasFinalAttempt) {
-                // When the last 
+                // When the last
                 $this->taskFailed($instance, $token, $exception->getMessage());
             }
         }