Jump to content

Tracy Debugger

Recommended Posts

Hey @Zeka - I have a fix for you, although I think you'll have to do it in your module - I haven't figured out how to do it from the Tracy side yet.

Add this to the top of your TemplateFile::render hook:

    if(strpos($event->object->filename, 'TracyDebugger') !== false) return;

I haven't had a good look (too busy atm), but if someone else has an idea on how Tracy could remove/cancel a TemplateFile::render hook when running code via Console/Snippet Runner I'd be happy to do it from Tracy's side instead.

PS - here's another possible option instead of the above:

    if(str_replace('site/assets/cache/FileCompiler/', '', $event->object->filename) !== $this->wire('page')->template->filename) return;

This will ignore your hook if the template file from the hook event is different to the template file for the current page. I am not sure about this in your situation, but if it works it's obviously more flexible than just blocking Tracy template files.

Share this post

Link to post
Share on other sites


Quite a noob question about WireExceptions. 

Have two exceptions ( output of PW logs) :

exceptions 2018‑03‑02 15:34:22 | admin | http://test.local:4000/shop/Method | TemplaterLayout::render does not exist or is not callable in this context (in D:\laragon\www\test\app\wire\core\Wire.php line 519) 

modules | 2018‑03‑02 15:31:10 | admin |http://test.local:4000/shop/ | Failed to ready module: Templater - Method TemplaterLayout::setTemplateFile does not exist or is not callable in this context

The first one generates full report like


The second one is only visible in PW logs panel without full report.

Why are they handled in different ways? 



Share this post

Link to post
Share on other sites

Hi @Zeka

I am not totally sure about why, but from what I can tell errors that show up in PW logs, but are not picked up by Tracy because the error is triggered in PW before Tracy is loaded. I have asked @ryan about adding a special method to allow loading Tracy earlier - he initially sounded supportive, but he hasn't gotten back to me since my follow up request. I think it's  only ever a problem when doing something in init() so it doesn't happen that often.

How did you go with those snippets to fix the Console panel problem?

Share this post

Link to post
Share on other sites

@adrian Do you have a future request on git, so I can support it? 

As for Console panel, both of your snippets didn't work. I have sent you a PM. 

Share this post

Link to post
Share on other sites
8 minutes ago, Zeka said:

Do you have a future request on git, so I can support it? 

No - it was a PM that I sent to Ryan - I didn't want to bug him about it publicly. I just tried to add you to the PM, but it said you couldn't be added - not sure, I haven't used that feature before.

Thanks for the module link - I'll take a look.

Share this post

Link to post
Share on other sites

Hi @adrian, just wondering if Tracy should create the "tracy-debugger" permission on install to save the user creating it manually? 

Share this post

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

Hi @adrian, just wondering if Tracy should create the "tracy-debugger" permission on install to save the user creating it manually? 

Only reason I didn't do this for Tracy is that I doubt many people use this option - just figured it was one extra permission to clog up the list that perhaps only a very small percentage of users will actually apply to a role in their system.

Does that seem fair enough? Or are lots of you actually using to to give Tracy access to non-superusers? If so, I can add to the install routine.

  • Like 1

Share this post

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

Does that seem fair enough? Or are lots of you actually using to to give Tracy access to non-superusers?

Yes, that's fair enough. I don't give anyone but myself access to Tracy, but need it sometimes when testing from non-superuser roles on a live server. But not all that regularly, and it doesn't take long to create the permission manually.

Share this post

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

need it sometimes when testing from non-superuser roles on a live server

That's what the User Switcher panel is for :) Have you tried it out?

  • Like 2

Share this post

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

Have you tried it out?

Yes I have tried it out... just now :grin:. Works great, thanks.

  • Like 1

Share this post

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

Yes I have tried it out... just now :grin:. Works great, thanks.

You can even test as a guest user by clicking the Logout button and the debug bar will still display.

  • Like 1

Share this post

Link to post
Share on other sites

Hi @adrian,

I just installed the MarkupLoadRSS module and all kinds of stuff started happening with Tracy. :D

First, I noticed that I can't place the mouse in the snippet name field. As soon as you click in the text box the cursor is immediately placed back in the console window. This is fresh PW.94 localhost install and Tracy.25 is the only other module installed.

Second, I now get the following:

Exception: Objects returned by MarkupLoadRSS::getIterator() must be traversable or implement interface Iterator in /var/www/tgp/site/assets/cache/FileCompiler/site/modules/TracyDebugger/panels/RequestInfoPanel.php:181
Stack trace:
#0 /var/www/tgp/site/assets/cache/FileCompiler/site/modules/TracyDebugger/tracy-master/src/Tracy/Bar.php(159): RequestInfoPanel->getPanel()

