Jump to content
adrian

Tracy Debugger

Recommended Posts

So the line added to the end of my compiled template files currently looks like:

if(class_exists('TracyDebugger')) {
    TracyDebugger::$templateVars = TracyDebugger::templateVars(get_defined_vars(), \ProcessWire\wire('page'));
}

Does that match what you are currently seeing?

What if you manually add \ProcessWire\ in front of each TracyDebugerr, like this - just do it for one of the compiled template files and load a page with that template - this is just a test for me at the moment to help debug.

if(class_exists('\ProcessWire\TracyDebugger')) {
    \ProcessWire\TracyDebugger::$templateVars = \ProcessWire\TracyDebugger::templateVars(get_defined_vars(), \ProcessWire\wire('page'));
}

I feel like I am going off on a tangent here, but what happens if you also add false to that check, eg:

if(class_exists('\ProcessWire\TracyDebugger', false)) {
    \ProcessWire\TracyDebugger::$templateVars = \ProcessWire\TracyDebugger::templateVars(get_defined_vars(), \ProcessWire\wire('page'));
}

I changed the module line 223 to this:

$event->return = preg_replace('/(\?>)?$/s', '$1', $event->return) . "\n?>\n<?php\nif(class_exists('\ProcessWire\TracyDebugger')) {\n\t\ProcessWire\TracyDebugger::".'$templateVars'." = \ProcessWire\TracyDebugger::templateVars(get_defined_vars(), wire('page'));\n}";
 
And now I don't get the error any more. BUT the variables panel only shows "array()" no real variables from my template.
 
I try to make a clean install in the evening. 
Edited by lpa
  • Like 1

Share this post


Link to post
Share on other sites

And now I don't get the error any more. BUT the variables panel only shows "array()" no real variables from my template.

Ok great - I actually made that change to the module already - I figured that it made sense regardless of whether it worked for you or not - still not sure why it was working as is for me - I am still getting the hang of this namespace stuff :)

Is it possible that your template doesn't have any defined variables? That wouldn't be uncommon in a simple template where you are just outputting PW fields. Try defining a test variable somewhere in the template file, eg.

$test = "this is my test variable";

and let me know if it starts showing up after that.

Btw - thanks for continuing to help debug this - really appreciated :)

Share this post


Link to post
Share on other sites

Is it possible that your template doesn't have any defined variables? That wouldn't be uncommon in a simple template where you are just outputting PW fields. Try defining a test variable somewhere in the template file, eg.

$test = "this is my test variable";

and let me know if it starts showing up after that.

Yes, I have one variable $help defined like this from the Compiled template file:

$help = 'kjlkj';
barDump($content);
timer();

?>
<?php
if(class_exists('\ProcessWire\TracyDebugger')) {
        \ProcessWire\TracyDebugger::$templateVars = \ProcessWire\TracyDebugger::templateVars(get_defined_vars(), \ProcessWire\wire('page'));
}
 
And the $Variables panel shows only: array()
 
Nice to be of some help!
  • Like 1

Share this post


Link to post
Share on other sites

@lpa - the latest version looks for the TracyDebugger class in the global namespace. This now works for me whether or not I specify the PW namespace at the top of my templates, which is what I think you might have been doing. I don't get any errors and the Variables panel is populated correctly. Hopefully it will finally work for you also :)

I have also added a new TracyLogs panel - works like the PW Logs one - very handy I think!

I also changed the config settings to put all the show panel options into one multiple checkbox field, so everyone who is upgrading will find they have to visit the settings to set the status of the panels again.

Share this post


Link to post
Share on other sites

Thanks! No issues here :)

The PW info shows the page title/name/path, parent, etc, but they show only the default language values, even viewing another language. Have you thought about displaying language values instead? I'm not sure if this would be much beneficial, just asking.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks! No issues here :)

The PW info shows the page title/name/path, parent, etc, but they show only the default language values, even viewing another language. Have you thought about displaying language values instead? I'm not sure if this would be much beneficial, just asking.

