Cannot generate request documentation: Scope is not initialized for route.

[RubenR-302]

⚠️ Cannot generate request documentation: Scope is not initialized for route.

what does the error mean ?
is this an bug in scramble or did we break scramble in some way with an custom extension?
Cause like we cant find anything about that warning in scramble docs self

[romalytvynenko]

@RubenR-302
What is your scramble version?
Also, do you see this error when you disable your custom exception?

[RubenR-302]

I removed all my extensions, but still the same issue.
We use scramble version: 0.13.6 normal and 0.8.1 for pro
so I rebuild the application like a docker compose up --build and then i load the docs then it does work like a charm.
Then i perform an ctrl + shift + r to refresh then the error comes back.

we have this for our setup of scramble, as you can see i stripped all the extensions, also the standart auth setup

This is our Provider for example:

<?php

namespace App\Providers;

use Dedoc\Scramble\Generator;
use Dedoc\Scramble\Scramble;
use Dedoc\Scramble\Support\Generator\SecurityScheme;
use Illuminate\Support\Facades\Route;
use Illuminate\Support\ServiceProvider;

class ScrambleServiceProvider extends ServiceProvider
{
    /**
     * Register
     */
    public function register(): void
    {
        Scramble::ignoreDefaultRoutes();
    }

    /**
     * Bootstrap for Scramble OpenAPI implementation
     */
    public function boot(): void
    {
        /**
         * @var array<string, string> $config
         */
        $config = config('api.scramble');
        Scramble::registerApi('api', $config);

        /**
         * Register extensions and transformers
         */
        Scramble::registerExtensions([

        ]);

        // Configure both APIs with identical extensions
        $this->configureApiExtensions('api');

        /**
         * API routes
         */
        Route::prefix('docs')->group(function () {
            Scramble::registerUiRoute('api', 'api');

            Route::get('api.json', function (Generator $generator) {
                $specPath = storage_path('app/api-spec/api.json');

                if (file_exists($specPath)) {
                    return response()->file($specPath, [
                        'Content-Type' => 'application/json',
                    ]);
                }

                // Dynamic generation fallback
                $config = Scramble::getGeneratorConfig('api');
                return response()->json($generator($config), options: JSON_PRETTY_PRINT);
            })->name('scramble.api.specification');
        });
    }

    /**
     * Configure API extensions for the given API name
     *
     * @param string $apiName
     * @return void
     */
    private function configureApiExtensions(string $apiName): void
    {
        Scramble::configure($apiName)
            ->withOperationTransformers($this->getOperationTransformers())
            ->withDocumentTransformers($this->getDocumentTransformers());
    }

    /**
     * Get the list of operation transformers
     *
     * @return array<int, class-string>
     */
    private function getOperationTransformers(): array
    {
        return [

        ];
    }

    /**
     * Get the list of document transformers
     *
     * @return array<int, class-string|callable>
     */
    private function getDocumentTransformers(): array
    {
        return [
        ];
    }
}

[romalytvynenko]

Oh interesting

I bet some either caching issue or maybe Octane related ones

Would you mind sharing your Docker setup?

[RubenR-302]

So i created an repo with an simple laravel application with a simpel docker and octane setup, where i was able to reproduce the same problem. So I think the combination of octane does give this error.

The repo with the test code and setup:
https://github.com/RubenR-302/Scramble-test-repo

Hope this helps : )

[romalytvynenko]

@RubenR-302 as always you are the best. Thank you. I will get back to you once the issue is fixed

[romalytvynenko]

@RubenR-302 please bump dedoc/scramble-pro to 0.8.4, it should work properly now!