Jump to content
adrian

Tracy Debugger

Recommended Posts

A couple of small updates to the Adminer panel / process module.

1) It is now restricted to the database for the PW install. Previously you could access all databases available with to the PW DB user. If some of you out there don't like this change, let me know and I can make it optional, but I think it's a better default (cleaner and a little safer).

2) It's now possible to uninstall the Adminer process module and it won't be automatically re-installed each time you upgrade Tracy - @Rudy was concerned about this with his setups. Obviously if a user has superuser access they can still install if they want, so it's more a case of removing something tempting for users without sufficient skills, rather than being a true change to security. On this note - Adminer is restricted to superusers (same with the Console, Snippet Runner and File Editor panels).

 

  • Like 2
  • Thanks 1

Share this post


Link to post
Share on other sites

So imagine my shock today when i tried to d($var) and nothing happened (well, apart from a few crumbs of debug on the page)! Not again!, I groaned. I scanned Tracy's settings and nothing jumped at me. Everything seemed OK. I even tried debugInfo=>false/true, but no joy. A quick look at the docs and eureka! 

@options: DETECT | DEVELOPMENT | PRODUCTION

@default: DETECT

 

A docker container's IP address would be treated differently! It was being read as site is in 'PRODUCTION'!. A quick change to that setting and normal Tracy was back! You gave me a fright Tracy! I've never seen this side of you. We've only ever met 'locally' 😎.

  • Like 1
  • Haha 2

Share this post


Link to post
Share on other sites

@kongondo - glad you sorted it out 🙂 and good to know that docker appears to be a production server to Tracy.

Just out of curiosity - do you usually use d($var) in template files? I always use bd($var). The only place d($var) makes sense to me is in the Console panel. Maybe you have a different use case or preference, or something else, but thought I'd mention it just in case.

Share this post


Link to post
Share on other sites
5 minutes ago, adrian said:

Just out of curiosity - do you usually use d($var) in template files? I always use bd($var). The only place d($var) makes sense to me is in the Console panel. Maybe you have a different use case or preference, or something else, but thought I'd mention it just in case.

I normally use bd($var) and only knew about the difference with d($var) when you pointed it out to me recently :-).

  • Like 1

Share this post


Link to post
Share on other sites

A couple of new features worth mentioning:

1) The RequestInfo panel's Field List & Values section now has a new "Adminer" column with a link to open the row for chosen field for the current page directly in Adminer.

2) I have finally committed the autocompletions for PW methods, properties and $page fields for the Console and File Editor panels. Hopefully you'll find this a nice shortcut, but more importantly a learning experience by finding new methods you didn't know about (or forgot). 

 TSaG4LXarg.thumb.gif.5f0b169ddcf5392764634bfeebfd504a.gif

  • Like 4

Share this post


Link to post
Share on other sites

Hi all,

on the Module Information page of Process Tracy Adminer, when I click the link "check for updates" I get this  message:

Quote

Error reported by web service: Unable to find that module

What's going wrong?  Thank you for hints.

(PW 3.0.105, Tracy Debugger 4.14.11, PHP 7.0)

 

Share this post


Link to post
Share on other sites
2 hours ago, ottogal said:

Hi all,

on the Module Information page of Process Tracy Adminer, when I click the link "check for updates" I get this  message:

What's going wrong?  Thank you for hints.

(PW 3.0.105, Tracy Debugger 4.14.11, PHP 7.0)

 

That's because ProcessTracyAdminer is included as Part of TracyDebugger. This is a normal response for any included "helper" module in ProcessWire. Personally I don't like this behavior, but it is as expected. ProcessTracyAdminer will be automatically updated when you update TracyDebugger.

Share this post


Link to post
Share on other sites

Thank you for the clarification.

Shouldn't that response be replaced by a less irritating message?

Share this post


Link to post
Share on other sites
6 minutes ago, ottogal said:

Thank you for the clarification.

Shouldn't that response be replaced by a less irritating message?

Probably 🙂 - that would be a Github issue/request for Ryan if you're keen!

  • Haha 1

Share this post


Link to post
Share on other sites

I just added several new links to Adminer from the Request Info panel.

image.png.1b030d04bc5e0cb2d4f4e8a3e4f2c7fc.png

That Adminer icon links directly to this:

image.png.1be8aff15425baf033bdb8cedff8b265.png

 

These links have been added to the following Request Info sections:

Page Info
Module Settings
Template Settings
Template Info
Field Settings

Obviously be very careful editing content directly in the database like this - it's certainly possible to do critical damage!