Thanks for the report that it's working!

I am not a ML user, so I don't think I would be the best person to figure out whether this would be useful, or what the right approach would be. Would it be useful at all to have a dedicated panel for each installed language that could show all sorts of language specific content, or would that just be going overboard ? If you guys brainstorm, I would be happy to implement, or accept a PR :)

Share this post


Link to post
Share on other sites

A new panel would be too much (there's already quite a few of them :)). What I could imagine is a toggle setting in the module to show the default language values or the current language values. Alternatively, adding a button next to the default language values which would show the other language values on click (maybe in a lightbox?). Anyway, I still have to use it for a while to decide its usefulness.

  • Like 1

Share this post


Link to post
Share on other sites

@lpa - the latest version looks for the TracyDebugger class in the global namespace. This now works for me whether or not I specify the PW namespace at the top of my templates, which is what I think you might have been doing. I don't get any errors and the Variables panel is populated correctly. Hopefully it will finally work for you also :)

Yes, it is working now! Thank you for this great module!

  • Like 1

Share this post


Link to post
Share on other sites

That's awesome news @Ipa - I was starting to go a little crazy!

i just committed a new version which adds a "Allow Logging in Production Mode" setting. This restores the default behavior of the core Tracy debug tool. With this checked (the default), Tracy will still run in the background for all users (including guest access) - she will quietly capture and log any errors/warnings/notices/dumps etc to her log files, which of course you can be emailed about, or view via the Tracy Logs panel when you are logged in as a superuser.

Please all take a look at the new option and let me know if you come across any inconsistencies between config setup and actual access.

Thanks again everyone for your help with this!

Share this post


Link to post
Share on other sites

I just wanted to mention how great I think it is to use Horst's ALIF module (https://processwire.com/talk/topic/11666-alif-admin-links-in-frontend/) in conjunction with Tracy.

The user switcher alone makes it invaluable! You'll notice that I disabled the Debug Mode indicator in ALIF because I have one in Tracy.

I have also just added a new option to hide the panel labels which makes the debug bar much more compact and visually appealing:

post-985-0-08260500-1456289019_thumb.png

Here's the version with the panel labels which is the default just so you initially know what's what!

post-985-0-88590800-1456289019_thumb.png

Note that for positioning of ALIF, I am using Bottom, Right, and 23px for the value for Top | Bottom setting.

  • Like 4

Share this post


Link to post
Share on other sites

Wednesday is my designated "Discovery Day" in my development lab, where I set aside time to properly look at third party modules.  I just installed your implementation of the Tracy Debugger.  Thank you for taking the time and effort to make this possible within ProcessWire.  This is a great asset.

  • Like 2

Share this post


Link to post
Share on other sites

Thanks Charles,

I am glad you like it!

It's funny really - I initially didn't expect to spend much time on it - I thought I would just implement it as is, but then kept having more and more ideas - and getting suggestions from lots of you guys (especially @tpr) and it just snowballed :)

  • Like 1

Share this post


Link to post
Share on other sites

I've been reading this post since you put this out and have been constantly smiling each morning.  You have made things very workable for the ProcessWire developer.

Case in point (an example)

post-756-0-35585500-1456325734_thumb.png

  • Like 2

Share this post


Link to post
Share on other sites

For those icons cstevensjr marked "Fantastic!", I would change the hover state, for example scaling up the icons.

The current solution seems more like a bug.

#someID a {
    transition: transform 0.12s;
}

#someID a:hover svg {
    transform: scale(1.4);
}

I guess you got the idea.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks @tpr - great idea. 

That horrible hover background highlighting was a result of the built-in Tracy css. It was on my list of things to tweak, but never got it. 

The latest version has your code in place and also contains a new CPU usage item on the System Info panel. I have submitted a PR to the Tracy project to see if they will include that in their package. I don't really want to have to maintain this addition every time they release an update - hopefully they will include it.

post-985-0-18453200-1456338899_thumb.png

  • Like 1

