Implemented sparse fieldsets support on the backend #1152

src/inc/apiv2/common/AbstractBaseAPI.class.php

@@ -160,7 +160,7 @@ protected function getUpdateHandlers($id, $current_user): array {
    * Implementations should use $includedData to collect related resources that should be included
    * in the API response, such as related entities or additional data.
    */
-  public static function aggregateData(object $object, array &$includedData=[]): array
+  public static function aggregateData(object $object, array &$includedData = [], array $aggregateFieldsets = null): array
   {
     return [];
   }
@@ -561,7 +561,7 @@ protected function obj2Array(object $obj): array {
    * @throws NotFoundExceptionInterface
    * @throws ContainerExceptionInterface
    */
-  protected function obj2Resource(object $obj, array &$expandResult = []): array {
+  protected function obj2Resource(object $obj, array &$expandResult = [], array $sparseFieldsets = null, array $aggregateFieldsets = null): array {
     // Convert values to JSON supported types
     $features = $obj->getFeatures();
     $kv = $obj->getKeyValueDict();
@@ -571,6 +571,11 @@ protected function obj2Resource(object $obj, array &$expandResult = []): array {
 
     $attributes = [];
     $relationships = [];
+
+    $sparseFieldsetsForObj = null;
+    if (is_array($sparseFieldsets) && array_key_exists($this->getObjectTypeName($obj), $sparseFieldsets)) {
+      $sparseFieldsetsForObj = explode(",", $sparseFieldsets[$this->getObjectTypeName($obj)]);
+    }
 
     /* Collect attributes */
     foreach ($features as $name => $feature) {
@@ -579,6 +584,12 @@ protected function obj2Resource(object $obj, array &$expandResult = []): array {
       if ($feature['private'] === true) {
         continue;
       }
+
+      // If sparse fieldsets (https://jsonapi.org/format/#fetching-sparse-fieldsets) is used, return only the requested data
+      if (is_array($sparseFieldsetsForObj) && !in_array($feature['alias'], $sparseFieldsetsForObj)) {
+        continue;
+      }
+
       // Hide the primaryKey from the attributes since this is used as indentifier (id) in response
       if ($feature['pk'] === true) {
         continue;
@@ -590,9 +601,8 @@ protected function obj2Resource(object $obj, array &$expandResult = []): array {
 
       $attributes[$feature['alias']] = $apiClass::db2json($feature, $kv[$name]);
     }
-
-    //TODO: only aggregate data when it has been included
-    $aggregatedData = $apiClass::aggregateData($obj, $expandResult);
+
+    $aggregatedData = $apiClass::aggregateData($obj, $expandResult, $aggregateFieldsets);
     $attributes = array_merge($attributes, $aggregatedData);
 
     /* Build JSON::API relationship resource */
@@ -1187,7 +1197,9 @@ protected function processExpands(
     array $expands,
     object $object,
     array $expandResult,
-    array $includedResources
+    array $includedResources,
+    array $sparseFieldsets = null,
+    array $aggregateFieldsets = null
 ): array {
 
     // Add missing expands to expands in case they have been added in aggregateData()
@@ -1204,14 +1216,16 @@ protected function processExpands(
 
       if (is_array($expandResultObject)) {
         foreach ($expandResultObject as $expandObject) {
-          $includedResources = self::addToRelatedResources($includedResources, $apiClass->obj2Resource($expandObject));
+          $noFurtherExpands = [];
+          $includedResources = self::addToRelatedResources($includedResources, $apiClass->obj2Resource($expandObject, $noFurtherExpands, $sparseFieldsets, $aggregateFieldsets));
         }
       } else {
           if ($expandResultObject === null) {
             // to-only relation which is nullable
             continue;
           }
-        $includedResources = self::addToRelatedResources($includedResources, $apiClass->obj2Resource($expandResultObject));
+        $noFurtherExpands = [];
+        $includedResources = self::addToRelatedResources($includedResources, $apiClass->obj2Resource($expandResultObject, $noFurtherExpands, $sparseFieldsets, $aggregateFieldsets));
       }
     }
 
@@ -1493,8 +1507,8 @@ protected static function getOneResource(object $apiClass, object $object, Reque
     // Convert objects to data resources 
     foreach ($objects as $object) {
       // Create object
-      $newObject = $apiClass->obj2Resource($object, $expandResult);
-      $includedResources = $apiClass->processExpands($apiClass, $expands, $object, $expandResult, $includedResources);
+      $newObject = $apiClass->obj2Resource($object, $expandResult, $request->getQueryParams()['fields'] ?? null, $request->getQueryParams()['aggregate'] ?? null);
+      $includedResources = $apiClass->processExpands($apiClass, $expands, $object, $expandResult, $includedResources, $request->getQueryParams()['fields'] ?? null, $request->getQueryParams()['aggregate'] ?? null);
 
       // Add to result output
       $dataResources[] = $newObject;

src/inc/apiv2/common/AbstractModelAPI.class.php

@@ -731,12 +731,13 @@ public static function getManyResources(object $apiClass, Request $request, Resp
     // Convert objects to data resources 
     foreach ($objects as $object) {
       // Create object  
-      $newObject = $apiClass->obj2Resource($object, $expandResult);
-      $includedResources = $apiClass->processExpands($apiClass, $expands, $object, $expandResult, $includedResources);
+      $newObject = $apiClass->obj2Resource($object, $expandResult, $request->getQueryParams()['fields'] ?? null, $request->getQueryParams()['aggregate'] ?? null);
+      $includedResources = $apiClass->processExpands($apiClass, $expands, $object, $expandResult, $includedResources, $request->getQueryParams()['fields'] ?? null, $request->getQueryParams()['aggregate'] ?? null);
 
       // Add to result output
       $dataResources[] = $newObject;
     }
+
     $baseUrl = Util::buildServerUrl();
     //build last link
     $lastParams = $request->getQueryParams();

src/inc/apiv2/helper/getTaskProgressImage.routes.php

@@ -79,8 +79,8 @@ public function getParamsSwagger(): array {
    */
   public function handleGet(Request $request, Response $response): Response {
     $this->preCommon($request);
-    $task_id = $request->getQueryParams()['task'];
-    $supertask_id = $request->getQueryParams()['supertask'];
+    $task_id = $request->getQueryParams()['task'] ?? null;
+    $supertask_id = $request->getQueryParams()['supertask'] ?? null;
 
     //check if task exists and get information
     if ($task_id) {

src/inc/apiv2/model/agents.routes.php

@@ -46,7 +46,7 @@ protected function getUpdateHandlers($id, $current_user): array {
    * @param array &$includedData
    * @return array not used here 
    */
-  static function aggregateData(object $object, array &$included_data = []): array {
+  static function aggregateData(object $object, array &$included_data = [], array $aggregateFieldsets = null): array {
     $agentId = $object->getId();
     $qFs = [];
     $qFs[] = new QueryFilter(Chunk::AGENT_ID, $agentId, "=");

src/inc/apiv2/model/tasks.routes.php

@@ -162,38 +162,57 @@ protected function createObject(array $data): int {
   }
 
   //TODO make aggregate data queryable and not included by default
-  static function aggregateData(object $object, array &$included_data = []): array {
-    $qF = new QueryFilter(Assignment::TASK_ID, $object->getId(), "=");
-    $activeAgents = Factory::getAssignmentFactory()->countFilter([Factory::FILTER => $qF]);
-    $aggregatedData["activeAgents"] = $activeAgents;
-
-    $keyspace = $object->getKeyspace();
-    $keyspaceProgress = $object->getKeyspaceProgress();
+  static function aggregateData(object $object, array &$included_data = [], array $aggregateFieldsets = null): array {
+    $aggregatedData = [];
 
-    $qF1 = new QueryFilter(Chunk::TASK_ID, $object->getId(), "=");
-    $agg1 = new Aggregation(Chunk::CHECKPOINT, Aggregation::SUM);
-    $agg2 = new Aggregation(Chunk::SKIP, Aggregation::SUM);
-    $agg3 = new Aggregation(Chunk::DISPATCH_TIME, Aggregation::MAX);
-    $agg4 = new Aggregation(Chunk::SOLVE_TIME, Aggregation::MAX);
-    $results = Factory::getChunkFactory()->multicolAggregationFilter([Factory::FILTER => $qF1], [$agg1, $agg2, $agg3, $agg4]);
+    if (is_null($aggregateFieldsets) || (is_array($aggregateFieldsets) && array_key_exists('task', $aggregateFieldsets))) {
+      if (!is_null($aggregateFieldsets)) {
+        $aggregateFieldsets['task'] = explode(",", $aggregateFieldsets['task']);
+      }
+
+      $activeAgents = [];
+      if (is_null($aggregateFieldsets) || in_array("activeAgents", $aggregateFieldsets['task'])) {
+        $qF = new QueryFilter(Assignment::TASK_ID, $object->getId(), "=");
+        $activeAgents = Factory::getAssignmentFactory()->countFilter([Factory::FILTER => $qF]);
+        $aggregatedData["activeAgents"] = $activeAgents;
+      }
 
-    $progress = $results[$agg1->getName()] - $results[$agg2->getName()];
-    $maxTime = max($results[$agg3->getName()], $results[$agg4->getName()]);
+      $keyspace = $object->getKeyspace();
+      $keyspaceProgress = $object->getKeyspaceProgress();
+
+      if (is_null($aggregateFieldsets) || in_array("dispatched", $aggregateFieldsets['task'])) {
+        $aggregatedData["dispatched"] = Util::showperc($keyspaceProgress, $keyspace);
+      }
 
-    //status 1 is running, 2 is idle and 3 is completed
-    $status = 2;
-    if (time() - $maxTime < SConfig::getInstance()->getVal(DConfig::CHUNK_TIMEOUT) && ($progress < $object->getKeyspace() || $object->getUsePreprocessor() && $object->getKeyspace() == DPrince::PRINCE_KEYSPACE)) { 
-      $status = 1;
-    }
-    $aggregatedData["dispatched"] = Util::showperc($keyspaceProgress, $keyspace);
-    $aggregatedData["searched"] = Util::showperc(TaskUtils::getTaskProgress($object), $keyspace);
-
-    if ($keyspaceProgress >= $keyspace && $keyspaceProgress > 0) {
-      $status = 3;
+      if (is_null($aggregateFieldsets) || in_array("searched", $aggregateFieldsets['task'])) {
+        $aggregatedData["searched"] = Util::showperc(TaskUtils::getTaskProgress($object), $keyspace);
+      }
+
+      if (is_null($aggregateFieldsets) || in_array("status", $aggregateFieldsets['task'])) {
+        $qF1 = new QueryFilter(Chunk::TASK_ID, $object->getId(), "=");
+        $agg1 = new Aggregation(Chunk::CHECKPOINT, Aggregation::SUM);
+        $agg2 = new Aggregation(Chunk::SKIP, Aggregation::SUM);
+        $agg3 = new Aggregation(Chunk::DISPATCH_TIME, Aggregation::MAX);
+        $agg4 = new Aggregation(Chunk::SOLVE_TIME, Aggregation::MAX);
+        $results = Factory::getChunkFactory()->multicolAggregationFilter([Factory::FILTER => $qF1], [$agg1, $agg2, $agg3, $agg4]);
+
+        $progress = $results[$agg1->getName()] - $results[$agg2->getName()];
+        $maxTime = max($results[$agg3->getName()], $results[$agg4->getName()]);
+
+        //status 1 is running, 2 is idle and 3 is completed
+        $status = 2;
+        if (time() - $maxTime < SConfig::getInstance()->getVal(DConfig::CHUNK_TIMEOUT) && ($progress < $keyspace || $object->getUsePreprocessor() && $keyspace == DPrince::PRINCE_KEYSPACE)) { 
+          $status = 1;
+        }
+
+        if ($keyspaceProgress >= $keyspace && $keyspaceProgress > 0) {
+          $status = 3;
+        }
+
+        $aggregatedData["status"] = $status;
+      }
     }
 
-    $aggregatedData["status"] = $status;
-
     return $aggregatedData;
   }