feat: approvedActivities API schema

Author: keenthekeen

.gitignore

@@ -12,8 +12,11 @@
 .env
 .env.backup
 .phpunit.result.cache
+_lighthouse_ide_helper.php
 docker-compose.override.yml
 Homestead.json
 Homestead.yaml
 npm-debug.log
+programmatic-types.graphql
+schema-directives.graphql
 yarn-error.log

app/GraphQL/Queries/ApprovedActivities.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace App\GraphQL\Queries;
+
+use App\Helper;
+use App\Models\Activity;
+use App\Models\Project;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Nuwave\Lighthouse\Execution\ResolveInfo;
+use Nuwave\Lighthouse\Support\Contracts\GraphQLContext;
+
+final class ApprovedActivities {
+    public function __invoke($root, array $args, GraphQLContext $context, ResolveInfo $resolveInfo): LengthAwarePaginator {
+        $perPage = $args['first'] ?? 25;
+        $currentPage = $args['page'] ?? 1;
+        $queryLimit = $perPage * $currentPage;
+
+        $projectsQuery = Project::where('closure_approved_status', 1)
+            ->whereBetween('closure_approved_at', [$args['from'], $args['until']]);
+        $projects = $projectsQuery->with([
+            'participants' => fn($query) => $query->where('approve_status', '>=', 1),
+            'participants.user',
+            'department',
+        ])
+            ->select([
+                'id', 'year', 'number', 'name', 'department_id', 'period_start', 'period_end', 'duration', 'closure_approved_at',
+                'closure_approved_status', 'advisor',
+            ])
+            ->orderBy('closure_approved_at', 'desc')
+            ->take($queryLimit)->get()
+            ->map(fn($project) => [
+                'identifier' => $project->year.'-'.$project->number,
+                'project_id' => $project->id,
+                'name' => $project->name,
+                'organization' => Helper::formatDepartmentName($project->department?->name ?? ''),
+                'period_start' => $project->period_start?->addYears(543)->toDateTimeString(),
+                'period_end' => $project->period_end?->addYears(543)->toDateTimeString(),
+                'duration' => $project->duration,
+                'approved_status' => $project->closure_approved_status,
+                'approved_at' => $project->closure_approved_at,
+                'advisor' => $project->advisor,
+                'participants' => $project->participants,
+            ])->toBase();
+        // Note that participant approve_status is not set in Activity
+        $activitiesQuery = Activity::with(['participants', 'participants.user'])
+            ->whereBetween('updated_at', [$args['from'], $args['until']]);
+        $activities = $activitiesQuery->orderBy('updated_at', 'desc')
+            ->take($queryLimit)->get()
+            ->map(fn($activity) => [
+                'identifier' => 'A'.$activity->id,
+                'activity_id' => $activity->id,
+                'name' => $activity->name,
+                'organization' => $activity->organization,
+                'period_start' => $activity->period_start?->toDateTimeString(),
+                'period_end' => $activity->period_end?->toDateTimeString(),
+                'duration' => $activity->duration,
+                'approved_at' => $activity->updated_at,
+                'participants' => $activity->participants,
+            ]);
+        $merged = $projects->merge($activities)->sortByDesc('approved_at');
+
+        return new LengthAwarePaginator(
+            items: $merged->chunk($perPage)[$currentPage - 1] ?? [],
+            total: ($projects->count() == $queryLimit or $activities->count() == $queryLimit)
+                ? ($projectsQuery->count() + $activitiesQuery->count()) // count directly from database
+                : $merged->count(),
+            perPage: $perPage,
+            currentPage: $currentPage
+        );
+    }
+}

app/Models/User.php

@@ -6,10 +6,11 @@
 use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Casts\Attribute;
-use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;
+use Illuminate\Support\Collection;
 use Laravel\Fortify\TwoFactorAuthenticatable;
 use Laravel\Jetstream\HasProfilePhoto;
 use Laravel\Sanctum\HasApiTokens;
@@ -86,7 +87,7 @@ class User extends Authenticatable {
         // 'profile_photo_url',
     ];
 
-    public function participants(): \Illuminate\Database\Eloquent\Relations\HasMany {
+    public function participants(): HasMany {
         return $this->hasMany(ProjectParticipant::class);
     }
 
@@ -97,22 +98,21 @@ public function rolesArray(): Attribute {
     /**
      * @return Collection<ProjectParticipant>
      */
-    public function participantAndProjects(): Collection
-    {
+    public function participantAndProjects(): Collection {
         return $this->participants()->where('project_type', 'App\Models\Project')->with([
             'project', 'project.approvalDocument', 'project.summaryDocument',
         ])->orderByDesc('id')->get()->filter(fn(ProjectParticipant $participant) => $participant->project?->approvalDocument)->values();
     }
 
-    public function projects(): \Illuminate\Database\Eloquent\Relations\HasMany {
+    public function projects(): HasMany {
         return $this->hasMany(Project::class);
     }
 
     /**
      * Returns the user's activity transcript, which is both
      * the projects and the activities (external projects) they have participated in.
      */
-    public function getActivityTranscript() {
+    public function getActivityTranscript(): Collection {
         if (!$this->relationLoaded('participants')) {
             $this->load(['participants', 'participants.project']);
             $this->participants->where('project_type', 'App\Models\Project')->load('project.department');

graphql/schema.graphql

@@ -18,7 +18,17 @@ type Query {
     users: [User!]! @paginate(defaultCount: 10)
 
     "List multiple projects."
-    projects: [Project!]! @paginate(defaultCount: 10)
+    projects(
+        orderBy: _ @orderBy(columns: ["closure_approved_at", "id", "created_at", "updated_at"])
+    ): [Project!]! @paginate(defaultCount: 10)
+
+    "List all approved projects and activities with approved participant list"
+    approvedActivities(
+        "Select activities with approved_at after this time"
+        from: DateTime!
+        "Select activities with approved_at before this time"
+        until: DateTime!
+    ): [ApprovedActivity!]! @paginate(resolver: "App\\GraphQL\\Queries\\ApprovedActivities", defaultCount: 25)
 }
 
 "Account of a person who uses this application."
@@ -64,7 +74,7 @@ type Project {
     period_start: DateTime
     period_end: DateTime
     department_id: Int
-    duration: Int
+    duration: Float
     estimated_attendees: String
     closure_submitted_at: DateTime
     closure_approved_status: Int
@@ -83,9 +93,12 @@ type ProjectParticipant {
     created_at: DateTime
     updated_at: DateTime
 
+    "Role; either organizer, staff, or attendee; optional for Activity"
     type: String
+    "Role title, as set by project organizer"
     title: String
     verify_status: Int!
+    "Approval status; 1 if approved"
     approve_status: Int!
 
     user: User
@@ -106,3 +119,21 @@ type TranscriptRecord {
     approve_status: Int!
     title: String
 }
+
+"A unified object representing an approved Project or Activity."
+type ApprovedActivity {
+    identifier: String!
+    "Project ID; present for Project type"
+    project_id: ID
+    "Activity ID; present for Activity type"
+    activity_id: ID
+    name: String!
+    organization: String!
+    period_start: DateTime!
+    period_end: DateTime!
+    duration: Float
+    approved_at: DateTime!
+    "Advisor name; absent in case of Activity"
+    advisor: String
+    participants: [ProjectParticipant!]!
+}