Performance Improvements

.github/workflows/deploy-pm4.yml

@@ -27,7 +27,7 @@ env:
   GITHUB_TOKEN: ${{ secrets.GIT_TOKEN }}
   BUILD_BASE: ${{ (contains(github.event.pull_request.body, 'ci:build-base') || github.event_name == 'schedule') && '1' || '0' }}
   BASE_IMAGE: ${{ secrets.REGISTRY_HOST }}/processmaker/processmaker:base
-  K8S_BRANCH: ${{ contains(github.event.pull_request.body, 'ci:next') && 'next' || 'develop' }}  
+  K8S_BRANCH: ${{ contains(github.event.pull_request.body, 'ci:next') && 'next' || 'develop' }}
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
@@ -145,6 +145,76 @@ jobs:
         run: |
           echo "Instance URL: '${INSTANCE_URL}'"
           bash argocd/gh_comment.sh "$CI_PROJECT" "$pull_req_id"
+  runAPITest:
+    name: Run API Tests
+    needs: [deployEKS]
+    if: contains(github.event.pull_request.body, 'ci:api-test')
+    runs-on: self-hosted
+    steps:
+      - name: Clone private repository
+        run: |
+          git clone --depth 1 -b eng "https://$GITHUB_TOKEN@github.com/ProcessMaker/argocd.git" argocd
+      - name: Install pm4-tools
+        run: |
+          git clone --depth 1 -b "$K8S_BRANCH" "https://$GITHUB_TOKEN@github.com/ProcessMaker/pm4-k8s-distribution.git" pm4-k8s-distribution     
+          echo "versionHelm=$(grep "version:" "pm4-k8s-distribution/charts/enterprise/Chart.yaml" | awk '{print $2}' | sed 's/\"//g')" >> $GITHUB_ENV
+          cd pm4-k8s-distribution/images/pm4-tools
+          composer install --no-interaction
+          cd ..
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID1 }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY1 }}
+          aws-region: ${{ secrets.AWS_REGION }}
+      - name: Set up kubectl
+        run: |
+          curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
+          chmod +x kubectl
+          sudo mv kubectl /usr/local/bin/
+      - name: Authenticate with Amazon EKS
+        run: aws eks update-kubeconfig --region us-east-1 --name pm4-eng
+      - name: Run the API tests
+        run: |
+          cd argocd 
+          deploy=$(echo -n ${{env.IMAGE_TAG}} | md5sum | head -c 10)
+          namespace="ci-$deploy-ns-pm4"
+          pr_body=$(jq -r .pull_request.body < "$GITHUB_EVENT_PATH" | base64)
+          kubectl get pods --namespace=$namespace
+          pod_names=$(kubectl get pods --namespace=$namespace --field-selector=status.phase=Running -o jsonpath="{.items[*].metadata.name}" | tr ' ' '\n' | grep -E '(-processmaker-scheduler-)')
+          for pod in $pod_names; do
+            code='
+              has_processmaker=$(ls /opt | grep processmaker)
+              has_sudo=$(ls /usr/bin | grep sudo)
+              has_php=$(ls /usr/bin | grep php)
+              if [ ! -z "$has_processmaker" ] && [ ! -z "$has_sudo" ] && [ ! -z "$has_php" ]; then
+                echo $pr_body | base64 -d > /tmp/pr_body
+                cd /opt/processmaker
+                sudo -u nginx php artisan pm4-api-testing:run --body="$pr_body"
+              else
+                exit 1
+              fi'
+            kubectl exec -n $namespace $pod -- /bin/sh -c "pr_body='${pr_body}';${code}" | tee /tmp/comment.md && break || true
+          done
+          # Send the content of /tmp/comment.md as a PR comment
+          MESSAGE=$(cat /tmp/comment.md)
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
+          GITHUB_REPOSITORY=${{ github.repository }}
+          PR_NUMBER=$(jq -r .number < "$GITHUB_EVENT_PATH")
+
+          if [ -z "$PR_NUMBER" ]; then
+              echo "The PR number is not available. Make sure this script is executed in a context of Pull Request."
+              exit 1
+          fi
+
+          URL="https://api.github.com/repos/${GITHUB_REPOSITORY}/issues/${PR_NUMBER}/comments"
+          json_payload=$(jq -n --arg message "$MESSAGE" '{"body": $message}')
+
+          curl -s \
+               -H "Authorization: token ${GITHUB_TOKEN}" \
+               -H "Accept: application/vnd.github.v3+json" \
+               -d "$json_payload" \
+               "${URL}"
   deleteEKS:
     name: Delete Instance
     if: github.event.action == 'closed'