Share this post


Link to post
Share on other sites

Hi Adrian, just wanted to let you know that I just upgraded to latest TracyDebugger and received the following error on the API Explorer Panel:

Error: Call to a member function convertNamesToUrls() on null in /Users/glenn/websites/pwmlec/wwwroot/site/assets/cache/FileCompiler/site/modules/TracyDebugger/panels/ApiExplorerPanel.php:205
Stack trace:
#0 /Users/glenn/websites/pwmlec/wwwroot/site/assets/cache/FileCompiler/site/modules/TracyDebugger/panels/ApiExplorerPanel.php(108): ApiExplorerPanel->buildTable('adminTheme', Array)
#1 /Users/glenn/websites/pwmlec/wwwroot/site/assets/cache/FileCompiler/site/modules/TracyDebugger/tracy-master/src/Tracy/Bar.php(161): ApiExplorerPanel->getPanel()
#2 /Users/glenn/websites/pwmlec/wwwroot/site/assets/cache/FileCompiler/site/modules/TracyDebugger/tracy-master/src/Tracy/Bar.php(110): Tracy\Bar->renderPanels()
#3 /Users/glenn/websites/pwmlec/wwwroot/site/assets/cache/FileCompiler/site/modules/TracyDebugger/tracy-master/src/Tracy/Debugger.php(294): Tracy\Bar->render()
#4 [internal function]: Tracy\Debugger::shutdownHandler()
#5 {main}

Thanks for the all the improvements!  They look really helpful.

  • Like 1

Share this post


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

Hi Adrian, just wanted to let you know that I just upgraded to latest TracyDebugger and received the following error on the API Explorer Panel:

Thanks for letting me know - it happened when the load order of panels was different to what I had set up. It should be fixed in the latest version.

Share this post


Link to post
Share on other sites

New links from the Debug Mode panel's "Cache" section to edit it in Adminer:

image.png.355758f1bf657b8c06a0ed2fc2eb9c2d.png

Adminer DB icon links to where you can easily review the cache content, edit, change the expires datetime, or delete it.

image.png.5e7de2334a5c492ac097a4ffb0cf3b38.png

Also note that Adminer now has @bernhard's request for a PW icon link back to the site's PW admin backend.

Let me know if you guys have any suggestions for other direct links to Adminer - I am finding these very handy.

 

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

Hi @adrian I just created a PR with two new panels.

1) A hello world panel to make it easier for others to create panels and contribute to your great module:

GgSaxD7.png

2) A WebHook panel that should make it easier to debug and develop webhook based functionality (like GIT webhooks or webhooks from foxycart or any other 3rd party service):

Settings are simple:
1kKKJyc.png

The panel shows the latest requests to templates you selected (in this screenshot the basic-page template was also enabled):
0s7ALdf.png

You can also retrieve the data of logged requests, so it is easier to develop scripts without having to fire webhooks over and over again:

4Y2qJc1.png

Open to feedback, as always 🙂 https://github.com/adrianbj/TracyDebugger/pull/30

  • Like 3

Share this post


Link to post
Share on other sites

Hey @bernhard - this looks really fantastic - thank you!

I have a few comments re code styling to match the rest of Tracy, but I can clean that up after accepting the PR.

What I am wondering is if it might be useful to add a $page->getWebHookData() method so that you don't need to know the ID of the hook. Obviously the data that is stored would need to include a pageid (I see you already store that) so this new method could grab an array of objects just for this page. I think it would also be great to be able to do: $page->getWebHookData()->last() to get the last one. Not sure how useful first() and eq() would be in this case. Maybe eq() could be in reverse order so you could get eq(0) as the last received, eq(1) as second last, etc - what do you think?

I'll take a better look tomorrow and do some testing, but really excited to start using this!

  • Like 1

Share this post


Link to post
Share on other sites

Glad you like it 🙂 

10 hours ago, adrian said:

What I am wondering is if it might be useful to add a $page->getWebHookData() method so that you don't need to know the ID of the hook. Obviously the data that is stored would need to include a pageid (I see you already store that) so this new method could grab an array of objects just for this page.

Good idea!

I was also thinking of an AJAX version that grabs the latest requests every x seconds and updates the dumps. But that was too much effort for me for too little benefit. You might be faster as you know tracy a lot better than me.

10 hours ago, adrian said:

I have a few comments re code styling to match the rest of Tracy, but I can clean that up after accepting the PR.

Yeah, I prefer array syntax. You can adjust as needed.

 

Share this post