Share this post


Link to post
Share on other sites

What the CPU measure exactly? Peak? Current? Average?

What it measures is "user time used" (that is what PHP's "getrusage" function returns). We grab the amount of user time on page init() and the again when everything has finished loading and average the usage across this time period. So I guess the short answer is "Average".

  • Like 1

Share this post


Link to post
Share on other sites

Latest version now includes a new Diagnostics /Debug panel.

The diagnostics are currently just filesystem stuff - the idea coming from the excellent ProcessDiagnostics module (http://modules.processwire.com/modules/process-diagnostics/). I just wanted a way of making the filesystem stuff available on the frontend of live sites as a quick and easy way to check if there are any problems. Please help me to test the results this is returning and the logic regarding the Status and Notes - I expect this may not be perfect yet.

I also added Owner (User:Group) and Permission (chmod) info for the template file of the current page to the Template Info section of the ProcessWire panel.

I have moved the Debug section from the PW Info panel into the Debug panel because I thought the PW Info panel was getting too long.

I have renamed a few classes and file includes, so you will probably need to revisit your "Show Panel" settings because some by now be hidden for you initially). The panels are also now orderable.

post-985-0-52233700-1456451194_thumb.png

PS Those results are not my real settings - just playing to get a variety of status and notes entries for you to look at :)

  • Like 5

Share this post


Link to post
Share on other sites

Hi, I just installed the tracy module and have this error on the front:

Fatal error: Call to undefined function posix_getpwuid() in \site\modules\TracyDebugger\ProcesswireInfoPanel.inc on line 172

The tracy toolbar doesn't show up.

I am using PW 2.7.2 with php 5.4.12 and am on windows 7 with a wamp stack, apache 2.4.3 mysql 5.6.10

I looked with google and found that posix_getpwuid() is not available for windows.

Maybe someone can confirm this ?

Share this post


Link to post
Share on other sites

Confirmed...

Seems getenv('USERNAME') could be an alternative to posix_getpwuid() but haven't found an alternative for posix_getgrgid

if function_exists('posix_getpwuid')......blah blah else
$owner = getenv(fileowner($templateFilePath));
Edited by kongondo

Share this post


Link to post
Share on other sites

Same error as @pwired on WAMP / pw-3.0.8 / php-5.5.12.

maybe $group = getenv(filegroup($templateFilePath)); or something can do the trick. It also need to be fixed in DiagnosticsPanel.inc.

Result on WAMP

post-4048-0-09875800-1456492297_thumb.pn

Share this post


Link to post
Share on other sites

Sorry about the Windows issues guys - I'll have a fix shortly.

Btw@flydev - by the look of the panels on your debugger bar, it looks like you haven't revisited the config settings - unless of course you intentionally turned off a couple of them.

Share this post


Link to post
Share on other sites

@adrian :  it was more about the column Owner, the rest is intentional yes.

If I am not dumb, on Windows, we could call stat(), but UID and GID under windows will always be 0, so I assume that the column showing the owner user/group will not work on Wamp.

Share this post


Link to post
Share on other sites

Hi everyone,

The latest version fixes the error on Windows, although I have had to remove the "Owner" details if that function isn't available. Thanks for the suggestion Kongondo, but I think it is more complicated than using "getenv". That allows you to get the current running user - what I need is the username of the ID returned by the "fileowner" function. It also seems that perhaps "fileowner" doesn't even work as expected on Windows: " - http://www.w3schools.com/php/func_filesystem_fileowner.asp

Note: This function doesn't produce meaningful results on Windows systems.

I don't have a Windows dev environment to test, so if there is someone out there who wants to test this and submit a working PR, I'll happily include it.

Please let me know if anyone has any problems with the latest version.

  • Like 2

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.

Guest
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 Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Process refunds and send customer notifications from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory (alpha version only available via GitHub) SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.60
      Composer: rockett/jumplinks
      ⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! 🙂
    • By Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
×
×
  • Create New...