Merge pull request #5760 from ProcessMaker/develop

Updating feature branch from develop branch... 2023-12-05

Author: julceslauhub

ProcessMaker/Http/Controllers/ProcessController.php

@@ -250,7 +250,7 @@ public function triggerStartEventApi(Process $process, Request $request)
         $apiRequest = new ApiProcessController();
         $response = $apiRequest->triggerStartEvent($process, $request);
 
-        return redirect('/requests/' . $response->id)->cookie('fromTriggerStartEvent', true, 1);
+        return redirect('/requests/' . $response->id . '?fromTriggerStartEvent=');
     }
 
     private function checkAuth()

ProcessMaker/Http/Controllers/RequestController.php

@@ -76,16 +76,22 @@ public function show(ProcessRequest $request, Media $mediaItems)
                 $definition = $startEvent->getDefinition();
                 $allowInterstitial = false;
                 if (isset($definition['allowInterstitial'])) {
-                    $allowInterstitial = filter_var($definition['allowInterstitial'], FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
+                    $allowInterstitial = filter_var(
+                        $definition['allowInterstitial'],
+                        FILTER_VALIDATE_BOOLEAN,
+                        FILTER_NULL_ON_FAILURE
+                    );
                 }
-                if ($allowInterstitial && $request->user_id == Auth::id() && request()->cookie('fromTriggerStartEvent')) {
+                if ($allowInterstitial && $request->user_id == Auth::id() && request()->has('fromTriggerStartEvent')) {
                     $active = $request->tokens()
                         ->where('user_id', Auth::id())
                         ->where('element_type', 'task')
                         ->where('status', 'ACTIVE')
                         ->orderBy('id')->first();
 
-                    return redirect(route('tasks.edit', ['task' => $active ? $active->getKey() : $startEvent->getKey()]))->withoutCookie('fromTriggerStartEvent');
+                    return redirect(route('tasks.edit', [
+                        'task' => $active ? $active->getKey() : $startEvent->getKey()
+                    ]));
                 }
             }
         }

ProcessMaker/Jobs/RefreshArtisanCaches.php

@@ -40,6 +40,10 @@ public function handle()
             Artisan::call('config:cache', $options);
         } else {
             Artisan::call('queue:restart', $options);
+
+            // We call this manually here since this job is dispatched
+            // automatically when the config *is* cached
+            RestartMessageConsumers::dispatchSync();
         }
     }
 }

ProcessMaker/Jobs/RestartMessageConsumers.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace ProcessMaker\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Str;
+
+class RestartMessageConsumers implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable;
+
+    /**
+     * Number of tries to run this job
+     *
+     * @var int
+     */
+    public $tries = 1;
+
+    public function __construct()
+    {
+        //
+    }
+
+    /**
+     * Execute the job.
+     *
+     * @return void
+     */
+    public function handle(): void
+    {
+        // For now, we;re only addressing the restart of the kafka consumer(s)
+        // and we will address the rabbitmq consumer(s) in another PR
+        if (Str::lower(config('app.message_broker_driver')) !== 'kafka') {
+            return;
+        }
+
+        $exitCode = Artisan::call('kafka:restart-consumers', [
+            '--no-interaction' => true,
+        ]);
+
+        Log::info('Kafka Consumer(s) Restart Attempted', [
+            'exit_code' => $exitCode,
+            'command_output' => Artisan::output(),
+        ]);
+    }
+}

ProcessMaker/Managers/ScreenBuilderManager.php

@@ -2,8 +2,7 @@
 
 namespace ProcessMaker\Managers;
 
