From 956c4058e64cf3ec338e08e5218980e7f93f72fa Mon Sep 17 00:00:00 2001
From: epriestley <git@epriestley.com>
Date: Sun, 4 Feb 2018 05:55:01 -0800
Subject: [PATCH] Add a `bin/conduit call` support binary

Summary:
Ref T13060. See PHI343. Triaging this bug required figuring out where in the pipeline UTF8 was being dropped, and bisecting the pipeline required making calls to Conduit.

Currently, there's no easy way to debug/inspect arbitrary Conduit calls, especially when they are `diffusion.*` calls which route to a different host (even if you have a real session and use the web console for these, you just see an HTTP service call to the target host in DarkConsole).

Add a `bin/conduit` utility to make this kind of debugging easier, with an eye toward the Phacility production cluster (or other similar clusters) specifically.

Test Plan:
  - Ran `echo '{}' | bin/conduit call --method conduit.ping --input -` and similar.
  - Used a similar approach to successfully diagnose the UTF8 issue in T13060.

Reviewers: amckinley

Reviewed By: amckinley

Maniphest Tasks: T13060

Differential Revision: https://secure.phabricator.com/D18987
---
 bin/conduit                                   |  1 +
 scripts/setup/manage_conduit.php              | 21 ++++++
 src/__phutil_library_map__.php                |  4 ++
 ...abricatorConduitCallManagementWorkflow.php | 66 +++++++++++++++++++
 .../PhabricatorConduitManagementWorkflow.php  |  4 ++
 5 files changed, 96 insertions(+)
 create mode 120000 bin/conduit
 create mode 100755 scripts/setup/manage_conduit.php
 create mode 100644 src/applications/conduit/management/PhabricatorConduitCallManagementWorkflow.php
 create mode 100644 src/applications/conduit/management/PhabricatorConduitManagementWorkflow.php

