Module Tracy Debugger

[tpr]

It's 4 decimals here:

timer('timer A');
$view->package = getPackages(1, 'random')->first();
bd(timer('timer A'));

Result:

"timer A : 0.0047" (16)

I can't use "t" because it's my translate function's name - maybe also a similar name collision is present there?

Btw, in the post above where "timer" was introduced, the bd('first') should be bd(t('first')) if I see it right.

[adrian]

It's 4 decimals here:

Thanks @tpr for the confirmation of decimal places.

I can't use "t" because it's my translate function's name - maybe also a similar name collision is present there?

So am I right in assuming that you unchecked "t" from the Enabled Shortcut Methods setting and it worked as expected?

Of course I could add a TD::t() option, but I feel like I might have already gone overboard here

Btw, in the post above where "timer" was introduced, the bd('first') should be bd(t('first')) if I see it right.

Thanks - corrected now!

[tpr]

So am I right in assuming that you unchecked "t" from the Enabled Shortcut Methods setting and it worked as expected?

No, everything is checked there. No error was shown because of "!function_exists('t')" in the module.

[adrian]

No, everything is checked there. No error was shown because of "!function_exists('t')" in the module.

Right - it comes down to when your version is initially defined vs the one in this module. When I tested re-defining one of these shortcut methods, it was in a template file, which is after this module, which is why I added the option to disable these as needed.

[adrian]

New "Method Info" panel to give a quick rundown of each method and their available aliases/shortcuts:

[LostKobrakai]

Of course I could add a TD::t() option, but I feel like I might have already gone overboard here

Yeah. Saving a few keystrokes is almost never a worthy trade to code clarity

[matjazp]

t();
sleep(1);
bd(t());

$timer = Debug::timer();
sleep(1);
bd(Debug::timer($timer));

result:

1.0
in ...\site\modules\TracyDebugger\TracyDebugger.module:286
"1.0000" (6)
in ...\site\modules\TracyDebugger\TracyDebugger.module:286

[lpa]

Very nice module! For some reason I get an empty list for Database Queries. Is that part supposed to contain something? Or should I enable it somehow?

[adrian]

@matjazp - can you please see what happens if you specify different sleep intervals. I am occasionally getting 1.0 etc, but changing the sleep value usually results in something with 4 decimal places.

@Ipa - I expect you might have debug mode turned off. That feature currently needs it turned on, although I'll see if it makes sense (or is possible) to get that to work without it on.

On another note, the current version has a new debug mode badge which I think is a very useful reminder:

Also, I have dealt with the issue of incorrect location reporting when calling the TD:: or shortcut/alias methods, so location reporting is now on by default. I think it's a handy addition. For those of you who are updating, you'll need to set this manually, so check the "Show Location" checkboxes in the module config settings.

This means that there is really no reason to ever call the native Tracy methods, so I have removed that info from the first post and the Github ReadMe.

[matjazp]

The difference is because you are returning float using round function, while PW timer is returning string using number_format ...

[adrian]

The difference is because you are returning float using round function, while PW timer is returning string using number_format ...

I understand that round() converts a number to a float before rounding, but I don't understand how you are getting a rounded result of: 1.0 for the Tracy timer - what actual value would ever get rounded to 1.0 - it should remove the decimal place completely and leave just: 1 - shouldn't it?

I feel like I am missing the problem here somehow - sorry for being dumb. Do you have any suggestions on how to fix what you are seeing? 

[adrian]

A quick update - I have added a row of buttons to various parts of the PW admin at the bottom of the PW panel.

The big news though is that I found out the FireLog() actually works with Chrome too. You just need this browser extension:

https://github.com/MattSkala/chrome-firelogger

https://chrome.google.com/webstore/detail/firelogger-for-chrome/hmagilfopmdjkeomnjpchokglfdfjfeh

This is awesome for debugging AJAX calls.

[matjazp]

Maybe:

$roundedTime = number_format(Debugger::timer($name),4);

How about displaying a list of local variables, without PW variables, something like get_defined_vars() but without fuel, wire, classLoader, hooks, config etc.

[kongondo]

This looks awesome @adrian, thanks!

I've just a quick glance, could this do breakpoints and step-throughs as well or its more of a logger?

[szabesz]

@adrian

First of all, thank you for this wonderful module! I have just found the time to check it out and have a few questions:

 

1)

Is it normal that I have this strange looking layout on the public frontend? (see attached image) It would be nice to have a bar that is only one row tall.

 

