Merge pull request #285 from HiEventsDev/feature/add-event-reports

Author: daveearley

backend/app/DomainObjects/Enums/ReportTypes.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace HiEvents\DomainObjects\Enums;
+
+enum ReportTypes: string
+{
+    use BaseEnum;
+
+    case PRODUCT_SALES = 'product_sales';
+    case DAILY_SALES_REPORT = 'daily_sales_report';
+    case PROMO_CODES_REPORT = 'promo_codes_report';
+}

backend/app/Http/Actions/Reports/GetReportAction.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace HiEvents\Http\Actions\Reports;
+
+use HiEvents\DomainObjects\Enums\ReportTypes;
+use HiEvents\DomainObjects\EventDomainObject;
+use HiEvents\Http\Actions\BaseAction;
+use HiEvents\Http\Request\Report\GetReportRequest;
+use HiEvents\Services\Handlers\Reports\DTO\GetReportDTO;
+use HiEvents\Services\Handlers\Reports\GetReportHandler;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Carbon;
+use Illuminate\Validation\ValidationException;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+
+class GetReportAction extends BaseAction
+{
+    public function __construct(private readonly GetReportHandler $reportHandler)
+    {
+    }
+
+    /**
+     * @throws ValidationException
+     */
+    public function __invoke(GetReportRequest $request, int $eventId, string $reportType): JsonResponse
+    {
+        $this->isActionAuthorized($eventId, EventDomainObject::class);
+
+        $this->validateDateRange($request);
+
+        if (!in_array($reportType, ReportTypes::valuesArray(), true)) {
+            throw new BadRequestHttpException('Invalid report type.');
+        }
+
+        $reportData = $this->reportHandler->handle(
+            reportData: new GetReportDTO(
+                eventId: $eventId,
+                reportType: ReportTypes::from($reportType),
+                startDate: $request->validated('start_date'),
+                endDate: $request->validated('end_date'),
+            ),
+        );
+
+        return $this->jsonResponse($reportData);
+    }
+
+    /**
+     * @throws ValidationException
+     */
+    private function validateDateRange(GetReportRequest $request): void
+    {
+        $startDate = $request->validated('start_date');
+        $endDate = $request->validated('end_date');
+
+        $diffInDays = Carbon::parse($startDate)->diffInDays(Carbon::parse($endDate));
+
+        if ($diffInDays > 370) {
+            throw ValidationException::withMessages(['start_date' => 'Date range must be less than 370 days.']);
+        }
+    }
+}

backend/app/Http/Request/Report/GetReportRequest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace HiEvents\Http\Request\Report;
+
+use HiEvents\Http\Request\BaseRequest;
+
+class GetReportRequest extends BaseRequest
+{
+    public function rules(): array
+    {
+        return [
+            'start_date' => 'date|before:end_date|required_with:end_date|nullable',
+            'end_date' => 'date|after:start_date|required_with:start_date|nullable',
+        ];
+    }
+}

backend/app/Resources/Product/ProductResourcePublic.php

@@ -18,6 +18,7 @@ public function toArray(Request $request): array
             'id' => $this->getId(),
             'title' => $this->getTitle(),
             'type' => $this->getType(),
+            'product_type' => $this->getProductType(),
             'description' => $this->getDescription(),
             'max_per_order' => $this->getMaxPerOrder(),
             'min_per_order' => $this->getMinPerOrder(),

backend/app/Resources/ProductCategory/ProductCategoryResourcePublic.php

@@ -3,7 +3,7 @@
 namespace HiEvents\Resources\ProductCategory;
 
 use HiEvents\DomainObjects\ProductCategoryDomainObject;
