adrian

Module
Tracy Debugger

935 posts in this topic

Introducing a new module which brings the Tracy Debugger (https://tracy.nette.org/) to ProcessWire.
 
A big thanks to @tpr for introducing me to Tracy and for the idea for this module and for significant feedback, testing, and feature suggestions.

The most comprehensive set of instructions and examples is now available on the PW blog: https://processwire.com/blog/posts/introducing-tracy-debugger/

Modules Directory: http://modules.processwire.com/modules/tracy-debugger/
Github: https://github.com/adrianbj/TracyDebugger

  • quickly detect and correct errors with an expandable call stack tree
  • log errors (and optionally receive emails when an error occurs in production mode)
  • dump variables
  • measure execution time of scripts/queries
  • see memory consumption between breakpoints

 
Debug Bar
 
I have added a custom ProcessWire panel which shows all the content of the current page object, along with all the info from the admin debug tools mode.
 
It also includes a PW Debug Mode badge to warn you that debug mode is on - great reminder for live sites.
 
A Method Info tab details the dumping/logging calls that you can make from your templates etc.
 
Screen Shot 2016-02-15 at 1.19.29 PM.png
 
 

Error Reporting
 
Expandable call stack of errors and other useful information:
 
joxi_screenshot_1455322556737.png
 
 
Manual Dumping, Logging, and Timing

Content can be dumped to the page via TD::dump() or to the debug bar via TD::barDump(), or logged via TD::log() from PW template files. eg.

 

 

 

TD::barDump($page->body, 'Body Field');
TD::barDump($fields->body, 'Body Settings');

Screen-Shot-2016-02-12-at-4.07.05-PM.png
 

TD::dump($page);

Screen Shot 2016-02-12 at 4.11.34 PM.png
 
 
Logging to Console (FireLog)
 
This works with Chrome and Firefox

TD::fireLog()
fireLog()
fl()

To make this work you need to install these browser extensions:
 
Chrome:
https://github.com/MattSkala/chrome-firelogger
 
Firefox:
http://www.getfirebug.com/
http://firelogger.binaryage.com/
 
Screen Shot 2016-02-15 at 1.21.36 PM.png 
 
Logging to File

TD::log('Log Message');

By default, manually logged content is sent to: /site/assets/logs/tracy/info.log, but you can specify an optional second parameter to one of the following: 'debug', 'info', 'warning', 'error', 'exception', 'critical' files.
eg. which will put the message in the debug.info file. 

 

 

 

TD::log('Log Message', 'debug'); 

 
Available Methods

TD::dump()
TD::barDump()
TD::log()
TD::fireLog()
TD::addBreakpoint()
TD::timer()

 
You can also use these shortcuts/aliases:
 
TD::dump($var)

dump()
d()

 
TD::barDump($var, $title)

barDump()
bd()

 
TD::log($message)

l()

Just in case you are wondering, log() is already defined in PW, which is why it is not included here.
 
 
TD::fireLog($message)

fireLog()
fl()

TD:addBreakpoint($name)

addBreakpoint()
bp()

 
TD:timer($name)

timer()
t()

 
These aliases/shortcuts can be disabled in the module config setting, either altogether, or individually, just in case you have functions with the same names defined them elsewhere on your site and are getting a "previously declared" error.
 
  
 
Config Settings 
 
There are several config settings to control the output of errors, dumps, logging, and emails of errors. If you find any additional Tracy settings that you would also like to have access to, please let me know and I'll be happy to add them.

37 people like this

Share this post


Link to post
Share on other sites

Good stuff!  :rolleyes:

I was hoping to see a more feminine screenshot too :)

2 people like this

Share this post


Link to post
Share on other sites

Thanks to a bug report from horst I just committed a new version that fixes a Windows directory path issue.

He also pointed me to another problem which is turns out means that this module currently only works with the 3.x branch of PW. I will look into supporting 2.x, but for the moment if you want to test, you will need 3.x or you can probably make it work on 2.7 if you uncheck "Show ProcessWire Panel" in the config settings. You'll miss out on that functionality, but hopefully everything else should work.

1 person likes this

Share this post


Link to post
Share on other sites

That is something nearly every developer can make use of. Thanks adrian and tpr!