ProcessMaker/Console/Commands/BuildScriptExecutors.php

@@ -8,6 +8,7 @@
 use ProcessMaker\Exception\InvalidDockerImageException;
 use ProcessMaker\Facades\Docker;
 use ProcessMaker\Models\ScriptExecutor;
+use ProcessMaker\ScriptRunners\Base;
 
 class BuildScriptExecutors extends Command
 {
@@ -157,6 +158,16 @@ public function buildExecutor()
         $command = Docker::command() .
             " build --build-arg SDK_DIR=./sdk -t {$image} -f {$packagePath}/Dockerfile.custom {$packagePath}";
 
+        $this->execCommand($command);
+
+        $isNayra = $scriptExecutor->language === Base::NAYRA_LANG;
+        if ($isNayra) {
+            Base::bringUpNayraExecutor($this, $image);
+        }
+    }
+
+    public function execCommand(string $command)
+    {
         if ($this->userId) {
             $this->runProc(
                 $command,
@@ -185,7 +196,7 @@ public function info($text, $verbosity = null)
         parent::info($text, $verbosity);
     }
 
-    private function sendEvent($output, $status)
+    public function sendEvent($output, $status)
     {
         if ($this->userId) {
             event(new BuildScriptExecutor($output, $this->userId, $status));

ProcessMaker/Console/Commands/DockerExecutorPhpNayra.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace ProcessMaker\Console\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Artisan;
+use ProcessMaker\Models\ScriptExecutor;
+use ProcessMaker\ScriptRunners\Base;
+
+class DockerExecutorPhpNayra extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'docker-executor-php-nayra:install';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Install and configure Docker Executor PHP Nayra';
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle()
+    {
+        $exists = ScriptExecutor::where('language', Base::NAYRA_LANG)->exists();
+        if (!$exists) {
+            ScriptExecutor::install([
+                'language' => Base::NAYRA_LANG,
+                'title' => 'Nayra (µService)',
+                'description' => 'Nayra (µService) Executor',
+                'config' => '',
+            ]);
+        }
+
+        // Build the instance image. This is the same as if you were to build it from the admin UI
+        Artisan::call('processmaker:build-script-executor ' . Base::NAYRA_LANG . ' --rebuild');
+    }
+}

ProcessMaker/Events/ActivityAssigned.php

@@ -60,4 +60,15 @@ public function getProcessRequestToken()
     {
         return $this->processRequestToken;
     }
+
+    /**
+     * Get data
+     */
+    public function getData(): array
+    {
+        return [
+            'payloadUrl' => $this->payloadUrl,
+            'element_type' => $this->processRequestToken->element_type,
+        ];
+    }
 }

ProcessMaker/Events/ProcessUpdated.php

@@ -8,6 +8,7 @@
 use Illuminate\Foundation\Events\Dispatchable;
 use Illuminate\Queue\SerializesModels;
 use ProcessMaker\Models\ProcessRequest;
+use ProcessMaker\Nayra\Contracts\Bpmn\TokenInterface;
 
 class ProcessUpdated implements ShouldBroadcastNow
 {
@@ -17,19 +18,28 @@ class ProcessUpdated implements ShouldBroadcastNow
 
     public $event;
 
+    public $tokenId;
+
+    public $elementType;
+
     private $processRequest;
 
     /**
      * Create a new event instance.
      *
      * @return void
      */
-    public function __construct(ProcessRequest $processRequest, $event)
+    public function __construct(ProcessRequest $processRequest, $event, TokenInterface $token = null)
     {
         $this->payloadUrl = route('api.requests.show', ['request' => $processRequest->getKey()]);
         $this->event = $event;
 
         $this->processRequest = $processRequest;
+
+        if ($token) {
+            $this->tokenId = $token->getId();
+            $this->elementType = $token->element_type;
+        }
     }
 
     /**

ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php

@@ -0,0 +1,102 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ProcessMaker\Http\Controllers\Api\V1_1;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\Request;
+use ProcessMaker\Http\Controllers\Controller;
+use ProcessMaker\Http\Resources\V1_1\TaskInterstitialResource;
+use ProcessMaker\Http\Resources\V1_1\TaskResource;
+use ProcessMaker\Http\Resources\V1_1\TaskScreen;
+use ProcessMaker\Models\ProcessRequestToken;
+
+class TaskController extends Controller
+{
+    protected $defaultFields = [
+        'id',
+        'element_id',
+        'element_name',
+        'element_type',
+        'status',
+        'due_at',
+    ];
+
+    /**
+     * Display a listing of the resource.
+     */
+    public function index()
+    {
+        $query = ProcessRequestToken::select($this->defaultFields)
+            ->where('element_type', 'task');
+
+        $this->processFilters(request(), $query);
+        $pagination = $query->paginate();
+        $perPage = $pagination->perPage();
+        $page = $pagination->currentPage();
+        $lastPage = $pagination->lastPage();
+        return [
+            'data' => $pagination->items(),
+            'meta' => [
+                'total' => $pagination->total(),
+                'perPage' => $pagination->perPage(),
+                'currentPage' => $pagination->currentPage(),
+                'lastPage' => $pagination->lastPage(),
+                'count' => $pagination->count(),
+                'from' => $perPage * ($page - 1) + 1,
+                'last_page' => $lastPage,
+                'path' => '/',
+                'per_page' => $perPage,
+                'to' => $perPage * ($page - 1) + $perPage,
+                'total_pages' => ceil($pagination->count() / $perPage),
+            ],
+        ];
+    }
+
+    private function processFilters(Request $request, Builder $query)
+    {
+        if ($request->has('process_request_id')) {
+            $query->where('process_request_id', $request->input('process_request_id'));
+        }
+        if ($request->has('status')) {
+            $query->where('status', $request->input('status'));
+        }
+    }
+
+    public function show(ProcessRequestToken $task)
+    {
+        $resource = TaskResource::preprocessInclude(request(), ProcessRequestToken::where('id', $task->id));
+        return $resource->toArray(request());
+    }
+
+    public function showScreen($taskId)
+    {
+        $task = ProcessRequestToken::select(
+                array_merge($this->defaultFields, ['process_request_id', 'process_id'])
+            )->findOrFail($taskId);
+        $response = new TaskScreen($task);
+        $response = response($response->toArray(request())['screen'], 200);
+        $now = time();
+        // screen cache time
+        $cacheTime = config('screen_task_cache_time', 86400);
+        $response->headers->set('Cache-Control', 'max-age=' . $cacheTime . ', must-revalidate, public');
+        $response->headers->set('Expires', gmdate('D, d M Y H:i:s', $now + $cacheTime) . ' GMT');
+        return $response;
+    }
+
+    public function showInterstitial($taskId)
+    {
+        $task = ProcessRequestToken::select(
+            array_merge($this->defaultFields, ['process_request_id', 'process_id'])
+        )->findOrFail($taskId);
+        $response = new TaskInterstitialResource($task);
+        $response = response($response->toArray(request())['screen'], 200);
+        $now = time();
+        // screen cache time
+        $cacheTime = config('screen_task_cache_time', 86400);
+        $response->headers->set('Cache-Control', 'max-age=' . $cacheTime . ', must-revalidate, public');
+        $response->headers->set('Expires', gmdate('D, d M Y H:i:s', $now + $cacheTime) . ' GMT');
+        return $response;
+    }
+}

ProcessMaker/Http/Resources/Task.php

@@ -113,20 +113,6 @@ private function addAssignableUsers(&$array, $include)
         }
     }
 
