clock-work

vendor/beyondcode/laravel-query-detector/src/Events/QueryDetected.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace BeyondCode\QueryDetector\Events;
+
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Collection;
+
+class QueryDetected {
+    use SerializesModels;
+
+    /** @var Collection */
+    protected $queries;
+
+    public function __construct(Collection $queries)
+    {
+        $this->queries = $queries;
+    }
+
+    /**
+     * @return Collection
+     */
+    public function getQueries()
+    {
+        return $this->queries;
+    }
+}

vendor/beyondcode/laravel-query-detector/src/LumenQueryDetectorServiceProvider.php

@@ -0,0 +1,21 @@
+<?php
+namespace BeyondCode\QueryDetector;
+
+use Illuminate\Support\ServiceProvider;
+
+class LumenQueryDetectorServiceProvider extends ServiceProvider
+{
+
+    public function register()
+    {
+        $this->app->configure('querydetector');
+        $this->mergeConfigFrom(__DIR__ . '/../config/config.php', 'querydetector');
+
+        $this->app->middleware([
+            QueryDetectorMiddleware::class
+        ]);
+
+        $this->app->singleton(QueryDetector::class);
+        $this->app->alias(QueryDetector::class, 'querydetector');
+    }
+}

vendor/beyondcode/laravel-query-detector/src/Outputs/Alert.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace BeyondCode\QueryDetector\Outputs;
+
+use Illuminate\Support\Collection;
+use Symfony\Component\HttpFoundation\Response;
+
+class Alert implements Output
+{
+    public function boot()
+    {
+        //
+    }
+
+    public function output(Collection $detectedQueries, Response $response)
+    {
+        if (stripos($response->headers->get('Content-Type'), 'text/html') !== 0 || $response->isRedirection()) {
+            return;
+        }
+
+        $content = $response->getContent();
+
+        $outputContent = $this->getOutputContent($detectedQueries);
+
+        $pos = strripos($content, '</body>');
+
+        if (false !== $pos) {
+            $content = substr($content, 0, $pos) . $outputContent . substr($content, $pos);
+        } else {
+            $content = $content . $outputContent;
+        }
+
+        // Update the new content and reset the content length
+        $response->setContent($content);
+
+        $response->headers->remove('Content-Length');
+    }
+
+    protected function getOutputContent(Collection $detectedQueries)
+    {
+        $output = '<script type="text/javascript">';
+        $output .= "alert('Found the following N+1 queries in this request:\\n\\n";
+        foreach ($detectedQueries as $detectedQuery) {
+            $output .= "Model: ".addslashes($detectedQuery['model'])." => Relation: ".addslashes($detectedQuery['relation']);
+            $output .= " - You should add \"with(\'".addslashes($detectedQuery['relation'])."\')\" to eager-load this relation.";
+            $output .= "\\n";
+        }
+        $output .= "')";
+        $output .= '</script>';
+
+        return $output;
+    }
+}

vendor/beyondcode/laravel-query-detector/src/Outputs/Clockwork.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace BeyondCode\QueryDetector\Outputs;
+
+use Illuminate\Support\Collection;
+use Symfony\Component\HttpFoundation\Response;
+
+class Clockwork implements Output
+{
+    public function boot()
+    {
+        //
+    }
+
+    public function output(Collection $detectedQueries, Response $response)
+    {
+        clock()->warning("{$detectedQueries->count()} N+1 queries detected:", $detectedQueries->toArray());
+    }
+}

