Added shareable reports

2026-08-16 12:12:15 +01:00 · 2024-11-08 13:27:51 +01:00
parent 9c82efdf07
commit 0860aa9d24
26 changed files with 986 additions and 107 deletions
--- a/app/Service/Dto/ReportPropertiesDto.php
+++ b/app/Service/Dto/ReportPropertiesDto.php
@@ -5,6 +5,8 @@ declare(strict_types=1);
 namespace App\Service\Dto;

 use App\Enums\TimeEntryAggregationType;
+use App\Enums\TimeEntryAggregationTypeInterval;
+use App\Enums\Weekday;
 use Illuminate\Contracts\Database\Eloquent\Castable;
 use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Illuminate\Database\Eloquent\Model;
@@ -14,13 +16,19 @@ use Illuminate\Support\Str;

 class ReportPropertiesDto implements Castable
 {
-    public ?TimeEntryAggregationType $group = null;
+    public TimeEntryAggregationType $group;

-    public ?TimeEntryAggregationType $subGroup = null;
+    public TimeEntryAggregationType $subGroup;

-    public ?Carbon $start = null;
+    public TimeEntryAggregationTypeInterval $historyGroup;

-    public ?Carbon $end = null;
+    public Weekday $weekStart;
+
+    public string $timezone;
+
+    public Carbon $start;
+
+    public Carbon $end;

    public ?bool $active = null;

@@ -64,6 +72,9 @@ class ReportPropertiesDto implements Castable
            private const array REQUIRED_PROPERTIES = [
                'group',
                'subGroup',
+                'historyGroup',
+                'weekStart',
+                'timezone',
                'start',
                'end',
                'active',
@@ -93,38 +104,21 @@ class ReportPropertiesDto implements Castable
                $dto->end = $data->end !== null ? Carbon::createFromFormat('Y-m-d\TH:i:s\Z', $data->end) : null;
                $dto->start = $data->start !== null ? Carbon::createFromFormat('Y-m-d\TH:i:s\Z', $data->start) : null;
                $dto->active = $data->active;
-                $dto->memberIds = $data->memberIds !== null ? $this->idArrayToCollection($data->memberIds) : null;
+                $dto->memberIds = $data->memberIds !== null ? ReportPropertiesDto::idArrayToCollection($data->memberIds) : null;
                $dto->billable = $data->billable;
-                $dto->clientIds = $data->clientIds !== null ? $this->idArrayToCollection($data->clientIds) : null;
-                $dto->projectIds = $data->projectIds !== null ? $this->idArrayToCollection($data->projectIds) : null;
-                $dto->tagIds = $data->tagIds !== null ? $this->idArrayToCollection($data->tagIds) : null;
-                $dto->taskIds = $data->taskIds ? $this->idArrayToCollection($data->taskIds) : null;
-                $dto->group = $data->group !== null ? TimeEntryAggregationType::from($data->group) : null;
-                $dto->subGroup = $data->subGroup !== null ? TimeEntryAggregationType::from($data->subGroup) : null;
+                $dto->clientIds = $data->clientIds !== null ? ReportPropertiesDto::idArrayToCollection($data->clientIds) : null;
+                $dto->projectIds = $data->projectIds !== null ? ReportPropertiesDto::idArrayToCollection($data->projectIds) : null;
+                $dto->tagIds = $data->tagIds !== null ? ReportPropertiesDto::idArrayToCollection($data->tagIds) : null;
+                $dto->taskIds = $data->taskIds ? ReportPropertiesDto::idArrayToCollection($data->taskIds) : null;
+                $dto->group = TimeEntryAggregationType::from($data->group);
+                $dto->subGroup = TimeEntryAggregationType::from($data->subGroup);
+                $dto->historyGroup = TimeEntryAggregationTypeInterval::from($data->historyGroup);
+                $dto->weekStart = Weekday::from($data->weekStart);
+                $dto->timezone = $data->timezone;

                return $dto;
            }

-            /**
-             * @param  array<mixed>  $ids
-             * @return Collection<int, string>
-             */
-            private function idArrayToCollection(array $ids): Collection
-            {
-                $collection = new Collection;
-                foreach ($ids as $id) {
-                    if (! is_string($id)) {
-                        throw new \InvalidArgumentException('The given ID is not a string');
-                    }
-                    if (Str::isUuid($id)) {
-                        throw new \InvalidArgumentException('The given ID is not a valid UUID');
-                    }
-                    $collection->push($id);
-                }
-
-                return $collection;
-            }
-
            /**
             * @param  ReportPropertiesDto  $value
             */
@@ -135,8 +129,8 @@ class ReportPropertiesDto implements Castable
                }

                $data = (object) [
-                    'end' => $value->end?->toIso8601ZuluString(),
-                    'start' => $value->start?->toIso8601ZuluString(),
+                    'end' => $value->end->toIso8601ZuluString(),
+                    'start' => $value->start->toIso8601ZuluString(),
                    'active' => $value->active,
                    'memberIds' => $value->memberIds?->toArray(),
                    'billable' => $value->billable,
@@ -144,8 +138,11 @@ class ReportPropertiesDto implements Castable
                    'projectIds' => $value->projectIds?->toArray(),
                    'tagIds' => $value->tagIds?->toArray(),
                    'taskIds' => $value->taskIds?->toArray(),
-                    'group' => $value->group?->value,
-                    'subGroup' => $value->subGroup?->value,
+                    'group' => $value->group->value,
+                    'subGroup' => $value->subGroup->value,
+                    'historyGroup' => $value->historyGroup->value,
+                    'weekStart' => $value->weekStart->value,
+                    'timezone' => $value->timezone,
                ];

                $jsonString = json_encode($data);