-    private function loadUserRequestPermission(ProcessRequest $request, User $user, array $permissions)
-    {
-        $permissions[] = [
-            'process_request_id' => $request->id,
-            'allowed' => $user ? $user->can('view', $request) : false,
-        ];
-
-        if ($request->parentRequest && $user) {
-            $permissions = $this->loadUserRequestPermission($request->parentRequest, $user, $permissions);
-        }
-
-        return $permissions;
-    }
-
     /**
      * Add the active users to the list of assigned users
      *
@@ -161,16 +147,4 @@ private function addActiveAssignedGroupMembers(array $groups, array $assignedUse
     {
         return (new Process)->getConsolidatedUsers($groups, $assignedUsers);
     }
-
-    private function getData()
-    {
-        if ($this->loadedData) {
-            return $this->loadedData;
-        }
-        $dataManager = new DataManager();
-        $task = $this->resource->loadTokenInstance();
-        $this->loadedData = $dataManager->getData($task);
-
-        return $this->loadedData;
-    }
 }

ProcessMaker/Http/Resources/V1_1/TaskInterstitialResource.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace ProcessMaker\Http\Resources\V1_1;
+
+use Illuminate\Http\Request;
+
+class TaskInterstitialResource extends TaskResource
+{
+    /**
+     * Transform the resource into an array.
+     *
+     * @param  Request
+     * @return array
+     */
+    public function toArray($request)
+    {
+        return $this->includeInterstitial();
+    }
+}