2)

Show Debug Bar option: a select or two checkboxes please

• Show on public frontend only
• Show on admin only
• Show on both
• Do not show

Currently I am only using it on the public frontend so it is just an obstacle on the admin.

 

3)

email option:

Quote: "Receive emails when an error occurs in production mode." you wrote in the forum, which is a much better description than the one you actually used in the module: "This email address will receive notification of errors."

 

thanks again!

[adrian]

Maybe:

$roundedTime = number_format(Debugger::timer($name),4);

Sorry, I still really don't get the point. Using number_format to round a value with less than 4 decimal places ends up displaying blank/non significant zeros, eg:

echo number_format(0.12, 4)

results in: 0.1200

Why do you want to display the extra zeros? I still don't see why "round" isn't working for you.

How about displaying a list of local variables, without PW variables, something like get_defined_vars() but without fuel, wire, classLoader, hooks, config etc.

I think this is a very useful addition - stay tuned - hopefully coming soon!

This looks awesome @adrian, thanks!

I've just a quick glance, could this do breakpoints and step-throughs as well or its more of a logger?

It doesn't allow for breakpoints and step-throughs. Its features are:

Logging

• dump() to DOM
• barDump() to the debugger bar
• log() to file
• fireLog() to the console (both Chrome and Firefox)
• objects and arrays are presented in a fully expandable tree interface

Error reporting

• Visualization of errors, exceptions, warning, notices etc with a full expandable and linked Call stack, which I find incredibly helpful in isolating the source of the error.
• Can be to DOM or debugger bar
• Automatic emailing of errors in production mode

Timing

• Total execution time
• Logging of custom calls for sections of code

System Info 

• Details on php and apache versions
• Max memory allocation for the page
• Number of includes files, classes and traits

ProcessWire Information

• Access to all the info from the Debug Mode Tools on the front-end via the PW panel in the debugger bar
• Extra sections to the PW panel with details of the current page, its template, the fields of this template
• Debug Mode indicator - nice reminder/warning in case you forget to turn it off once the site is live
• Links to various context relevant places in the admin, as well as general admin links

Hope that helps to answer your question. I am looking for feature suggestions, like @matjazp's idea for showing all available variables. I will probably also add functions and classes too. I am also looking to include some other Tracy plugins, like performance monitoring panels.

@adrian

First of all, thank you for this wonderful module! I have just found the time to check it out and have a few questions:

1)

Is it normal that I have this strange looking layout on the public frontend? (see attached image) It would be nice to have a bar that is only one row tall.

tracy-height-2016-02-16.png

2)

Show Debug Bar option: a select or two checkboxes please

• Show on public frontend only
• Show on admin only
• Show on both
• Do not show

Currently I am only using it on the public frontend so it is just an obstacle on the admin.

3)

email option:

Quote: "Receive emails when an error occurs in production mode." you wrote in the forum, which is a much better description than the one you actually used in the module: "This email address will receive notification of errors."

thanks again!

I haven't seen that issue with the bar taking up more than one line. I have tested in Chrome, Firefox, and Safari. What browser are you using? Can you show me the dom of the bar so I can see what might be causing that?

I have added the option to disable the bar on the backend. I went with just two checkboxes, one for the frontend, and one for the backend. I think this works well and I agree, the module is often not needed in the backend, although I am really enjoying using it for module development - it's so nice to be able to dump variables to the debugger bar, or console when it would otherwise be impossible to get them to display without logging to a log file.

I have changed the description for the email address - thanks for picking that up.

I have also added options to disable the Methods Info panel and the DebugMode Indicator - users upgrading will need to revisit your config settings to enable these.

[matjazp]

Sorry, I still really don't get the point. Using number_format to round a value with less than 4 decimal places ends up displaying blank/non significant zeros, eg: echo number_format(0.12,4) results in: 0.1200

Yes, of course I was just commenting the difference between results from Tracy and PW timers and not "requesting" to be the same. Sorry for not making that clear. I was thinking like this: if you have multiple timers, than it might be visually better to see them aligned ...

[matjazp]

I upgraded to the latest version and I get 

in_array() expects parameter 2 to be array, integer given

TracyDebugger.module, line 154. No access to admin.

I commented lines in ready() so that admin worked again, then updated module settings.

[adrian]

I upgraded to the latest version and I get 

TracyDebugger.module, line 154. No access to admin.

I commented lines in ready() so that admin worked again, then updated module settings.

