adrian

Tracy Debugger

Recommended Posts

@gmclelland - I think you're issues should be fixed in the latest version (thanks for PM help with this).

@bernhard - I have modified the behavior of the large/small buttons in the Console panel to be fullscreen/halfscreen. Please take a look and let me know if you think that behavior suits your needs. I am ok with adding it to other panels as well if you think it works well, although obviously some panels would look pretty silly fullscreen :)

As for the z-index issues - I think that's maybe an AOS conflict - @tpr was working on that yesterday. Please let me know if they persist with AOS disabled.

Everyone else - while fixing the issue that @gmclelland was having, I make quite a few changes to the the Field List & Values section of the Request Info panel. It should now generally be even lighter and yet also show more depth of details. It also now shows unformatted and formatted values for each field. There is also a new Image Details column - displaying the thumbnails is optional (check config settings - you may want to disable if you have image fields with lots of images).

image.thumb.png.109622e46c5c87e126e0296843176aa8.png

Please let me know if you have any issues with the new version or ideas for improvements.

 

  • Like 3
  • Thanks 1

Share this post


Link to post
Share on other sites

Great job @adrian!  I'm just confirming that the update did get rid of the error I was seeing.

I like the new enhancements and how the image is displayed.  What do you think about the thumbnail linking to the original file?

  • Like 1

Share this post


Link to post
Share on other sites

That Field Values panel is huge :) I guess it's available for a while but I haven't seen it (probably along with many others) :)

Here is a small tweak that could make such large tables easier to read - sticky table headers:

.tracy-panel th {
  position: sticky;
  top: -13px;
}

sticky-th.thumb.gif.e1db7d6eebd9b5f451270bde23ac25f4.gif

The value -13px is probably a margin issue, and the inverted TH colors are there for better separation.

Of course these sticky headers could be enabled separately for the different panels but I think they won't do any harm when applied globally but maybe I'm wrong.

And Now for Something Completely Different

Rollup panel on double-click on their titles:

doubleclick-toggle.gif.7ae3a62a43c64b1e8b72008efc1eb9bc.gif

This is only quick devtools implementation but if you're interested I can roll down a better one :)

  • Like 5

Share this post


Link to post
Share on other sites
19 minutes ago, gmclelland said:

What do you think about the thumbnail linking to the original file?

Sure, I'll add to the next version.

6 minutes ago, tpr said:

Here is a small tweak that could make such large tables easier to read - sticky table headers

Sounds like a good idea - thanks!

6 minutes ago, tpr said:

Rollup panel on double-click on their titles

I think this looks awesome actually. I was kinda looking for something along these lines, but never really figured out the best approach. I went with the ESC to close all panels, but then there was no way to restore. I was going to add a Tab key option to work like tool panels in Adobe products, but you can't really make use of the tab key like that because it's needed for so many other things. I think what you have here looks like a great option for quickly getting a panel out of the way without closing it. Would appreciate some code whenever you get around to it - thanks!

  • Like 1

Share this post


Link to post
Share on other sites

Of course several unforseen issues came up but most of them are fixed:

  • closing a rolled-up panel and re-activating it from the debug bar opened it in the rolled-up state. To fix, on closing a rolled-up panel "tracy-mode-rollup" class is removed so it opens up in normal state.
  • setting width-height were tricky here and there but seems to be OK now with all the panels I've tried (Chrome only though).
  • "ProcessWire Logs" panel has a link in h1, I've added pointer-events: none in rolled-up state to prevent accidental click on move
  • resized panels were loaded cropped after page reload (if they were rolled up before reload). I've fixed it with a "beforeunload" event to allow Tracy save positions correctly
  • keeping state after page reload: would be nice to have but I think this would be better handled in the core (Nette Tracy)

Changes:

style.css

Lines at the bottom + added "user-select: none" on line 111 for h1

TracyDebugger.module

Lines 823-867 - I haven't found a better place to add the JS part, I thought there's a js file that the module always loads but apparently there isn't.

tracy-rollup.zip

  • Like 3

