Page MenuHomeIn-Portal Phabricator
  • Changed Files
  • branches/5.2.x/core/kernel/utility/debugger.php

INP-1881 - Change default Debugger URL handler to PhpStorm
ClosedPublic

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

Details

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
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

alex created this revision.Oct 26 2024, 9:27 AM
alex requested review of this revision.Oct 26 2024, 9:27 AM
Harbormaster completed remote builds in B1315: Diff 1267.
alex edited the test plan for this revision. (Show Details)Oct 26 2024, 9:47 AM
erik accepted this revision.Oct 30 2024, 6:02 AM
This revision is now accepted and ready to land.Oct 30 2024, 6:02 AM
This revision was landed with ongoing or failed builds.Oct 30 2024, 7:56 AM
This revision was automatically updated to reflect the committed changes.