Page MenuHomeIn-Portal Phabricator

INP-1881 - Change default Debugger URL handler to PhpStorm
Needs ReviewPublic

Authored by alex on Sat, Oct 26, 9:27 AM.

Details

Reviewers
erik
Test Plan
NOTE: The document root is the directory on a web server where the website files for a domain name are stored.

Part 1 - defaults (the DBG_LOCAL_BASE_PATH and DBG_EDITOR_URL)

  1. in IDE:
    • open the /system/debug.php file for editing
    • comment-out these keys in the $dbg_options array: DBG_LOCAL_BASE_PATH, DBG_EDITOR_URL
    • save changes
  2. in Admin Console
    • stay on the login screen
    • open the Debugger Report
    • use Inspect context menu entry on the 1st file editing link below an SQL query (has logger.php:265 text for me)
    • confirm, that shown URL:
      • is encoded (all the / symbols are replaced with %2F)
      • URL-decoded version of it looks like phpstorm://open?file=/path/to/file&line=line_number (/path/to/file - path to a file from the Web Server including Document Root; line_number - line number in that file)

Part 2 - custom DBG_LOCAL_BASE_PATH

  1. in IDE:
    • open the /system/debug.php file for editing
    • comment-out these keys in the $dbg_options array: DBG_EDITOR_URL
    • in the DBG_LOCAL_BASE_PATH key of the $dbg_options array specify '/Volumes/web'
    • save changes
  2. in Admin Console
    • stay on the login screen
    • open the Debugger Report
    • use Inspect context menu entry on the 1st file editing link below an SQL query (has logger.php:265 text for me)
    • confirm, that shown URL:
      • is encoded (all the / symbols are replaced with %2F)
      • URL-decoded version of it looks like phpstorm://open?file=/path/to/file&line=line_number (/path/to/file - path to a file from the Web Server, where Document Root was replaced with /Volumes/web; line_number - line number in that file)

Part 3 - custom DBG_EDITOR_URL

  1. in IDE:
    • open the /system/debug.php file for editing
    • comment-out these keys in the $dbg_options array: DBG_LOCAL_BASE_PATH
    • in the DBG_EDITOR_URL key of the $dbg_options array specify 'subl://open?url=%F&line=%L'
    • save changes
  2. in Admin Console
    • stay on the login screen
    • open the Debugger Report
    • use Inspect context menu entry on the 1st file editing link below an SQL query (has logger.php:265 text for me)
    • confirm, that shown URL:
      • is encoded (all the / symbols are replaced with %2F)
      • URL-decoded version of it looks like subl://open?url=/path/to/file&line=line_number (/path/to/file - path to a file from the Web Server including Document Root; line_number - line number in that file)

Diff Detail

