Question: How to activate SQL debugging?

[markus-hsk]

Hi there,
i recently started using this package. It's working so far but i am unable to get the executed SQLs to be printed. Like in this issue #72 i have checked my .env-File:

APP_ENV=local
APP_DEBUG=true

also in the /api/config/request-docs.php i have set this:

'debug' => true,

but sadly i dont see any SQL statements. What am i doing wrong?

I am using these versions:

laravel/framework                  v9.42.2
rakutentech/laravel-request-docs   1.30

[kevincobain2000]

I don't see anything wrong, probably headers have been over-ridden somewhere?

laravel-request-docs/src/LaravelRequestDocsMiddleware.php

Lines 16 to 40 in 2ad2626

	if (!$request->headers->has('X-Request-LRD') || !config('app.debug')) {
	return $next($request);
	}
	$this->listenDB();
	$response = $next($request);
	$content = $response->getData();
	$content->_lrd = [
	'queries' => $this->queries,
	'memory' => (string) round(memory_get_peak_usage(true) / 1048576, 2) . "MB",
	];
	$jsonContent = json_encode($content);
	if (in_array('gzip', $request->getEncodings()) && function_exists('gzencode')) {
	$level = 9; // best compression;
	$jsonContent = gzencode($jsonContent, $level);
	$response->headers->add([
	'Content-type' => 'application/json; charset=utf-8',
	'Content-Length'=> strlen($jsonContent),
	'Content-Encoding' => 'gzip',
	]);
	}
	$response->setContent($jsonContent);
	return $response;

[kevincobain2000]

Make sure the config has the middleware?

laravel-request-docs/src/LaravelRequestDocsServiceProvider.php

Line 33 in 2ad2626

->middleware(config('request-docs.middlewares'));

laravel-request-docs/config/request-docs.php

Lines 14 to 16 in 2ad2626

	'middlewares' => [
	//Example
	// \App\Http\Middleware\NotFoundWhenProduction::class,

I should add that default middleware to the config

[markus-hsk]

I'm a bit unsure if i do it right, because i recently started using laravel and not yet absolutely firm with it.

I now have added this to /config/request-docs.php:

'middlewares' => [
        \Rakutentech\LaravelRequestDocs\LaravelRequestDocsMiddleware::class

        //Example
        // \App\Http\Middleware\NotFoundWhenProduction::class,
    ],

but nothing is changing.

[kevincobain2000]

Will respond this weekend with troubleshooting steps.

[syahrul84]

I have the same problem and I've been wondering how to get this to work. I hope you can update the readme and how to set this up.

[kevincobain2000]

I have no issues on my project. Following are 2 debugging ways if you can try and let me know the output.

First

cd <to-your-project>
code rakutentech/laravel-request-docs/src/LaravelRequestDocsMiddleware.php

<?php

namespace Rakutentech\LaravelRequestDocs;

use Closure;
use Illuminate\Database\Events\QueryExecuted;
use Illuminate\Support\Facades\DB;
use KitLoong\AppLogger\QueryLog\LogWriter as QueryLogger;

class LaravelRequestDocsMiddleware extends QueryLogger
{
    private array $queries = [];

    public function handle($request, Closure $next)
    {
        if (!$request->headers->has('X-Request-LRD') || !config('app.debug')) {
// ...............................................
// Log here.................................
// ...............................................
            \Log::info("X-Request-LRD header not found or app.debug is false");
            return $next($request);
        }

        $this->listenDB();
        $response = $next($request);

        $content = $response->getData();
        $content->_lrd = [
            'queries' => $this->queries,
            'memory' => (string) round(memory_get_peak_usage(true) / 1048576, 2) . "MB",
        ];
        $jsonContent = json_encode($content);

         if (in_array('gzip', $request->getEncodings()) && function_exists('gzencode')) {
            $level = 9; // best compression;
            $jsonContent = gzencode($jsonContent, $level);
            $response->headers->add([
                'Content-type' => 'application/json; charset=utf-8',
                'Content-Length'=> strlen($jsonContent),
                'Content-Encoding' => 'gzip',
            ]);
        }
        $response->setContent($jsonContent);
// ...............................................
// Log here.................................
// ...............................................
        \Log::info($this->queries);
        return $response;
    }

    public function listenDB()
    {
        DB::listen(function (QueryExecuted $query) {
            $this->queries[] = $this->getMessages($query);
        });
    }
}

Secondly

You can also confirm if the queries are attached to the response on the browser by checking the Chrome Developer tools -> Network -> Response has _lrd attached to it.

@kitloong Can you please also have a look. I couldn't find anything wrong with the implementation of the query logger.

[kevincobain2000]

I am not sure and I don't think it'd cause any issues. But if you have laravel debug bar also enabled, then could try to disable it? Could have a clash with it's listener

[syahrul84]

I am able to find out the issues:-

1. Adding \Rakutentech\LaravelRequestDocs\LaravelRequestDocsMiddleware::class, into Kernel.php Middleware
2. Test the API and get an error, because the gzip is clashing with my own.
3. I need to make the LRD middleware run first, then my gzip middleware.

For the middleware, I believe it's best to separate the gzip and the query logger, so the user has the ability to use gzip or not for all the API or only with LRD.

[kevincobain2000]

Thanks for the details. Will make two separate middlewares in our upcoming big release. Soon.

[markus-hsk]

Hi there, thanks for the reply. Right now i enjoy a bit of vacation. I return on January and check it out then. So long i wish you all nice holidays.

[markus-hsk]

Hi there and happy new year. I found the reason and an error

I forgot to add \Rakutentech\LaravelRequestDocs\LaravelRequestDocsMiddleware::class to kernel.php, like @syahrul84 mentioned here #109 (comment)

Now the middleware is called but runs into an error:

Method Illuminate\Http\Response::getData does not exist. {"exception":"[object] (BadMethodCallException(code: 0): Method Illuminate\\Http\\Response::getData does not exist. at C:\\wamp64\\www\\api\\vendor\\laravel\\framework\\src\\Illuminate\\Macroable\\Traits\\Macroable.php:113)

There is no getData method for the Response object (https://laravel.com/api/9.x/Illuminate/Http/Response.html).

I tried to fix it this way:

        $content = $response->getOriginalContent();
        $content['_lrd'] = [
            'queries' => $this->queries,
            'memory' => (string) round(memory_get_peak_usage(true) / 1048576, 2) . "MB",
        ];

For the future release I suggest placing the complete response in an own json that contains _lrd, memory and content as top level attributes instead of extending the given response. That would be more secure IMHO.

[kevincobain2000]

Thanks for pointing out the issue with getData.
By own response, are you suggesting multiple json responses? In my understanding, extending the current json is the only way to attach such information.

[markus-hsk]

Ah no, i guess my suggestion is a bit misleading.

Currently you're extending the response content with an additional attribute _lrd, blindly assuming the response is of type object. If its not (string p.e.) the assignment would crash.

I suggest something like this:

        $original_content = $response->getOriginalContent();
        $new_content = [
            'content' => $original_content,
            'queries' => $this->queries,
            'memory'  => (string) round(memory_get_peak_usage(true) / 1048576, 2) . "MB",
        ];

Create a new array and add the original content as an element. Now the type and structure of the response content is irrelevant. I hope you can follow my thought. :-)

[kevincobain2000]

I got it now. Will do that.