@@ -157,4 +154,64 @@ class ReportPropertiesDto implements Castable
            }
        };
    }
+
+    /**
+     * @param  array<mixed>  $ids
+     * @return Collection<int, string>
+     */
+    public static function idArrayToCollection(array $ids): Collection
+    {
+        $collection = new Collection;
+        foreach ($ids as $id) {
+            if (! is_string($id)) {
+                throw new \InvalidArgumentException('The given ID is not a string');
+            }
+            if (! Str::isUuid($id)) {
+                throw new \InvalidArgumentException('The given ID is not a valid UUID');
+            }
+            $collection->push($id);
+        }
+
+        return $collection;
+    }
+
+    /**
+     * @param  array<mixed>|null  $memberIds
+     */
+    public function setMemberIds(?array $memberIds): void
+    {
+        $this->memberIds = $memberIds !== null ? ReportPropertiesDto::idArrayToCollection($memberIds) : null;
+    }
+
+    /**
+     * @param  array<mixed>|null  $clientIds
+     */
+    public function setClientIds(?array $clientIds): void
+    {
+        $this->clientIds = $clientIds !== null ? ReportPropertiesDto::idArrayToCollection($clientIds) : null;
+    }
+
+    /**
+     * @param  array<mixed>|null  $projectIds
+     */
+    public function setProjectIds(?array $projectIds): void
+    {
+        $this->projectIds = $projectIds !== null ? ReportPropertiesDto::idArrayToCollection($projectIds) : null;
+    }
+
+    /**
+     * @param  array<mixed>|null  $tagIds
+     */
+    public function setTagIds(?array $tagIds): void
+    {
+        $this->tagIds = $tagIds !== null ? ReportPropertiesDto::idArrayToCollection($tagIds) : null;
+    }
+
+    /**
+     * @param  array<mixed>|null  $taskIds
+     */
+    public function setTaskIds(?array $taskIds): void
+    {
+        $this->taskIds = $taskIds !== null ? ReportPropertiesDto::idArrayToCollection($taskIds) : null;
+    }
 }
--- a/app/Service/TimeEntryAggregationService.php
+++ b/app/Service/TimeEntryAggregationService.php
@@ -146,12 +146,14 @@ class TimeEntryAggregationService
     *       grouped_data: null|array<array{
     *           key: string|null,
     *           description: string|null,
+     *           color: string|null,
     *           seconds: int,
     *           cost: int,
     *           grouped_type: string|null,
     *           grouped_data: null|array<array{
     *               key: string|null,
     *               description: string|null,
+     *               color: string|null,
     *               seconds: int,
     *               cost: int,
     *               grouped_type: null,
@@ -180,15 +182,17 @@ class TimeEntryAggregationService
            }
        }