vendor/beyondcode/laravel-query-detector/src/Outputs/Console.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace BeyondCode\QueryDetector\Outputs;
+
+use Illuminate\Support\Collection;
+use Symfony\Component\HttpFoundation\Response;
+
+class Console implements Output
+{
+    public function boot()
+    {
+        //
+    }
+
+    public function output(Collection $detectedQueries, Response $response)
+    {
+        if (stripos($response->headers->get('Content-Type'), 'text/html') !== 0 || $response->isRedirection()) {
+            return;
+        }
+
+        $content = $response->getContent();
+
+        $outputContent = $this->getOutputContent($detectedQueries);
+
+        $pos = strripos($content, '</body>');
+
+        if (false !== $pos) {
+            $content = substr($content, 0, $pos) . $outputContent . substr($content, $pos);
+        } else {
+            $content = $content . $outputContent;
+        }
+
+        // Update the new content and reset the content length
+        $response->setContent($content);
+
+        $response->headers->remove('Content-Length');
+    }
+
+    protected function getOutputContent(Collection $detectedQueries)
+    {
+        $output = '<script type="text/javascript">';
+        $output .= "console.warn('Found the following N+1 queries in this request:\\n\\n";
+        foreach ($detectedQueries as $detectedQuery) {
+            $output .= "Model: ".addslashes($detectedQuery['model'])." => Relation: ".addslashes($detectedQuery['relation']);
+            $output .= " - You should add \"with(\'".$detectedQuery['relation']."\')\" to eager-load this relation.";
+            $output .= "\\n\\n";
+            $output .= "Model: ".addslashes($detectedQuery['model'])."\\n";
+            $output .= "Relation: ".$detectedQuery['relation']."\\n";
+            $output .= "Num-Called: ".$detectedQuery['count']."\\n";
+            $output .= "\\n";
+            $output .= 'Call-Stack:\\n';
+
+            foreach ($detectedQuery['sources'] as $source) {
+                $output .= "#$source->index $source->name:$source->line\\n";
+            }
+        }
+        $output .= "')";
+        $output .= '</script>';
+
+        return $output;
+    }
+}

vendor/beyondcode/laravel-query-detector/src/Outputs/Debugbar.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace BeyondCode\QueryDetector\Outputs;
+
+use Illuminate\Support\Collection;
+use Symfony\Component\HttpFoundation\Response;
+
+use Barryvdh\Debugbar\Facade as LaravelDebugbar;
+use DebugBar\DataCollector\MessagesCollector;
+
+class Debugbar implements Output
+{
+    protected $collector;
+
+    public function boot()
+    {
+        $this->collector = new MessagesCollector('N+1 Queries');
+        
+        if (!LaravelDebugbar::hasCollector($this->collector->getName())) {
+            LaravelDebugbar::addCollector($this->collector);
+        }
+    }
+
+    public function output(Collection $detectedQueries, Response $response)
+    {
+        foreach ($detectedQueries as $detectedQuery) {
+            $this->collector->addMessage(sprintf('Model: %s => Relation: %s - You should add `with(%s)` to eager-load this relation.',
+                $detectedQuery['model'],
+                $detectedQuery['relation'],
+                $detectedQuery['relation']
+            ));
+        }
+    }
+}

vendor/beyondcode/laravel-query-detector/src/Outputs/Json.php

@@ -0,0 +1,27 @@
+<?php
+namespace BeyondCode\QueryDetector\Outputs;
+
+use Illuminate\Support\Collection;
+use Symfony\Component\HttpFoundation\Response;
+use Illuminate\Http\JsonResponse;
+
+class Json implements Output
+{
+    public function boot()
+    {
+        //
+    }
+
+    public function output(Collection $detectedQueries, Response $response)
+    {
+        if ($response instanceof JsonResponse) {
+            $data = $response->getData(true);
+            if (! is_array($data)){
+                $data = [ $data ];
+            }
+            
+            $data['warning_queries'] = $detectedQueries;
+            $response->setData($data);
+        }
+    }
+}

vendor/beyondcode/laravel-query-detector/src/Outputs/Log.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace BeyondCode\QueryDetector\Outputs;
+
+use Illuminate\Support\Facades\Log as LaravelLog;
+use Illuminate\Support\Collection;
+use Symfony\Component\HttpFoundation\Response;
+
+class Log implements Output
+{
+    public function boot()
+    {
+        //
+    }
+
+    public function output(Collection $detectedQueries, Response $response)
+    {
+        $this->log('Detected N+1 Query');
+
+        foreach ($detectedQueries as $detectedQuery) {
+            $logOutput = 'Model: '.$detectedQuery['model'] . PHP_EOL;
+
+            $logOutput .= 'Relation: '.$detectedQuery['relation'] . PHP_EOL;
+
+            $logOutput .= 'Num-Called: '.$detectedQuery['count'] . PHP_EOL;
+
+            $logOutput .= 'Call-Stack:' . PHP_EOL;
+
+            foreach ($detectedQuery['sources'] as $source) {
+                $logOutput .= '#'.$source->index.' '.$source->name.':'.$source->line . PHP_EOL;
+            }
+
+            $this->log($logOutput);
+        }
+    }
+
+    private function log(string $message)
+    {
+        LaravelLog::channel(config('querydetector.log_channel'))->info($message);
+    }
+}

