adrian

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

@adrian

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

5a9947a7632dc_2018-03-0214_43_37.thumb.png.b57fa3a7185e10aea81a633ee47ced77.png

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

Why are they handled in different ways? 

Thanks. 

 

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:

https://github.com/ryancramerdesign/MarkupLoadRSS/blob/16e735b9ccc015eb36814689f862c007bff935a9/MarkupLoadRSS.module#L207

with:

    protected $items = array();

and this function:

https://github.com/ryancramerdesign/MarkupLoadRSS/blob/16e735b9ccc015eb36814689f862c007bff935a9/MarkupLoadRSS.module#L428-L430

with:

    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?

image.thumb.png.99a1ba0868adcd1370e9067f1afbce21.png

 

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.

image.thumb.png.ab677801676b9532b948e4b878f2bf70.png

  • 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.

Gideon

 

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.

Gideon

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.

 console.gif.1f09b4f49ebfe55e4ac4727bab695c91.gif

  • 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 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!
    • By kongondo
      Sites Manager
       
      16 September 2018:
      FOR NOW, PLEASE DO NOT USE THIS MODULE IN A PRODUCTION SITE. A  RECENT ProcessWire UPDATE HAS BROKEN THE MODULE. I AM WORKING ON A FIX.
       
      ################
       
      Sites Manager is a module for ProcessWire that allows Superusers to easily create/install ProcessWire sites on the same serverspace the module is running in. Only Superusers can use the module. You can create both stand-alone and multi-sites.
       
      Single/Stand-alone Sites
      Stand-alone or single-sites are sites that will run in their own document root/directory with their own wire and site folders, .htaccess, index.php, etc. In other words, a normal ProcessWire site.
      Multiple Sites
      Multi-sites are sites that will run off one wire folder (shared amongst two or more sites) each having their own site folder and database. In this regard, it is important to note that Sites Manager is not in itself a multiple sites solution! Rather, it is a utility that helps you create multi-sites to be run using the ProcessWire core multiple sites feature. For more on this core feature, see the official ProcessWire documentation, specifically the solution referred to as Option #1.
      Option #1 approach requires the site admin to initially install ProcessWire in a temporary directory for each new site. The directory then needs to be renamed as site-xxx, where ‘xxx’ is any name you want to use to differentiate the installation from other sites, before it is moved to the webroot. For instance, site-mysite, site-another, site-whatever. In addition, the /wire/index.config.php file must be copied/moved to the webroot. Each time a site is added, the index.config.php has to be edited to add ‘domain’ => ‘site-directory’ key=>value pairs for the site. This process can become a bit tedious. This module aims to automate the whole multi-site site creation process.
      The module is based off the official ProcessWire installer. Creating a site is as simple as completing and submitting a single form! You also have the option to type and paste values or reuse a pre-defined install configuration.
       
      The module will:
      Install a ProcessWire site in your named directory, applying chmod values as specified
      Move the directory to your webroot
      Update/Create a Superuser account as per the submitted form, including setting the desired admin theme and colour
      For multi sites, update sites.json (used by index.config.php to get array of installed sites)
       
      For multi sites, the only difference in relation to the core multi-sites index.config.php is that this file is slightly different from the one that ships with ProcessWire.
      Download from GitHub: Sites Manager (Beta Release)
      Features
      Install unlimited number of sites in one (multi-sites) or independent (single-site) ProcessWire installs. Install by completing a Form, Typing or pasting in configurations or using pre-created install configurations. Choose an Admin Theme to auto-install along with the site installation. For single-sites installation, download, save and reuse ProcessWire versions of your choice. Install and maintain site profiles for reuse to create other sites. Create install configurations to speed up installation tasks. Client and server-side validation of site creation values. Edit uploaded profiles (e.g., replace profile file). Lock installed sites, configurations and profiles to prevent editing. Bulk delete items such as site profiles, installed site directories and/or databases (confirmation required for latter two). View important site details (admin login, chmod, etc). Links to installed sites home and admin pages. Timezones auto-complete/-suggest. Pre-requisites, Installation & Usage
      Please see the documentation.
      Technicalities/Issues
      Only Superusers can use the module.
      ProcessWire 2.7 - 3.x compatible
      Currently using ProcessWire 2.7 installer (install.php)
      For multi-sites, potential race condition when sites.json is being updated on a new site install vs. index.config.php accessing the json file?
      Not tested with sub-directory installs (for instance localhost/pw/my-site-here/)
      Currently not doing the extra/experimental database stuff (database charset and engine)
      Future Possibilities
      Install specified modules along with the ProcessWire install
      Profile previews?
      Credits
      @ryan: for the ProcessWire installer
      @abdus: for the index.config.php reading from JSON idea
      @swampmusic: for the challenge
      Video Demo
      Demo  showing how quick module works on a remote server [YMMV!]. Video shows downloading and processing two versions of ProcessWire (~takes 7 seconds) and installing a single/stand-alone ProcessWire 3 site using the new Admin Theme UI Kit (~2 seconds) on a remote server.
       
      Screens
      1

      2

       
       
    • By Robin S
      Breadcrumb Dropdowns
      Adds dropdown menus of page edit links to the breadcrumbs in Page Edit.

      Installation
      Install the Breadcrumb Dropdowns module. The module requires ProcessWire >= v3.0.83 and AdminThemeUikit.
      There is a checkbox option in the module config that determines if the breadcrumb dropdowns will include pages that the user does not have permission to edit.
      Features/details
      The module adds an additional breadcrumb item at the end for the currently edited page. That's because I think it's more intuitive for the dropdown under each breadcrumb item to show the item's sibling pages rather than the item's child pages. In the dropdown menus the current page and the current page's parents are highlighted in a crimson colour to make it easier to quickly locate them in case you want to edit the next or previous sibling page. Unpublished and hidden pages are indicated in the dropdowns with similar styling to that used in Page List. If the option to include uneditable pages is selected then those pages are indicated by italics with a reduced text opacity and the "not-allowed" cursor is shown on hover. There is a limit of 25 pages per dropdown for performance reasons and to avoid the dropdown becoming unwieldy. If the current user is allowed to add new pages under the parent page an "Add New" link is shown at the bottom of the breadcrumb dropdown. If the currently edited page has children or the user may add children, a caret at the end of the breadcrumbs reveals a dropdown of up to the first 25 children and/or an "Add New" link. Overriding the listed siblings for a page
      If you want to override the siblings that are listed in the dropdowns you can hook the BreadcrumbDropdowns::getSiblingsmethod and change the returned PageArray. For most use cases this won't be necessary.
      Incompatibilities
      This module replaces the AdminThemeUikit::renderBreadcrumbs method so will potentially be incompatible with other modules that hook the same method.
       
      https://modules.processwire.com/modules/breadcrumb-dropdowns/
      https://github.com/Toutouwai/BreadcrumbDropdowns
    • 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
      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 Ken Muldrew
      I'm trying to get a short routine to run once per day that will look at some pages and send a reminder email when that customer's subscription (yearly) is about to expire. When I run the code in a template then it works without issue, but inside my lazycron service routine, I get an "Error: Uncaught Error: Call to a member function get() on null" as if the database cannot be found. My autoload module is just the sample HelloWorld module included with ProcessWire, editted to perform this task. The whole of it is included below (I've stripped out the code that generates the email because it never gets past $pages->find):
       
      <?php namespace ProcessWire;
      /**
       * ProcessWire 'LazyCronLoad'  module
       *
       */
      class LazyCronLoad extends WireData implements Module {
          public static function getModuleInfo() {
              return array(
                  'title' => 'LazyCronLoad', 
                  'version' => 1, 
                  'summary' => 'Just loads a lazy cron callback.',
                  'singular' => true, 
                  'autoload' => true, 
                  );
          }
          public function init() {
              // initialize the hook in the AutoLoad module
              $this->addHook('LazyCron::everyDay', $this, 'myHook');
              
          }
          public function myHook(HookEvent $e) {
              // called once per day
              wire('log')->save('user_activities',' lazy cron service routine');
                  $transport_pages = $pages->find("template=aggregate-entry, aggregate_type.title='Transport'");
                  foreach ($transport_pages as $page) {
                      if (($page->purchase_date + 30325800 < time()) && ($page->purchase_date + 30412600 > time())) { // between 351 and 352 days
                          wire('log')->save('user_activities', $page->id . ' email reminder sent');
                          // send email
                  }
              }
          }        
          
      }
      The first wire('log') shows up but the second one doesn't (the purchase_date condition is met (as demonstrated by running the code in a template close in time to when the lazycron routine executes)). The error log gives the Uncaught Error shown above. 
      I think this is a beginner's mistake with something obvious being missed and would be grateful for any assistance in fixing it.