Jump to content
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 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
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
×
×
  • Create New...