Could you please suggest a proper way to debug process modules stuff with it? On the tracy page I have read about outputting stuff to fiebug...

 
 
 

Share this post


Link to post
Share on other sites

That is something nearly every developer can make use of. Thanks adrian and tpr!

Could you please suggest a proper way to debug process modules stuff with it? On the tracy page I have read about outputting stuff to fiebug...

 

Thanks Ivan, there are several options - Firebug is actually something I haven't implement yet in this module. It requires an additional package which I haven't included. I figure that most of us are on Chrome, so didn't bother with it yet. But if there is interest, I will definitely take a look.

I should have pointed to the best of the Tracy docs: https://doc.nette.org/en/2.3/debugging - for some reason the ones on the main page don't include the barDump() option yet.

You can use: TD::dump(), TD::barDump(), TD::log()

I also implemented some aliases - d(), bd(), l() as very short options for lazy typists, but not sure about keeping these due to possible name conflicts.

Anyway, let me know if that links helps and if you have any specific questions.

Edited by adrian
Corrected info about the Firebug option.

Share this post


Link to post
Share on other sites

Thanks everyone for the great interest in this module!

I have just added 2 new sections to the PW panel that shows details of all fields on the current page.

I would love to hear from you if you have any ideas for other sections/info that you would find useful to have in the PW panel.

List View

Shows basic details with the name linked to the edit page for that field:

post-985-0-77931100-1455395881_thumb.png

Object View

Shows the fields object - for details of each field, expand the "data" section:

post-985-0-51904500-1455395880_thumb.png

4 people like this

Share this post


Link to post
Share on other sites

Sorry, this is just too much fun :)

Just added a Current Page Info section, with links to edit the page (from the name), edit the template, and open the page tree with this page expanded to show the children (from the number of children).

post-985-0-19806300-1455399024_thumb.png

3 people like this

Share this post


Link to post
Share on other sites

Looks like you're really in love with Tracy :)

Actually I am, and have been for 18 years now, but that is a very different kind of love ;)

4 people like this

Share this post


Link to post
Share on other sites

That was high time then to make a module from it :)

Page Info: it's useful, but it's a bit inconvenient to show. How about adding it to a separate tab? That way it would only require to hover. 

I don't know how much work is it, just asking.

Share this post


Link to post
Share on other sites

That was high time then to make a module from it :)

Page Info: it's useful, but it's a bit inconvenient to show. How about adding it to a separate tab? That way it would only require to hover. 

I don't know how much work is it, just asking.

New tab/panel isn't hard to do at all, but I wonder whether just having that section always expanded would be ok/better?

There are so many options and ways to present info that I am not totally sure the best option yet. I'd really love some thoughts from others about what they think they would use/access most often. Perhaps I could add several PW tabs/panels with different elements on each. Anyone have any ideas on what else they would like to have accessible and what should be grouped with what?

EDIT: I have just made the Page Info section open by default so a hover over the PW tab is enough to see that info. Still amenable to making separate tabs/panels if that is the consensus though.

1 person likes this

Share this post


Link to post
Share on other sites

Just been playing around with shortcuts to the various dump/log methods.

TD::dump()
TD::barDump()
TD::log()
TD::fireLog()
TD::timer()

 
You can now also use these shortcuts/aliases:
 
TD::dump($var)

dump()
d()

 
TD::barDump($var, $title)

barDump()
bd()

 
TD::log($message)

l()

Just in case you are wondering, log() is already defined in PW, which is why it is not included here.
 

TD::fireLog($message)

fireLog()
fl()

TD:timer($name)

timer()
t()

These aliases/shortcuts can be disabled in the module config setting, either altogether, or individually, just in case you have functions with the same names defined them elsewhere on your site and are getting a "previously declared" error.
 

I'd really appreciate any feedback on these shortcuts/aliases - I think they make dumping/logging substantially quicker, but I am definitely open to suggestion/criticisms to this approach.

Share this post


Link to post
Share on other sites

In followup to that last post, I decided to add an option to load the Tracy library for non-superusers.

This will NOT show errors or the debug bar for non-superusers. It just loads the Tracy library so that you can call Tracy methods directly, eg. Tracy\Debugger::dump() without non-superusers getting a "Fatal error: Class \'Tracy\Debugger\' not found" fatal error.
 
The downside to this setting is that the library is loaded for everyone - while it may not be a significant increase in resources, it is still something, so in general I recommend leaving this unchecked.

Share this post


Link to post
Share on other sites

How about making a dummy Tracy class with barDump/dump/log methods to load for non-superusers? (as a workaround)

This way less resources would be needed.

1 person likes this

Share this post


Link to post
Share on other sites

How about making a dummy Tracy class with barDump/dump/log methods to load for non-superusers? (as a workaround)

This way less resources would be needed.

I think that sounds like a decent approach, so I just implemented it.

Now there is no need to worry if for some reason you want to make direct calls via (Tracy\Debugger::method()) on a live site as non-superusers will just get the dummy methods which return nothing.

I also just implemented the TD::timer() method, along with timer() and t() shortcut aliases.

With timer() you can do:

t();
// insert resource intensive code here
bd(t());

to dump the results of the time to the debug bar.

1 person likes this

Share this post


Link to post
Share on other sites

t() returns number like 3.0994415283203e-6 Could that be "better" formated?

Sure, it is now rounded to 4 decimal places. This matches the precision of PW's built in Debug::timer() which of course you could also use and dump or bardump to Tracy.

Is that what you were getting at?

I have also added the name of the timer to the output - if you specify it like:

t('first');
sleep(1);
bd(t('first'));

t('second');
sleep(2);
bd(t('second'));

This way you can have multiple timers and output them at once, and know which value responds to which timer.

Please let me know if that is better for you, or if you have any more specific suggestions.

Share this post


Link to post
Share on other sites

There's a typo in the name of "ShortcutMethods": the first "S" is lowercase in the filename which causes an error (perhaps not on every server).

Share this post


Link to post
Share on other sites

There's a typo in the name of "ShortcutMethods": the first "S" is lowercase in the filename which causes an error (perhaps not on every server).

That's weird - it was actually a git issue - I had already changed the filename locally to match the require statement, but git didn't update it when syncing. Looks to be fixed now.

1 person likes this

Share this post


Link to post
Share on other sites

4 decimal places is ok (from my point of view), but now it show 0.0 instead of 0.0000

Weird - I am not seeing that at all - could you please post exactly how you are calling this? Also, how many times have you reloaded the page. As you can image if the result was 3.100000000 it would round to be 3.1, rather than 3.1000, although it seems unlikely that the result would only have 2 significant figures.

I am wondering what might be different on your setup. I don't see why PHP version would matter and can't think of anything else.

Anyone else out there seeing only one decimal place?

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!


Register a new account

Sign in

Already have an account? Sign in here.


Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Richard Jedlička
      Tense    
      Tense (Test ENvironment Setup & Execution) is a command-line tool to easily run tests agains multiple versions of ProcessWire CMF.
      Are you building a module, or a template and you need to make sure it works in all supported ProcessWire versions? Then Tense is exactly what you need. Write the tests in any testing framework, tell Tense which ProcessWire versions you are interested in and it will do the rest for you.

      See example or see usage in a real project.
      How to use?
      1. Install it: 
      composer global require uiii/tense 2. Create tense.yml config:
      tense init 3. Run it:
      tense run  
      For detailed instructions see Github page: https://github.com/uiii/tense
       
      This is made possible thanks to the great wireshell tool by @justb3a, @marcus and others.
       
      What do you think about it? Do you find it useful? Do you have some idea? Did you find some bug? Tell me you opinion. Write it here or in the issue tracker.
    • By ukyo
      FieldtypeFontIconPicker
      v.0.1.6
      Fix FieldtypeFontIconPicker sanitizeValue() v.0.1.5
      Added uikit icon select support (required AdminThemeUikit), because uikit icons not working standalone. v.0.1.4 :
      Fix issue FontIconPicker inside repeater v.0.1.3 :
      FontAwesome updated to 4.7.0 v.0.1.2 :
      Little Corrections Some works about icon pickers inside repeater via ajax load v.0.1.1 :
      FontAwesome updated to 4.6.3 v.0.1.0 :
      Custom CSS file url support Added hook method ___beforeRender(), you can check hook example for usage Added multiple icons library use option Added Ionicons Library Now module using cdn for load icon fonts v.0.0.9 inside dev branch
      Added hook method ___beforeRender(), you can check hook example for usage Added multiple icons library use option Added Ionicons Library Now module using cdn for load icon fonts v.0.0.8
      FontAwesome 4.5 update, Improvements and Performance updates Important ! After update module check your input settings, because i changed input attribute names (This will only effect input options, like theme, category). Changed loading icon method from input:hidden to select>optgroup>option, added module js file for load and correct icon picker container many changes…. v.0.0.7
      FontAwesome updated to 4.4.0 v.0.0.6
      Missed... array compatibility for usage, from [$foo, $bar] to array($foo, $bar) v.0.0.5
      Fix for oldest pw versions (Assets file loding scripts moved to inputfieldfonticonpicker module) v.0.0.4
      Array compatibility for usage, from [$foo, $bar] to array($foo, $bar) v.0.0.3
      Small z-index problem solved v.0.0.2
      MarkupFontIconPicker added v.0.0.1
      Start Point Module allow you to use Fotn-Awesome icons easily. You can select icons directly from icon select list, also you can set settings for each InputfieldFontIconPicker.
       
      NOTE : Module store data without prefix, you need to add "prefix" when you want to show your icon on front-end, because some of front-end frameworks using font-awesome with different "prefix".

      Example :
      if($my-icon-field) echo "<i class='my-prefix-{$my-icon-field}' />"; Hook Before Render Example This example using /site/templates/admin.php file for hook
      wire()->addHook('InputfieldFontIconPicker::beforeRender', function($event) { if(!$event->return) return; // Get Input Name (For specified input hook, if you want apply all InputfieldFontIconPicker remove inputName check) $inputName = ""; if(isset($event->object->attributes['name'])) $inputName = $event->object->attributes['name']; // Get Input Name (For specified input hook, if you want apply all InputfieldFontIconPicker remove inputName check) if($inputName == 'icon_picker') { /** * Load your custom icons function file * Your array need to be same format with Icons/FontAwesome.php or Icons/Ionicons.php * Also you can pass directly an array */ wireIncludeFile('MyCustomIconFile'); // Set icons as $icons variable $icons = MyCustomIconsArray(); // Set your options $return = array( 'attributes' => array( 'category' => '', 'theme' => 'fip-grey', 'empty-icon' => 1, 'empty-icon-value' => '', 'icons-per-page' => 20, 'has-search' => 1 ), 'icons' => $icons ); // Return the event $event->return = $return; } $event->return; }); MarkupFontIconPicker Usage
      // MarkupFontIconPicker::render(YourIconField=string, Options=array) echo MarkupFontIconPicker::render($page->YourIconField, [ 'prefix' => 'uk-icon-', // Icon class prefix, if you have different prefix, default is : "fa fa-" 'tag' => 'span', // Icon tag default is : "i" 'class' => 'fa-lg', // If you have extra cutom classes, for example : icons sizes, Array or Sting value 'style' => 'your custom styles if you have' // Array or String Value ]); Module Using
      Font-Awesome v4.3 jQuery fontIconPicker v2.0.0 Screenshots - InputfieldFontIconPicker input settings

      InputfieldFontIconPicker Setting "Category Select"
       


      InputfieldFontIconPicker Setting "Theme Select"



      Screenshots - InputfieldFontIconPicker page edit views

      InputfieldFontIconPicker Search


      InputfieldFontIconPicker Categories


       
      For issues and other things here is MY Github Repo
    • By FIA2008
      I'm using this piece of code to add a table layout to my module configuration:
      $this ->wire('modules') ->get('MarkupAdminDataTable') Then I use this to add rows to my table:
      $this ->wire('modules') ->get('MarkupAdminDataTable') ->row($data) But when I try to add a field to my table, It's not rendered as a field, I only see the the classname of the input field instead of the field itself.
      Is it possible to render a field into a table row?
    • By FIA2008
      In my module's getModuleConfigInputfields method, I've added a field of type: InputfieldButton.
      I want this button have a different action than the usual submit button (which is still there) and the submit button to behave as it always does.
      For example; I want the InputfieldButton button to clear a few folders when it's clicked. Is this possible, if so, how can I achieve this?
    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      A module for ProcessWire CMS/CMF. Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.

      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.