Sorry about that - it was due to the change in that setting from being a single checkbox to an array with two options. The error should go away after saving the config settings again, but to ease the update, I have added a check that will prevent the error.

[szabesz]

Thank you adrian!

How should I update the module? I simply downloaded it from GitHub (about 10 minutes ago ), replaced the entire directory but it only works if I'm logged in (superuser), otherwise I get this:

Fatal error: Access to undeclared static property: Tracy\Debugger::$showBar in .../site/assets/cache/FileCompiler/site/modules/TracyDebugger/TracyDebugger.module on line 160

I re-saved the config settings a few times and I also used "Modules > Refresh", but these actions did not help.

[adrian]

Thank you adrian!

 

How should I update the module? I simply downloaded it from GitHub (about 10 minutes ago ), replaced the entire directory but it only works if I'm logged in (superuser), otherwise I get this:

Fatal error: Access to undeclared static property: Tracy\Debugger::$showBar in .../site/assets/cache/FileCompiler/site/modules/TracyDebugger/TracyDebugger.module on line 160

I re-saved the config settings a few times and I also used "Modules > Refresh", but these actions did not help.

Sorry - I didn't check non-superusers after the recent change to the Show Debugger Bar settings. The latest version (just committed) should fix that new error!

PS, I'll be adding this to the modules directory in the next couple of days, so updates will be easy via the PW Upgrade module (http://modules.processwire.com/modules/process-wire-upgrade/).

[tpr]

Yesterday I had a "Bad gateway" error, perhaps nginx-related, but the new version seems to fixed this too.

Unrelated: if you uninstall a module, then settings are gone, right? If so, I could think of a file-based settings file which you could edit by hand, to set you own (custom) defaults which would survive uninstalls. Is it a bad idea, or perhaps there's already something like this?

[adrian]

Unrelated: if you uninstall a module, then settings are gone, right? If so, I could think of a file-based settings file which you could edit by hand, to set you own (custom) defaults which would survive uninstalls. Is it a bad idea, or perhaps there's already something like this?

Take a look at: https://processwire.com/talk/topic/8410-module-toolkit/ - among other things, it lets you export a module along with all its settings and install again, already configured. It is still alpha/early beta for some features, but I do hope to get it finalized soon.

Back to Tracy:

I have a question for you guys. With Tracy Debugger, PW's debug mode doesn't really change error reporting anymore. It is controlled by this module and is currently restricted to superusers. So I am thinking of the need to sometimes debug when logged in as a non-superuser/guest. So should I make the module work for non-superusers when PW's debug mode is on? Or maybe a separate setting altogether than turns it on for non-superusers? Or should there be a separate config setting for enabling certain users or roles to have Tracy enabled for? Would really appreciate your thoughts on this - thanks!

[szabesz]

I have a question for you guys. With Tracy Debugger, PW's debug mode doesn't really change error reporting anymore. It is controlled by this module and is currently restricted to superusers. So I am thinking of the need to sometimes debug when logged in as a non-superuser/guest. So should I make the module work for non-superusers when PW's debug mode is on? Or maybe a separate setting altogether than turns it on for non-superusers? Or should there be a separate config setting for enabling certain users or roles to have Tracy enabled for? Would really appreciate your thoughts on this - thanks!

"PW's debug mode doesn't really change error reporting anymore". Can you please explain it a bit more? I do not quite get this.

 

About "superuser only mode": the module should also support non-superuser debugging too. What happens when we want to debug while logged in as another user+role? Why should we miss Tracy in this case? The more control we have in this area is the better, I suppose.

[szabesz]

1)

Is it normal that I have this strange looking layout on the public frontend? (see attached image) It would be nice to have a bar that is only one row tall.

attachicon.giftracy-height-2016-02-16.png

I haven't seen that issue with the bar taking up more than one line. I have tested in Chrome, Firefox, and Safari. What browser are you using? Can you show me the dom of the bar so I can see what might be causing that?

I should have checked "my" css before asking this question, sorry for this. I use a "framework" called Responsee 3 which happens to change the display property of <img> to "block". Changing it back to "inline" or "inline-block" fixes is the issue.

I do not know if you want deal with this issue or not, but you might be able to address this by targeting Tracy's <img> tags to set "inline" or "inline-block" !important on them, just in case... As far as I can see, Tracy itself uses a lot of !important rules as well. Maybe the developers of Tracy should apply this, and it is out of the scope of your module.

EDIT: "inline" or "inline-block"

Edited February 18, 2016 by szabesz