Merge branch '#2-add-getting-data-from-github-api' of https://github.…

…com/blumilksoftware/gha-analyzer into #51-getting-and-displaying-data-from-db
blumilksoftware · Jul 9, 2024 · 1d9fbaa · 1d9fbaa
2 parents 3ee6aa6 + 3da145c
commit 1d9fbaa
Show file tree

Hide file tree

Showing 17 changed files with 208 additions and 22 deletions.
diff --git a/app/Http/Controllers/GithubController.php b/app/Http/Controllers/GithubController.php
@@ -4,8 +4,13 @@
 
 namespace App\Http\Controllers;
 
+use App\Http\Integrations\GithubConnector;
+use App\Jobs\FetchDataFromApi;
 use App\Models\User;
 use App\Services\AssignUserToOrganizationsService;
+use App\Services\FetchRepositoriesService;
+use App\Services\FetchWorkflowJobsService;
+use App\Services\FetchWorkflowRunsService;
 use Illuminate\Support\Facades\Auth;
 use Laravel\Socialite\Facades\Socialite;
 use Symfony\Component\HttpFoundation\RedirectResponse;
@@ -40,4 +45,19 @@ public function callback(): RedirectResponse
 
         return redirect("/");
     }
+
+    public function fetchData($organizationId): RedirectResponse
+    {
+        $userId = Auth::user()->id;
+
+        FetchDataFromApi::dispatch(
+            (int)$organizationId,
+            $githubConnector = new GithubConnector(),
+            new FetchRepositoriesService($githubConnector, $userId),
+            new FetchWorkflowRunsService($githubConnector, $userId),
+            new FetchWorkflowJobsService($githubConnector, $userId),
+        );
+
+        return redirect()->back();
+    }
 }
diff --git a/app/Http/Integrations/GithubConnector.php b/app/Http/Integrations/GithubConnector.php
@@ -4,12 +4,20 @@
 
 namespace App\Http\Integrations;
 
+use Illuminate\Support\Facades\Cache;
 use Saloon\Http\Connector;
+use Saloon\Http\Response;
+use Saloon\RateLimitPlugin\Contracts\RateLimitStore;
+use Saloon\RateLimitPlugin\Helpers\RetryAfterHelper;
+use Saloon\RateLimitPlugin\Limit;
+use Saloon\RateLimitPlugin\Stores\LaravelCacheStore;
+use Saloon\RateLimitPlugin\Traits\HasRateLimits;
 use Saloon\Traits\Plugins\AlwaysThrowOnErrors;
 
 class GithubConnector extends Connector
 {
     use AlwaysThrowOnErrors;
+    use HasRateLimits;
 
     public function resolveBaseUrl(): string
     {
@@ -23,4 +31,27 @@ protected function defaultHeaders(): array
             "Accept" => "application/json",
         ];
     }
+
+    protected function resolveLimits(): array
+    {
+        return [
+            Limit::allow(config("services.rate_limit"))->everyHour(),
+        ];
+    }
+
+    protected function resolveRateLimitStore(): RateLimitStore
+    {
+        return new LaravelCacheStore(Cache::store("redis"));
+    }
+
+    protected function handleTooManyAttempts(Response $response, Limit $limit): void
+    {
+        if ($response->status() !== 429 && $response->status() !== 403) {
+            return;
+        }
+
+        $limit->exceeded(
+            releaseInSeconds: RetryAfterHelper::parse($response->header("Retry-After")),
+        );
+    }
 }
diff --git a/app/Http/Integrations/Requests/GetRepositoriesRequest.php b/app/Http/Integrations/Requests/GetRepositoriesRequest.php
@@ -7,8 +7,8 @@
 use App\DTO\OrganizationDTO;
 use App\DTO\RepositoryDTO;
 use App\Models\Organization;
+use App\Models\User;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\Auth;
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
 use Saloon\Http\Response;
@@ -19,11 +19,12 @@ class GetRepositoriesRequest extends Request
 
     public function __construct(
         protected OrganizationDTO $organizationDto,
+        protected User $user,
     ) {}
 
     public function resolveEndpoint(): string
     {
-        return "/orgs" . $this->organizationDto->name . "/repos";
+        return "/orgs/" . $this->organizationDto->name . "/repos";
     }
 
     public function createDtoFromResponse(Response $response): Collection
@@ -49,7 +50,7 @@ public function createDtoFromResponse(Response $response): Collection
     protected function defaultHeaders(): array
     {
         return [
-            "Authorization" => "Bearer " . Auth::user()->github_token,
+            "Authorization" => "Bearer " . $this->user->github_token,
         ];
     }
 }
