CSlant\Blog\Api\Http\Actions\Post\PostStoreViewCountAction

Complexity

Total Complexity

3

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
B	__invoke()	0	80	2

<?php

namespace CSlant\Blog\Api\Http\Actions\Post;

use CSlant\Blog\Api\Http\Resources\Post\ViewCountResource;
use CSlant\Blog\Api\OpenApi\Schemas\Resources\Post\ViewCountResourceSchema;
use CSlant\Blog\Api\Services\VisitorLogsService;
use CSlant\Blog\Core\Http\Actions\Action;
use CSlant\Blog\Core\Http\Responses\Base\BaseHttpResponse;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;
use Illuminate\Support\Facades\DB;
use OpenApi\Attributes\JsonContent;
use OpenApi\Attributes\Parameter;
use OpenApi\Attributes\Post;
use OpenApi\Attributes\Property;
use OpenApi\Attributes\Response;
use OpenApi\Attributes\Schema;

class PostStoreViewCountAction extends Action
{
    protected VisitorLogsService $visitorLogsService;

    public function __construct(VisitorLogsService $visitorLogsService)
    {
        $this->visitorLogsService = $visitorLogsService;
    }

    #[
        Post(
            path: "/posts/{id}/increment-views",
            operationId: "incrementViewCountPostById",
            description: "Increment views count of the post by ID. Only adds 1 view per IP within a time period specified in the environment configuration.",
            summary: "Increment views count of the post by ID",
            tags: ["Post"],
            parameters: [
                new Parameter(
                    name: 'id',
                    description: 'Post Id',
                    in: 'path',
                    required: true,
                    schema: new Schema(type: 'integer', example: 1)
                ),
            ],
            responses: [
                new Response(
                    response: 200,
                    description: "Success",
                    content: new JsonContent(
                        properties: [
                            new Property(
                                property: 'error',
                                description: 'Error status',
                                type: 'boolean',
                                default: false
                            ),
                            new Property(
                                property: "data",
                                ref: ViewCountResourceSchema::class,
                                description: "Updated view count data",
                                type: "object",
                            ),
                        ]
                    )
                ),
                new Response(
                    ref: \CSlant\Blog\Api\OpenApi\Responses\Errors\BadRequestResponseSchema::class,
                    response: 400,
                ),
                new Response(
                    ref: \CSlant\Blog\Api\OpenApi\Responses\Errors\ErrorNotFoundResponseSchema::class,
                    response: 404,
                ),
                new Response(
                    ref: \CSlant\Blog\Api\OpenApi\Responses\Errors\InternalServerResponseSchema::class,
                    response: 500,
                ),
                new Response(
                    ref: \CSlant\Blog\Api\OpenApi\Responses\Errors\TooManyRequestsResponseSchema::class,
                    response: 429,
                ),
            ]
        )
    ]
    public function __invoke(Request $request, int $id): BaseHttpResponse|JsonResponse|JsonResource|RedirectResponse
    {
        $ipAddress = $request->header('X-Forwarded-For') ?? $request->ip();
        $userAgent = $request->userAgent();

        DB::beginTransaction();

        try {
            $post = $this->visitorLogsService->trackPostView($id, $ipAddress, $userAgent);

It seems like $ipAddress can also be of type array; however, parameter $ipAddress of CSlant\Blog\Api\Services\VisitorLogsService::trackPostView() does only seem to accept null|string, maybe add an additional type check?

            DB::commit();

            return $this
                ->httpResponse()
                ->setData(new ViewCountResource($post))
                ->toApiResponse();
        } catch (\Exception $exception) {
            DB::rollBack();

            return $this
                ->httpResponse()
                ->setError()
                ->setStatusCode(500)
                ->setMessage($exception->getMessage());
        }
    }
}