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 37

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 Mike Rockett
      As I mentioned in this issue, I've create a new textformatter for ParsedownExtraPlugin, which adds some oomph to your markdown.
      Repo: Parsedown Extra Plugin
      Unlike the built-in textformatter for Parsedown and Parsedown Extra, this should be used when you want to use Extra with additional configuration/customisation.
      Some examples:
      ### Test {.heading} - A [external link](https://google.com/){.google} with `google` as a class that opens in a new tab if the config property is set. - [Another link](/page){target=_blank} that opens in a new tab even though it isn't external. ```html .html <p>Test</p> ``` There's some config options available to you, such as setting attributes on all/external images and links, setting table and table-cell alignment classes, adjusting footnote classes and IDs, adding <code> attributes to their parent <pre> elements, and changing the <code> class if your syntax highlighter does not use language-*.
      I was thinking about adding the ability to make links open in a new tab by appending a plus to the link syntax, but only external links should be opening in a new tab anyway. Further, this would add extra, unnecessary processing time.
      Please let me know if you bump into any problems. ☺️
    • By Mike Rockett
      TextformatterTypographer (0.4.0 Beta)
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      Learn more on my blog
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
      Please do test it out and let me know what you think.
      Also note that I have indicated support for PW 2.8, but I haven't tested there as yet. This was built on PW 3.0.42/62.
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.50
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! 
    • By bernhard
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support for 60€ per hour (excl vat).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By thomasaull
      Some time ago I created a site profile for creation of a REST API with ProcessWire. Since I kept struggeling with updating stuff between different projects which use this, I decided to convert it into a module. It is now ready for testing: https://github.com/thomasaull/RestApi
      Additionally I added a few small features:
      automatic creation of JWT Secret at module install routes can be flagged as auth: false, which makes them publicly accessible even though JWT Auth is activated in module settings To check things out, download and install the module and check the folder /site/api for examples.
      If you find any bugs or can think of improvements, please let me know!