Lastly, I cannot scroll the results pane horizontally. There is no scroll bar.

I have uninstalled the rss module, shutdown pw, and restarted... the behavior is consistent. So I am not sure whether this was present before I installed the rss module.

I am not sure if this is related, but on another localhost development site (never had rss module installed), I upgraded Tracy from .23 to .25 and got this error:

Failed to init module: TracyDebugger - Tracy\Debugger::dispatch() called after some output has been sent. Output started at /.../wire/core/FileCompiler.php:980

And the behavior is identical as seen with the other localhost site.


Edit: Additional Info...

I am not able to select any text from within the results pane. It behaves as if some selection is already in progress. When attempting to make a selection, either by mouse or keyboard, the selection starts at the very beginning of the results pane content and selects wherever the mouse or keyboard control was initiated. I have seen something like this before quite a while back. If I remember correctly it was a JS issue. I do not remember how it was resolved.

Share this post

Link to post
Share on other sites

Hey @rick - sorry you've hard a bad run with Tracy here.

1) I believe the issue with MarkupRSSLoad to be a bug in that module. Replace this line:



    protected $items = array();

and this function:



    public function getIterator() {
        return new ArrayObject($this->items);

If that works and you find the module still works as expected, perhaps you could post an issue for Ryan on that module's github page.


2) As for the snippet name field in the Console panel - that is fixed in the latest version just committed.

3) I am getting a horizontal scrollbar in the Console panel here. Maybe there is some specific I am not doing to reproduce - can you provide more details?



4) I have seen the "Failed to init module: TracyDebugger - Tracy\Debugger::dispatch()" error a few times - it can happen when some error is output to the browser before Tracy is called. I am keeping my eye on this to see if it's something that can be fixed, but not sure it can. Let me know if you continue to see it on a regular basis and if something specific triggers it.


5) I can select text from the results pane, but maybe I just fixed that at the same time I fixed the snippet name focus issue. Let me know if you still have problems with this.


  • Like 1

Share this post

Link to post
Share on other sites

Hi @adrian,

I haven't had a bad run with Tracy at all. On the contrary, I nominate Tracy for module of the year. And you have done an excellent job of maintaining this indispensable tool.

I've made the changes to the rss module. I don't see anything crop up yet. Thanks for those.

Upgraded to Tracy.26 on both local installs and all is functioning well.

I appreciate your time and help!

  • Like 3

Share this post

Link to post
Share on other sites

A couple of tweaks today.

1) The "Template Info" section in Request Info panel now properly shows the data for the template being edited when you are editing the settings for a template in the admin.

2) The User Switcher now has an option to limit the list of available users by restricted roles. I had a site where I was using the Users system to store details for frontend members so the list was ridiculously long. Now I can exclude that member role to keep the list concise and easy to use.

  • Like 3

Share this post

Link to post
Share on other sites
17 minutes ago, Gideon So said:

@adrian How can I debug a module?? I get bd() is undefined error.



Most of the time you can debug modules just fine - it all depends on the load order of things. I have asked Ryan via PM if he'd consider a special hook so that Tracy can be loaded earlier so that it's always available for all modules.

Perhaps we need a Github feature request for this?

Maybe it should come from someone other than me?

  • Like 1

Share this post

Link to post
Share on other sites
Just now, Gideon So said:

@adrian Let me add that and see how @ryan response to it.


Maybe post a link here so others coming across this can go give it a thumbs up!

  • Like 2

Share this post

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

@adrian Here you are. Please take a look. I am not sure I put it well enough.


Thanks for that - I have commented on your request and also provided a very simple hack this get it working right now by including the tracy core file in the index.php at the root of your site. It seems to work brilliantly - great for debugging PW core files even.

Would be great if others could add their +1 to this please!

  • Like 1

Share this post

Link to post
Share on other sites

Is there an easy way to enable/disable Tracy debugger via API? As I am still on my way to create test with PHPUnit it would be awesome if there's an easy way (ideally via config.php) to disable tracy if it's called from the phpunit testing scripts.


  • Like 1

Share this post

Link to post
Share on other sites
11 hours ago, chrizz said:

Is there an easy way to enable/disable Tracy debugger via API? 

There is now :)

$config->tracyDisabled = true;


  • Like 4
  • Thanks 1

Share this post

Link to post
Share on other sites

Hi @adrian,

