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 Robin S
      Checkbox Reversed
      Modifies InputfieldCheckbox so that it shows the reverse of its true value. The checkbox will be unchecked when the field value is 1 and checked when the field value is not 1.
      Background
      The core FieldtypeCheckbox does not have a setting that allows a checkbox to be checked by default. One reason for this is that only a checked field saves a value to the database. An unchecked field does not save "0" to the database, but rather does not save any value for the field at all. Therefore there is no way to distinguish between a new field that has not yet been saved (and therefore could potentially get a default checked state) and a field that has deliberately been saved as unchecked.
      Because of this you sometimes have to use a checkbox in the opposite way than you would like. Suppose your client has requested a checkbox labelled "Bootylicious" that will be checked by default. This isn't possible with FieldtypeCheckbox so instead you have to convince them that a checkbox labelled "Not bootylicious" that is unchecked by default is just as good. This alternative will achieve the same thing, but it's not ideal.
      A solution
      This module doesn't change the limitations of the core checkbox field, but it provides a workaround that allows you to show the checkbox with the desired default state and label. So in the example above you would still name the field "not_bootylicious" (otherwise it could get confusing in your template files) but you can label the field "Bootylicious" and the checkbox will appear checked when its true value is actually unchecked, and vice versa. This allows new pages to show the checkbox checked by default. Clear as mud?
      Usage
      Install the Checkbox Reversed module.
      For any Checkbox field where you want the inputfield to show the reverse of its true value, activate the "Reverse the checked state of this inputfield?" option in the field settings.

       
      https://github.com/Toutouwai/CheckboxReversed
      http://modules.processwire.com/modules/checkbox-reversed/
    • By louisstephens
      I have been following @bernhard's great tutorial on creating a Dashboard and everything has very easy to understand so far. However, I need to add a select field that a template is using (so users can create a new page from the dashboard), but I am really at a complete lost on how to achieve this. I have been googling, but can't really find anything on the matter.
      $field = $this->modules->get('InputfieldSelect'); $field->name = "Select Manufacturer"; $field->findPagesSelector = "template=basic-page"; //not needed for select field $field->labelFieldName = "title"; $field->name = "Manufacturer Select"; $field->columnWidth = 34; $fieldset->add($field); I have the above code, which was originally an InputfieldPage, but since this is an options field, I have changed it. Has anyone actually gotten a select from a template (and its' values) in a module?
    • By Lex Sanchez
      Video or Social Post Embed
      Based on the TextformatterVideoEmbed module developed by Ryan Cramer, we have added the possibility to embed publications of the main social networks Facebook, Twitter and Instagram.
      ProcessWire Textformatter module that enables translation of YouTube, Vimeo, Instagram, Facebook, Twitter or Issuu URLs to full embed codes, resulting in a viewable video or social post in textarea fields you apply it to.
      How to install
      Download or Clone from Github: https://github.com/lexsanchez/VideoOrSocialPostEmbed
      Copy the VideoOrSocialPostEmbed.module file to your /site/modules/ directory (or place it in /site/modules/VideoOrSocialPostEmbed/).
      Click check for new modules in ProcessWire Admin Modules screen. Click install for the module labeled: "Video or Social Post Embed".
      Now you will be on the module config screen. Please make note of the config options and set as you see fit.
      How to use
      Edit your body field in Setup > Fields (or whatever field(s) you will be placing videos in). On the details tab, find the Text Formatters field and select "Video or Social Post Embed". Save.
      Edit a page using the field you edited and paste in YouTube, Vimeo, Facebook, Twitter, Instagram and/or Issuu URLs each on their own paragraph.
      Example
      How it might look in your editor (like TinyMCE):
      How it works
      This module uses YouTube, Vimeo, Instagram, Facebook, Twitter and Issuu oEmbed services to generate the embed codes populated in your content. After these services are queried the first time, the embed code is cached so that it doesn't need to be pulled again.
      Configuration
      You may want to update the max width and max height settings on the module's configuration screen. You should make these consistent with what is supported by your site design.
      If you change these max width / max height settings you may also want to check the box to clear cache, so that YouTube/Vimeo/Facebook/Twitter/Instagram/Issuu oembed services will generate new embed codes for you.
      Using with Markdown, Textile or other LML
      This text formatter is looking for a YouTube, Vimeo, Instagram, Facebook, Twitter or Issuu video URL surrounded by paragraph tags. As a result, if you are using Markdown or Textile (or something else like it) you want that text formatter to run before this one. That ensures that the expected paragraph tags will be present when VideoOrSocialPostEmbed runs. You can control the order that text formatters are run in by drag/drop sorting in the field editor.
      Copyright 2018 by Ryan Cramer / Updated by Lex Sanchez
    • By kixe
      Email Verification
      This module provides functions to validate email adresses and hosts. The module generates a textfile for blacklisted mailhosts (trashmail), which will be always up to date.
      Download
      https://modules.processwire.com/modules/email-verification/
      API
      // get module $mailcheck = $modules->get('EmailVerification'); // return bool/ string - automatted update of blacklist file $mailcheck->blacklisted(email|domain) // return bool - validate a top level domain, checks against IANA list $mailcheck->validTLD(tld) // return array of punycoded TLDs - cyclic updated, data pulled from IANA $mailcheck->getTLDs(cycle=2592000) // return bool - checks syntax converts to punycode $mailcheck->validDomainName(domain); // return bool - checks punycode encoded syntax $mailcheck->validHostName(host); // return bool - checks syntax and accessibility $mailcheck->validHost(email|domain) // add a single value to blacklist $mailcheck->addToBlacklist(email|domain) USAGE
      $mailcheck = $modules->get('EmailCheck'); $email = 'susi@trashmail.com'; if($mailcheck->blacklisted($email)) echo 'Email Provider not allowed'; if(!$mailcheck->validHost($email)) echo 'Mailhost not available'; Example blacklist file:  blacklist.txt