diff --git a/app/Http/Integrations/Requests/GetWorkflowJobsRequest.php b/app/Http/Integrations/Requests/GetWorkflowJobsRequest.php
@@ -6,11 +6,11 @@
 
 use App\DTO\WorkflowJobDTO;
 use App\DTO\WorkflowRunDTO;
+use App\Models\User;
 use App\Models\WorkflowRun;
 use App\Services\CalculateJobTimeService;
 use App\Services\GetRunnerDataService;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\Auth;
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
 use Saloon\Http\Response;
@@ -23,6 +23,7 @@ public function __construct(
         protected WorkflowRunDTO $workflowRunDto,
         protected string $organizationName,
         protected string $repositoryName,
+        protected User $user,
     ) {}
 
     public function resolveEndpoint(): string
@@ -62,7 +63,7 @@ public function createDtoFromResponse(Response $response): Collection
     protected function defaultHeaders(): array
     {
         return [
-            "Authorization" => "Bearer " . Auth::user()->github_token,
+            "Authorization" => "Bearer " . $this->user->github_token,
         ];
     }
 }
diff --git a/app/Http/Integrations/Requests/GetWorkflowRunsRequest.php b/app/Http/Integrations/Requests/GetWorkflowRunsRequest.php
@@ -8,9 +8,9 @@
 use App\DTO\WorkflowRunDTO;
 use App\Models\Organization;
 use App\Models\Repository;
+use App\Models\User;
 use DateTime;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\Auth;
 use Saloon\Enums\Method;
 use Saloon\Http\Request;
 use Saloon\Http\Response;
@@ -21,6 +21,7 @@ class GetWorkflowRunsRequest extends Request
 
     public function __construct(
         protected RepositoryDTO $repositoryDto,
+        protected User $user,
     ) {}
 
     public function resolveEndpoint(): string
@@ -55,7 +56,7 @@ public function createDtoFromResponse(Response $response): Collection
     protected function defaultHeaders(): array
     {
         return [
-            "Authorization" => "Bearer " . Auth::user()->github_token,
+            "Authorization" => "Bearer " . $this->user->github_token,
         ];
     }
 }
