IDEA: Fruitcake debugbar helper for production environments

[ssw1cblarrion]

I opened it as an issue because there's no discussions tab

fruitcake/laravel-debugbar is for debug environments, but there should be an option to leave code as measurements or informational messages.
I'm not sure if I'm misunderstanding the usage. If I accidentally leave debugbar()->startMeasure or any other method and send it to production where vendor laravel-debugbar doesn't exist, it will give me an error.

maybe there should be a package used as a fallback in production(fruitcake/laravel-debugbar-helper, fruitcake/laravel-debugbar-fallback, other name).
PoC example:

// src\LaravelDebugbarHelper.php
namespace Fruitcake\LaravelDebugbarHelper {
    if( !class_exists(\Fruitcake\LaravelDebugbar\LaravelDebugbar::class) ) {
        // dump helper class
        class LaravelDebugbarHelper{
            private static $_INSTANCE=null;

            public static function instance(){
                if(!self::$_INSTANCE)
                    self::$_INSTANCE=new static();

                return self::$_INSTANCE;
            }
            public function __call($name,$args) {
                return static::__callStatic($name,$args);
            }
            public static function __callStatic($name,$args) {
                if($name=='measure' && is_callable($args[1]??null))
                    return $args[1](); // run the closure on measure

                return null;
            }
        }
        // alias dump helper class as the real class name
        class_alias(\Fruitcake\LaravelDebugbarHelper\LaravelDebugbarHelper::class,\Fruitcake\LaravelDebugbar\LaravelDebugbar::class);
        class_alias(\Fruitcake\LaravelDebugbarHelper\LaravelDebugbarHelper::class,\Fruitcake\LaravelDebugbar\Facades\Debugbar::class);
    }
}
// src\helpers.php
namespace  {
    if( class_exists(\Fruitcake\LaravelDebugbarHelper\LaravelDebugbarHelper::class) ) {
        if(!function_exists('debugbar')){
            function debugbar(?string $collector = null) : \Fruitcake\LaravelDebugbar\LaravelDebugbar{
                return $collector ? null : \Fruitcake\LaravelDebugbarHelper\LaravelDebugbarHelper::instance();
            }
        }
        if(!function_exists('debug')){
            function debug(): void {}
        }
    }
}

The same could also exist for php-debugbar/php-debugbar

[m13v]

the part that bites in this fallback is the silent no-op. your __callStatic returns null for everything and only fires the closure on 'measure', so a stray debugbar()->startMeasure/stopMeasure shipped to prod runs clean and records nothing. you've swapped a loud 'class not found' fatal, the one signal telling you debug instrumentation leaked into the build, for a green path that throws nothing and quietly drops every timing. the hot path you thought you were measuring just isn't, and nothing in the logs says so. a fallback that no-ops is fine for convenience, but it can't double as your prod measurement story.

[barryvdh]

I guess you could create your own helper and make sure it loads earlier, and check if debugbar is loaded?

Otherwise I would add some CI tooling (like GrumPHP with php parser) to blacklist this helpers in code.

[ssw1cblarrion]

I guess you could create your own helper and make sure it loads earlier, and check if debugbar is loaded?

Yes, that’s what I did, and it works well for me, but I was saying it would be great to have an official option from Fruitcake.

therwise I would add some CI tooling (like GrumPHP with php parser) to blacklist this helpers in code.

It won't be possible with this code.

...returns null for everything and only fires the closure on 'measure', so a stray debugbar()->startMeasure/stopMeasure shipped to prod runs clean and records nothing...

@m13v hi, I'm not sure if I don't understand you or if you've completely lost the point; the idea is to do nothing when the composer installation is --no-dev (production doesn't have debugbar—that's in require-dev).