-        $descriptionMapGroup1 = $group1Type !== null ? $this->loadDescriptionMap($keysGroup1, $group1Type) : [];
-        $descriptionMapGroup2 = $group2Type !== null ? $this->loadDescriptionMap($keysGroup2, $group2Type) : [];
+        $descriptionMapGroup1 = $group1Type !== null ? $this->loadDescriptorsMap($keysGroup1, $group1Type) : [];
+        $descriptionMapGroup2 = $group2Type !== null ? $this->loadDescriptorsMap($keysGroup2, $group2Type) : [];

        if ($aggregatedTimeEntries['grouped_data'] !== null) {
            foreach ($aggregatedTimeEntries['grouped_data'] as $keyGroup1 => $group1) {
-                $aggregatedTimeEntries['grouped_data'][$keyGroup1]['description'] = $group1['key'] !== null ? ($descriptionMapGroup1[$group1['key']] ?? null) : null;
+                $aggregatedTimeEntries['grouped_data'][$keyGroup1]['description'] = $group1['key'] !== null ? ($descriptionMapGroup1[$group1['key']]['description'] ?? null) : null;
+                $aggregatedTimeEntries['grouped_data'][$keyGroup1]['color'] = $group1['key'] !== null ? ($descriptionMapGroup1[$group1['key']]['color'] ?? null) : null;
                if ($aggregatedTimeEntries['grouped_data'][$keyGroup1]['grouped_data'] !== null) {
                    foreach ($aggregatedTimeEntries['grouped_data'][$keyGroup1]['grouped_data'] as $keyGroup2 => $group2) {
-                        $aggregatedTimeEntries['grouped_data'][$keyGroup1]['grouped_data'][$keyGroup2]['description'] = $group2['key'] !== null ? ($descriptionMapGroup2[$group2['key']] ?? null) : null;
+                        $aggregatedTimeEntries['grouped_data'][$keyGroup1]['grouped_data'][$keyGroup2]['description'] = $group2['key'] !== null ? ($descriptionMapGroup2[$group2['key']]['description'] ?? null) : null;
+                        $aggregatedTimeEntries['grouped_data'][$keyGroup1]['grouped_data'][$keyGroup2]['color'] = $group2['key'] !== null ? ($descriptionMapGroup2[$group2['key']]['color'] ?? null) : null;
                    }
                }
            }
@@ -200,12 +204,14 @@ class TimeEntryAggregationService
         *        grouped_data: null|array<array{
         *            key: string|null,
         *            description: string|null,
+         *            color: string|null,
         *            seconds: int,
         *            cost: int,
         *            grouped_type: string|null,
         *            grouped_data: null|array<array{
         *                key: string|null,
         *                description: string|null,
+         *                color: string|null,
         *                seconds: int,
         *                cost: int,
         *                grouped_type: null,
@@ -222,33 +228,61 @@ class TimeEntryAggregationService

    /**
     * @param  array<int, string>  $keys
-     * @return array<string, string>
+     * @return array<string, array{
+     *     description: string,
+     *     color: string|null
+     * }>
     */
-    private function loadDescriptionMap(array $keys, TimeEntryAggregationType $type): array
+    private function loadDescriptorsMap(array $keys, TimeEntryAggregationType $type): array
    {
+        $descriptorMap = [];
        if ($type === TimeEntryAggregationType::Client) {
-            return Client::query()
+            $clients = Client::query()
                ->whereIn('id', $keys)
-                ->pluck('name', 'id')
-                ->toArray();
+                ->select('id', 'name')
+                ->get();
+            foreach ($clients as $client) {
+                $descriptorMap[$client->id] = [
+                    'description' => $client->name,
+                    'color' => null,
+                ];
+            }
        } elseif ($type === TimeEntryAggregationType::User) {
-            return User::query()
+            $users = User::query()
                ->whereIn('id', $keys)
-                ->pluck('name', 'id')
-                ->toArray();
+                ->select('id', 'name')
+                ->get();
+            foreach ($users as $user) {
+                $descriptorMap[$user->id] = [
+                    'description' => $user->name,
+                    'color' => null,
+                ];
+            }
        } elseif ($type === TimeEntryAggregationType::Project) {
-            return Project::query()
+            $projects = Project::query()
                ->whereIn('id', $keys)
-                ->pluck('name', 'id')
-                ->toArray();
+                ->select('id', 'name', 'color')
+                ->get();
+            foreach ($projects as $project) {
+                $descriptorMap[$project->id] = [
+                    'description' => $project->name,
+                    'color' => $project->color,
+                ];
+            }
        } elseif ($type === TimeEntryAggregationType::Task) {
-            return Task::query()
+            $tasks = Task::query()
                ->whereIn('id', $keys)
-                ->pluck('name', 'id')
-                ->toArray();
-        } else {
-            return [];
+                ->select('id', 'name')
+                ->get();
+            foreach ($tasks as $task) {
+                $descriptorMap[$task->id] = [
+                    'description' => $task->name,
+                    'color' => null,
+                ];
+            }
        }
+
+        return $descriptorMap;
    }

    /**
--- a/app/Service/TimeEntryFilter.php
+++ b/app/Service/TimeEntryFilter.php
@@ -30,7 +30,17 @@ class TimeEntryFilter
        if ($dateTime === null) {
            return $this;
        }
-        $this->builder->where('start', '<', Carbon::createFromFormat('Y-m-d\TH:i:s\Z', $dateTime, 'UTC'));
+        $this->addEnd(Carbon::createFromFormat('Y-m-d\TH:i:s\Z', $dateTime, 'UTC'));
+
+        return $this;
+    }
+
+    public function addEnd(?Carbon $end): self
+    {
+        if ($end === null) {
+            return $this;
+        }
+        $this->builder->where('start', '<', $end);

        return $this;
    }
@@ -40,7 +50,17 @@ class TimeEntryFilter
        if ($dateTime === null) {
            return $this;
        }
-        $this->builder->where('start', '>', Carbon::createFromFormat('Y-m-d\TH:i:s\Z', $dateTime, 'UTC'));
+        $this->addStart(Carbon::createFromFormat('Y-m-d\TH:i:s\Z', $dateTime, 'UTC'));
+
+        return $this;
+    }
+
+    public function addStart(?Carbon $start): self
+    {
+        if ($start === null) {
+            return $this;
+        }
+        $this->builder->where('start', '>', $start);

        return $this;
    }
@@ -51,9 +71,21 @@ class TimeEntryFilter
            return $this;
        }
        if ($active === 'true') {
-            $this->builder->whereNull('end');
+            $this->addActive(true);
+        } elseif ($active === 'false') {
+            $this->addActive(false);
+        } else {
+            Log::warning('Invalid active filter value', ['value' => $active]);
        }
-        if ($active === 'false') {
+
+        return $this;
+    }
+
+    public function addActive(?bool $active): self
+    {
+        if ($active) {
+            $this->builder->whereNull('end');
+        } else {
            $this->builder->whereNotNull('end');
        }

@@ -89,9 +121,9 @@ class TimeEntryFilter
            return $this;
        }
        if ($billable === 'true') {
-            $this->builder->where('billable', '=', true);
+            $this->addBillable(true);
        } elseif ($billable === 'false') {
-            $this->builder->where('billable', '=', false);
+            $this->addBillable(false);
        } else {
            Log::warning('Invalid billable filter value', ['value' => $billable]);
        }
@@ -99,6 +131,16 @@ class TimeEntryFilter
        return $this;
    }

+    public function addBillable(?bool $billable): self
+    {
+        if ($billable === null) {
+            return $this;
+        }
+        $this->builder->where('billable', '=', $billable);
+
+        return $this;
+    }
+
    /**
     * @param  array<string>|null  $clientIds
     */