diff --git a/app/Jobs/FetchDataFromApi.php b/app/Jobs/FetchDataFromApi.php
@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Jobs;
+
+use App\DTO\OrganizationDTO;
+use App\Http\Integrations\GithubConnector;
+use App\Models\Organization;
+use App\Services\FetchRepositoriesService;
+use App\Services\FetchWorkflowJobsService;
+use App\Services\FetchWorkflowRunsService;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Log;
+use Saloon\RateLimitPlugin\Helpers\ApiRateLimited;
+
+class FetchDataFromApi implements ShouldQueue
+{
+    use Dispatchable;
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
+
+    public function __construct(
+        protected int $organizationId,
+        protected GithubConnector $githubConnector,
+        protected FetchRepositoriesService $fetchRepositoriesService,
+        protected FetchWorkflowRunsService $fetchWorkflowRunsService,
+        protected FetchWorkflowJobsService $fetchWorkflowJobsService,
+    ) {}
+
+    public function handle(): void
+    {
+        $organization = Organization::query()->where("id", $this->organizationId)->firstOrFail();
+        $organizationDto = new OrganizationDTO(
+            $organization->name,
+            $organization->github_id,
+            $organization->avatar_url,
+        );
+
+        $repositories = collect();
+        $repositories = $this->fetchRepositoriesService->fetchRepositories($organizationDto);
+
+        $workflowRuns = collect();
+
+        foreach ($repositories as $repositoryDto) {
+            $workflowRuns = $workflowRuns->union($this->fetchWorkflowRunsService->fetchWorkflowRuns($repositoryDto));
+        }
+
+        foreach ($workflowRuns as $workflowRunDto) {
+            $this->fetchWorkflowJobsService->fetchWorkflowJobs($workflowRunDto);
+        }
+    }
+
+    public function middleware(): array
+    {
+        return [new ApiRateLimited()];
+    }
+}
diff --git a/app/Services/FetchRepositoriesService.php b/app/Services/FetchRepositoriesService.php
@@ -13,19 +13,19 @@
 use App\Models\User;
 use Exception;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\Auth;
 use Illuminate\Validation\UnauthorizedException;
 
 class FetchRepositoriesService
 {
     public function __construct(
         protected GithubConnector $githubConnector,
+        protected int $userId,
     ) {}
 
-    public function fetchRepositories(OrganizationDTO $organizationDto): void
+    public function fetchRepositories(OrganizationDTO $organizationDto): Collection
     {
         $organization = Organization::query()->where("github_id", $organizationDto->githubId)->firstOrFail();
-        $user = User::query()->where("id", Auth::user()->id)->firstOrFail();
+        $user = User::query()->where("id", $this->userId)->firstOrFail();
 
         $userOrganizationExists = $user->organizations()
             ->where("organization_id", $organization->id)
@@ -34,11 +34,13 @@ public function fetchRepositories(OrganizationDTO $organizationDto): void
 
         if ($userOrganizationExists) {
             try {
-                $request = new GetRepositoriesRequest($organizationDto);
+                $request = new GetRepositoriesRequest($organizationDto, $user);
 
                 $response = $this->githubConnector->send($request);
 
                 $this->storeRepositories($response->dto());
+
+                return $response->dto();
             } catch (Exception $exception) {
                 throw new FetchingRepositoriesErrorException(
                     message: "Error ocurred while fetching repositories",

diff --git a/app/Services/FetchWorkflowJobsService.php b/app/Services/FetchWorkflowJobsService.php
@@ -15,13 +15,13 @@
 use App\Models\WorkflowRun;
 use Exception;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\Auth;
 use Illuminate\Validation\UnauthorizedException;
 
 class FetchWorkflowJobsService
 {
     public function __construct(
         protected GithubConnector $githubConnector,
+        protected int $userId,
     ) {}
 
     public function fetchWorkflowJobs(WorkflowRunDTO $workflowRunDto): void
@@ -40,7 +40,7 @@ public function fetchWorkflowJobs(WorkflowRunDTO $workflowRunDto): void
             ->where("id", $repository->organization_id)
             ->firstOrFail();
 
-        $user = User::query()->where("id", Auth::user()->id)->firstOrFail();
+        $user = User::query()->where("id", $this->userId)->firstOrFail();
 
         $userOrganizationExists = $user->organizations()
             ->where("organization_id", $organization->id)
@@ -49,7 +49,7 @@ public function fetchWorkflowJobs(WorkflowRunDTO $workflowRunDto): void
 
         if ($userOrganizationExists) {
             try {
-                $request = new GetWorkflowJobsRequest($workflowRunDto, $organization->name, $repository->name);
+                $request = new GetWorkflowJobsRequest($workflowRunDto, $organization->name, $repository->name, $user);
 
                 $response = $this->githubConnector->send($request);
 

diff --git a/app/Services/FetchWorkflowRunsService.php b/app/Services/FetchWorkflowRunsService.php
@@ -13,19 +13,19 @@
 use App\Models\WorkflowRun;
 use Exception;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\Auth;
 use Illuminate\Validation\UnauthorizedException;
 
 class FetchWorkflowRunsService
 {
     public function __construct(
         protected GithubConnector $githubConnector,
+        protected int $userId,
     ) {}
 
-    public function fetchWorkflowRuns(RepositoryDTO $repositoryDto): void
+    public function fetchWorkflowRuns(RepositoryDTO $repositoryDto): Collection
     {
         $organization = Organization::query()->where("id", $repositoryDto->organizationId)->firstOrFail();
-        $user = User::query()->where("id", Auth::user()->id)->firstOrFail();
+        $user = User::query()->where("id", $this->userId)->firstOrFail();
 
         $userOrganizationExists = $user->organizations()
             ->where("organization_id", $organization->id)
@@ -34,11 +34,13 @@ public function fetchWorkflowRuns(RepositoryDTO $repositoryDto): void
 
         if ($userOrganizationExists) {
             try {
-                $request = new GetWorkflowRunsRequest($repositoryDto);
+                $request = new GetWorkflowRunsRequest($repositoryDto, $user);
 
                 $response = $this->githubConnector->send($request);
 
                 $this->storeWorkflowRuns($response->dto());
+
+                return $response->dto();
             } catch (Exception $exception) {
                 throw new FetchingWorkflowRunsErrorException(
                     message: "Error ocurred while fetching workflow runs",

diff --git a/composer.json b/composer.json
@@ -14,6 +14,7 @@
         "laravel/socialite": "^5.14",
         "laravel/tinker": "^2.9",
         "nesbot/carbon": "^3.6",
+        "saloonphp/rate-limit-plugin": "^2.0",
         "saloonphp/saloon": "^3.0"
     },
     "require-dev": {