Exception on Compiled Closure Routes

[LucianMihalache]

Scribe version

5.2.1

PHP version

8.4.7

Laravel version

12.16.0

Scribe config

Does not matter in this case

What happened?

If you have a closure route:
Route::get('/test', function () { return response()->json([]); });
And run laravel's optimization: php artisan optimize
Then run scribe's generation: php artisan scribe:generate
Throws error because scribe is trying to look for a controller and an action to look into it.

local.ERROR: Unable to retrieve controller and method for route; try running `php artisan route:clear` {"exception":"[object] (Knuckles\\Scribe\\Exceptions\\CouldntGetRouteDetails(code: 0): Unable to retrieve controller and method for route; try running `php artisan route:clear` at /var/www/vendor/knuckleswtf/scribe/src/Exceptions/CouldntGetRouteDetails.php:9)
[stacktrace]
#0 /var/www/vendor/knuckleswtf/scribe/src/Tools/Utils.php(98): Knuckles\\Scribe\\Exceptions\\CouldntGetRouteDetails::new()
#1 /var/www/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php(107): Knuckles\\Scribe\\Tools\\Utils::getRouteClassAndMethodNames()
#2 /var/www/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php(72): Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp->extractEndpointsInfoFromLaravelApp()
#3 /var/www/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php(50): Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp->extractEndpointsInfoAndWriteToDisk()
#4 /var/www/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php(55): Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp->get()
#5 /var/www/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php(36): Knuckles\\Scribe\\Commands\\GenerateDocumentation->handle()
#6 /var/www/vendor/laravel/framework/src/Illuminate/Container/Util.php(43): Illuminate\\Container\\BoundMethod::{closure:Illuminate\\Container\\BoundMethod::call():35}()
#7 /var/www/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php(96): Illuminate\\Container\\Util::unwrapIfClosure()
#8 /var/www/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php(35): Illuminate\\Container\\BoundMethod::callBoundMethod()
#9 /var/www/vendor/laravel/framework/src/Illuminate/Container/Container.php(754): Illuminate\\Container\\BoundMethod::call()
#10 /var/www/vendor/laravel/framework/src/Illuminate/Console/Command.php(211): Illuminate\\Container\\Container->call()
#11 /var/www/vendor/symfony/console/Command/Command.php(279): Illuminate\\Console\\Command->execute()
#12 /var/www/vendor/laravel/framework/src/Illuminate/Console/Command.php(180): Symfony\\Component\\Console\\Command\\Command->run()
#13 /var/www/vendor/symfony/console/Application.php(1094): Illuminate\\Console\\Command->run()
#14 /var/www/vendor/symfony/console/Application.php(342): Symfony\\Component\\Console\\Application->doRunCommand()
#15 /var/www/vendor/symfony/console/Application.php(193): Symfony\\Component\\Console\\Application->doRun()
#16 /var/www/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php(197): Symfony\\Component\\Console\\Application->run()
#17 /var/www/vendor/laravel/framework/src/Illuminate/Foundation/Application.php(1234): Illuminate\\Foundation\\Console\\Kernel->handle()
#18 /var/www/artisan(16): Illuminate\\Foundation\\Application->handleCommand()
#19 {main}
"}

The issue is here: Knuckles\Scribe\Tools\Utils::getRouteClassAndMethodNames()
It checks only for normal routes. It does not know about closure routes.
I know its an edge case, but still.

Docs

• I've checked the docs, the troubleshooting guide, and existing issues, but I didn't find a solution

[shalvah]

That's surprising. We normally can handle closure routes. .For instance, see this test:

scribe/tests/GenerateDocumentation/BehavioursTest.php

Lines 68 to 72 in 99c2121

	public function can_process_closure_routes()
	{
	RouteFacade::get('/api/closure', fn() => 'hi');
	$this->generateAndExpectConsoleOutput(expected: ['Processed route: [GET] api/closure']);
	}

Please debug this some more on your end

[LucianMihalache]

@shalvah sorry for the late response, things been busy
So, I just installed a total fresh laravel (laravel new ...) and then installed scribe (composer require knuckleswtf/scribe)
Added this in routes/web.php

Route::get('/test', function () { return response()->json([]); });

Run php artisan optimize, php artisan scribe:generate, php artisan serve. All good, no errors. Although web.php is not shown in the /docs as intended.
Added api.php in boostrap/app.php
Moved the test route from above in api.php
Run the commands above again and then:

PS D:\Munca\---\Test-ToDelete\test-scribe> php artisan scribe:generate
PHP Warning:  PHP Startup: Unable to load dynamic library 'rdkafka' (tried: E:\Php\8.4.5\ext\rdkafka (The specified module could not be found), E:\Php\8.4.5\ext\php_rdkafka.dll (The specified module could not be found)) in Unknown on line 0

Warning: PHP Startup: Unable to load dynamic library 'rdkafka' (tried: E:\Php\8.4.5\ext\rdkafka (The specified module could not be found), E:\Php\8.4.5\ext\php_rdkafka.dll (The specified module could not be found)) in Unknown on line 0

   Knuckles\Scribe\Exceptions\CouldntGetRouteDetails 

  Unable to retrieve controller and method for route; try running `php artisan route:clear`

  at vendor\knuckleswtf\scribe\src\Exceptions\CouldntGetRouteDetails.php:9
      5▕ class CouldntGetRouteDetails extends \RuntimeException implements ScribeException
      6▕ {
      7▕     public static function new(): self
      8▕     {
  ➜   9▕         return new self("Unable to retrieve controller and method for route; try running `php artisan route:clear`");
     10▕     }
     11▕ }
     12▕

  1   vendor\knuckleswtf\scribe\src\Tools\Utils.php:96
      Knuckles\Scribe\Exceptions\CouldntGetRouteDetails::new()

  2   vendor\knuckleswtf\scribe\src\GroupedEndpoints\GroupedEndpointsFromApp.php:107
      Knuckles\Scribe\Tools\Utils::getRouteClassAndMethodNames(Object(Illuminate\Routing\Route))

PS D:\Munca\....\Test-ToDelete\test-scribe>

PS: ignore the rdkafka. PHP on windows is weird.

[LucianMihalache]

Just to make it clear, the issue is with the route:cache (optimize) and the scribe generation.
Without route:cache it works as expected

With optimize:

[LucianMihalache]

[LucianMihalache]

The fix is adding something like this:

try {
    $closure = unserialize($uses)->getClosure();
    return [$closure, '__invoke'];
} catch (Throwable $e) {
    throw CouldntGetRouteDetails::new();
}

This seems to do the trick