Update Slowvote voting methods to use sensible string constants

epriestley · epriestley · commit 03d3d1889d60 · 2022-05-26T10:27:01.000-07:00
Summary: Ref T13682. Use API-friendly string constants instead of opaque integers in Slowvote voting methods. Test Plan: Created, edited, and voted in polls with various voting methods. Examined database after migrations. Subscribers: PHID-OPKG-gm6ozazyms6q6i22gyam Maniphest Tasks: T13682 Differential Revision: https://secure.phabricator.com/D21846
diff --git a/resources/sql/autopatches/20220525.slowvote.06.method-type.sql b/resources/sql/autopatches/20220525.slowvote.06.method-type.sql
@@ -0,0 +1,2 @@
+ALTER TABLE {$NAMESPACE}_slowvote.slowvote_poll
+  CHANGE method method VARCHAR(32) NOT NULL COLLATE {$COLLATE_TEXT};
diff --git a/resources/sql/autopatches/20220525.slowvote.07.method-value.sql b/resources/sql/autopatches/20220525.slowvote.07.method-value.sql
@@ -0,0 +1,5 @@
+UPDATE {$NAMESPACE}_slowvote.slowvote_poll
+  SET method = 'plurality' WHERE method = '0';
+
+UPDATE {$NAMESPACE}_slowvote.slowvote_poll
+  SET method = 'approval' WHERE method = '1';
diff --git a/src/applications/slowvote/constants/SlowvotePollVotingMethod.php b/src/applications/slowvote/constants/SlowvotePollVotingMethod.php
@@ -3,8 +3,8 @@
 final class SlowvotePollVotingMethod
   extends Phobject {
 
-  const METHOD_PLURALITY = 0;
-  const METHOD_APPROVAL = 1;
+  const METHOD_PLURALITY = 'plurality';
+  const METHOD_APPROVAL = 'approval';
 
   private $key;
 
diff --git a/src/applications/slowvote/controller/PhabricatorSlowvoteEditController.php b/src/applications/slowvote/controller/PhabricatorSlowvoteEditController.php
@@ -57,7 +57,7 @@ public function handleRequest(AphrontRequest $request) {
       $v_space = $request->getStr('spacePHID');
 
       if ($is_new) {
-        $poll->setMethod($request->getInt('method'));
+        $poll->setMethod($request->getStr('method'));
       }
 
       if (!strlen($v_question)) {
diff --git a/src/applications/slowvote/storage/PhabricatorSlowvotePoll.php b/src/applications/slowvote/storage/PhabricatorSlowvotePoll.php
@@ -54,7 +54,7 @@ protected function getConfiguration() {
         'question' => 'text255',
         'responseVisibility' => 'text32',
         'shuffle' => 'bool',
-        'method' => 'uint32',
+        'method' => 'text32',
         'description' => 'text',
         'isClosed' => 'bool',
       ),
diff --git a/src/applications/slowvote/view/SlowvoteEmbedView.php b/src/applications/slowvote/view/SlowvoteEmbedView.php
@@ -301,13 +301,17 @@ private function renderStatus(PhabricatorSlowvoteOption $option) {
 
     $percent = sprintf('%d%%', $count ? 100 * $choices / $count : 0);
 
-    switch ($poll->getMethod()) {
+    $method = $poll->getMethod();
+    switch ($method) {
       case SlowvotePollVotingMethod::METHOD_PLURALITY:
         $status = pht('%s (%d / %d)', $percent, $choices, $count);
         break;
       case SlowvotePollVotingMethod::METHOD_APPROVAL:
         $status = pht('%s Approval (%d / %d)', $percent, $choices, $count);
         break;
+      default:
+        $status = pht('Unknown ("%s")', $method);
+        break;
     }
 
     return phutil_tag(

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+ALTER TABLE {$NAMESPACE}_slowvote.slowvote_poll`
	`2`	`+ CHANGE method method VARCHAR(32) NOT NULL COLLATE {$COLLATE_TEXT};`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public function handleRequest(AphrontRequest $request) {`
`57`	`57`	`$v_space = $request->getStr('spacePHID');`
`58`	`58`
`59`	`59`	`if ($is_new) {`
`60`		`- $poll->setMethod($request->getInt('method'));`
	`60`	`+ $poll->setMethod($request->getStr('method'));`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`if (!strlen($v_question)) {`