Link to post
Share on other sites
On 11/14/2018 at 7:03 PM, adrian said:

2) It's now possible to uninstall the Adminer process module and it won't be automatically re-installed each time you upgrade Tracy

Thanks for this, I think I will keep it uninstalled, partly because I do not like it's menu item to appear in the main menu. However, on he Tracy settings page:

Adminer settings are available here. results in a system message "Unknown module", so you might wan to change it to something like Adminer settings are only available when the Process Tracy Adminer module is installed.

Edited by szabesz
typos
  • Like 1

Share this post


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

Thanks for this, I think I will keep it uninstalled, partly because I do not like it's menu item to appear in the main menu. However, on he Tracy settings page:

Adminer settings are available here. results in a system message "Unknown module", so you might wan to change it to something like Adminer settings are only available when the Process Tracy Adminer module is installed.

Sorry about the issue with the unknown module error. I'll fix that in the next commit.

Keep in mind that if you don't want it to appear under the Setup menu, you just need to make Admin > Setup > Adminer hidden. That way you could still use the Adminer panel from the Tracy debug bar. Does that help? Also, I know it's obvious, but only superusers will see the Setup > Adminer option.

  • Like 1

Share this post


Link to post
Share on other sites
9 minutes ago, adrian said:

Keep in mind that if you don't want it to appear under the Setup menu, you just need to make Admin > Setup > Adminer hidden. That way you could still use the Adminer panel from the Tracy debug bar. Does that help?

Thanks for the tip! Yeah, I guess this will do the trick 🙂

  • Like 1

Share this post


Link to post
Share on other sites

Well it took several hours of discussions with @bernhard and lots of back and forwards on the best way to do things, but we've finally committed the "WebHooks" panel he posted about above.

It's now called the Request Logger panel because in reality it is logging requests to a page on your site - who knows whether it's really a "webhook" request or something else.

Instructions

1) In the PW admin, edit the page you want to log incoming requests for.

2) Open the Request Logger panel.

3) Click the "Enable logging on this page" button.

image.png.f55ec8bcbcd7e2c305a8fb0129d874e3.png

4) Send a request to that page. This may be something like a confirmation of payment webhook call from Paypal etc. 

5) Reload the edit page in the PW admin to see the logged request. The reason we say to edit the page, rather than visit it on the frontend is because visiting the page would result in a logged request.

image.png.b52ea8d49ca25d2dac8f8a7cbbddfe96.png

