chore: add phpstan static analysis minimum (#4511)

.github/workflows/docker.yaml

@@ -1,4 +1,4 @@
-name: Publish Docker Image
+name: Docker
 
 on:
   push:
@@ -8,16 +8,16 @@ on:
 
 jobs:
   push:
-    name: Push Image to GitHub Packages
+    name: Push
     runs-on: ubuntu-20.04
     # Always run against a tag, even if the commit into the tag has [docker skip]
     # within the commit message.
     if: "!contains(github.ref, 'develop') || (!contains(github.event.head_commit.message, 'skip docker') && !contains(github.event.head_commit.message, 'docker skip'))"
     steps:
-      - name: Code Checkout
+      - name: Code checkout
         uses: actions/checkout@v3
 
-      - name: Docker Metadata
+      - name: Docker metadata
         uses: docker/metadata-action@v4
         id: docker_meta
         with:
@@ -26,10 +26,10 @@ jobs:
       - name: Setup QEMU
         uses: docker/setup-qemu-action@v2
 
-      - name: Setup Docker Buildx
+      - name: Setup Docker buildx
         uses: docker/setup-buildx-action@v2
 
-      - name: Docker Login
+      - name: Docker login
         uses: docker/login-action@v2
         with:
           registry: ghcr.io

.github/workflows/ci.yaml → .github/workflows/laravel.yaml

@@ -1,4 +1,4 @@
-name: Tests
+name: Laravel
 
 on:
   push:
@@ -11,8 +11,58 @@ on:
       - "1.0-develop"
 
 jobs:
+  analysis:
+    name: Static Analysis
+    runs-on: ubuntu-20.04
+    env:
+      APP_ENV: testing
+      APP_DEBUG: "true"
+      APP_KEY: SomeRandomString3232RandomString
+      CACHE_DRIVER: array
+      MAIL_MAILER: array
+      SESSION_DRIVER: array
+      QUEUE_CONNECTION: sync
+    steps:
+      - name: Code checkout
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.1
+          extensions: bcmath, cli, curl, gd, mbstring, mysql, openssl, pdo, tokenizer, xml, zip
+          tools: composer:v2
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --no-interaction --no-progress --no-suggest --prefer-dist
+
+      - name: Analyze
+        run: vendor/bin/phpstan analyse
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Code checkout
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.1
+          extensions: bcmath, curl, gd, mbstring, mysql, openssl, pdo, tokenizer, xml, zip
+          tools: composer:v2
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --no-interaction --no-progress --no-suggest --prefer-dist
+
+      - name: PHP CS Fixer
+        run: vendor/bin/php-cs-fixer fix --dry-run --diff
+
   mysql:
-    name: MySQL
+    name: Tests (MySQL)
     runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
@@ -36,20 +86,17 @@ jobs:
       APP_TIMEZONE: UTC
       APP_URL: http://localhost/
       APP_ENVIRONMENT_ONLY: "true"
-
-      DB_CONNECTION: mysql
-      DB_HOST: 127.0.0.1
-      DB_DATABASE: testing
-      DB_USERNAME: root
-
       CACHE_DRIVER: array
       MAIL_MAILER: array
       SESSION_DRIVER: array
       QUEUE_CONNECTION: sync
-
       HASHIDS_SALT: test123
+      DB_CONNECTION: mysql
+      DB_HOST: 127.0.0.1
+      DB_DATABASE: testing
+      DB_USERNAME: root
     steps:
-      - name: Code Checkout
+      - name: Code checkout
         uses: actions/checkout@v3
 
       - name: Get cache directory
@@ -78,7 +125,6 @@ jobs:
 
       - name: Unit tests
         run: vendor/bin/phpunit --bootstrap vendor/autoload.php tests/Unit
-        if: ${{ always() }}
         env:
           DB_HOST: UNIT_NO_DB
 
@@ -88,7 +134,7 @@ jobs:
           DB_PORT: ${{ job.services.database.ports[3306] }}
 
   postgres:
-    name: PostgreSQL
+    name: Tests (PostgreSQL)
     runs-on: ubuntu-20.04
     if: "!contains(github.event.head_commit.message, 'skip ci') && !contains(github.event.head_commit.message, 'ci skip')"
     strategy:
@@ -114,35 +160,32 @@ jobs:
       APP_TIMEZONE: UTC
       APP_URL: http://localhost/
       APP_ENVIRONMENT_ONLY: "true"
-
-      DB_CONNECTION: pgsql
-      DB_HOST: 127.0.0.1
-      DB_DATABASE: testing
-      DB_USERNAME: postgres
-      DB_PASSWORD: postgres
-
       CACHE_DRIVER: array
       MAIL_MAILER: array
       SESSION_DRIVER: array
       QUEUE_CONNECTION: sync
-
       HASHIDS_SALT: test123
+      DB_CONNECTION: pgsql
+      DB_HOST: 127.0.0.1
+      DB_DATABASE: testing
+      DB_USERNAME: postgres
+      DB_PASSWORD: postgres
     steps:
-      - name: Code Checkout
+      - name: Code checkout
         uses: actions/checkout@v3
 
       - name: Get cache directory
         id: composer-cache
         run: |
-          echo "::set-output name=dir::$(composer config cache-files-dir)"
+          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
 
       - name: Cache
         uses: actions/cache@v3
         with:
-          path: |
-            ~/.php_cs.cache
-            ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-cache-${{ matrix.php }}-${{ hashFiles('**.composer.lock') }}
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ matrix.php }}-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-${{ matrix.php }}-
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -157,7 +200,6 @@ jobs:
 
       - name: Unit tests
         run: vendor/bin/phpunit --bootstrap vendor/autoload.php tests/Unit
