adrian

Tracy Debugger

Recommended Posts

36 minutes ago, rick said:

So basically a stack trace of hooks and their parameters and results. Correct?  Personally, I think this would be great, especially for those of us who have not dove into the hook pool yet.

... Of all hookable methods that are executed. So when you save a page you would see all methods you can hook into in the right order... Save, saveready, saved...

  • Like 2

Share this post


Link to post
Share on other sites

Hi @adrian,

I just created a subdomain (sep pw install) where I installed tracy, but the bar does not show up. In fact, it was running fine on the primary domain, but after installing it, neither site shows the debug bar. When I uninstall it still does not show up on the primary domain even though it is enabled there.

Both sites are:
pw 3.0.62
tracy 4.8.24
php 7.0
maria 10

Other modules (upgrade, profile export) all function on both sites.

There are no errors in apache/pw logs.

Any suggestions where I should look next?

Share this post


Link to post
Share on other sites

Hi @rick - I would start with clearing your browser cache / cookies (at least any related to Tracy), or at least try in a private / incognito window to rule out something along those lines.

Next would be to check that Tracy is actually being loaded - the PW admin Debug Mode Tools > Modules Loaded is probably the easiest place to start.

Also curious about what settings to you - what mode, is superuser force dev turned on, etc.

Share this post


Link to post
Share on other sites

Hi @adrian,

Sorry for the delayed reply. I set superuser force dev and the bar shows up correctly. Didn't tracy look at config->debug before? I don't recall having to set this option. No matter, it works now so all is good. :)

Thanks!

  • Like 1

Share this post


Link to post
Share on other sites
1 minute ago, rick said:

Didn't tracy look at config->debug before?

No the showing of the debug bar has never been linked to PW's debug mode.

I am hoping to start work on redoing the docs in the new year and I will try to better explain how the modes work (local dev vs live) and superuser vs other allowed users. I realize it's not super clear at the moment. The good thing is that it's super conservative about who gets access where.

 

  • Like 1

Share this post


Link to post
Share on other sites

I never really paid any attention to those access permissions before. Oh, the irony of being a tech writer and not RTFM! :blush:

I'm just glad to have this toolbox available again. Kinda feel lost without it.

  • Like 1

Share this post


Link to post
Share on other sites

When I execute a portion of code in the terminal and output the result using BD() it is placed in the Dumps (Ajax) panel, which is fine. However, there is no Clear Dumps option. If I change pages (another admin menu option) and return, all results are now listed in the Dumps Recorder panel, which does have the Clear Dumps option. The Dumps (Ajax) panel is then empty.

Is there a way to add the Clear Dumps option to the Dumps Ajax panel?

  • Like 1

Share this post


Link to post
Share on other sites
10 minutes ago, rick said:

Dumps Recorder panel, which does have the Clear Dumps option

It sounds like you are running an older version of Tracy - the Dumps Recorder hasn't had a "Clear Dumps" option for a while now. Please try the latest version and see if the current behavior works for you. I rarely use the Dumps Recorder anymore - it's really only relevant if you need to compare successive page loads, or you have a bd() in an unusual location that that main Dumps panel (and the ajax and redirect versions) can't pickup - this usually only happens in module or PW core debugging.

Share this post


Link to post
Share on other sites

Okay, I upgrade Tracy from 4.8.23 to 24.

This is the result when executing bd($result); in the console:

tracy-ajax.jpg.1cc5538718d61b8b72de8e575c7f5993.jpg

This is the result when I change pages from the admin menu:

tracy-dumps.jpg.81aa343b90330fa6e65ffc62ea4cfd15.jpg

 

  • Like 1

Share this post


Link to post
Share on other sites

Sorry Rick,

I got confused between the Clear Dumps button and the older "Preserve Dumps" checkbox - my bad!

Back to your issue. I am not sure I fully understand the need. I would suggest leaving the Dumps Recorder disabled unless you really need it for something.

The Dumps (ajax) panel is designed to append new bd() calls so you don't miss any. As soon as you reload the page (or navigate to another page), they should be automatically cleared.