Note that you can easily test incoming requests using the Postman app (https://www.getpostman.com/). You can choose POST or GET and under "Body" you'll want to specify Raw / JSON

image.png.9982322e32f5144bfae0b0466b2033ab.png

You'll notice the json supplied in the Postman Body is what shows up in the Request Logger panel under "input" and "inputParsed".

This is all well and good, but here's where the magic really comes in 🙂 There is a new getRequestData() method added to $page so you can get the logged data in your code. You can get logged requests by:

  • ID (shown in the title of the logged entry in the Request Logger panel)
  • ALL requests (an array of all logged requests for the page)
  • The last logged request by passing "true"
  • The current live request

This allows you to have access to the data sent by the webhook without constantly having to trigger it each time - ie no need to continually make test payments over and over as you refine and debug the your scripts that consume/parse this data! You can even make use of $page->getRequestData() in your final live code if you want - this does not rely on Tracy being enabled - it just has to be installed. So you could potentially execute one request and then use the "true" option while testing, and then when you're ready to go live, you can remove the "true" so it returns the live request.

There is a config setting to determine whether this method returns an array or an object.

image.png.8a45974c7747bb15a4cfc7d87c04de7e.png


Please take it for a test drive and let us know what you think!

@bernhard - did I miss anything worth mentioning?

  • Like 4

Share this post


Link to post
Share on other sites

Just wanted to upgrade her, but I got compile error: "Cannot declare class TracyDebugger, because the name is already in use", File: ...\modules\TracyDebugger\TracyDebugger.module.php:24  

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 gebeer
      I am happy to present my new fieldtype FieldtypeImageFromPage. It is made up of 2 modules:
      Fieldtype Image Reference From Another Page is a Fieldtype that stores a reference to a single image from another page. The image can be selected with the associated Inputfield.
      Inputfield Select Image From Page is an Inputfield to select a single image from images on a predefined page and it's children.
      And there also is a helper module that takes care of cleanup tasks.
      This module evolved out of a discussion about my other Module FieldtypeImagePicker.  It caters for use cases where a set of images is being reused multiple times across a site. With this fieldtype these images can be administered through a chosen page. All images uploaded to that page will be available in the inputfield.
      When to use ?
      Let editors choose an image from a set of images that is being used site-wide. Ideal for images that are being re-used across the site.
      Suited for images that are used on multiple pages throughout the site (e.g. icons).
      Other than the native ProcessWire images field, the images here are not stored per page. Only references to images on another page are stored. This has several advantages:
      one central place to organize images when images change, you only have to update them in one place. All references will be updated, too. (Provided the name of the image that has changed stays the same) Features
      Images can be manipulated like native ProcessWire images (resizing, cropping etc.) Image names are fully searchable through the API Accidental image deletion is prevented. When you want to delete an image from one of the pages that hold your site-wide images, the module searches all pages that use that image. If any page contains a reference to the image you are trying to delete, deletion will be prevented. You will get an error message to help you edit those pages and remove references there before you can finally delete the image. How to install and setup
      Download and install this module like any other modules in ProcessWire Create a page in the page tree that will hold your images. This page's template must have an images field Upload some images to the page you created in step 2 Create a new field. As type choose 'Image Reference From Another Page'. Save the field. In 'Details' Tab of the field choose the page you created in step 2 Click Save button Choose the images field name for the field that holds your images (on page template from step 2) Click Save button again Choose whether you want to include child pages of page from step 2 to supply images Add the field to any template You are now ready to use the field View of the inputfield on the page edit screen:

      View of the field settings

      The module can be installed from this github repo. Some more info in the README there, too.
      In my tests it was fairly stable. After receiving your valued feedback, I will eventually add it to the modules directory.
      My ideas for further improvement:
      - add ajax loading of thumbnails
      Happy to hear your feedback!
       
    • By gebeer
      Although the PW backend is really intuitive, ever so often my clients need some assistance. Be it they are not so tech savvy or they are not working in the backend often.
      For those cases it is nice to make some help videos available to editors. This is what this module does.
      ProcessHelpVideos Module
      A Process module to display help videos for the ProcessWire CMS. It can be used to make help videos (screencasts) available to content editors.
      This module adds a 'Help Videos" section to the ProcessWire backend. The help videos are accessible through an automatically created page in the Admin page tree. You can add your help videos as pages in the page tree. The module adds a hidden page to the page tree that acts as parent page for the help video pages. All necessary fields and templates will be installed automatically. If there are already a CKEditor field and/or a file field for mp4 files installed in the system, the module will use those. Otherwise it will create the necessary fields. Also the necessary templates for the parent help videos page and it's children are created on module install. The module installs a permission process-helpvideos. Every user role that should have access to the help video section, needs this permission. I use the help video approach on quite a few production sites. It is stable so far and well received by site owners/editors. Up until now I installed required fields, templates and pages manually and then added the module. Now I added all this logic to the install method of the module and it should be ready to share.
      The module and further description on how to use it is available on github: https://github.com/gebeer/ProcessHelpVideos
      If you like to give it a try, I am happy to receive your comments/suggestions here.
    • By Robin S
      A module created in response to the topic here:
      Page List Select Multiple Quickly
      Modifies PageListSelectMultiple to allow you to select multiple pages without the tree closing every time you select a page.
      The screencast says it all:

       
      https://github.com/Toutouwai/PageListSelectMultipleQuickly
      https://modules.processwire.com/modules/page-list-select-multiple-quickly/
    • By gebeer
      Hello all,
      sharing my new module FieldtypeImagePicker. It provides a configurable input field for choosing any type of image from a predefined folder.
      The need for it came up because a client had a custom SVG icon set and I wanted the editors to be able to choose an icon in the page editor.
      It can also be used to offer a choice of images that are used site-wide without having to upload them to individual pages.
      There are no image manipulation methods like with the native PW image field.
      Module and full description can be found on github https://github.com/gebeer/FieldtypeImagePicker
      Kudos to @Martijn Geerts. I used his module FieldTypeSelectFile as a base to build upon.
      Here's how the input field looks like in the page editor:

      Hope it can be of use to someone.
      If you like to give it a try, I'm happy to hear your comments or suggestions for improvement. Eventually this will go in the module directory soon, too.
    • By bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.
      Description from PW Weekly:
       
      Modules Directory: https://modules.processwire.com/modules/rock-pdf/
      Download & Docs: https://github.com/BernhardBaumrock/RockPDF
       
      You can combine it easily with RockReplacer: 
      See also a little showcase of the RockPdf module in this thread:
       
×
×
  • Create New...