FOUR-16001 Implement resources and apiClient to use v1.1 in charts

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;
-    }
-
     private function getAssignedUsers($users)
     {
         foreach ($users as $user) {
@@ -148,16 +134,4 @@ private function getAssignedGroupMembers($groups)
 
         return $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/TaskResource.php

@@ -0,0 +1,174 @@
+<?php
+
+namespace ProcessMaker\Http\Resources\V1_1;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasOne;
+use Illuminate\Database\Eloquent\Relations\Relation;
+use Illuminate\Http\Request;
+use ProcessMaker\Http\Resources\ApiResource;
+use ProcessMaker\Http\Resources\ScreenVersion as ScreenVersionResource;
+use ProcessMaker\Http\Resources\Task;
+use ProcessMaker\Models\ProcessRequestToken;
+use ProcessMaker\ProcessTranslations\ProcessTranslation;
+use ProcessMaker\Traits\TaskResourceIncludes;
+use ProcessMaker\Traits\TaskScreenResourceTrait;
+
+class TaskResource extends ApiResource
+{
+    use TaskResourceIncludes;
+
+    const INCLUDE_PREFIX = 'include';
+
+    protected static $includeMethods = [
+        'data',
+        'user',
+        'requestor',
+        'processRequest',
+        'draft',
+        'component',
+        'screen',
+        'requestData',
+        'loopContext',
+        'definition',
+        'bpmnTagName',
+        'interstitial',
+        'userRequestPermission',
+        'process',
+    ];
+
+    protected static $defaultFields = [
+        'id',
+        'element_name',
+        'element_id',
+        'due_at',
+    ];
+
+    protected static $defaultIncludes = [
+        'process',
+        'advanceStatus',
+    ];
+
+    protected static $defaultFieldsFor = [
+        'user' => ['id', 'firstname', 'lastname', 'email', 'username', 'avatar'],
+        'requestor' => ['id', 'first_name', 'last_name', 'email'],
+        'processRequest' => ['id', 'process_id', 'status'],
+        'draft' => ['id', 'task_id', 'data'],
+        'screen' => ['id', 'config'],
+        'process' => ['id', 'name'],
+    ];
+
+    /**
+     * Transform the resource into an array.
+     *
+     * @param  \Illuminate\Http\Request
+     * @return array
+     */
+    public function toArray($request)
+    {
+        $array = [
+            'id' => $this->id,
+            'element_name' => $this->element_name,
+            'element_id' => $this->element_id,
+            'due_at' => $this->due_at,
+            'advancedStatus' => $this->advanceStatus,
+        ];
+
+        return $this->processInclude($request, $array);
+    }
+
+    private static function addRelationshipKeyColumn(Builder $query, string $relationship): bool
+    {
+        $model = $query->getModel();
+        if (!method_exists($model, $relationship)) {
+            return false;
+        }
+        $relationshipObject = $model->$relationship();
+        if (!($relationshipObject instanceof Relation)) {
+            return false;
+        }
+
+        if ($relationshipObject instanceof BelongsTo) {
+            $relationshipKey = $relationshipObject->getForeignKeyName();
+            $query->addSelect($relationshipKey);
+        }
+
+        return true;
+    }
+
+    private static function addRelationship(ProcessRequestToken $model, string $relationship): bool
+    {
+        if (!method_exists($model, $relationship)) {
+            return false;
+        }
+        $relationshipObject = $model->$relationship();
+        if (!($relationshipObject instanceof Relation)) {
+            return false;
+        }
+
+        $relationshipColumns = self::$defaultFieldsFor[$relationship] ?? ['id'];
+        $model->$relationship = $relationshipObject->select($relationshipColumns)->get();
+
+        return true;
+    }
+
+    public static function preprocessInclude(Request $request, Builder $query): self
+    {
+        foreach (self::$defaultFields as $field) {
+            $query->addSelect($field);
+        }
+
+        $include = $request->query('include', []);
+        if ($include) {
+            $include = explode(',', $include);
+        }
+        $include = array_merge($include, self::$defaultIncludes);
+
+        if (in_array('data', $include)) {
+            $query->addSelect('process_request_id');
+        }
+
+        foreach (self::$includeMethods as $key) {
+            if (!in_array($key, $include)) {
+                continue;
+            }
+
+            self::addRelationshipKeyColumn($query, $key);
+        }
+
+        $model = $query->first();
+        foreach (self::$includeMethods as $key) {
+            if (!in_array($key, $include)) {
+                continue;
+            }
+
+            self::addRelationship($model, $key);
+        }
+
+        return new static($model);
+    }
+
+    private function processInclude(Request $request, array $array)
+    {
+        $include = $request->query('include', []);
+        if ($include) {
+            $include = explode(',', $include);
+        }
+
+        foreach (self::$includeMethods as $key) {
+            if (!in_array($key, $include)) {
+                continue;
+            }
+
+            $method = self::INCLUDE_PREFIX . ucfirst($key);
+            if (method_exists($this, $method)) {
+                $attributes = $this->$method();
+                $array = array_merge($array, $attributes);
+            } else {
+                $array[$key] = $this->$key;
+            }
+        }
+        return $array;
+    }
+}

ProcessMaker/Traits/TaskResourceIncludes.php

@@ -6,14 +6,29 @@
 use ProcessMaker\Http\Resources\ScreenVersion as ScreenVersionResource;
 use ProcessMaker\Http\Resources\Users;
 use ProcessMaker\Managers\DataManager;
+use ProcessMaker\Models\ProcessRequest;
 use ProcessMaker\Models\TaskDraft;
+use ProcessMaker\Models\User;
 use ProcessMaker\ProcessTranslations\ProcessTranslation;
 use StdClass;
 
 trait TaskResourceIncludes
 {
     use TaskScreenResourceTrait;
 
+
+    private function getData()
+    {
+        if ($this->loadedData) {
+            return $this->loadedData;
+        }
+        $dataManager = new DataManager();
+        $task = $this->resource->loadTokenInstance();
+        $this->loadedData = $dataManager->getData($task);
+
+        return $this->loadedData;
+    }
+
     private function includeData()
     {
         return ['data' => $this->getData()];
@@ -131,7 +146,7 @@ private function includeInterstitial()
 
         // Remove inspector metadata
         $interstitial['interstitial_screen']['config'] = $this->removeInspectorMetadata(
-            $interstitial['interstitial_screen']['config']
+            $interstitial['interstitial_screen']['config'] ?: []
         );
 
         return [
@@ -146,4 +161,18 @@ private function includeUserRequestPermission()
 
         return ['user_request_permission' => $userRequestPermission];
     }
+
+    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;
+    }
 }

resources/js/bootstrap.js

@@ -232,7 +232,30 @@ if (token) {
   console.error("CSRF token not found: https://laravel.com/docs/csrf#csrf-x-csrf-token");
 }
 
+// Setup api versions
+const apiVersionConfig = [
+  { version: "1.0", baseURL: "/api/1.0/" },
+  { version: "1.1", baseURL: "/api/1.1/" },
+];
+
 window.ProcessMaker.apiClient.defaults.baseURL = "/api/1.0/";
+window.ProcessMaker.apiClient.interceptors.request.use((config) => {
+  if (typeof config.url !== "string" || !config.url) {
+    throw new Error("Invalid URL in the request configuration");
+  }
+
+  apiVersionConfig.forEach(({ version, baseURL }) => {
+    const versionPrefix = `/api/${version}/`;
+    if (config.url.startsWith(versionPrefix)) {
+      // eslint-disable-next-line no-param-reassign
+      config.baseURL = baseURL;
+      // eslint-disable-next-line no-param-reassign
+      config.url = config.url.replace(versionPrefix, "");
+    }
+  });
+
+  return config;
+});
 
 // Set the default API timeout
 let apiTimeout = 5000;