-use Illuminate\Support\Facades\Storage;
-use ProcessMaker\Models\ScreenType;
+use Illuminate\Foundation\PackageManifest;
 
 class ScreenBuilderManager
 {
@@ -57,6 +56,11 @@ public function addPackageScripts($type = 'DISPLAY')
         $extensionsFile = 'screen-builder-' . strtolower($type) . '-components.js';
 
         $directories = glob('vendor/processmaker/packages/*', GLOB_ONLYDIR);
+        $installed = app(PackageManifest::class)->list();
+        $directories = array_values(array_filter($directories, function ($directory) use ($installed) {
+            $package = 'processmaker/' . basename($directory);
+            return in_array($package, $installed);
+        }));
         foreach ($directories as $directory) {
             $extensionsFullName = $directory . '/js/' . $extensionsFile;
             $files = glob($extensionsFullName);

ProcessMaker/Nayra/Managers/WorkflowManagerRabbitMq.php

@@ -140,7 +140,6 @@ public function completeTask(Definitions $definitions, ExecutionInstanceInterfac
         // Get complementary information
         $version = $instance->process_version_id;
         $userId = $this->getCurrentUserId();
-        $state = $this->serializeState($instance);
 
         // Dispatch complete task action
         $this->dispatchAction([
@@ -152,7 +151,7 @@ public function completeTask(Definitions $definitions, ExecutionInstanceInterfac
                 'element_id' => $token->element_id,
                 'data' => $data,
             ],
-            'state' => $state,
+            'collaboration_uuid' => $instance->collaboration_uuid,
             'session' => [
                 'user_id' => $userId,
             ],
@@ -556,7 +555,7 @@ public function throwSignalEventRequest(ProcessRequest $request, $signalRef, arr
     /**
      * Retrieves IDs of all instances collaborating with the given instance.
      *
-     * This function compiles a list of IDs from execution instances associated 
+     * This function compiles a list of IDs from execution instances associated
      * with the same process as the input instance, including the instance itself.
      *
      * @param ProcessRequest $instance The instance to find collaborators for.

ProcessMaker/Providers/SettingServiceProvider.php

@@ -7,6 +7,7 @@
 use Illuminate\Support\ServiceProvider;
 use ProcessMaker\Events\MarkArtisanCachesAsInvalid;
 use ProcessMaker\Jobs\RefreshArtisanCaches;
+use ProcessMaker\Jobs\RestartMessageConsumers;
 use ProcessMaker\Jobs\TerminateHorizon;
 use ProcessMaker\Models\Setting;
 use ProcessMaker\Repositories\ConfigRepository;
@@ -19,14 +20,14 @@ class SettingServiceProvider extends ServiceProvider
      *
      * @var bool
      */
-    protected static $shouldCacheConfiguration = false;
+    protected static bool $shouldCacheConfiguration = false;
 
     /**
      * Eloquent events which trigger configuration-related updates
      *
      * @var array
      */
-    public static $listen = [
+    public static array $listen = [
         'eloquent.saved: ' . Setting::class,
         'eloquent.deleted: ' . Setting::class,
     ];
@@ -53,10 +54,11 @@ public function register(): void
         });
 
         // When the config:cache command is run, we need to restart
-        // horizon to ensure they use the latest version of the
-        // cached configuration
+        // horizon and the message consumer(s) to ensure they use
+        // the latest version of the cached configuration
         $this->app['events']->listen(CommandFinished::class, function ($event) {
             if ($this->isCacheConfigCommand($event)) {
+                $this->restartMessageConsumers();
                 $this->restartHorizon();
             }
         });
@@ -119,6 +121,23 @@ public function isCacheConfigCommand($event): bool
         return is_int(strpos($command, 'config:cache'));
     }
 
+    /**
+     * Restart the `processmaker:consume` commands to
+     * pick up new config changes
+     *
+     * @return void
+     */
+    public function restartMessageConsumers(): void
+    {
+        // If there's already a job pending to restart the message consumers,
+        // then we don't need to queue another. The job itself checks which
+        // messaging service is configured and will restart the consumer for
+        // it appropriately
+        if (!job_pending($job = RestartMessageConsumers::class)) {
+            $job::dispatch();
+        }
+    }
+
     /**
      * Restart the horizon queue manager whenever the configuration is cached so ensure
      * the new configuration is picked up by the supervisor/queue processes.

composer.json

@@ -96,7 +96,7 @@
             "Gmail"
         ],
         "processmaker": {
-            "build": "3daac8b4",
+            "build": "822678fc",
             "custom": {
                 "package-ellucian-ethos": "1.14.1",
                 "package-plaid": "1.3.1",
@@ -148,7 +148,7 @@
                 "package-files": "1.11.2",
                 "package-googleplaces": "1.9.0",
                 "package-photo-video": "1.2.0",
-                "package-pm-blocks": "1.3.2",
+                "package-pm-blocks": "1.3.3",
                 "package-process-documenter": "1.8.0",
                 "package-process-optimization": "1.8.0",
                 "package-product-analytics": "1.5.8",

composer.lock

@@ -42,7 +42,7 @@
     'github' => [
         'base_url' => 'https://raw.githubusercontent.com/processmaker/',
         'template_repo' => env('DEFAULT_TEMPLATE_REPO', 'process-templates'),
-        'template_branch' => env('DEFAULT_TEMPLATE_BRANCH', 'main'),
+        'template_branch' => env('DEFAULT_TEMPLATE_BRANCH', '2023-fall'),
         'template_categories' => env('DEFAULT_TEMPLATE_CATEGORIES', 'accounting-and-finance,customer-success,human-resources,marketing-and-sales,operations,it'),
     ],
 

config/services.php

@@ -51,9 +51,9 @@
         "@fortawesome/free-solid-svg-icons": "^5.15.1",
         "@fortawesome/vue-fontawesome": "^0.1.9",
         "@panter/vue-i18next": "^0.15.2",
-        "@processmaker/modeler": "1.42.1",
+        "@processmaker/modeler": "1.42.2",
         "@processmaker/processmaker-bpmn-moddle": "0.14.1",
-        "@processmaker/screen-builder": "2.79.0",
+        "@processmaker/screen-builder": "2.79.1",
         "@processmaker/vue-form-elements": "0.49.4",
         "@processmaker/vue-multiselect": "2.2.0",
         "autoprefixer": "10.4.5",

package-lock.json

@@ -79,11 +79,10 @@ export default {
         .then(response => {
           this.spin = 0;
           let instance = response.data;
-          this.$cookies.set('fromTriggerStartEvent', true, '1min');
           if (this.$cookies.get("isMobile") === "true") {
             window.location = "/requests/mobile/" + instance.id;
           } else {
-            window.location = "/requests/" + instance.id;
+            window.location = `/requests/${instance.id}?fromTriggerStartEvent=`;
           }
         }).catch((err) => {
           this.disabled = false;

package.json

@@ -78,7 +78,7 @@
           v-if="isProjectsInstalled"
           v-model="formData.projects"
           :errors="errors.projects"
-          :projectId="projectId"
+          :project-id="projectId"
           :label="$t('Project')"
           :required="isProjectSelectionRequired"
           api-get="projects"
@@ -161,13 +161,13 @@ export default {
     this.resetFormData();
     this.resetErrors();
     if (this.isQuickCreate === true) {
-      this.screenTypes = filterScreenType();
+      this.screenTypes = filterScreenType() ?? this.types;
       // in any case the screenType if the only one, default to the first value
       if (Object.keys(this.screenTypes).length === 1) this.formData.type = Object.keys(this.screenTypes)[0];
     }
     if (this.callFromAiModeler === true) {
       this.screenTypes = this.types;
-    } 
+    }
   },
   methods: {
     show() {
@@ -193,10 +193,10 @@ export default {
       this.resetErrors();
     },
     close() {
-      this.$bvModal.hide('createScreen');
+      this.$bvModal.hide("createScreen");
       this.disabled = false;
-      this.$emit('reload');
-    },  
+      this.$emit("reload");
+    },
     onSubmit() {
       this.resetErrors();
       // single click

resources/js/components/requests/card.vue

@@ -2,8 +2,10 @@ import { ScreenTypes } from "../models/screens";
 
 /**
  * Filter the screen types based on the task
+ * @return {?Object};
  */
 export function filterScreenType() {
-  const screen = new URLSearchParams(window.location.search).get("screenType").split(",");
+  const screen = new URLSearchParams(window.location.search).get("screenType")?.split(",");
+  if (!screen) return;
   return Object.fromEntries(Object.entries(ScreenTypes).filter(([key]) => screen.includes(key)));
 }