Handle cached closure routes more gracefully

knuckleswtf · Feb 14, 2023 · 6fba3a6 · 6fba3a6
1 parent 27937c2
commit 6fba3a6
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/src/Exceptions/CouldntGetRouteDetails.php b/src/Exceptions/CouldntGetRouteDetails.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Knuckles\Scribe\Exceptions;
+
+class CouldntGetRouteDetails extends \RuntimeException implements ScribeException
+{
+    public static function forRoute(string $route): self
+    {
+        return new self("Unable to retrieve controller and method for route $route; try running `php artisan route:clear`");
+    }
+}
diff --git a/src/GroupedEndpoints/GroupedEndpointsFromApp.php b/src/GroupedEndpoints/GroupedEndpointsFromApp.php
@@ -2,13 +2,15 @@
 
 namespace Knuckles\Scribe\GroupedEndpoints;
 
+use Illuminate\Routing\Route;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Knuckles\Camel\Camel;
 use Knuckles\Camel\Extraction\ExtractedEndpointData;
 use Knuckles\Camel\Output\OutputEndpointData;
 use Knuckles\Scribe\Commands\GenerateDocumentation;
+use Knuckles\Scribe\Exceptions\CouldntGetRouteDetails;
 use Knuckles\Scribe\Extracting\ApiDetails;
 use Knuckles\Scribe\Extracting\Extractor;
 use Knuckles\Scribe\Matching\MatchedRoute;
@@ -102,7 +104,7 @@ private function extractEndpointsInfoFromLaravelApp(array $matches, array $cache
             $route = $routeItem->getRoute();
 
             $routeControllerAndMethod = u::getRouteClassAndMethodNames($route);
-            if (!$this->isValidRoute($routeControllerAndMethod)) {
+            if (!$this->isValidRoute($routeControllerAndMethod, $route)) {
                 c::warn('Skipping invalid route: ' . c::getRouteRepresentation($route));
                 continue;
             }
@@ -217,9 +219,12 @@ protected function writeEndpointsToDisk(array $grouped): void
         }
     }
 
-    private function isValidRoute(array $routeControllerAndMethod = null): bool
+    private function isValidRoute(?array $routeControllerAndMethod, Route $route): bool
     {
         if (is_array($routeControllerAndMethod)) {
+            if (count($routeControllerAndMethod) < 2) {
+                throw CouldntGetRouteDetails::forRoute(c::getRouteRepresentation($route));
+            }
             [$classOrObject, $method] = $routeControllerAndMethod;
             if (u::isInvokableObject($classOrObject)) {
                 return true;