44 minutes ago, rick said:

If I change pages (another admin menu option) and return, all results are now listed in the Dumps Recorder panel, which does have the Clear Dumps option. The Dumps (Ajax) panel is then empty.

I am still a little confused by this - are you trying to prevent the items from the ajax panel ending up in the Dumps Recorder panel? I could potentially add that Clear Dumps button if you really need it, but I would like to know if you are using the Dumps Recorder always - just trying to understand the use case so I can come up with the best solution for you.

On a side note, I almost always use d() calls when using the Console panel. I assume you know about this, but just in case you don't, it is usually a nicer experience.

Share this post


Link to post
Share on other sites

In this particular case, I am testing various parameters of a method in the console and viewing the output in the dumps panel (currently the ajax panel as in the first image). There can be many separate testing results listed in the ajax panel. So I thought there was a means to clear the previous result set before executing another test.

Two things.

1) I have to reload the page, or navigate away, to clear the ajax dumps panel, correct? When I do that, the content of the ajax panel is copied to the recorder panel where I can then clear the result sets. No, I'm not trying to prevent the results in the ajax panel from moving to the recorder panel. I was just looking to clear previous result sets from the ajax panel. The ajax panel is a small panel and not resizeable, and I can have quite a few result sets listed.

2) the d() command displays the raw data appended to the current page, below the footer. It does not display the dump result in any panel that I can find yet. Hence my use of bd(). I could write the results to a log file, but then I have the same problem clearing old data.

I'm not requesting a change to Tracy. I am not sure about the proper procedure, or if I am missing some configuration option. Either way, it is pilot error and not equipment malfunction.

Thanks for your help!

  • Like 1

Share this post


Link to post
Share on other sites
5 minutes ago, rick said:

There can be many separate testing results listed in the ajax panel. So I thought there was a means to clear the previous result set before executing another test.

I think this might be a worthwhile addition. Interestingly, the default behavior for the ajax dumps panel in the Tracy core is actually to clear previous results on each ajax call. I am overriding this because this means you miss consecutive ajax calls (if they happen without user interaction).

7 minutes ago, rick said:

I have to reload the page, or navigate away, to clear the ajax dumps panel, correct?

Yes, currently this is true, but I am thinking of adding the Clear Dumps button for you so this won't be necessary.

8 minutes ago, rick said:

The ajax panel is a small panel and not resizeable

It should automatically increase in height as more items are added to it. Once it hits the height of the viewport, the contents become scrollable.

 

9 minutes ago, rick said:

the d() command displays the raw data appended to the current page, below the footer. It does not display the dump result in any panel that I can find yet. Hence my use of bd(). I could write the results to a log file, but then I have the same problem clearing old data.

If you call d() from a template or other file, yes this is the case, but if you call it from the Console Panel (which is what I thought you were talking about), the output appears below the code in the Console panel - much nicer :)

Share this post


Link to post
Share on other sites
11 minutes ago, adrian said:

If you call d() from a template or other file, yes this is the case, but if you call it from the Console Panel (which is what I thought you were talking about), the output appears below the code in the Console panel - much nicer :)

I am calling d($result) from the console panel. I have a saved snippet that I refer to often. The result is appended to the admin page and doesn't display in any panel I have found.

I would keep the ajax panel functioning as you have overridden. Maybe the manual clear option is best.

The ajax panel does increase vertically. It doesn't appear to stop at the view port top, though. The same with the console panel. I have to clear the result on the console panel for it to resize back down where i can close it. But I am not concerned about that. One pilot error at a time. :)

Edit: We can take this offline to PM if you wish. I hate clogging up this thread with my stuff.

  • Like 1

Share this post


Link to post
Share on other sites
14 minutes ago, rick said:

I am calling d($result) from the console panel. I have a saved snippet that I refer to often. The result is appended to the admin page and doesn't display in any panel I have found.

 

I don't understand this. It should look like this. Can you please confirm you are using like this, and include a screenshot showing where the output appears? Just to check, what browser are you using?

