Never use "{branches}" in Mercurial

Summary:
Fixes T5304. Mercurial features a "{branches}" template keyword, documented as:

```
    branches      List of strings. The name of the branch on which the
                  changeset was committed. Will be empty if the branch name
                  was default.
```

At some time long in the past, I misinterpreted this to mean "list of branches where the branch head is a descendant of the commit". It is more like "list of zero or one elements, possibly containing the name of the branch the commit was originally made to, if that branch was not 'default'".

In fact, it seems like this is because a //very// long time in the past, Mercurial worked roughly like I expected:

> Ages ago (2005), we had a very different and ultimately unworkable
> approach to named branches that worked vaguely like .hgtags and allowed
> multiple branch names per revision.

http://marc.info/?l=mercurial-devel&m=129883069414855

This appears to be deprecated in modern Mercurial (it's not in the modern web documentation) although I can't find a commit about it so maybe that's just a documentation issue.

In any case, `{branches}` seems to never be useful: `{branch}` provides the same information without the awkward "default-if-empty" case.

Switch from `{branches}` to either `{branch}` (where that's good enough, notably in the hook engine) or `(descendants(%s) and head())`, which is equivalent to `--contains` in Git.

This fixes pushing to branches with spaces in their names, and makes the "Branches" / "Contains" queries moderately more consistent.

Test Plan:
  - Pushed to a Mercurial branch with a space in it.
  - Viewed list of branches in a Mercurial repository.
  - Viewed containing branches of a Mercurial commit in Diffusion.

Reviewers: btrahan

Reviewed By: btrahan

Subscribers: epriestley

Maniphest Tasks: T5304

Differential Revision: https://secure.phabricator.com/D9453

src/applications/diffusion/conduit/ConduitAPI_diffusion_branchquery_Method.php

@@ -62,41 +62,16 @@ final class ConduitAPI_diffusion_branchquery_Method
     $drequest = $this->getDiffusionRequest();
     $repository = $drequest->getRepository();
 
-    $refs = id(new DiffusionLowLevelMercurialBranchesQuery())
+    $query = id(new DiffusionLowLevelMercurialBranchesQuery())
-      ->setRepository($repository)
+      ->setRepository($repository);
-      ->execute();
 
-    // If we have a 'contains' query, filter these branches down to just the
-    // ones which contain the commit.
     $contains = $request->getValue('contains');
     if (strlen($contains)) {
-      list($branches_raw) = $repository->execxLocalCommand(
+      $query->withContainsCommit($contains);
-        'log --template %s --limit 1 --rev %s --',
-        '{branches}',
-        hgsprintf('%s', $contains));
-
-      $branches_raw = trim($branches_raw);
-      if (!strlen($branches_raw)) {
-        $containing_branches = array('default');
-      } else {
-        $containing_branches = explode(' ', $branches_raw);
-      }
-
-      $containing_branches = array_fuse($containing_branches);
-
-      // NOTE: We get this very slightly wrong: a branch may have multiple
-      // heads and we'll keep all of the heads of the branch, even if the
-      // commit is only on some of the heads. This should be rare, is probably
-      // more clear to users as is, and would potentially be expensive to get
-      // right since we'd have to do additional checks.
-
-      foreach ($refs as $key => $ref) {
-        if (empty($containing_branches[$ref->getShortName()])) {
-          unset($refs[$key]);
-        }
-      }
     }
 
+    $refs = $query->execute();
+
     return $this->processBranchRefs($request, $refs);
   }
 

src/applications/diffusion/engine/DiffusionCommitHookEngine.php

@@ -688,7 +688,7 @@ final class DiffusionCommitHookEngine extends Phobject {
     foreach (array('old', 'new') as $key) {
       $futures[$key] = $repository->getLocalCommandFuture(
         'heads --template %s',
-        '{node}\1{branches}\2');
+        '{node}\1{branch}\2');
     }
     // Wipe HG_PENDING out of the old environment so we see the pre-commit
     // state of the repository.
@@ -697,7 +697,7 @@ final class DiffusionCommitHookEngine extends Phobject {
     $futures['commits'] = $repository->getLocalCommandFuture(
       'log --rev %s --template %s',
       hgsprintf('%s:%s', $hg_node, 'tip'),
-      '{node}\1{branches}\2');
+      '{node}\1{branch}\2');
 
     // Resolve all of the futures now. We don't need the 'commits' future yet,
     // but it simplifies the logic to just get it out of the way.
@@ -978,15 +978,8 @@ final class DiffusionCommitHookEngine extends Phobject {
     $commits_lines = array_filter($commits_lines);
     $commit_map = array();
     foreach ($commits_lines as $commit_line) {
-      list($node, $branches_raw) = explode("\1", $commit_line);
+      list($node, $branch) = explode("\1", $commit_line);
-
+      $commit_map[$node] = array($branch);
-      if (!strlen($branches_raw)) {
-        $branches = array('default');
-      } else {
-        $branches = explode(' ', $branches_raw);
-      }
-
-      $commit_map[$node] = $branches;
     }
 
     return $commit_map;
@@ -1152,6 +1145,9 @@ final class DiffusionCommitHookEngine extends Phobject {
       case PhabricatorRepositoryType::REPOSITORY_TYPE_GIT:
         return idx($this->gitCommits, $identifier, array());
       case PhabricatorRepositoryType::REPOSITORY_TYPE_MERCURIAL:
+        // NOTE: This will be "the branch the commit was made to", not
+        // "a list of all branch heads which descend from the commit".
+        // This is consistent with Mercurial, but possibly confusing.
         return idx($this->mercurialCommits, $identifier, array());
       case PhabricatorRepositoryType::REPOSITORY_TYPE_SVN:
         // Subversion doesn't have branches.

src/applications/diffusion/query/lowlevel/DiffusionLowLevelMercurialBranchesQuery.php

@@ -6,21 +6,36 @@
 final class DiffusionLowLevelMercurialBranchesQuery
   extends DiffusionLowLevelQuery {
 
+  private $contains;
+
+  public function withContainsCommit($commit) {
+    $this->contains = $commit;
+    return $this;
+  }
+
   protected function executeQuery() {
     $repository = $this->getRepository();
 
-    // NOTE: `--debug` gives us 40-character hashes.
+    if ($this->contains !== null) {
+      $spec = hgsprintf('(descendants(%s) and head())', $this->contains);
+    } else {
+      $spec = hgsprintf('head()');
+    }
+
     list($stdout) = $repository->execxLocalCommand(
-      '--debug branches');
+      'log --template %s --rev %s',
-    $stdout = PhabricatorRepository::filterMercurialDebugOutput($stdout);
+      '{node}\1{branch}\2',
+      $spec);
 
     $branches = array();
 
-    $lines = ArcanistMercurialParser::parseMercurialBranches($stdout);
+    $lines = explode("\2", $stdout);
-    foreach ($lines as $name => $spec) {
+    $lines = array_filter($lines);
+    foreach ($lines as $line) {
+      list($node, $branch) = explode("\1", $line);
       $branches[] = id(new DiffusionRepositoryRef())
-        ->setShortName($name)
+        ->setShortName($branch)
-        ->setCommitIdentifier($spec['rev']);
+        ->setCommitIdentifier($node);
     }
 
     return $branches;