Drupal Crashes When Path to XHProf Executable is Incorrect [#1192362]

The entire site became inaccessible after enabling XHProf because of an incorrect entry in the "xhprof directory:" field. What appeared instead was an error display indicating the file was not found on line 487 in devel.module. To recover I had to disable XHProf from phpMyAdmin (devel_xhprof_enabled in the variable table). Upon disabling I found the "White Screen of Death" on every page of my site. This is because most of the entries in the theme registry had been wiped out. To get the site back up I had to get the theme registry rebuilt by executing "drush cache-clear" from site root and select every cache to be cleared.

The devel module needs to check for the presence of the file when the path is entered in the "xhprof directory:" field. If not present it should warn the user and disable XHProf. If the program does branch to the vicinity of line 487 in devel.module while the entry at "xhprof directory:" is incorrect devel needs to recover gracefully from this error so the site will remain accessible.

Also, the example paths below the "xhprof directory:" field which are now:
Location of the xhprof source code on your system, usually somewhere in /usr/local/share or /usr/share, include the leading forward slash.
need to be changed to:
Location of the xhprof source code on your system, usually somewhere in /usr/local/share/xhprof or /usr/share/xhprof, include the leading forward slash.
to alert the user that the "xhprof" directory needs to be included at the end of the path.

Comment	File	Size	Author
#9	devel_validate_xhprof.1192362.7.patch	1.4 KB	salvis
#9

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

salvis

he/his

CreditAttribution: salvis commented 18 June 2011 at 08:30

Does this happen on D7, too? If so, then please upload a patch for 7.x-1.x-dev first, otherwise for 6.x-1.x-dev.

Comment #2

spflanze CreditAttribution: spflanze commented 18 June 2011 at 17:17

I do not know about D7. I have not upgraded to it because there still aren't D7 versions of many of the modules I use.

I have the path correct now and so have no reason to patch. It will be enough for me to get the fix in a stable version.

Comment #3

salvis

he/his

CreditAttribution: salvis commented 18 June 2011 at 18:35

I have the path correct now and so have no reason to patch. It will be enough for me to get the fix in a stable version.

This is not how it works here. It's unlikely that you "get the fix" unless you provide it.

Comment #4

spflanze CreditAttribution: spflanze commented 22 June 2011 at 14:09

If I were to do this it will be a while before I can. My priority now is to get the websites I am working ready for production. If no one else gets to it before my sites are in production I will do it.

This is a very serious bug because an incorrect entry in that field causes the entire website to go down. Getting it back up requires some degree of skill.

Comment #5

deanflory CreditAttribution: deanflory commented 27 November 2011 at 19:32

Yeah, finding this out the hard way. Any hints on how I can uninstall devel or what tables in the database will remove the fatal error? I'm not finding any way of doing this and I'm a noob so not sure where to look beyond tables with "devel" in the name.

Comment #6

salvis

he/his

CreditAttribution: salvis commented 27 November 2011 at 19:45

From the OP:

(devel_xhprof_enabled in the variable table)

Set its value to 0 in the database to disable XHProf. Then go to the Modules page (admin/build/modules) to clear the caches if necessary.

Comment #7

deanflory CreditAttribution: deanflory commented 27 November 2011 at 20:20

So, I'm having to completely drop all tables in my database because of one mistyped character in the XHProf directory field. ARGH! There goes days of effort.

Comment #8

salvis

he/his

CreditAttribution: salvis commented 27 November 2011 at 21:08

So, I'm having to completely drop all tables in my database because of one mistyped character in the XHProf directory field. ARGH! There goes days of effort.

Is that how you interpret #6? Maybe you want to read it again...

Comment #9

salvis

he/his

CreditAttribution: salvis commented 27 November 2011 at 21:23

Status:

Active

» Needs review

File	Size
devel_validate_xhprof.1192362.7.patch	1.4 KB

According to #1278858-9: xhprof outputted file has the wrong format for latest version, we don't need to fix XHProf in D7+ anymore.

Here's a patch for D6.

Will we find any XHProf users to review this? and #1345240: Patch not to break xhprof reporting when site name contains spaces?

Comment #10

27 November 2011 at 21:24

Status:

Needs review

» Needs work

The last submitted patch, devel_validate_xhprof.1192362.7.patch, failed testing.

Comment #11

salvis

he/his

CreditAttribution: salvis commented 27 November 2011 at 22:22

Version:	6.x-1.9	» 6.x-1.x-dev
Status:	Needs work	» Needs review

Hmm — from the testbot's log:

[14:24:05] Command [git --work-tree='/var/lib/drupaltestbot/sites/default/files/checkout/sites/default/modules/devel' --git-dir='/var/lib/drupaltestbot/sites/default/files/checkout/sites/default/modules/devel/.git' checkout '6.x-1.9' 2>&1] succeeded
  Duration: 0 seconds
  Directory: [/var/lib/drupaltestbot/sites/default/files/checkout/sites/default/modules]
  Completion status: [0]
  Output: [Note: checking out '6.x-1.9'.