Share this post


Link to post
Share on other sites

Hey @tpr - thanks for your work on this - I think it's a great addition.

Not sure why, but I had to change max-height for the rolled up version from 39px to 47px, otherwise I got a scrollbar in the header. Does it look OK for you with this change (just committed).

I moved the js into main.js (which is new) as a place to load all general JS (that doesn't need injected PHP vars).

The last version also includes some z-index fixes (introduced recently in the Tracy core), your sticky table header, and I added the fullscreen/halfscreen button to a couple of other panels that I thought could benefit from it. Also added @gmclelland's idea of linking to fullsize version of image. In the PW admin this opens in a modal, but just same page in frontend.

Thanks again!

  • Like 4

Share this post


Link to post
Share on other sites

Thanks, works fine here. The 47px vs 39px issue may come from a box-sizing border-box/content-box issue, perhaps my frontend CSS was interfering somehow. If so, .tracy-panels should get box-sizing: border-box in Tracy.

Sticky table headers are working fine too, thanks.

What do you think about making the panel headers a bit smaller? I feel they are a bit too large, a  slightly slower font and less padding wouldn't hurt imho.

  • Like 1

Share this post


Link to post
Share on other sites
4 minutes ago, tpr said:

What do you think about making the panel headers a bit smaller? I feel they are a bit too large, a  slightly slower font and less padding wouldn't hurt imho.

+1 :) I am all for slim GUI for development tools...

  • Like 1

Share this post


Link to post
Share on other sites
19 hours ago, adrian said:

I have modified the behavior of the large/small buttons in the Console panel to be fullscreen/halfscreen. Please take a look and let me know if you think that behavior suits your needs. I am ok with adding it to other panels as well if you think it works well, although obviously some panels would look pretty silly fullscreen :)

awesome! this helps a lot, thanks :)

  • Like 2

Share this post


Link to post
Share on other sites
7 hours ago, tpr said:

What do you think about making the panel headers a bit smaller? I feel they are a bit too large, a  slightly slower font and less padding wouldn't hurt imho.

Sounds good, now what about the border width: 4, 3, 2, or 1?

I am thinking 2 or 3

image.png.7967a1e4819ae6a74498c886282e546c.png

image.png.63604391f7f82ea949b59c823c85d721.png

image.png.14eebb87bf57562df47384d6fa5f156c.png

image.png.5c21c83e0e942f950d2bf9405d1725d3.png

 

 

  • Like 1

Share this post


Link to post
Share on other sites

Yepp, the border is a bit thick now. I'm fine with v4 if you think panels doesn't merge too much with the rest of the site.

One thing though: the icon positions need to be adjusted (before the title and the window/close icons too) + the newly added rollup state needs adjustments too.

  • Like 1

Share this post


Link to post
Share on other sites

Hey @adrian,

what do you think of adding a check if debugInfo is available for the requested object and if not, set it to "false" automatically?

I'm working on my RockFinder module and wanted to debug my subclass. This was the result:

5ad47946b6454_2018-04-1612_20_18-ModulesProcessWirerockfinder_test.png.e0267c434c3d6fd07fd3e84078647597.png

Switching "debugInfo" to false I get this:

5ad4794a17156_2018-04-1612_19_43-ModulesProcessWirerockfinder_test.png.f8c096810386a145bf0df467a3f2bab1.png

Which is of course much more helpful. Luckily I remembered about that because we were talking about it here, but if someone missed that it could be quite hard to find out what is going on and why the information does not show up...

Also it is quite annoying to always set ['debugInfo' => false] for every quick d($myobject)

  • Like 1

Share this post


Link to post
Share on other sites

Hey @bernhard - I think it should already work that way:

image.png.9513aad49d69547b4adb94cd8f792e40.png

So I am wondering if it's due to your class extending a PW class that does implement __debugInfo()

Could you please let me know what you trying to dump in your module so I can reproduce what you are seeing. 

  • Like 1

Share this post


Link to post
Share on other sites