5a4192c9524bc_ScreenShot2017-12-25at4_06_57PM.png.8dca61d2b833728ffb1907bb7cb0c140.png

 

16 minutes ago, rick said:

I would keep the ajax panel functioning as you have overridden. Maybe the manual clear option is best.

Just implementing now - will appear in the next version.

 

16 minutes ago, rick said:

The ajax panel does increase vertically. It doesn't appear to stop at the view port top, though. The same with the console panel. I have to clear the result on the console panel for it to resize back down where i can close it. But I am not concerned about that.

The console panel does have issues - I have a new version I am testing here (to be released shortly) that fixes this. I don't understand why the Dumps panels would not be stopping at the viewport though, but I would like to sort it out if it's happening for you - again maybe we have a browser issue here - what browser/version are you running?

Yes - let's take to PM now :) - I do want to figure out why you are having these issues.

I am going offline for the rest of the day now - so we can pick this up later!

  • Like 2

Share this post


Link to post
Share on other sites

Hi @adrian,

Not a major, but the Console panel layout is a bit messed up when the panel is opened as a window.

2017-12-27_121759.png.506f7e871be345b0ae016d465a36c49c.png

  • Like 1

Share this post


Link to post
Share on other sites
1 hour ago, Robin S said:

Hi @adrian,

Not a major, but the Console panel layout is a bit messed up when the panel is opened as a window.

Thanks Robin,

Please check your PM - a have a major new version in the works (probably released tomorrow) which already fixes this along with Rick's issues. I have sent you a preview to test.

  • Like 3

Share this post


Link to post
Share on other sites

@adrian

Does TD work in init method of autoload module? 

I'm trying to use bd(), but get 

Call to undefined function

 

Share this post


Link to post
Share on other sites
1 minute ago, Zeka said:

@adrian

Does TD work in init method of autoload module? 

I'm trying to use bd(), but get 


Call to undefined function

 

Unfortunately it depends on the load order of the modules. If Tracy is loaded before the module you are trying to debug, then yes it will work. I use it regularly for debugging when developing modules.

