refactor: optimize and clean github-project-php package

tanhongit · Copilot · tanhongit · commit 3bdeaa5cce05 · 2026-03-02T20:35:23.000+07:00
Bug fixes: - Fix ServiceProvider namespace (CSlant\GithubProject → CSlant\GitHubProject) - Fix double validatePayloadForComment() call in WebhookService - Fix lang copy-paste ('Hello from the blog core!' → proper message) - Remove redundant Cache::forget() after Cache::pull() - Remove dead array_map identity function in aggregateMessages() Security: - Remove stack trace/file/line leak in GenerateCommentAction error response Modernization: - Add declare(strict_types=1) to all PHP files - Constructor property promotion with readonly in all classes - Replace empty() with strict null/empty-string checks - Replace loose comparisons (!=, ==) with strict (!==, ===) in Blade - Replace (string) config() casts with @var string annotations - Use Illuminate\Http\Request consistently (not Symfony Request) - Use ->header() instead of raw server vars Architecture: - Dependency injection in ProcessAggregatedEvents (handle(GithubService)) - Simplify ServiceProvider: mergeConfigFrom() instead of scandir() loop - Remove empty registerCommands() method - Remove empty Constants/ and Http/ directories - Fix provides() return type (array, not ?array) - Add route names for all routes - Clean up PHPStan baseline (remove overly broad wildcards) Net: -133 lines removed Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diff --git a/common/helpers.php b/common/helpers.php
@@ -1,16 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 if (!function_exists('color_value_format')) {
     /**
-     * Format a value with an optional color.
-     *
-     * @param  string  $value
-     * @param  null|string  $color
-     * @return string
+     * Format a value with an optional color using LaTeX syntax for GitHub Markdown.
      */
     function color_value_format(string $value, ?string $color = null): string
     {
-        if (empty($color)) {
+        if ($color === null || $color === '') {
             return $value;
         }
 
@@ -20,22 +18,17 @@ function color_value_format(string $value, ?string $color = null): string
 
 if (!function_exists('format_date')) {
     /**
-     * Format a date string.
-     *
-     * @param  null|string  $date
-     * @param  string  $format
-     *
-     * @return null|string
+     * Format a date string using Carbon.
      */
     function format_date(?string $date, string $format = 'Y-m-d'): ?string
     {
-        if (!$date) {
+        if ($date === null || $date === '') {
             return null;
         }
 
         try {
             return \Carbon\Carbon::parse($date)->format($format);
-        } catch (\Exception $e) {
+        } catch (\Exception) {
             return $date;
         }
     }
diff --git a/composer.json b/composer.json
@@ -36,20 +36,20 @@
     }
   },
   "require": {
-    "php": "^8.3",
+    "php": "^8.4",
     "knplabs/github-api": "^3.16",
     "nyholm/psr7": "^1.8",
-    "symfony/http-client": "^7.2"
+    "symfony/http-client": "^8.0"
   },
   "require-dev": {
-    "friendsofphp/php-cs-fixer": "^v3.0",
-    "nunomaduro/collision": "^7.10",
-    "nunomaduro/larastan": "^2.9",
-    "orchestra/testbench": "^8.0",
-    "pestphp/pest": "^2.0",
-    "phpstan/extension-installer": "^1.3",
-    "phpstan/phpstan-deprecation-rules": "^1.1",
-    "phpstan/phpstan-phpunit": "^1.3"
+    "friendsofphp/php-cs-fixer": "^v3.94",
+    "nunomaduro/collision": "^8.9",
+    "nunomaduro/larastan": "^3.9",
+    "orchestra/testbench": "^10.0",
+    "pestphp/pest": "^4.0",
+    "phpstan/extension-installer": "^1.4",
+    "phpstan/phpstan-deprecation-rules": "^2.0",
+    "phpstan/phpstan-phpunit": "^2.0"
   },
   "scripts": {
     "a": "vendor/bin/phpstan analyse",
diff --git a/lang/en/github-project.php b/lang/en/github-project.php
@@ -1,7 +1,7 @@
 <?php
 
 return [
-    'message' => 'Hello from the blog core!',
+    'message' => 'GitHub Project notification package.',
 
     'error' => [
         'message' => 'An error occurred.',
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -3,14 +3,8 @@ parameters:
         - message: '#Parameter \#1 \$prefix of static method Illuminate\\Support\\Facades\\Route::prefix\(\) expects string, mixed given\.#'
           path: routes/*.php
 
-        - message: '#Part \$routePrefix \(mixed\) of encapsed string cannot be cast to string\.#'
-          path: routes/*.php
-
-        - message: '#Cannot cast mixed to string#'
-          path: src/*.php
-
-        - message: '#Cannot cast mixed to int#'
-          path: src/*.php
-
-        - message: '#Cannot access offset .+ on mixed#'
-          path: src/*.php
+        - message: '#Parameter \#1 \$view of function view expects view-string\|null, string given\.#'
+          paths:
+              - src/Services/GithubService.php
+              - src/Jobs/ProcessWebhookEvent.php
+              - src/Jobs/ProcessAggregatedEvents.php
diff --git a/resources/views/md/field_types/date.blade.php b/resources/views/md/field_types/date.blade.php
@@ -3,11 +3,11 @@
     $toValue = $toValue ? \Carbon\Carbon::parse($toValue)->format('Y-m-d') : null;
 @endphp
 
-@if($fromValue != null && $toValue != null)
+@if($fromValue !== null && $toValue !== null)
     **`{{ $fieldName }}`** has been changed:
     - From **`{{ $fromValue }}`**
     - To **`{{ $toValue }}`**.
-@elseif ($toValue == null)
+@elseif ($toValue === null)
     The value of **`{{ $fieldName }}`** has been removed.
 @else
     **`{{ $fieldName }}`** has been set to **`{{ $toValue }}`**.
diff --git a/resources/views/md/field_types/iteration.blade.php b/resources/views/md/field_types/iteration.blade.php
@@ -1,8 +1,8 @@
-@if($fromValue != null && $toValue != null)
+@if($fromValue !== null && $toValue !== null)
     **`{{ $fieldName }}`** has been changed:
     - From **`{{ $fromValue }}`**
     - To **`{{ $toValue }}`**.
-@elseif ($toValue == null)
+@elseif ($toValue === null)
     The value of **`{{ $fieldName }}`** has been removed.
 @else
     **`{{ $fieldName }}`** has been set to **`{{ $toValue }}`**.
diff --git a/resources/views/md/field_types/milestone.blade.php b/resources/views/md/field_types/milestone.blade.php
@@ -1,8 +1,8 @@
-@if($fromValue != null && $toValue != null)
+@if($fromValue !== null && $toValue !== null)
     **`{{ $fieldName }}`** has been updated:
     - From: **`{{ $fromValue['title'] }}`**
     - To: **`{{ $toValue['title'] }}`**
-@elseif ($toValue == null)
+@elseif ($toValue === null)
     **`{{ $fieldName }}`** has been removed from the issue.
 @else
     **`{{ $fieldName }}`** has been set to **`{{ $toValue['title'] }}`**.
diff --git a/resources/views/md/field_types/number.blade.php b/resources/views/md/field_types/number.blade.php
@@ -1,6 +1,6 @@
-@if($fromValue != null && $toValue != null)
+@if($fromValue !== null && $toValue !== null)
     **`{{ $fieldName }}`** has been changed From **`{{ $fromValue }}`** To **`{{ $toValue }}`**.
-@elseif ($toValue == null)
+@elseif ($toValue === null)
     The value of **`{{ $fieldName }}`** has been removed.
 @else
     **`{{ $fieldName }}`** has been set to **`{{ $toValue }}`**.
diff --git a/resources/views/md/field_types/single_select.blade.php b/resources/views/md/field_types/single_select.blade.php
@@ -3,9 +3,9 @@
     $toColor = $fieldData['to']['color'] ?? null;
 @endphp
 
-@if($fromValue != null && $toValue != null)
+@if($fromValue !== null && $toValue !== null)
     **`{{ $fieldName }}`** has been changed from {{ color_value_format($fromValue, $fromColor) }} to {{ color_value_format($toValue, $toColor) }}.
-@elseif ($toValue == null)
+@elseif ($toValue === null)
     The value of **`{{ $fieldName }}`** has been removed.
 @else
     **`{{ $fieldName }}`** has been set to {{ color_value_format($toValue, $toColor) }}.
diff --git a/resources/views/md/field_types/text.blade.php b/resources/views/md/field_types/text.blade.php
@@ -1,8 +1,8 @@
-@if($fromValue != null && $toValue != null)
+@if($fromValue !== null && $toValue !== null)
     **`{{ $fieldName }}`** has been changed:
     - From **`{{ $fromValue }}`**
     - To **`{{ $toValue }}`**.
-@elseif ($toValue == null)
+@elseif ($toValue === null)
     The value of **`{{ $fieldName }}`** has been removed.
 @else
     **`{{ $fieldName }}`** has been set to **`{{ $toValue }}`**.
diff --git a/routes/github-project.php b/routes/github-project.php
@@ -1,22 +1,16 @@
 <?php
 
-/*
-|--------------------------------------------------------------------------
-| Core Routes
-|--------------------------------------------------------------------------
-|
-| Here is where you can register core routes for your application. The RouteServiceProvider and all of they load these | routes will
-| be assigned to the "core" middleware group. Enjoy building your API!
-|
-*/
+declare(strict_types=1);
 
 use Illuminate\Support\Facades\Route;
 
-$routePrefix = config('github-project.route_prefix');
+/** @var string $routePrefix */
+$routePrefix = config('github-project.route_prefix', 'github-project');
 
-Route::prefix($routePrefix)->name("$routePrefix.")->group(function () {
-    Route::post('/webhook', \CSlant\GitHubProject\Actions\WebhookAction::class);
+Route::prefix($routePrefix)->name("{$routePrefix}.")->group(function (): void {
+    Route::post('/webhook', \CSlant\GitHubProject\Actions\WebhookAction::class)
+        ->name('webhook');
 
     Route::post('/generate-comment', \CSlant\GitHubProject\Actions\GenerateCommentAction::class)
-        ->name('github-project.generate-comment');
+        ->name('generate-comment');
 });
diff --git a/src/Actions/GenerateCommentAction.php b/src/Actions/GenerateCommentAction.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CSlant\GitHubProject\Actions;
 
 use CSlant\GitHubProject\Services\GithubService;
@@ -10,23 +12,14 @@
 
 class GenerateCommentAction
 {
-    protected WebhookService $webhookService;
-
-    protected GithubService $githubService;
-
-    public function __construct(WebhookService $webhookService, GithubService $githubService)
-    {
-        $this->webhookService = $webhookService;
-        $this->githubService = $githubService;
-    }
+    public function __construct(
+        protected readonly WebhookService $webhookService,
+        protected readonly GithubService $githubService,
+    ) {}
 
     /**
-     * Generate a comment message from the webhook payload
-     *
-     * @param  Request  $request
-     * @param  bool  $validate  Whether to validate the payload (default: true)
+     * Generate a comment message from the webhook payload.
      *
-     * @return JsonResponse
      * @throws Throwable
      */
     public function __invoke(Request $request, bool $validate = true): JsonResponse
@@ -64,20 +57,13 @@ public function __invoke(Request $request, bool $validate = true): JsonResponse
                 'success' => true,
                 'message' => __('github-project::github-project.success.message'),
                 'comment' => $comment,
-                'execution_time' => round((microtime(true) - $startTime) * 1000, 2) . 'ms',
+                'execution_time' => round((microtime(true) - $startTime) * 1000, 2).'ms',
             ]);
         } catch (\Exception $e) {
             return response()->json([
                 'success' => false,
-                'message' => 'Error processing request',
-                'error' => [
-                    'message' => $e->getMessage(),
-                    'type' => get_class($e),
-                    'file' => $e->getFile(),
-                    'line' => $e->getLine(),
-                    'trace' => explode("\n", $e->getTraceAsString()),
-                ],
-                'execution_time' => round((microtime(true) - $startTime) * 1000, 2) . 'ms',
+                'message' => $e->getMessage(),
+                'execution_time' => round((microtime(true) - $startTime) * 1000, 2).'ms',
             ], 500);
         }
     }
diff --git a/src/Actions/WebhookAction.php b/src/Actions/WebhookAction.php
@@ -1,32 +1,27 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CSlant\GitHubProject\Actions;
 
 use CSlant\GitHubProject\Services\GithubService;
 use CSlant\GitHubProject\Services\WebhookService;
 use Illuminate\Http\JsonResponse;
-use Symfony\Component\HttpFoundation\Request;
+use Illuminate\Http\Request;
 use Throwable;
 
 class WebhookAction
 {
-    protected WebhookService $webhookService;
-
-    protected GithubService $githubService;
-
-    public function __construct(WebhookService $webhookService, GithubService $githubService)
-    {
-        $this->webhookService = $webhookService;
-        $this->githubService = $githubService;
-    }
+    public function __construct(
+        protected readonly WebhookService $webhookService,
+        protected readonly GithubService $githubService,
+    ) {}
 
     /**
      * @throws Throwable
      */
-    public function __invoke(): JsonResponse
+    public function __invoke(Request $request): JsonResponse
     {
-        $request = Request::createFromGlobals();
-
         if (!$this->webhookService->eventRequestApproved($request)) {
             return response()->json(['message' => __('github-project::github-project.error.event.denied')], 403);
         }
diff --git a/src/Jobs/ProcessAggregatedEvents.php b/src/Jobs/ProcessAggregatedEvents.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CSlant\GitHubProject\Jobs;
 
 use CSlant\GitHubProject\Services\GithubService;
@@ -17,54 +19,29 @@ class ProcessAggregatedEvents implements ShouldQueue
     use Queueable;
     use SerializesModels;
 
-    protected string $nodeId;
-
-    /**
-     * Create a new job instance.
-     */
-    public function __construct(string $nodeId)
-    {
-        $this->nodeId = $nodeId;
-    }
+    public function __construct(
+        protected readonly string $nodeId,
+    ) {}
 
-    /**
-     * Execute the job.
-     */
-    public function handle(): void
+    public function handle(GithubService $githubService): void
     {
-        $commentAggregationCacheKey = config('github-project.comment_aggregation_cache_key')."_{$this->nodeId}";
+        /** @var string $cacheKeyPrefix */
+        $cacheKeyPrefix = config('github-project.comment_aggregation_cache_key', 'github-project-comment-aggregation');
+        $cacheKey = "{$cacheKeyPrefix}_{$this->nodeId}";
 
-        /** @var array<string, mixed> $eventMessages */
-        $eventMessages = Cache::pull($commentAggregationCacheKey, []);
+        /** @var list<string> $eventMessages */
+        $eventMessages = Cache::pull($cacheKey, []);
 
-        $message = $this->aggregateMessages($eventMessages);
-        $author = Cache::pull($commentAggregationCacheKey.'_author', []);
+        $message = implode("\n", $eventMessages);
 
-        Cache::forget($commentAggregationCacheKey);
-        Cache::forget($commentAggregationCacheKey.'_author');
+        /** @var array{name: string, html_url: string} $author */
+        $author = Cache::pull("{$cacheKey}_author", ['name' => 'Unknown', 'html_url' => '#']);
 
         $message .= view(
             'github-project::md.shared.author',
-            ['name' => $author['name'], 'html_url' => $author['html_url']]
+            ['name' => $author['name'], 'html_url' => $author['html_url']],
         )->render();
 
-        $githubService = new GithubService;
         $githubService->commentOnNode($this->nodeId, $message);
     }
-
-    /**
-     * Aggregate messages from events.
-     *
-     * @param  array<string, mixed>  $eventMessages
-     *
-     * @return string
-     */
-    protected function aggregateMessages(array $eventMessages): string
-    {
-        $messages = array_map(function ($message) {
-            return $message;
-        }, $eventMessages);
-
-        return implode("\n", $messages);
-    }
 }
diff --git a/src/Jobs/ProcessWebhookEvent.php b/src/Jobs/ProcessWebhookEvent.php
diff --git a/src/Providers/GithubProjectServiceProvider.php b/src/Providers/GithubProjectServiceProvider.php
diff --git a/src/Services/GithubService.php b/src/Services/GithubService.php
diff --git a/src/Services/WebhookService.php b/src/Services/WebhookService.php
