Add logging to all GraphQL mutations (#3721)

All mutations are currently untraceable, making debugging difficult.
This PR adds basic logging to each of our existing mutations to resolve
this.

Author: williamjallen

app/GraphQL/Mutations/ChangeGlobalRole.php

@@ -7,6 +7,7 @@
 use App\Enums\GlobalRole;
 use App\Exceptions\GraphQLMutationException;
 use App\Models\User;
+use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Validation\Rule;
 use Illuminate\Validation\ValidationException;
@@ -55,6 +56,8 @@ public function __invoke(null $_, array $args): self
         $userToChange->admin = $args['role'] === GlobalRole::ADMINISTRATOR;
         $userToChange->save();
 
+        Log::info("User {$user->id} changed global role to {$args['role']->value} for user {$userToChange->id}.");
+
         $this->user = $userToChange;
 
         return $this;

app/GraphQL/Mutations/ChangeProjectRole.php

@@ -9,6 +9,7 @@
 use App\Models\Project;
 use App\Models\User;
 use Exception;
+use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Validation\Rule;
 
@@ -65,6 +66,8 @@ public function __invoke(null $_, array $args): self
             },
         ]);
 
+        Log::info("User {$user->id} changed role to {$args['role']->value} for user {$userToChange->id} in project {$project->id}.");
+
         if ($rowsEdited !== 1) {
             throw new Exception('Failed to update pivot table with new role.');
         }

app/GraphQL/Mutations/ClaimSite.php

@@ -7,6 +7,7 @@
 use App\Exceptions\GraphQLMutationException;
 use App\Models\Site;
 use App\Models\User;
+use Illuminate\Support\Facades\Log;
 
 final class ClaimSite extends AbstractMutation
 {
@@ -36,6 +37,8 @@ public function __invoke(null $_, array $args): self
 
         $site->maintainers()->syncWithoutDetaching($user);
 
+        Log::info("User {$user->id} claimed site {$site->id}.");
+
         $this->site = $site;
         $this->user = $user;
 

app/GraphQL/Mutations/CreateAuthenticationToken.php

@@ -10,6 +10,7 @@
 use Illuminate\Auth\AuthenticationException;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\Gate;
+use Illuminate\Support\Facades\Log;
 
 final class CreateAuthenticationToken extends AbstractMutation
 {
@@ -47,6 +48,13 @@ public function __invoke(null $_, array $args): self
             $args['expiration'],
         );
 
+        $logMessage = "User {$user->id} created authentication token with scope {$this->token->scope}";
+        if ($this->token->projectid > 0) {
+            $logMessage .= " for project {$this->token->projectid}";
+        }
+
+        Log::info("$logMessage.");
+
         return $this;
     }
 }

app/GraphQL/Mutations/CreateComment.php

@@ -8,6 +8,7 @@
 use App\Models\Comment;
 use Illuminate\Auth\AuthenticationException;
 use Illuminate\Support\Facades\Gate;
+use Illuminate\Support\Facades\Log;
 
 final class CreateComment extends AbstractMutation
 {
@@ -41,6 +42,8 @@ public function __invoke(null $_, array $args): self
 
         $this->comment = $comment->refresh();
 
+        Log::info("User {$user->id} left comment {$comment->id} on build {$build?->id}.");
+
         return $this;
     }
 }

app/GraphQL/Mutations/CreateGlobalInvitation.php

@@ -12,6 +12,7 @@
 use Exception;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\Hash;
+use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Mail;
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\Str;
@@ -74,6 +75,8 @@ public function __invoke(null $_, array $args): self
             'password' => Hash::make($password),
         ]);
 
+        Log::info("User {$user->id} invited user {$this->invitedUser->email} with role {$this->invitedUser->role->value}.");
+
         // The email gets sent to the queue, so we have no way to know immediately whether it was sent or not.
         // TODO: We should eventually track whether the email was actually sent.
         Mail::to($args['email'])->send(new InvitedToCdash($this->invitedUser, $password));

app/GraphQL/Mutations/CreatePinnedTestMeasurement.php

@@ -7,6 +7,7 @@
 use App\Models\PinnedTestMeasurement;
 use App\Models\Project;
 use Illuminate\Support\Facades\Gate;
+use Illuminate\Support\Facades\Log;
 
 final class CreatePinnedTestMeasurement extends AbstractMutation
 {
@@ -35,6 +36,9 @@ public function __invoke(null $_, array $args): self
             'position' => $nextAvailablePosition,
         ]);
 
+        $user = auth()->user();
+        Log::info("User {$user?->id} created pinned test measurement {$this->pinnedTestMeasurement?->id} for project {$project?->id}.");
+
         return $this;
     }
 }

app/GraphQL/Mutations/CreateProject.php

@@ -7,6 +7,7 @@
 use App\Models\Project;
 use App\Services\ProjectService;
 use Illuminate\Support\Facades\Gate;
+use Illuminate\Support\Facades\Log;
 
 class CreateProject
 {
@@ -27,6 +28,9 @@ public function __invoke(null $_, array $args): Project
             'role' => Project::PROJECT_ADMIN,
         ]);
 
+        $user = auth()->user();
+        Log::info("User {$user?->id} created project {$project->id}.");
+
         return $project;
     }
 }

app/GraphQL/Mutations/CreateRepository.php

@@ -7,6 +7,7 @@
 use App\Models\Project;
 use App\Models\Repository;
 use Illuminate\Support\Facades\Gate;
+use Illuminate\Support\Facades\Log;
 
 final class CreateRepository extends AbstractMutation
 {
@@ -34,6 +35,9 @@ public function __invoke(null $_, array $args): self
             'branch' => $args['branch'],
         ]);
 
+        $user = auth()->user();
+        Log::info("User {$user?->id} created repository {$this->repository?->id} for project {$project?->id}.");
+
         return $this;
     }
 }

app/GraphQL/Mutations/DeleteAuthenticationToken.php

@@ -7,6 +7,7 @@
 use App\Models\AuthToken;
 use App\Utils\AuthTokenUtil;
 use Illuminate\Auth\AuthenticationException;
+use Illuminate\Support\Facades\Log;
 
 final class DeleteAuthenticationToken extends AbstractMutation
 {
@@ -26,6 +27,8 @@ public function __invoke(null $_, array $args): self
             throw new AuthenticationException('This action is unauthorized.');
         }
 
+        Log::info("User {$userid} deleted authentication token {$args['tokenId']}.");
+
         return $this;
     }
 }