-use HiEvents\Resources\Product\ProductResource;
+use HiEvents\Resources\Product\ProductResourcePublic;
 use Illuminate\Http\Resources\Json\JsonResource;
 
 /**
@@ -21,7 +21,7 @@ public function toArray($request): array
             'order' => $this->getOrder(),
             'no_products_message' => $this->getNoProductsMessage(),
             $this->mergeWhen((bool)$this->getProducts(), fn() => [
-                'products' => ProductResource::collection($this->getProducts()),
+                'products' => ProductResourcePublic::collection($this->getProducts()),
             ]),
         ];
     }

backend/app/Services/Domain/Report/AbstractReportService.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace HiEvents\Services\Domain\Report;
+
+use HiEvents\Repository\Interfaces\EventRepositoryInterface;
+use Illuminate\Cache\Repository;
+use Illuminate\Database\DatabaseManager;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Collection;
+
+abstract class AbstractReportService
+{
+    public function __construct(
+        private readonly Repository               $cache,
+        private readonly DatabaseManager          $queryBuilder,
+        private readonly EventRepositoryInterface $eventRepository,
+    )
+    {
+    }
+
+    public function generateReport(int $eventId, ?Carbon $startDate = null, ?Carbon $endDate = null): Collection
+    {
+        $event = $this->eventRepository->findById($eventId);
+        $timezone = $event->getTimezone();
+
+        $endDate = Carbon::parse($endDate ?? now(), $timezone);
+        $startDate = Carbon::parse($startDate ?? $endDate->copy()->subDays(30), $timezone);
+
+        $reportResults = $this->cache->remember(
+            key: $this->getCacheKey($eventId, $startDate, $endDate),
+            ttl: Carbon::now()->addSeconds(20),
+            callback: fn() => $this->queryBuilder->select(
+                $this->getSqlQuery($startDate, $endDate),
+                [
+                    'event_id' => $eventId,
+                ]
+            )
+        );
+
+        return collect($reportResults);
+    }
+
+    abstract protected function getSqlQuery(Carbon $startDate, Carbon $endDate): string;
+
+    protected function getCacheKey(int $eventId, ?Carbon $startDate, ?Carbon $endDate): string
+    {
+        return static::class . "$eventId.{$startDate?->toDateString()}.{$endDate?->toDateString()}";
+    }
+}

backend/app/Services/Domain/Report/Exception/InvalidDateRange.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace HiEvents\Services\Domain\Report\Exception;
+
+use Exception;
+
+class InvalidDateRange extends Exception
+{
+
+}

backend/app/Services/Domain/Report/Factory/ReportServiceFactory.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace HiEvents\Services\Domain\Report\Factory;
+
+use HiEvents\DomainObjects\Enums\ReportTypes;
+use HiEvents\Services\Domain\Report\AbstractReportService;
+use HiEvents\Services\Domain\Report\Reports\DailySalesReport;
+use HiEvents\Services\Domain\Report\Reports\ProductSalesReport;
+use HiEvents\Services\Domain\Report\Reports\PromoCodesReport;
+use Illuminate\Support\Facades\App;
+
+class ReportServiceFactory
+{
+    public function create(ReportTypes $reportType): AbstractReportService
+    {
+        return match ($reportType) {
+            ReportTypes::PRODUCT_SALES => App::make(ProductSalesReport::class),
+            ReportTypes::DAILY_SALES_REPORT => App::make(DailySalesReport::class),
+            ReportTypes::PROMO_CODES_REPORT => App::make(PromoCodesReport::class),
+        };
+    }
+}

backend/app/Services/Domain/Report/Reports/DailySalesReport.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace HiEvents\Services\Domain\Report\Reports;
+
+use HiEvents\Services\Domain\Report\AbstractReportService;
+use Illuminate\Support\Carbon;
+
+class DailySalesReport extends AbstractReportService
+{
+    public function getSqlQuery(Carbon $startDate, Carbon $endDate): string
+    {
+        $startDateStr = $startDate->toDateString();
+        $endDateStr = $endDate->toDateString();
+
+        return <<<SQL
+            WITH date_range AS (
+                SELECT generate_series('$startDateStr'::date, '$endDateStr'::date, '1 day'::interval) AS date
+            )
+            SELECT
+                d.date,
+                COALESCE(eds.sales_total_gross, 0.00) AS sales_total_gross,
+                COALESCE(eds.total_tax, 0.00) AS total_tax,
+                COALESCE(eds.sales_total_before_additions, 0.00) AS sales_total_before_additions,
+                COALESCE(eds.products_sold, 0) AS products_sold,
+                COALESCE(eds.orders_created, 0) AS orders_created,
+                COALESCE(eds.total_fee, 0.00) AS total_fee,
+                COALESCE(eds.total_refunded, 0.00) AS total_refunded,
+                COALESCE(eds.total_views, 0) AS total_views
+            FROM
+                date_range d
+                LEFT JOIN event_daily_statistics eds
+                    ON d.date = eds.date
+                    AND eds.event_id = :event_id
+            ORDER BY d.date desc;
+SQL;
+    }
+}

backend/app/Services/Domain/Report/Reports/ProductSalesReport.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace HiEvents\Services\Domain\Report\Reports;
+
+use HiEvents\DomainObjects\Status\OrderStatus;
+use HiEvents\Services\Domain\Report\AbstractReportService;
+use Illuminate\Support\Carbon;
+
+class ProductSalesReport extends AbstractReportService
+{
+    protected function getSqlQuery(Carbon $startDate, Carbon $endDate): string
+    {
+        $startDateString = $startDate->format('Y-m-d H:i:s');
+        $endDateString = $endDate->format('Y-m-d H:i:s');
+        $completedStatus = OrderStatus::COMPLETED->name;
+
+        return <<<SQL
+            WITH filtered_orders AS (
+                SELECT
+                    oi.product_id,
+                    oi.total_tax,
+                    oi.total_gross,
+                    oi.total_service_fee,
+                    oi.id AS order_item_id
+                FROM order_items oi
+                JOIN orders o ON oi.order_id = o.id
+                WHERE o.status = '$completedStatus'
+                    AND o.event_id = :event_id
+                    AND o.created_at BETWEEN '$startDateString' AND '$endDateString'
+                    AND oi.deleted_at IS NULL
+            )
+            SELECT
+                p.id AS product_id,
+                p.title AS product_title,
+                p.type AS product_type,
+                COALESCE(SUM(fo.total_tax), 0) AS total_tax,
+                COALESCE(SUM(fo.total_gross), 0) AS total_gross,
+                COALESCE(SUM(fo.total_service_fee), 0) AS total_service_fees,
+                COUNT(fo.order_item_id) AS number_sold
+            FROM products p
+            LEFT JOIN filtered_orders fo ON fo.product_id = p.id
+            WHERE p.event_id = :event_id
+                AND p.deleted_at IS NULL
+            GROUP BY p.id, p.title, p.type
+            ORDER BY p."order"
+SQL;
+    }
+}