Ok, thx. My class is indeed extending Wire... Maybe there is a possibility to check for the number of properties the debugInfo object returns and in case it is 0 it falls back to the original object dump?

Share this post


Link to post
Share on other sites
2 minutes ago, bernhard said:

Ok, thx. My class is indeed extending Wire... Maybe there is a possibility to check for the number of properties the debugInfo object returns and in case it is 0 it falls back to the original object dump?

Maybe - I'll see what can be done, but to make it a little easier, can you let me know what variable in RockSqlFinder you are dumping, and where?

  • Like 1

Share this post


Link to post
Share on other sites

I'm doing a complete rewrite (again :P ). What I have so far is this:

<?php namespace ProcessWire;
class RockFinderField extends Wire {

  private $name; // name of the final object property
  private $field; // name of the field to query
  private $closure = null; // closure to calc value

  /**
   * constructor
   */
  public function __construct($name, $field) {
    // set the final column name for this field
    if(is_string($name)) $this->name = $name;
    else $this->name = $field;

    // check the field type
    if(is_callable($field) AND !is_string($field)) {
      $this->closure = $field;
    }
    else {
      $this->field = $field;
    }
  }
}

And in the module I do this:

foreach($fields as $key => $value) $this->fields[] = new RockFinderField($key, $value);
bd($this->fields);

 

Share this post


Link to post
Share on other sites

@bernhard - I have a temporary solution for you. Replace https://github.com/adrianbj/TracyDebugger/blob/93fe130026244fe727e5553b82183a85b78e2c9f/tracy-master/src/Tracy/Dumper.php#L460

with:

return count((array) $obj->__debugInfo()) ? $obj->__debugInfo() : (array) $obj;

There are other ways this could be achieved, but since this is modifying the Tracy core, I am going to ask them what they think is the best approach.

Let me know if it works as expected for you.

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

thx, this works :) looking forward to hearing their feedback!

  • Like 1

Share this post


Link to post
Share on other sites

@adrian Morning,

I've been having a hard time with the panels since you introduced the "resize feature". I use AOS with sticky header enabled in Reno. The panels keep moving under Reno's sticky header, making it impossible to move them anywhere, as the head of the panel is "covered" by the admin's header.

There are various occasions when this happens but here is a frequent example: I use bd() and click on the arrow to expand an object with a long list. The panel expands too, moving its head under the sticky header of Reno. BTW: I'm currently running AOS 1.9.0 and Tracy 4.10.18, so these are the latest.

Before you introduced the "resize feature" I had never had such issues. Is there anything that can be done? Maybe @tpr can do something? :)

See image:

Spoiler

tray-panel-under-sticky-header.thumb.png.502cc28a93633850550d6182a2387ea2.png

 

Share this post


Link to post
Share on other sites

Hey @szabesz - I can reproduce, but it's fine with the default and Uikit themes with sticky headers so I think it's something that @tpr might need to fix. I know he made some recent changes on this front so maybe those changes need to be applied to the reno sticky header as well?

  • Like 1

Share this post


Link to post
Share on other sites

Thanks Adrian, let's wait for Roland. In the meantime I figured that making the browser window narrow removes the sticky header ("mobile view"), and I can at least drag the panel this way.

Share this post


Link to post
Share on other sites

I haven't found a way to make all the z-indexes work nicely together. I could add #tracy-debug { z-index: 100000; } or so when sticky headers are enabled in AOS but that would make menu dropdowns and such overlapped by Tracy panels.

Share this post


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

I haven't found a way to make all the z-indexes work nicely together. I could add #tracy-debug { z-index: 100000; } or so when sticky headers are enabled in AOS but that would make menu dropdowns and such overlapped by Tracy panels.

But sticky headers are working fine with Tracy panels in the default and UiKit themes. Is there something different about the reno sticky header that you can't change to be like the other two?

Share this post


Link to post
Share on other sites

There are lot more elements in Reno, including the sidebar and many header elements. Setting #wrap { z-index: 0 } also solves the panel issue but still the panels are above menus.

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

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

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

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