Repository
rINP In-Portal
Branch
/in-portal/branches/5.2.x
Lint
Lint ErrorsExcuse: Haven't introduced any of these in this change.
SeverityLocationCodeMessage
Errorcore/kernel/utility/debugger.php:463PHPCS.E.CodingStandard.Commenting.InlineComment.InvalidEndCharCodingStandard.Commenting.InlineComment.InvalidEndChar
Errorcore/kernel/utility/debugger.php:463PHPCS.E.CodingStandard.Commenting.InlineComment.NotCapitalCodingStandard.Commenting.InlineComment.NotCapital
Errorcore/kernel/utility/debugger.php:469PHPCS.E.CodingStandard.Commenting.InlineComment.InvalidEndCharCodingStandard.Commenting.InlineComment.InvalidEndChar
Errorcore/kernel/utility/debugger.php:469PHPCS.E.CodingStandard.Formatting.ItemAssignment.MixedWhitespaceAfterCodingStandard.Formatting.ItemAssignment.MixedWhitespaceAfter
Errorcore/kernel/utility/debugger.php:469PHPCS.E.CodingStandard.Formatting.ItemAssignment.MixedWhitespaceBeforeCodingStandard.Formatting.ItemAssignment.MixedWhitespaceBefore
Errorcore/kernel/utility/debugger.php:469PHPCS.E.CodingStandard.Formatting.SpaceOperator.SpacingBeforeCodingStandard.Formatting.SpaceOperator.SpacingBefore
Errorcore/kernel/utility/debugger.php:469PHPCS.E.CodingStandard.WhiteSpace.CommaSpacing.AfterCodingStandard.WhiteSpace.CommaSpacing.After
Errorcore/kernel/utility/debugger.php:469PHPCS.E.Squiz.WhiteSpace.OperatorSpacing.SpacingAfterSquiz.WhiteSpace.OperatorSpacing.SpacingAfter
Errorcore/kernel/utility/debugger.php:470PHPCS.E.CodingStandard.Formatting.ItemAssignment.MixedWhitespaceAfterCodingStandard.Formatting.ItemAssignment.MixedWhitespaceAfter
Errorcore/kernel/utility/debugger.php:470PHPCS.E.CodingStandard.Formatting.ItemAssignment.MixedWhitespaceBeforeCodingStandard.Formatting.ItemAssignment.MixedWhitespaceBefore
Errorcore/kernel/utility/debugger.php:470PHPCS.E.CodingStandard.Formatting.SpaceOperator.SpacingBeforeCodingStandard.Formatting.SpaceOperator.SpacingBefore
Errorcore/kernel/utility/debugger.php:470PHPCS.E.Squiz.WhiteSpace.OperatorSpacing.SpacingAfterSquiz.WhiteSpace.OperatorSpacing.SpacingAfter
Errorcore/kernel/utility/debugger.php:471PHPCS.E.CodingStandard.Commenting.InlineComment.InvalidEndCharCodingStandard.Commenting.InlineComment.InvalidEndChar
Errorcore/kernel/utility/debugger.php:471PHPCS.E.CodingStandard.Commenting.InlineComment.NotCapitalCodingStandard.Commenting.InlineComment.NotCapital
Errorcore/kernel/utility/debugger.php:471PHPCS.E.CodingStandard.Formatting.ItemAssignment.MixedWhitespaceAfterCodingStandard.Formatting.ItemAssignment.MixedWhitespaceAfter
Errorcore/kernel/utility/debugger.php:471PHPCS.E.CodingStandard.Formatting.ItemAssignment.MixedWhitespaceBeforeCodingStandard.Formatting.ItemAssignment.MixedWhitespaceBefore
Errorcore/kernel/utility/debugger.php:471PHPCS.E.CodingStandard.Formatting.SpaceOperator.SpacingBeforeCodingStandard.Formatting.SpaceOperator.SpacingBefore
Errorcore/kernel/utility/debugger.php:471PHPCS.E.CodingStandard.WhiteSpace.CommaSpacing.AfterCodingStandard.WhiteSpace.CommaSpacing.After
Errorcore/kernel/utility/debugger.php:471PHPCS.E.Generic.Files.LineLength.MaxExceededGeneric.Files.LineLength.MaxExceeded
Errorcore/kernel/utility/debugger.php:471PHPCS.E.Squiz.WhiteSpace.OperatorSpacing.SpacingAfterSquiz.WhiteSpace.OperatorSpacing.SpacingAfter
Errorcore/kernel/utility/debugger.php:472PHPCS.E.CodingStandard.Formatting.ItemAssignment.MixedWhitespaceAfterCodingStandard.Formatting.ItemAssignment.MixedWhitespaceAfter
Errorcore/kernel/utility/debugger.php:472PHPCS.E.CodingStandard.Formatting.ItemAssignment.MixedWhitespaceBeforeCodingStandard.Formatting.ItemAssignment.MixedWhitespaceBefore
Errorcore/kernel/utility/debugger.php:472PHPCS.E.CodingStandard.Formatting.SpaceOperator.SpacingBeforeCodingStandard.Formatting.SpaceOperator.SpacingBefore
Errorcore/kernel/utility/debugger.php:472PHPCS.E.Squiz.WhiteSpace.OperatorSpacing.SpacingAfterSquiz.WhiteSpace.OperatorSpacing.SpacingAfter
Errorcore/kernel/utility/debugger.php:473PHPCS.E.Squiz.WhiteSpace.OperatorSpacing.SpacingAfterSquiz.WhiteSpace.OperatorSpacing.SpacingAfter
Unit
No Unit Test Coverage
Build Status
Buildable 1315
Build 1315: arc lint + arc unit