adrian

Tracy Debugger

Recommended Posts

tracy-icon.png.5e7c4709b2890fc86b23dcd06fa1b422.png     Tracy Debugger for ProcessWire

The ultimate “swiss army knife” debugging and development tool for the ProcessWire CMF/CMS

 

debug-bar-kitchen-sink.thumb.png.605f217a8684498d7c746f4b3e315583.png

 

Integrates and extends Nette's Tracy debugging tool and adds 30+ custom tools designed for effective ProcessWire debugging and lightning fast development

The most comprehensive set of instructions and examples is available at: https://adrianbj.github.io/TracyDebugger

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

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.

  • Like 38
  • Thanks 1

Share this post


Link to post
Share on other sites

Good stuff!  :rolleyes:

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

  • Like 2

Share this post


Link to post
Share on other sites

Many Thanks. This will be a first choice development tool. :)

  • Like 1

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.

  • Like 1

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

  • Like 4

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

  • Like 3

Share this post


Link to post
Share on other sites

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

  • Like 2

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 ;)

  • Like 4

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.

  • Like 1

Share this post


Link to post
Share on other sites

I like the way it works now, thanks!

  • Like 1

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.

  • Like 1

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.

  • Like 1

Share this post


Link to post
Share on other sites

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

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

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

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.

  • Like 1

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 anderson
      Hi all,
      I'm a new to website building. Learned some CRASH course of js,jquery,php. Then I found CMS. Still learning around forum, youtube....
      Anyway, please help me with some beginer questions:
      1, About template - please correct me if I understand wrong : every page should be (or recommended) built on a template. So if in total I'll have 10 pages, 2 of them have same layout, I'll need 9 templates.  And, what fields a page includes, is not defined in page, but defined in the template that page uses. 
      2,  Where to see what modules I've installed? is it in "Modules - Site"? 
      3, I installed "PageTable Extended", then what?  As in a youtube tutorial, it should appear in Setup tab, but it doesn't.  What's in there: templates,fields,logs,comments. (I installed "Uikit 3 site_blog profile".)
      4, I did a search in Processwire website for the famous "repeater matrix" module, and can not find it, there's a Repeater, as well as a Matrix. Is it not a module?
      5, I watched this youtube tuts: https://www.youtube.com/watch?v=IHqnLQy9R1A
      Anybody familiar with this tuts please help: 
      After he analysed a target webpage layout he wanted to mimic, he created some fields, some template, then based on those he created a page and input some "content" in there, then clicked "view", it's just some text. So, here comes my question, he copied a folder "assets" (subfolders are: css,fonts,js,img) over, then the page have the appearance/layout he wanted to mimic. Where does that assets folder come from?
      Appreciate any help.
    • By mtwebit
      I've created a set of modules for importing (manipulating and displaying) data from external resources. A key requirement was to handle large (100k+) number of pages easily.
      Main features
      import data from CSV and XML sources in the background (using Tasker) purge, update or overwrite existing pages using selectors user configurable input <-> field mappings on-the-fly data conversion and composition (e.g. joining CSV columns into a single field) download external resources (files, images) during import handle page references by any (even numeric) fields How it works
      You can upload CSV or XML files to DataSet pages and specify import rules in their description.
      The module imports the content of the file and creates/updates child pages automatically.
      How to use it
      Create a DataSet page that stores the source file. The file's description field specifies how the import should be done:
      After saving the DataSet page an import button should appear below the file description.

      When you start the import the DataSet module creates a task (executed by Tasker) that will import the data in the background.
      You can monitor its execution and check its logs for errors.

      See the module's wiki for more details.
      The module was already used in three projects to import and handle large XML and CSV datasets. It has some rough edges and I'm sure it needs improvement so comments are welcome.
    • By dreerr
      TemplateEnginePug (formally TemplateEngineJade)
       
      This module adds Pug templates to the TemplateEngineFactory. It uses https://github.com/pug-php/pug to render templates.
      doctype html html(lang='en') head meta(http-equiv='content-type', content='text/html; charset=utf-8') title= $page->title link(rel='stylesheet', type='text/css', href=$config->urls->templates . 'styles/main.css') body include header.pug h1= $page->title if $page->editable() p: a(href=$page->editURL) Edit Project on GitHub: github.com/dreerr/TemplateEnginePug
      Project in modules directory: modules.processwire.com/modules/template-engine-pug/
       
      For common problems/features/questions about the Factory, use the TemplateEngineFactory thread.
       
    • By Robin S
      Pages At Bottom
      Keeps selected pages at the bottom of their siblings.
      A "bottom page" will stay at the bottom even if it is drag-sorted to a different location or another page is drag-sorted below it (after Page List is refreshed the bottom page will still be at the bottom).
      Newly added sibling pages will not appear below a bottom page.
      The module also prevents the API methods $pages->sort() and $pages->insertAfter() from affecting the position of bottom pages.
      Note: the module only works when the sort setting for children on the parent page/template is "Manual drag-n-drop".
      Why?
      Because you want some pages to always be at the bottom of their siblings for one reason or another. And someone requested it. 🙂
      Usage
      Install the Pages At Bottom module.
      Select one or more pages to keep at the bottom of their siblings. If you select more than one bottom page per parent then their sort order in the page list will be the same as the sort order in the module config.

       
      https://github.com/Toutouwai/PagesAtBottom
      https://modules.processwire.com/modules/pages-at-bottom/
    • By Robin S
      Another little admin helper module...
      Template Field Widths
      Adds a "Field widths" field to Edit Template that allows you to quickly set the widths of inputfields in the template.

      Why?
      When setting up a new template or trying out different field layouts I find it a bit slow and tedious to have to open each field individually in a modal just to set the width. This module speeds up the process.
      Installation
      Install the Template Field Widths module.
      Config options
      You can set the default presentation of the "Field widths" field to collapsed or open. You can choose Name or Label as the primary identifier shown for the field. The unchosen alternative will become the title attribute shown on hover. You can choose to show the original field width next to the template context field width.  
      https://github.com/Toutouwai/TemplateFieldWidths
      https://modules.processwire.com/modules/template-field-widths/