Adding an endpoint to retrieve a list of group's shadow assignments.

Author: Martin Krulis

app/V1Module/presenters/GroupsPresenter.php

@@ -6,6 +6,7 @@
 use App\Exceptions\NotFoundException;
 use App\Helpers\Localizations;
 use App\Model\Entity\Assignment;
+use App\Model\Entity\ShadowAssignment;
 use App\Model\Entity\Exercise;
 use App\Model\Entity\Group;
 use App\Model\Entity\Instance;
@@ -18,9 +19,11 @@
 use App\Exceptions\ForbiddenRequestException;
 use App\Model\View\ExerciseViewFactory;
 use App\Model\View\AssignmentViewFactory;
+use App\Model\View\ShadowAssignmentViewFactory;
 use App\Model\View\GroupViewFactory;
 use App\Model\View\UserViewFactory;
 use App\Security\ACL\IAssignmentPermissions;
+use App\Security\ACL\IShadowAssignmentPermissions;
 use App\Security\ACL\IExercisePermissions;
 use App\Security\ACL\IGroupPermissions;
 use App\Security\Identity;
@@ -77,6 +80,12 @@ class GroupsPresenter extends BasePresenter {
    */
   public $assignmentAcl;
 
+  /**
+   * @var IShadowAssignmentPermissions
+   * @inject
+   */
+  public $shadowAssignmentAcl;
+
   /**
    * @var Loader
    * @inject
@@ -113,6 +122,12 @@ class GroupsPresenter extends BasePresenter {
    */
   public $assignmentViewFactory;
 
+  /**
+   * @var ShadowAssignmentViewFactory
+   * @inject
+   */
+  public $shadowAssignmentViewFactory;
+
   public function checkDefault() {
     if (!$this->groupAcl->canViewAll()) {
       throw new ForbiddenRequestException();
@@ -475,6 +490,32 @@ public function actionAssignments(string $id) {
     })->getValues());
   }
 
+  public function checkShadowAssignments(string $id) {
+    /** @var Group $group */
+    $group = $this->groups->findOrThrow($id);
+
+    if (!$this->groupAcl->canViewAssignments($group)) {
+      throw new ForbiddenRequestException();
+    }
+  }
+
+  /**
+   * Get all shadow assignments for a group
+   * @GET
+   * @param string $id Identifier of the group
+   */
+  public function actionShadowAssignments(string $id) {
+    /** @var Group $group */
+    $group = $this->groups->findOrThrow($id);
+
+    $assignments = $group->getShadowAssignments();
+    $this->sendSuccessResponse($assignments->filter(function (ShadowAssignment $assignment) {
+      return $this->shadowAssignmentAcl->canViewDetail($assignment);
+    })->map(function (ShadowAssignment $assignment) {
+      return $this->shadowAssignmentViewFactory->getAssignment($assignment);
+    })->getValues());
+  }
+
   public function checkExercises(string $id) {
     $group = $this->groups->findOrThrow($id);
 

app/V1Module/router/RouterFactory.php

@@ -212,6 +212,7 @@ private static function createGroupsRoutes(string $prefix): RouteList {
     $router[] = new DeleteRoute("$prefix/<id>/admin/<userId>", "Groups:removeAdmin");
 
     $router[] = new GetRoute("$prefix/<id>/assignments", "Groups:assignments");
+    $router[] = new GetRoute("$prefix/<id>/shadow-assignments", "Groups:shadowAssignments");
     $router[] = new GetRoute("$prefix/<id>/exercises", "Groups:exercises");
 
     return $router;

tests/Presenters/GroupsPresenter.phpt

@@ -462,20 +462,33 @@ class TestGroupsPresenter extends Tester\TestCase
     $token = PresenterTestHelper::login($this->container, $this->adminLogin);
 
     $groups = $this->presenter->groups->findAll();
-    $group = array_pop($groups);
+    foreach ($groups as $group) {
+      $payload = PresenterTestHelper::performPresenterRequest($this->presenter, 'V1:Groups', 'GET',
+        ['action' => 'assignments', 'id' => $group->getId()]
+      );
 
-    $request = new Nette\Application\Request('V1:Groups',
-      'GET',
-      ['action' => 'assignments', 'id' => $group->getId()]
-    );
-    $response = $this->presenter->run($request);
-    Assert::type(Nette\Application\Responses\JsonResponse::class, $response);
+      $correctIds = PresenterTestHelper::extractIdsMap($group->getAssignments()->toArray());
+      $payloadIds = PresenterTestHelper::extractIdsMap($payload);
 
-    $result = $response->getPayload();
-    $payload = $result['payload'];
-    Assert::equal(200, $result['code']);
+      Assert::equal($correctIds, $payloadIds);
+    }
+  }
+
+  public function testShadowAssignments()
+  {
+    $token = PresenterTestHelper::login($this->container, $this->adminLogin);
 
-    Assert::equal($group->getAssignments()->toArray(), $payload); // admin can access everything
+    $groups = $this->presenter->groups->findAll();
+    foreach ($groups as $group) {
+      $payload = PresenterTestHelper::performPresenterRequest($this->presenter, 'V1:Groups', 'GET',
+        ['action' => 'shadowAssignments', 'id' => $group->getId()]
+      );
+
+      $correctIds = PresenterTestHelper::extractIdsMap($group->getShadowAssignments()->toArray());
+      $payloadIds = PresenterTestHelper::extractIdsMap($payload);
+
+      Assert::equal($correctIds, $payloadIds);
+    }
   }
 
   public function testExercises()

tests/base/PresenterTestHelper.php

@@ -158,10 +158,10 @@ public static function jsonResponse($payload) {
   /**
    * Perform regular presenter request and make common asserts.
    * @param $presenter The presenter which should handle the request.
-   * @param $module String representing the module path (e.g., 'V1:Exercises').
+   * @param string $module String representing the module path (e.g., 'V1:Exercises').
    * @param string $method HTTP method of the request (GET, POST, ...).
    * @param array $params Parameters of the request.
-   * @param array $params Body of the request (must be POST).
+   * @param array $post Body of the request (must be POST).
    * @param int $expectedCode Expected HTTP response code (200 by default).
    * @return array|null Payload subtree of JSON request.
    * @throws Exception
@@ -177,4 +177,25 @@ public static function performPresenterRequest($presenter, string $module, strin
     return array_key_exists('payload', $result) ? $result['payload'] : null;
   }
 
+  /**
+   * Traverse a list of objects, assoc. arrays, or string IDs and convert it into an array indexed by the IDs.
+   * @param array $list List of entities to be processed.
+   * @return array Indexed by IDs, values are trues.
+   * @throws Exception
+   */
+  public static function extractIdsMap(array $list)
+  {
+    $res = [];
+    foreach ($list as $item) {
+      if (is_array($item) && !empty($item['id'])) {
+        $res[$item['id']] = true;
+      } else if (is_object($item) && !empty($item->id)) {
+        $res[$item->id] = true;
+      } else {
+        Tester\Assert::match('#^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$#', $item);
+        $res[(string)$item->id] = true;
+      }
+    }
+    return $res;
+  }
 }