diff --git a/bin/conduit b/bin/conduit
new file mode 120000
index 0000000000..9221340a93
--- /dev/null
+++ b/bin/conduit
@@ -0,0 +1 @@
+../scripts/setup/manage_conduit.php
\ No newline at end of file
diff --git a/scripts/setup/manage_conduit.php b/scripts/setup/manage_conduit.php
new file mode 100755
index 0000000000..07384e7ed8
--- /dev/null
+++ b/scripts/setup/manage_conduit.php
@@ -0,0 +1,21 @@
+#!/usr/bin/env php
+<?php
+
+$root = dirname(dirname(dirname(__FILE__)));
+require_once $root.'/scripts/init/init-script.php';
+
+$args = new PhutilArgumentParser($argv);
+$args->setTagline(pht('manage Conduit'));
+$args->setSynopsis(<<<EOSYNOPSIS
+**conduit** __command__ [__options__]
+    Manage Conduit.
+
+EOSYNOPSIS
+  );
+$args->parseStandardArguments();
+
+$workflows = id(new PhutilClassMapQuery())
+  ->setAncestorClass('PhabricatorConduitManagementWorkflow')
+  ->execute();
+$workflows[] = new PhutilHelpArgumentWorkflow();
+$args->parseWorkflows($workflows);
diff --git a/src/__phutil_library_map__.php b/src/__phutil_library_map__.php
index aff0d5e36f..7076cde010 100644
--- a/src/__phutil_library_map__.php
+++ b/src/__phutil_library_map__.php
@@ -2425,6 +2425,7 @@ phutil_register_library_map(array(
     'PhabricatorCommonPasswords' => 'applications/auth/constants/PhabricatorCommonPasswords.php',
     'PhabricatorConduitAPIController' => 'applications/conduit/controller/PhabricatorConduitAPIController.php',
     'PhabricatorConduitApplication' => 'applications/conduit/application/PhabricatorConduitApplication.php',
+    'PhabricatorConduitCallManagementWorkflow' => 'applications/conduit/management/PhabricatorConduitCallManagementWorkflow.php',
     'PhabricatorConduitCertificateToken' => 'applications/conduit/storage/PhabricatorConduitCertificateToken.php',
     'PhabricatorConduitConsoleController' => 'applications/conduit/controller/PhabricatorConduitConsoleController.php',
     'PhabricatorConduitContentSource' => 'infrastructure/contentsource/PhabricatorConduitContentSource.php',
@@ -2435,6 +2436,7 @@ phutil_register_library_map(array(
     'PhabricatorConduitLogController' => 'applications/conduit/controller/PhabricatorConduitLogController.php',
     'PhabricatorConduitLogQuery' => 'applications/conduit/query/PhabricatorConduitLogQuery.php',
     'PhabricatorConduitLogSearchEngine' => 'applications/conduit/query/PhabricatorConduitLogSearchEngine.php',
+    'PhabricatorConduitManagementWorkflow' => 'applications/conduit/management/PhabricatorConduitManagementWorkflow.php',
     'PhabricatorConduitMethodCallLog' => 'applications/conduit/storage/PhabricatorConduitMethodCallLog.php',
     'PhabricatorConduitMethodQuery' => 'applications/conduit/query/PhabricatorConduitMethodQuery.php',
     'PhabricatorConduitRequestExceptionHandler' => 'aphront/handler/PhabricatorConduitRequestExceptionHandler.php',
@@ -7822,6 +7824,7 @@ phutil_register_library_map(array(
     'PhabricatorCommonPasswords' => 'Phobject',
     'PhabricatorConduitAPIController' => 'PhabricatorConduitController',
     'PhabricatorConduitApplication' => 'PhabricatorApplication',
+    'PhabricatorConduitCallManagementWorkflow' => 'PhabricatorConduitManagementWorkflow',
     'PhabricatorConduitCertificateToken' => 'PhabricatorConduitDAO',
     'PhabricatorConduitConsoleController' => 'PhabricatorConduitController',
     'PhabricatorConduitContentSource' => 'PhabricatorContentSource',
@@ -7832,6 +7835,7 @@ phutil_register_library_map(array(
     'PhabricatorConduitLogController' => 'PhabricatorConduitController',
     'PhabricatorConduitLogQuery' => 'PhabricatorCursorPagedPolicyAwareQuery',
     'PhabricatorConduitLogSearchEngine' => 'PhabricatorApplicationSearchEngine',
+    'PhabricatorConduitManagementWorkflow' => 'PhabricatorManagementWorkflow',
     'PhabricatorConduitMethodCallLog' => array(
       'PhabricatorConduitDAO',
       'PhabricatorPolicyInterface',
diff --git a/src/applications/conduit/management/PhabricatorConduitCallManagementWorkflow.php b/src/applications/conduit/management/PhabricatorConduitCallManagementWorkflow.php
new file mode 100644
index 0000000000..6cb3bd2409
--- /dev/null
+++ b/src/applications/conduit/management/PhabricatorConduitCallManagementWorkflow.php
@@ -0,0 +1,66 @@
+<?php
+
+final class PhabricatorConduitCallManagementWorkflow
+  extends PhabricatorConduitManagementWorkflow {
+
+  protected function didConstruct() {
+    $this
+      ->setName('call')
+      ->setSynopsis(pht('Call a Conduit method..'))
+      ->setArguments(
+        array(
+          array(
+            'name' => 'method',
+            'param' => 'method',
+            'help' => pht('Method to call.'),
+          ),
+          array(
+            'name' => 'input',
+            'param' => 'input',
+            'help' => pht(
+              'File to read parameters from, or "-" to read from '.
+              'stdin.'),
+          ),
+        ));
+  }
+
+  public function execute(PhutilArgumentParser $args) {
+    $viewer = $this->getViewer();
+
+    $method = $args->getArg('method');
+    if (!strlen($method)) {
+      throw new PhutilArgumentUsageException(
+        pht('Specify a method to call with "--method".'));
+    }
+
+    $input = $args->getArg('input');
+    if (!strlen($input)) {
+      throw new PhutilArgumentUsageException(
+        pht('Specify a file to read parameters from with "--input".'));
+    }
+
+    if ($input === '-') {
+      fprintf(STDERR, tsprintf("%s\n", pht('Reading input from stdin...')));
+      $input_json = file_get_contents('php://stdin');
+    } else {
+      $input_json = Filesystem::readFile($input);
+    }
+
+    $params = phutil_json_decode($input_json);
+
+    $result = id(new ConduitCall($method, $params))
+      ->setUser($viewer)
+      ->execute();
+
+    $output = array(
+      'result' => $result,
+    );
+
+    echo tsprintf(
+      "%B\n",
+      id(new PhutilJSON())->encodeFormatted($output));
+
+    return 0;
+  }
+
+}
diff --git a/src/applications/conduit/management/PhabricatorConduitManagementWorkflow.php b/src/applications/conduit/management/PhabricatorConduitManagementWorkflow.php
new file mode 100644
index 0000000000..4abb250fc4
--- /dev/null
+++ b/src/applications/conduit/management/PhabricatorConduitManagementWorkflow.php
@@ -0,0 +1,4 @@
+<?php
+
+abstract class PhabricatorConduitManagementWorkflow
+  extends PhabricatorManagementWorkflow {}