-        if: ${{ always() }}
         env:
           DB_HOST: UNIT_NO_DB
 

.github/workflows/release.yaml

@@ -10,20 +10,20 @@ jobs:
     name: Release
     runs-on: ubuntu-20.04
     steps:
-      - name: Code Checkout
+      - name: Code checkout
         uses: actions/checkout@v3
 
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16
-          cache: "yarn"
+          node-version: 18
+          cache: yarn
 
       - name: Install dependencies
         run: yarn install --frozen-lockfile
 
       - name: Build
-        run: yarn build:production
+        run: yarn build
 
       - name: Create release branch and bump version
         env:
@@ -41,7 +41,7 @@ jobs:
 
       - name: Create release archive
         run: |
-          rm -rf node_modules/ test/ codecov.yml CODE_OF_CONDUCT.md CONTRIBUTING.md phpunit.xml Vagrantfile
+          rm -rf node_modules/ tests/ CODE_OF_CONDUCT.md CONTRIBUTING.md phpstan.neon phpunit.xml
           tar -czf panel.tar.gz * .env.example .eslintignore .eslintrc.js
 
       - name: Extract changelog
@@ -58,7 +58,7 @@ jobs:
           echo -e "\n#### SHA256 Checksum\n\n\`\`\`\n$SUM\n\`\`\`\n" >> ./RELEASE_CHANGELOG
           echo $SUM > checksum.txt
 
-      - name: Create Release
+      - name: Create release
         id: create_release
         uses: actions/create-release@v1
         env:

.github/workflows/ui.yaml

@@ -11,28 +11,47 @@ on:
       - "1.0-develop"
 
 jobs:
-  build-and-test:
-    name: Build and Test
+  lint:
+    name: Lint
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Code checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Lint
+        run: yarn run lint
+
+  tests:
+    name: Tests
     runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
       matrix:
-        node-version: [16, 18]
+        node: [16, 18]
     steps:
-      - name: Code Checkout
+      - name: Code checkout
         uses: actions/checkout@v3
 
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node-version }}
-          cache: "yarn"
+          node-version: ${{ matrix.node }}
+          cache: yarn
 
       - name: Install dependencies
         run: yarn install --frozen-lockfile
 
       - name: Build
-        run: yarn build
+        run: yarn run build
 
       - name: Tests
-        run: yarn test
+        run: yarn run test

app/Exceptions/Handler.php

@@ -25,7 +25,7 @@
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 
-class Handler extends ExceptionHandler
+final class Handler extends ExceptionHandler
 {
     /**
      * The validation parser in Laravel formats custom rules using the class name

app/Http/Controllers/Admin/ApiController.php

@@ -9,7 +9,6 @@
 use Illuminate\Http\RedirectResponse;
 use Prologue\Alerts\AlertsMessageBag;
 use Pterodactyl\Services\Acl\Api\AdminAcl;
-use Illuminate\View\Factory as ViewFactory;
 use Pterodactyl\Http\Controllers\Controller;
 use Pterodactyl\Services\Api\KeyCreationService;
 use Pterodactyl\Contracts\Repository\ApiKeyRepositoryInterface;
@@ -23,8 +22,7 @@ class ApiController extends Controller
     public function __construct(
         private AlertsMessageBag $alert,
         private ApiKeyRepositoryInterface $repository,
-        private KeyCreationService $keyCreationService,
-        private ViewFactory $view,
+        private KeyCreationService $keyCreationService
     ) {
     }
 
@@ -33,7 +31,7 @@ public function __construct(
      */
     public function index(Request $request): View
     {
-        return $this->view->make('admin.api.index', [
+        return view('admin.api.index', [
             'keys' => $this->repository->getApplicationKeys($request->user()),
         ]);
     }
@@ -48,7 +46,7 @@ public function create(): View
         $resources = AdminAcl::getResourceList();
         sort($resources);
 
-        return $this->view->make('admin.api.new', [
+        return view('admin.api.new', [
             'resources' => $resources,
             'permissions' => [
                 'r' => AdminAcl::READ,