Fix Pholio RuntimeException: Undefined variable $dictionary (when adding an empty Inline Comment)
ClosedPublic
Actions

Authored by aklapper on Jun 9 2023, 18:55.

Details

Reviewers

valerio.bozzolan

Group Reviewers

O1: Blessed Committers

Maniphest Tasks

T15456: Pholio: RuntimeException: Undefined variable $dictionary when adding an empty Inline Comment

Commits

rP7c1487e4dcfa: Fix Pholio RuntimeException: Undefined variable $dictionary (when adding an…

Summary

Trying to create an empty inline comment in a Pholio mock, $dictionary does not get set as both strlen($v_content) and $inline->getID() are not true.

Thus show a more explanatory error message ('Comment cannot be empty.') to users instead of exposing internal variable names.

EXCEPTION: (RuntimeException) Undefined variable $dictionary at [<arcanist>/src/error/PhutilErrorHandler.php:261]
arcanist(head=master, ref.master=b325304b6e52), phorge(head=master, ref.master=980293b707a0)
  #0 <#2> PhutilErrorHandler::handleError(integer, string, string, integer) called at [<phorge>/src/applications/pholio/controller/PholioInlineController.php:117]

Closes T15456

Test Plan

After applying this change, try to add an empty Inline Comment in a Pholio mock. See that the error message is now "Comment cannot be empty." instead of "Undefined variable $dictionary".

Diff Detail

Repository

rP Phorge

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

aklapper created this revision.Jun 9 2023, 18:55

Owners added a reviewer: O1: Blessed Committers.Jun 9 2023, 18:55

Herald added subscribers: Cigaryno, Matthew, valerio.bozzolan and 2 others. · View Herald TranscriptJun 9 2023, 18:55

aklapper requested review of this revision.Jun 9 2023, 18:55

Harbormaster completed remote builds in B523: Diff 910.Jun 9 2023, 18:55

aklapper edited the test plan for this revision. (Show Details)Jun 9 2023, 19:03

Thanks!

Soft +1 since generating an unhandled exception seems reasonable:

Screenshot_2023_06_12_230545.png (230×682 px, 12 KB)

But I discovered that we can also call setError() somewhere to show a nice user message. I tried in this way that maybe can be used as inspiration:

--- a/src/applications/pholio/controller/PholioInlineController.php
+++ b/src/applications/pholio/controller/PholioInlineController.php
@@ -102,6 +102,7 @@ final class PholioInlineController extends PholioController {
         ->addCancelButton($mock_uri, pht('Close'));
     }

+    $error = null;
     if ($request->isFormPost()) {
       $v_content = $request->getStr('content');

@@ -112,9 +113,13 @@ final class PholioInlineController extends PholioController {
       } else if ($inline->getID()) {
         $inline->delete();
         $dictionary = array();
+      } else {
+        $error = pht('Comment cannot be empty.');
       }

-      return id(new AphrontAjaxResponse())->setContent($dictionary);
+      if(!$error) {
+        return id(new AphrontAjaxResponse())->setContent($dictionary);
+      }
     }

     switch ($mode) {
@@ -151,7 +156,8 @@ final class PholioInlineController extends PholioController {
           ->setUser($viewer)
           ->setName('content')
           ->setLabel(pht('Comment'))
-          ->setValue($v_content));
+          ->setValue($v_content)
+          ->setError($error));

     return $this->newDialog()
       ->setTitle($title)

In that case, this would be the result - still very ugly to me - but somehow less raw, and also the popup is not closed and you can just continue typing: