sapling/edenscm/hgext/phrevset.py
Mateusz Kwapich d5bae8360a phrevset: avoid crashing on null graphql reply
Summary:
The Dxxxx revset does two things in parallel:
 * walks the changelog in the search of commit associated with Dxxx.
 * makes graphql query to resolve Dxxxx to the hash associated with the last
   submitted version.

This behaviour is clowny and confusing and should be changed long-term. This is
just a short term fix to prevent it from crashing in cases there's no local
commit associated with Dxxx (or it's very old) and the graphql query comes back
with empty result (because there are no versions for the diff).

Reviewed By: markbt

Differential Revision: D14851313

fbshipit-source-id: 14f7531aa4691007266291a38a016242de563de4
2019-04-09 07:53:43 -07:00

322 lines
10 KiB
Python

# phrevset.py - support for Phabricator revsets
#
# Copyright 2013 Facebook, Inc.
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.
"""provides support for Phabricator revsets
Allows for queries such as `hg log -r D1234567` to find the commit which
corresponds to a specific Differential revision.
Automatically handles commits already in subversion, or whose hash has
changed since submitting to Differential (due to amends or rebasing).
Requires arcanist to be installed and properly configured.
Repositories should include a callsign in their hgrc.
Example for www:
[phrevset]
callsign = E
"""
import json
import os
import re
import signal
import threading
from edenscm.mercurial import error, hg, namespaces, pycompat, registrar, util
from edenscm.mercurial.i18n import _
from .extlib.phabricator import arcconfig, diffprops, graphql
try:
from hgsubversion import util as svnutil
except ImportError:
svnutil = None
configtable = {}
configitem = registrar.configitem(configtable)
configitem("phrevset", "callsign", default=None)
namespacepredicate = registrar.namespacepredicate()
DIFFERENTIAL_REGEX = re.compile(
"Differential Revision: http.+?/" # Line start, URL
"D(?P<id>[0-9]+)", # Differential ID, just numeric part
flags=re.LOCALE,
)
DESCRIPTION_REGEX = re.compile(
"Commit r" # Prefix
"(?P<callsign>[A-Z]{1,})" # Callsign
"(?P<id>[a-f0-9]+)", # rev
flags=re.LOCALE,
)
def getdiff(repo, diffid):
"""Resolves a phabricator Diff number to a commit hash of it's latest version """
timeout = repo.ui.configint("ssl", "timeout", 5)
ca_certs = repo.ui.configpath("web", "cacerts")
try:
client = graphql.Client(
repodir=pycompat.getcwd(), ca_bundle=ca_certs, repo=repo
)
return client.getdifflatestversion(timeout, diffid)
except Exception as e:
raise error.Abort("Could not not call phabricator graphql API: %s" % e)
def finddiff(repo, diffid, querythread=None):
"""Scans the changelog for commit lines mentioning the Differential ID
If the optional querythread parameter is provided, it must be a threading.Thread
instance. It will be polled during the iteration and if it indicates that
the thread has finished, the function will raise StopIteration"""
repo.ui.debug("[diffrev] Traversing log for %s\n" % diffid)
# traverse the changelog backwards
for rev in repo.changelog.revs(start=len(repo.changelog), stop=0):
if rev % 100 == 0 and querythread and querythread.is_alive() is False:
raise StopIteration("Parallel query completed")
changectx = repo[rev]
desc = changectx.description()
match = DIFFERENTIAL_REGEX.search(desc)
if match and match.group("id") == diffid:
return changectx.rev()
return None
def forksearch(repo, diffid):
"""Perform a log traversal and GraphQL call in parallel
Returns a (revisions, graphql_response) tuple, where one of the items will be
None, depending on which process terminated first"""
repo.ui.debug("[diffrev] Starting graphql call\n")
result = [None, None]
def makegraphqlcall():
try:
result[0] = getdiff(repo, diffid)
except Exception as exc:
result[1] = exc
querythread = threading.Thread(target=makegraphqlcall, name="graphqlquery")
querythread.daemon = True
querythread.start()
try:
repo.ui.debug("[diffrev] Starting log walk\n")
rev = finddiff(repo, diffid, querythread)
repo.ui.debug("[diffrev] Parallel log walk completed with %s\n" % rev)
if rev is None:
# walked the entire repo and couldn't find the diff
raise error.Abort("Could not find diff D%s in changelog" % diffid)
return ([rev], None)
except StopIteration:
# search terminated because arc returned
# if returncode == 0, return arc's output
repo.ui.debug("[diffrev] graphql call returned %s\n" % result[0])
if result[1] is not None:
raise result[1]
return (None, result[0])
def parsedesc(repo, resp, ignoreparsefailure):
desc = resp["description"]
if desc is None:
if ignoreparsefailure:
return None
else:
raise error.Abort("No Conduit description")
match = DESCRIPTION_REGEX.match(desc)
if not match:
if ignoreparsefailure:
return None
else:
raise error.Abort("Cannot parse Conduit description '%s'" % desc)
callsign = match.group("callsign")
repo_callsign = repo.ui.config("phrevset", "callsign")
if callsign != repo_callsign:
raise error.Abort(
"Diff callsign '%s' is different from repo"
" callsign '%s'" % (callsign, repo_callsign)
)
return match.group("id")
@util.lrucachefunc
def revsetdiff(repo, diffid):
"""Return a set of revisions corresponding to a given Differential ID """
repo_callsign = repo.ui.config("phrevset", "callsign")
if repo_callsign is None:
msg = _("phrevset.callsign is not set - doing a linear search\n")
hint = _("This will be slow if the diff was not committed recently\n")
repo.ui.warn(msg)
repo.ui.warn(hint)
rev = finddiff(repo, diffid)
if rev is None:
raise error.Abort("Could not find diff D%s in changelog" % diffid)
else:
return [rev]
revs, resp = forksearch(repo, diffid)
if revs is not None:
# The log walk found the diff, nothing more to do
return revs
if resp is None:
# The graphql query finished but didn't return anything
return []
vcs = resp["source_control_system"]
repo.ui.debug("[diffrev] VCS is %s\n" % vcs)
if vcs == "svn" and svnutil:
# commit has landed in svn, parse the description to get the SVN
# revision and delegate to hgsubversion for the rest
svnrev = parsedesc(repo, resp, ignoreparsefailure=False)
repo.ui.debug("[diffrev] SVN rev is r%s\n" % svnrev)
return [repo[n].rev() for n in svnutil.lookuprev(repo, svnrev)]
elif vcs == "git":
gitrev = parsedesc(repo, resp, ignoreparsefailure=False)
repo.ui.debug("[diffrev] GIT rev is %s\n" % gitrev)
peerpath = repo.ui.expandpath("default")
remoterepo = hg.peer(repo, {}, peerpath)
remoterev = remoterepo.lookup("_gitlookup_git_%s" % gitrev)
repo.ui.debug("[diffrev] HG rev is %s\n" % remoterev.encode("hex"))
if not remoterev:
repo.ui.debug("[diffrev] Falling back to linear search\n")
linear_search_result = finddiff(repo, diffid)
if linear_search_result is None:
# walked the entire repo and couldn't find the diff
raise error.Abort("Could not find diff D%s in changelog" % diffid)
return [linear_search_result]
return [repo[remoterev].rev()]
elif vcs == "hg":
rev = parsedesc(repo, resp, ignoreparsefailure=True)
if rev:
# The response from phabricator contains a changeset ID.
# Convert it back to a rev number.
try:
return [repo[rev.encode("utf-8")].rev()]
except error.RepoLookupError:
# TODO: 's/svnrev/globalrev' after turning off Subversion
# servers. We will know about this when we remove the `svnrev`
# revset.
#
# Unfortunately the rev can also be a svnrev/globalrev :(.
if rev.isdigit():
try:
return [r for r in repo.revs("svnrev(%s)" % rev)]
except error.RepoLookupError:
pass
raise error.Abort(
"Landed commit for diff D%s not available "
'in current repository: run "hg pull" '
"to retrieve it" % diffid
)
# commit is still local, get its hash
props = resp["phabricator_version_properties"]["edges"]
commits = []
for prop in props:
if prop["node"]["property_name"] == "local:commits":
commits = json.loads(prop["node"]["property_value"])
# the JSON parser returns Unicode strings, convert to `str` in UTF-8
revs = [c["commit"].encode("utf-8") for c in commits.values()]
# verify all revisions exist in the current repo; if not, try to
# find their counterpart by parsing the log
results = set()
for rev in revs:
# TODO: This really should be searching in repo.unfiltered(),
# and then resolving successors if the commit was hidden.
try:
node = repo[rev.encode("utf-8")]
results.add(node.rev())
except error.RepoLookupError:
repo.ui.warn(_("Commit not found - doing a linear search\n"))
parsed_rev = finddiff(repo, diffid)
if not parsed_rev:
raise error.Abort(
"Could not find diff " "D%s in changelog" % diffid
)
results.add(parsed_rev)
if not results:
raise error.Abort("Could not find local commit for D%s" % diffid)
return set(results)
else:
if not vcs:
msg = (
"D%s does not have an associated version control system\n"
"You can view the diff at http://phabricator.fb.com/D%s\n\n"
)
repo.ui.warn(msg % (diffid, diffid))
return []
else:
raise error.Abort(
"Conduit returned unknown " 'sourceControlSystem "%s"' % vcs
)
def _lookupname(repo, name):
cl = repo.changelog
tonode = cl.node
if name.startswith("D") and name[1:].isdigit():
return [tonode(r) for r in revsetdiff(repo, name[1:])]
else:
return []
@namespacepredicate("phrevset", priority=70)
def _getnamespace(_repo):
return namespaces.namespace(
listnames=lambda repo: [], namemap=_lookupname, nodemap=lambda repo, node: []
)