I'm seeing an issue in the Console panel where the indentation (tabs) of saved snippets gets lost when the page is reloaded. In the screen capture below I save the snippet with the correct indentation and I can load that snippet again okay until I reload the page. After that the snippet doesn't load with the correct indentation.


  • Like 1

Share this post

Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
      Here are Ryans announcement.

      Current Version 0.4.1
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.

      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; } Following are a ...

      List of all options and features

      testConnection () - returns true on success, false on failures

      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)

      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here

      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification

      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename

      send () - send the message(s) and return number of successful sent messages

      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,

      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      // Add your custom path inside ready or init function, didn't tested outside Mystique::add('your-configs-path'); All config files need to return a php array like examples.
      Same as ProcessWire Inputfield Api, only difference is set and showIf usage
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
    • By Robin S
      File Info
      A textformatter module for ProcessWire. The module can add information to local Pagefile links in two ways:
      As extra markup before, within or after the link As data attributes on the link (handy if you want to use a Javascript tooltip library, for instance) Screenshots
      Module config

      Example of output

      Install the File Info module.
      Add the textformatter to one or more CKEditor fields.
      Add markup action (and general)
      Select "Add markup to links" Select the Pagefile attributes that will be retrieved. The attribute "filesizeStrCustom" is similar to the core "filesizeStr" attribute but allows for setting a custom number of decimal places. If you select the "modified" or "created" attributes then you can define a date format for the value. Enter a class string to add to the links if needed. Define the markup that will be added to the links. Surround Pagefile attribute names in {brackets}. Attributes must be selected in the "Pagefile attributes" section in order to be available in the added markup. If you want include a space character at the start or end of the markup then you'll need >= PW 3.0.128. Select where the markup should be added: prepended or appended within the link, before the link, or after the link. Add data attributes action
      Select "Add data attributes to links" Select the Pagefile attributes that will be retrieved. These attributes will be added to the file links as data attributes. Attributes with camelcase names will be converted to data attribute names that are all lowercase, i.e. filesizeStrCustom becomes data-filesizestrcustom. Hook
      If you want to customise or add to the attributes that are retrieved from the Pagefile you can hook TextformatterFileInfo::getFileAttributes(). For example:
      $wire->addHookAfter('TextformatterFileInfo::getFileAttributes', function(HookEvent $event) { $pagefile = $event->arguments(0); $page = $event->arguments(1); $field = $event->arguments(2); $attributes = $event->return; // Add a new attribute $attributes['sizeNote'] = $pagefile->filesize > 10000000 ? 'This file is pretty big' : 'This file is not so big'; $event->return = $attributes; });  
    • By Robin S
      Access By Query String
      Grant/deny access to pages according to query string.
      Allows visitors to view protected pages by accessing the page via a special URL containing an "access" GET variable. This allows you to provide a link to selected individuals while keeping the page(s) non-viewable to the public and search engines. The recipients of the link do not need to log in so it's very convenient for them.
      The view protection does not provide a high level of security so should only be used for non-critical scenarios. The purpose of the module was to prevent new websites being publicly accessible before they are officially launched, hence the default message in the module config. But it could be used for selected pages on existing websites also.
      Once a visitor has successfully accessed a protected page via the GET variable then they can view any other page protected by the same access rule without needing the GET variable for that browsing session.
      Superusers are not affected by the module.
      Install the Access By Query String module.
      Define access rules in the format [GET variable]??[selector], one per line.
      As an example the rule...
      rumpelstiltskin??template=skills, title~=gold ...means that any pages using the "skills" template with the word "gold" in the title will not be viewable unless it is accessed with ?access=rumpelstiltskin in the URL. So you could provide a view link like https://domain.com/skills/spin-straw-into-gold/?access=rumpelstiltskin to selected individuals.
      Or you could limit view access to the whole frontend with a rule like...
      4fU4ns7ZWXar??template!=admin You can choose what happens when a protected page is visited without the required GET variable:
      Replace the rendered markup Throw a 404 exception If replacing the rendered markup you can define a meta title and message to be shown. Or if you want to use more advanced markup you can hook AccessByQueryString::replacementMarkup().
      $wire->addHookAfter('AccessByQueryString::replacementMarkup', function(HookEvent $event) { // Some info in hook arguments if needed... // The page that the visitor is trying to access $page = $event->arguments(0); // An array of access keys that apply to the page $access_keys = $event->arguments(1); // The title $title = $event->arguments(2); // The message $message = $event->arguments(3); // Return some markup $event->return = 'Your markup'; }); Screenshot

    • By David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate a repeater item from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Changelog
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: – soon –
  • Create New...