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

Please do use the forum's ability to wrap code snippets in code blocks instead of posting it as raw text.

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

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 MoritzLost
      This module allows you to integrate hCaptcha bot / spam protection into ProcessWire forms. hCaptcha is a great alternative to Google ReCaptcha, especially if you are in the EU and need to comply with privacy regulations.

      The development of this module is sponsored by schwarzdesign.
      The module is built as an Inputfield, allowing you to integrate it into any ProcessWire form you want. It's primarily intended for frontend forms and can be added to Form Builder forms for automatic spam protection. There's a step-by-step guide for adding the hCaptcha widget to Form Builder forms in the README, as well as instructions for API usage.
      Features
      Inputfield that displays an hCaptcha widget in ProcessWire forms. The inputfield verifies the hCaptcha response upon submission, and adds a field error if it is invalid. All hCaptcha configuration options for the widget (theme, display size etc) can be changed through the inputfield configuration, as well as programmatically. hCaptcha script options can be changed through a hook. Error messages can be translated through ProcessWire's site translations. hCaptcha secret keys and site-keys can be set for each individual inputfield or globally in your config.php. Error codes and failures are logged to help you find configuration errors. Please check the README for setup instructions.
      Links
      Github Repository and documentation InputfieldHCaptcha in the module directory (pending approval) Screenshots (configuration)

      Screenshots (hCaptcha widget)

       
       

       
    • By joshua
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button> This module is still in development, but we already use it on several production websites.
      You find it here: PrivacyWire Git Repo
      Download as .zip
      I would love to hear your feedback 🙂
      CHANGELOG
      0.1.1 Debugging: fixed error during uninstall 0.1.0 Added new detection of async scripts for W3C Validation 0.0.6 CSS-Debugging for hiding unused buttons, added ProCache support for the JavaScript tag 0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">) 0.0.4 Added possibility to add an imprint link to the banner 0.0.3 Multi-language support for module config (still in development) 0.0.2 First release 0.0.1 Early development
    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
×
×
  • Create New...