Add UpdatePinnedTestMeasurementOrder mutation

Author: williamjallen

app/GraphQL/Mutations/DeletePinnedTestMeasurement.php

@@ -20,6 +20,6 @@ protected function mutate(array $args): void
 
         Gate::authorize('deletePinnedTestMeasurement', $measurement?->project);
 
-        $measurement->delete();
+        $measurement?->delete();
     }
 }

app/GraphQL/Mutations/UpdatePinnedTestMeasurementOrder.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\GraphQL\Mutations;
+
+use App\Models\PinnedTestMeasurement;
+use App\Models\Project;
+use Exception;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Gate;
+
+final class UpdatePinnedTestMeasurementOrder extends AbstractMutation
+{
+    /** @var ?Collection<PinnedTestMeasurement> */
+    public ?Collection $pinnedTestMeasurements = null;
+
+    /**
+     * @param array{
+     *     projectId: int,
+     *     pinnedTestMeasurementIds: array<int>,
+     * } $args
+     */
+    protected function mutate(array $args): void
+    {
+        $project = Project::find((int) $args['projectId']);
+        Gate::authorize('updatePinnedTestMeasurementOrder', $project);
+
+        $projectMeasurementIds = $project?->pinnedTestMeasurements()->pluck('id');
+        $newOrder = collect($args['pinnedTestMeasurementIds']);
+
+        if ($projectMeasurementIds->diff($newOrder)->isNotEmpty()) {
+            throw new Exception('IDs for all PinnedTestMeasurements must be provided.');
+        }
+
+        if ($newOrder->count() !== $projectMeasurementIds->count()) {
+            throw new Exception('Provided set cannot contain duplicate IDs.');
+        }
+
+        if ($newOrder->isEmpty()) {
+            throw new Exception("Can't order an empty set.");
+        }
+
+        // We start at the previous maximum ID + 1 to guarantee that there are never any conflicts.
+        // Only the relative order matters, so we don't care if the minimum position is now 1.
+        $position = (int) $project?->pinnedTestMeasurements()->max('position') + 1;
+        foreach ($newOrder as $id) {
+            /** @var PinnedTestMeasurement $measurement */
+            $measurement = $project?->pinnedTestMeasurements()->findOrFail((int) $id);
+
+            $measurement->position = $position;
+            $measurement->save();
+            $position++;
+        }
+
+        $this->pinnedTestMeasurements = $project?->pinnedTestMeasurements()->orderBy('position')->get();
+    }
+}

app/Policies/ProjectPolicy.php

@@ -151,6 +151,11 @@ public function deletePinnedTestMeasurement(User $currentUser, Project $project)
         return $this->update($currentUser, $project);
     }
 
+    public function updatePinnedTestMeasurementOrder(User $currentUser, Project $project): bool
+    {
+        return $this->update($currentUser, $project);
+    }
+
     private function isLdapControlledMembership(Project $project): bool
     {
         // If a LDAP filter has been specified and LDAP is enabled, CDash controls the entire members list.

app/cdash/tests/CMakeLists.txt

@@ -280,6 +280,8 @@ add_feature_test_in_transaction(/Feature/GraphQL/Mutations/CreatePinnedTestMeasu
 
 add_feature_test_in_transaction(/Feature/GraphQL/Mutations/DeletePinnedTestMeasurementTest)
 
+add_feature_test_in_transaction(/Feature/GraphQL/Mutations/UpdatePinnedTestMeasurementOrderTest)
+
 add_feature_test_in_transaction(/Feature/GlobalInvitationAcceptanceTest)
 
 add_feature_test_in_transaction(/Feature/GraphQL/GlobalInvitationTypeTest)

graphql/schema.graphql

@@ -117,6 +117,12 @@ type Mutation {
 
   "Remove a pinned test measurement.  Does not re-number positions."
   deletePinnedTestMeasurement(input: DeletePinnedTestMeasurementInput! @spread): DeletePinnedTestMeasurementMutationPayload! @field(resolver: "DeletePinnedTestMeasurement")
+
+  """
+  Reorder the pinned measurements.  Note: positions will be sequential, starting at 1 + the
+  previous maximum position.  Only the relative order is guaranteed.
+  """
+  updatePinnedTestMeasurementOrder(input: UpdatePinnedTestMeasurementOrderInput! @spread): UpdatePinnedTestMeasurementOrderMutationPayload! @field(resolver: "UpdatePinnedTestMeasurementOrder")
 }
 
 
@@ -542,6 +548,23 @@ type DeletePinnedTestMeasurementMutationPayload implements MutationPayloadInterf
 }
 
 
+input UpdatePinnedTestMeasurementOrderInput {
+  projectId: ID!
+
+  "A list of PinnedTestMeasurement IDs.  Relative position will be set based on position in the list."
+  pinnedTestMeasurementIds: [ID!]!
+}
+
+
+type UpdatePinnedTestMeasurementOrderMutationPayload implements MutationPayloadInterface {
+  "Optional error message."
+  message: String
+
+  "The new list of pinned measurements."
+  pinnedTestMeasurements: [PinnedTestMeasurement!]
+}
+
+
 "Configure."
 type Configure {
   "Unique primary key."
@@ -1187,5 +1210,6 @@ type PinnedTestMeasurement {
 
   name: String!
 
+  "Note: Only the relative positions of PinnedTestMeasurements are guaranteed."
   position: Int!
 }

phpstan-baseline.neon

@@ -282,6 +282,12 @@ parameters:
 			count: 1
 			path: app/GraphQL/Mutations/CreatePinnedTestMeasurement.php
 
+		-
+			rawMessage: 'Parameter #1 $args (array{id: int}) of method App\GraphQL\Mutations\DeletePinnedTestMeasurement::mutate() should be contravariant with parameter $args (array<string, mixed>) of method App\GraphQL\Mutations\AbstractMutation::mutate()'
+			identifier: method.childParameterType
+			count: 1
+			path: app/GraphQL/Mutations/DeletePinnedTestMeasurement.php
+
 		-
 			rawMessage: 'Parameter #1 $args (array{email: string, projectId: int, role: App\Enums\ProjectRole}) of method App\GraphQL\Mutations\InviteToProject::mutate() should be contravariant with parameter $args (array<string, mixed>) of method App\GraphQL\Mutations\AbstractMutation::mutate()'
 			identifier: method.childParameterType
@@ -324,6 +330,36 @@ parameters:
 			count: 1
 			path: app/GraphQL/Mutations/UnclaimSite.php
 
+		-
+			rawMessage: 'Cannot call method count() on Illuminate\Support\Collection<(int|string), mixed>|null.'
+			identifier: method.nonObject
+			count: 1
+			path: app/GraphQL/Mutations/UpdatePinnedTestMeasurementOrder.php
+
+		-
+			rawMessage: 'Cannot call method diff() on Illuminate\Support\Collection<(int|string), mixed>|null.'
+			identifier: method.nonObject
+			count: 1
+			path: app/GraphQL/Mutations/UpdatePinnedTestMeasurementOrder.php
+
+		-
+			rawMessage: Cannot cast mixed to int.
+			identifier: cast.int
+			count: 1
+			path: app/GraphQL/Mutations/UpdatePinnedTestMeasurementOrder.php
+
+		-
+			rawMessage: 'Parameter #1 $args (array{projectId: int, pinnedTestMeasurementIds: array<int>}) of method App\GraphQL\Mutations\UpdatePinnedTestMeasurementOrder::mutate() should be contravariant with parameter $args (array<string, mixed>) of method App\GraphQL\Mutations\AbstractMutation::mutate()'
+			identifier: method.childParameterType
+			count: 1
+			path: app/GraphQL/Mutations/UpdatePinnedTestMeasurementOrder.php
+
+		-
+			rawMessage: 'Property App\GraphQL\Mutations\UpdatePinnedTestMeasurementOrder::$pinnedTestMeasurements with generic class Illuminate\Support\Collection does not specify its types: TKey, TValue'
+			identifier: missingType.generics
+			count: 1
+			path: app/GraphQL/Mutations/UpdatePinnedTestMeasurementOrder.php
+
 		-
 			rawMessage: 'Parameter #1 $args (array{siteId: int, description: string}) of method App\GraphQL\Mutations\UpdateSiteDescription::mutate() should be contravariant with parameter $args (array<string, mixed>) of method App\GraphQL\Mutations\AbstractMutation::mutate()'
 			identifier: method.childParameterType