Merge pull request #9 from cybex-gmbh/release/1.x

establish main as the default branch

Author: lupinitylabs

.github/workflows/tests.yml

@@ -15,11 +15,15 @@ jobs:
             fail-fast: true
             matrix:
                 php: [ 7.3, 7.4, 8.0, 8.1 ]
-                laravel: [ 7.*, 8.* ]
+                laravel: [ 7.*, 8.*, 9.* ]
                 dependency-version: [ prefer-stable ]
                 exclude:
                     -   php: 8.1
                         laravel: 7.*
+                    -   php: 7.3
+                        laravel: 9.*
+                    -   php: 7.4
+                        laravel: 9.*
 
         name: PHP ${{ matrix.php }} with Laravel ${{ matrix.laravel }} (${{ matrix.dependency-version }})
 

README.md

@@ -3,10 +3,10 @@
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/cybex/laravel-query-tracer.svg)](https://packagist.org/packages/cybex/laravel-query-tracer)
 [![Packagist Downloads](https://img.shields.io/packagist/dt/cybex/laravel-query-tracer.svg)](https://packagist.org/packages/cybex/laravel-query-tracer)
-![Github build status](https://github.com/cybex-gmbh/laravel-query-tracer/workflows/tests/badge.svg)
+![Github build status](https://github.com/cybex-gmbh/laravel-query-tracer/actions/workflows/tests.yml/badge.svg)
 [![GitHub pull-requests](https://img.shields.io/github/issues-pr/cybex-gmbh/laravel-query-tracer.svg)](https://github.com/cybex-gmbh/laravel-query-tracer/pull/)
 [![GitHub issues](https://img.shields.io/github/issues/cybex-gmbh/laravel-query-tracer.svg)](https://github.com/cybex-gmbh/laravel-query-tracer/issues/)
-[![Laravel Version](https://img.shields.io/badge/Minimum_Laravel_Version-6.x-red.svg)](https://laravel.com/docs/6.x)
+[![Laravel Version](https://img.shields.io/badge/Minimum_Laravel_Version-7.x-red.svg)](https://laravel.com/docs/7.x)
 
 ![Sample Query with Trace](media/query.png)
 
@@ -33,7 +33,7 @@ composer require cybex/laravel-query-tracer
 To activate the Query Tracer, just add the following line to your `.env` file:
 
 ```
-ENABLE_QUERY_TRACER=true
+QUERY_TRACER_ENABLED=true
 ```
 
 Once you have done this, all Model queries will contain a comment with useful information to locate the source of the
@@ -234,15 +234,8 @@ composer test
 
 ## Requirements
 
-- PHP: (7.2*), 7.3, 7.4, 8.0, 8.1
-- Laravel: 6*, 7, 8
-
-> (*) **PLEASE NOTE:** While we tried to make sure that Laravel Query Tracer will run on PHP 7.2 and Laravel 6, its compatibility is ***not guaranteed***.
->
->
-> **We are only actively testing for PHP 7.3+ and Laravel 7+. Use at your own risk.**
->
-> We are using [Pest](https://github.com/pestphp/pest) for testing, which neither supports PHP 7.2 nor Laravel 6.
+- PHP: 7.3, 7.4, 8.0, 8.1
+- Laravel: 7, 8, 9
 
 ## Changelog
 

composer.json

@@ -22,11 +22,11 @@
     "require": {
         "php": "^7.2.5|^8.0",
         "ext-pdo": "*",
-        "illuminate/support": "^6.0|^7.0|^8.0"
+        "illuminate/support": "^7.0|^8.0|^9.0"
     },
     "require-dev": {
-        "laravel/framework": "^7.0|^8.0",
-        "orchestra/testbench": "^5.0|^6.0",
+        "laravel/framework": "^7.0|^8.0|^9.0",
+        "orchestra/testbench": "^5.0|^6.0|^7.0",
         "pestphp/pest": "^1.20",
         "pestphp/pest-plugin-laravel": "^1.1"
     },
@@ -46,7 +46,10 @@
         "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     },
     "extra": {
         "laravel": {

config/query-tracer.php

@@ -124,14 +124,14 @@
         | Backtrace Frame Limit
         |--------------------------------------------------------------------------
         |
-        | Setting this limit to any non-null value greater than 0 will limit the
-        | amount of stack frames to parse. Depending on the application and your
-        | restriction settings, a good value might be between 8 and 25. If in
-        | doubt, leave this setting unlimited as long as you don't experience
-        | serious performance or memory consumption issues.
+        | Setting this limit to any value greater than 0 will limit the amount
+        | of stack frames to parse. Depending on the application and your
+        | restriction settings, a good value might be between 8 and 25.
+        | If in doubt, leave this setting unlimited as long as you do
+        | not experience performance or memory consumption issues.
         |
         */
-        'limit' => null,
+        'limit' => 0,
 
         /*
         |--------------------------------------------------------------------------

src/Classes/StackTrace.php

@@ -90,7 +90,7 @@ public function getLastMatchingStackFrame(): ?ArrayIterator
         $excludeContaining = (array)config('query-tracer.backtrace.excludeFilesContaining');
 
         $fullBacktrace = debug_backtrace(
-            config('query-tracer.backtrace.withArgs') ? 1 : DEBUG_BACKTRACE_IGNORE_ARGS,
+            DEBUG_BACKTRACE_PROVIDE_OBJECT | (config('query-tracer.backtrace.withArgs') ? false : DEBUG_BACKTRACE_IGNORE_ARGS),
             config('query-tracer.backtrace.limit')
         );
 
@@ -135,7 +135,7 @@ protected function getCall(array $stackFrame, bool $withClass = true): string
 
         $args = '';
 
-        if (is_array($stackFrame['args']) && count($stackFrame['args'])) {
+        if (is_array($stackFrame['args'] ?? false) && count($stackFrame['args'])) {
             $args = app('trace.formatter.argument')->formatStackFrameArguments(array_values($stackFrame['args']));
         }
 

src/QueryTracerServiceProvider.php

@@ -11,15 +11,12 @@
 use Cybex\QueryTracer\Classes\SqlCommentFormatter;
 use Cybex\QueryTracer\Interfaces\ArgumentFormatterInterface;
 use Cybex\QueryTracer\Scopes\QueryTracerScope;
-use Illuminate\Container\Container;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Support\Collection;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Config;
-use Illuminate\Support\Facades\File;
+use Illuminate\Support\Facades\Event;
 use Illuminate\Support\ServiceProvider;
-use Illuminate\Support\Str;
 use InvalidArgumentException;
-use ReflectionClass;
 
 class QueryTracerServiceProvider extends ServiceProvider
 {
@@ -73,40 +70,11 @@ public function register(): void
      */
     protected function registerScopeOnAllModels(): void
     {
-        $this->getAllModels()
-            ->each(function ($model) {
+        Event::listen(['eloquent.booted: *'], function ($event, $arguments) {
+            if (($model = Arr::first($arguments)) instanceof Model) {
                 $model::addGlobalScope(new QueryTracerScope());
-            });
-    }
-
-    /**
-     * Returns a Collection of all available Models via the Filesystem.
-     *
-     * @param bool $withoutAbstract if true, do not include abstract classes in the Collection.
-     * @param bool $withoutLeadingBackslash if true, the namespaces will not be prefixed by a backslash (what SomeClass::class would return).
-     *
-     * @return Collection
-     */
-    protected function getAllModels(bool $withoutAbstract = true, bool $withoutLeadingBackslash = false): Collection
-    {
-        $appNamespace = Container::getInstance()->getNamespace();
-        $modelNamespace = config('query-tracer.model-namespace', '');
-
-        return collect(
-            File::allFiles(app_path(str_replace('\\', DIRECTORY_SEPARATOR, $modelNamespace)))
-        )->map(
-            function ($item) use ($appNamespace, $modelNamespace, $withoutAbstract, $withoutLeadingBackslash) {
-                $class = sprintf(
-                    ($withoutLeadingBackslash ? '' : '\\') . '%s%s%s',
-                    $appNamespace,
-                    $modelNamespace ? $modelNamespace . '\\' : '',
-                    implode('\\', explode('/', Str::beforeLast($item->getRelativePathname(), '.')))
-                );
-
-                return class_exists($class) && is_subclass_of($class, Model::class) &&
-                ($withoutAbstract === false || (new ReflectionClass($class))->isAbstract() === false) ? $class : null;
             }
-        )->filter();
+        });
     }
 
     /**