vendor/beyondcode/laravel-query-detector/src/Outputs/Output.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace BeyondCode\QueryDetector\Outputs;
+
+use Illuminate\Support\Collection;
+use Symfony\Component\HttpFoundation\Response;
+
+interface Output
+{
+    public function boot();
+
+    public function output(Collection $detectedQueries, Response $response);
+}

vendor/beyondcode/laravel-query-detector/src/QueryDetector.php

@@ -0,0 +1,216 @@
+<?php
+
+namespace BeyondCode\QueryDetector;
+
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
+use Illuminate\Database\Eloquent\Builder;
+use Symfony\Component\HttpFoundation\Response;
+use Illuminate\Database\Eloquent\Relations\Relation;
+use BeyondCode\QueryDetector\Events\QueryDetected;
+
+class QueryDetector
+{
+    /** @var Collection */
+    private $queries;
+
+    public function __construct()
+    {
+        $this->queries = Collection::make();
+    }
+
+    public function boot()
+    {
+        DB::listen(function($query) {
+            $backtrace = collect(debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, 50));
+
+            $this->logQuery($query, $backtrace);
+        });
+
+        foreach ($this->getOutputTypes() as $outputType) {
+            app()->singleton($outputType);
+            app($outputType)->boot();
+        }
+    }
+
+    public function isEnabled(): bool
+    {
+        $configEnabled = value(config('querydetector.enabled'));
+
+        if ($configEnabled === null) {
+            $configEnabled = config('app.debug');
+        }
+
+        return $configEnabled;
+    }
+
+    public function logQuery($query, Collection $backtrace)
+    {
+        $modelTrace = $backtrace->first(function ($trace) {
+            return Arr::get($trace, 'object') instanceof Builder;
+        });
+
+        // The query is coming from an Eloquent model
+        if (! is_null($modelTrace)) {
+            /*
+             * Relations get resolved by either calling the "getRelationValue" method on the model,
+             * or if the class itself is a Relation.
+             */
+            $relation = $backtrace->first(function ($trace) {
+                return Arr::get($trace, 'function') === 'getRelationValue' || Arr::get($trace, 'class') === Relation::class ;
+            });
+
+            // We try to access a relation
+            if (is_array($relation) && isset($relation['object'])) {
+                if ($relation['class'] === Relation::class) {
+                    $model = get_class($relation['object']->getParent());
+                    $relationName = get_class($relation['object']->getRelated());
+                    $relatedModel = $relationName;
+                } else {
+                    $model = get_class($relation['object']);
+                    $relationName = $relation['args'][0];
+                    $relatedModel = $relationName;
+                }
+
+                $sources = $this->findSource($backtrace);
+
+                $key = md5($query->sql . $model . $relationName . $sources[0]->name . $sources[0]->line);
+
+                $count = Arr::get($this->queries, $key.'.count', 0);
+                $time = Arr::get($this->queries, $key.'.time', 0);
+
+                $this->queries[$key] = [
+                    'count' => ++$count,
+                    'time' => $time + $query->time,
+                    'query' => $query->sql,
+                    'model' => $model,
+                    'relatedModel' => $relatedModel,
+                    'relation' => $relationName,
+                    'sources' => $sources
+                ];
+            }
+        }
+    }
+
+    protected function findSource($stack)
+    {
+        $sources = [];
+
+        foreach ($stack as $index => $trace) {
+            $sources[] = $this->parseTrace($index, $trace);
+        }
+
+        return array_values(array_filter($sources));
+    }
+
+    public function parseTrace($index, array $trace)
+    {
+        $frame = (object) [
+            'index' => $index,
+            'name' => null,
+            'line' => isset($trace['line']) ? $trace['line'] : '?',
+        ];
+
+        if (isset($trace['class']) &&
+            isset($trace['file']) &&
+            !$this->fileIsInExcludedPath($trace['file'])
+        ) {
+            $frame->name = $this->normalizeFilename($trace['file']);
+
+            return $frame;
+        }
+
+        return false;
+    }
+
+    /**
+     * Check if the given file is to be excluded from analysis
+     *
+     * @param string $file
+     * @return bool
+     */
+    protected function fileIsInExcludedPath($file)
+    {
+        $excludedPaths = [
+            '/vendor/laravel/framework/src/Illuminate/Database',
+            '/vendor/laravel/framework/src/Illuminate/Events',
+        ];
+
+        $normalizedPath = str_replace('\\', '/', $file);
+
+        foreach ($excludedPaths as $excludedPath) {
+            if (strpos($normalizedPath, $excludedPath) !== false) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Shorten the path by removing the relative links and base dir
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function normalizeFilename($path): string
+    {
+        if (file_exists($path)) {
+            $path = realpath($path);
+        }
+
+        return str_replace(base_path(), '', $path);
+    }
+
+    public function getDetectedQueries(): Collection
+    {
+        $exceptions = config('querydetector.except', []);
+
+        $queries = $this->queries
+            ->values();
+
+        foreach ($exceptions as $parentModel => $relations) {
+            foreach ($relations as $relation) {
+                $queries = $queries->reject(function ($query) use ($relation, $parentModel) {
+                    return $query['model'] === $parentModel && $query['relatedModel'] === $relation;
+                });
+            }
+        }
+
+        $queries = $queries->where('count', '>', config('querydetector.threshold', 1))->values();
+
+        if ($queries->isNotEmpty()) {
+            event(new QueryDetected($queries));
+        }
+
+        return $queries;
+    }
+
+    protected function getOutputTypes()
+    {
+        $outputTypes = config('querydetector.output');
+
+        if (! is_array($outputTypes)) {
+            $outputTypes = [$outputTypes];
+        }
+
+        return $outputTypes;
+    }
+
+    protected function applyOutput(Response $response)
+    {
+        foreach ($this->getOutputTypes() as $type) {
+            app($type)->output($this->getDetectedQueries(), $response);
+        }
+    }
+
+    public function output($request, $response)
+    {
+        if ($this->getDetectedQueries()->isNotEmpty()) {
+            $this->applyOutput($response);
+        }
+
+        return $response;
+    }
+}

vendor/beyondcode/laravel-query-detector/src/QueryDetectorMiddleware.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace BeyondCode\QueryDetector;
+
+use Closure;
+
+class QueryDetectorMiddleware
+{
+    /** @var QueryDetector */
+    private $detector;
+
+    public function __construct(QueryDetector $detector)
+    {
+        $this->detector = $detector;
+    }
+
+    /**
+     * Handle an incoming request.
+     *
+     * @param  Request  $request
+     * @param  Closure  $next
+     * @return mixed
+     */
+    public function handle($request, Closure $next)
+    {
+        if (! $this->detector->isEnabled()) {
+            return $next($request);
+        }
+
+        $this->detector->boot();
+
+        /** @var \Illuminate\Http\Response $response */
+        $response = $next($request);
+
+        // Modify the response to add the Debugbar
+        $this->detector->output($request, $response);
+
+        return $response;
+    }
+}

vendor/beyondcode/laravel-query-detector/src/QueryDetectorServiceProvider.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace BeyondCode\QueryDetector;
+
+use Illuminate\Contracts\Http\Kernel;
+use Illuminate\Support\ServiceProvider;
+
+class QueryDetectorServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     */
+    public function boot()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->publishes([
+                __DIR__.'/../config/config.php' => config_path('querydetector.php'),
+            ], 'config');
+        }
+
+        $this->registerMiddleware(QueryDetectorMiddleware::class);
+    }
+
+    /**
+     * Register the application services.
+     */
+    public function register()
+    {
+        $this->app->singleton(QueryDetector::class);
+
+        $this->app->alias(QueryDetector::class, 'querydetector');
+
+        $this->mergeConfigFrom(__DIR__.'/../config/config.php', 'querydetector');
+    }
+
+    /**
+     * Register the middleware
+     *
+     * @param  string $middleware
+     */
+    protected function registerMiddleware($middleware)
+    {
+        $kernel = $this->app[Kernel::class];
+        $kernel->pushMiddleware($middleware);
+    }
+}