Unfortunately, the order that modules are loaded seems to be pretty random (although I haven't looked into this properly). I have put in a request to Ryan to add a way for Tracy to be loaded earlier, but I haven't heard anything on that.

I'll keep it mind to see if there is a solution I can come up with to get it loaded earlier though - it might be possible to include the required files manually in the root index.php or something like that, but it could get messy.

  • Like 1

Share this post


Link to post
Share on other sites

Hi @adrian,

With Tracy Debugger v4.8.24 (occurs in older versions too) on PW 2.7.2 the Console panel gives a JS error when opened.

ace.js:1 Uncaught TypeError: Cannot read property 'match' of undefined
    at a.$detectNewLine (ace.js:1)
    at a.insert (ace.js:1)
    at a.setValue (ace.js:1)
    at b.setValue (ace.js:1)
    at <anonymous>:307:33
    at HTMLScriptElement.script.onreadystatechange.script.onload [as onreadystatechange] (<anonymous>:43:33)

I was able to reproduce this on a clean PW 2.7.2 installation with only Tracy installed.

Share this post


Link to post
Share on other sites
24 minutes ago, Robin S said:

With Tracy Debugger v4.8.24 (occurs in older versions too) on PW 2.7.2 the Console panel gives a JS error when opened.

Thanks for the report. I think I might have actually fixed this error in 4.9 (the closed beta I shared with a few of you last week). Would you mind testing with that version and let me know if the problem still exists. Sorry, I don't have a PW 2.x install at the moment - my dev machine is ridiculously low on space and I cleaned out a lot of unnecessary stuff recently. If it's not fixed, I'll have to get set up with 2.x again.

Share this post


Link to post
Share on other sites
1 hour ago, adrian said:

I think I might have actually fixed this error in 4.9 (the closed beta I shared with a few of you last week). Would you mind testing with that version and let me know if the problem still exists.

The problem exists in 4.9 also unfortunately.

But I think I may have traced the source of the issue. Code reference for 4.8.x but the solution is the same for 4.9.

When localStorage for the editor contents is empty (which is the case the first time the Console panel is opened - I used localStorage.clear() during debugging) the value of Ace editor is set to the PHP $code variable (string). This string needs quotes around it when used as the argument for setValue().

tce.setValue('{$code}');

 

 

Share this post


Link to post
Share on other sites

Thanks @Robin S - appreciate the help, but it's actually not quite that simple - that works on a new install of Tracy before you have ever run any console code, but once you have, those quotes mess things up. I have a fix ready here - I also need to add to the new File Editor and then I'll post in that PM thread for you.

Hopefully I can get that new version released to everyone sometime next week.

Share this post


Link to post
Share on other sites

New dedicated documentation website is up at https://adrianbj.github.io/TracyDebugger

It's very early days still, but finally there is a home for doing a good job on the docs.

It's easy to navigate with a top navbar and sidebar menu and a search term option.

Once I get the key Debug Bar and Configuration settings added, I really want to do a good job on the "Tips" section because I there are a lot of users out there who are a little lost on all the things that can be achieved.

Hopefully lots of updates coming in the next few days!

PS  - if you're more artistic than I am and you hate the logo, please let me know :)

image.thumb.png.57f4c1d376f01a7bcdc38b515839de3a.png

image.thumb.png.80c645437e5d2e0611f45ab36b0f7290.png

  • Like 11

Share this post


Link to post
Share on other sites

Looks nice and handy, thanks!

Don't wanna steal the focus but when I bardump long (bdl) an object, eg. a field, the dump looks like this - the pink text should be above the filename:linenum I guess.

tracy-bd-object.png

  • Like 1

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 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 tpr
      ProcessNetteTester
      Run Nette Tester tests within ProcessWire admin.
      (continued from here)

      Features
      AJAX interface for running Nette Tester tests, in bulk or manually display counter, error message and execution time in a table run all tests at once or launch single tests show formatted test error messages and report PHP syntax errors stop on first failed test (optional) hide passed tests (optional) display failed/total instead passed/total (optional) re-run failed tests only (optional) auto scroll (optional) include or exclude tests based on query parameters start/stop all tests with the spacebar reset one test or all tests (ctrl+click) https://modules.processwire.com/modules/process-nette-tester/
      https://github.com/rolandtoth/ProcessNetteTester
    • 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/RockGrid
      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
       
      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.
       
      Changelog
      180711 bugfix (naming issue) 180630 alpha realease  
      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 tpr
      Update 2018-07-09: ProcessNetteTester module is available in the Modules Directory and on GitHub.

      This is a short tutorial on how to use Nette Tester with ProcessWire.
      As you will see it's very easy to setup and use and it's perfect for testing your code's functionality. With bootstrapping ProcessWire it's also possible to check the rendered markup of pages using the API, checking page properties, etc. It's also a great tool for module developers for writing better code. 
      While there will be nothing extraordinary here that you couldn't find in Tester's docs this can serve as a good starting point.
      Prerequisites: PHP 5.6+
      01 Download Tester
      Go to https://github.com/nette/tester/releases and download the latest release (currently 2.0.2). Download from the link reading "Source code (zip)". You can use composer also if you wish.
      02 Extract Tester files
      Create a new directory in your site root called "tester". Extract the zip downloaded here, so it should look like this:
      /site /tester/src /tester/tools /tester/appveyor.yml /tester/composer.json /tester/contributing.md /tester/license.md /tester/readme.md /wire ... 03 Create directory for test files
      Add a new directory in "/tester" called "tests". Tester recognizes "*.Test.php" and "*.phpt" files in the tests directory, recursively. 
      04 Create your first test
      In the "tests" directory create a new "MyTest.php" file.
      The first test is a very simple one that bootstraps ProcessWire and checks if the Home page name is "Home". This is not the smartest test but will show you the basics.
      Add this to "/tester/tests/MyTest.php":
      <?php namespace ProcessWire; use \Tester\Assert; use \Tester\DomQuery; use \Tester\TestCase; use \Tester\Environment; require __DIR__ . '/../src/bootstrap.php'; // load Tester require __DIR__ . '/../../index.php'; // bootstrap ProcessWire Environment::setup(); class MyTest extends TestCase {     // first test (step 04)     public function testHomeTitle()     {         $expected = 'Home'; // we expect the page title to be "Home"         $actual = wire('pages')->get(1)->title; // check what's the actual title Assert::equal($expected, $actual); // check whether they are equal     }     // second test will go here (step 06)     // third test will go here (step 07) } // run testing methods (new MyTest())->run(); I've added comment placeholders for the second and third tests that we will insert later.
      05 Run Tester
      Tester can be run either from the command line or from the browser. The command line output is more verbose and colored while in the browser it's plain text only (see later).
      Running from the command line
      Navigate to the "/tester" directory in your console and execute this:
      php src/tester.php -C tests This will start "/tester/src/tester.php" and runs test files from the "/tester/tests" directory. The "-C" switch tells Tester to use the system-wide php ini file, that is required here because when bootstrapping ProcessWire you may run into errors (no php.ini file is used by default). You may load another ini file with the "-c <path>" (check the docs).
      If the title of your Home page is "Home" you should see this:

      If it's for example "Cats and Dogs", you should see this:

      Running from the browser
      First we need to create a new PHP file in ProcessWire's root, let's call it "testrunner.php". This is because ProcessWire doesn't allow to run PHP files from its "site" directory.
      The following code runs two test classes and produces a legible output. IRL you should probably iterate through directories to get test files (eg. with glob()), and of course it's better not allow tests go out to production.
      <?php ini_set('html_errors', false); header('Content-type: text/plain'); echo 'Starting tests.' . PHP_EOL; echo '--------------------------' . PHP_EOL; $file = __DIR__ . '/PATH_TO/FirstTest.php'; echo basename($file) . ' '; require $file; echo '[OK]' . PHP_EOL; $file = __DIR__ . '/PATH_TO/SecondTest.php'; echo basename($file) . ' '; require $file; echo '[OK]' . PHP_EOL; echo '--------------------------' . PHP_EOL; echo 'Tests finished.'; exit; Navigate to "DOMAIN/testrunner.php" in your browser to execute the file. If every test succeeds you should get this:

      If there are failed tests the execution stops and you can read the error message. If there were more tests (eg. ThirdTest), those won't be displayed under the failed test.

      06 DOM test
      This test will check if a page with "basic-page" template has a "h1" element. We will create the page on the fly with ProcessWire's API. To keep things simple we will add the new test as a new method to our MyTest class.
      Add this block to the MyTest class:
      public function testBasicPageHeadline() {     $p = new Page();     $p->template = 'basic-page';     $html = $p->render();     $dom = DomQuery::fromHtml($html);     Assert::true($dom->has('h1')); } This will most likely be true but of course you can check for something more specific, for example "div#main". Note that we have used the DomQuery helper here (check the "use" statement on the top of the file).
      07 Custom function test
      You will probably want to make sure your custom functions/methods will work as they should so let's write a test that demonstrates this.
      I don't want to complicate things so I'll check if the built-in "pageName" sanitizer works as expected. Add this to the myTest class:
      public function testPageNameSanitizer() {     $expected = 'hello-world';     $actual = wire('sanitizer')->pageName('Hello world!', true);     Assert::equal($expected, $actual); } This should also be true. Try to change the expected value if you are eager to see a failure message.
       
      08 Next steps
      You can add more methods to the MyTest class or create new files in the "tests" directory. Check out the range of available Assertions and other features in the docs and see how they could help you writing more fail-safe code.
      Once you make a habit of writing tests you'll see how it can assist making your code more bulletproof and stable. Remember: test early, test often 🙂
      If you find out something useful or cool with Tester make sure to share.
    • By bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.
      Description from PW Weekly:
       
      Download & Docs: https://gitlab.com/baumrock/RockPdf
       
      You can combine it easily with RockReplacer: 
      See also a little showcase of the RockPdf module in this thread: