This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8170

phabricator: update the protocol documentation
ClosedPublic

Authored by mharbison72 on Feb 26 2020, 2:51 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGadb93aa98c78: phabricator: update the protocol documentation
Summary

The branch property wasn't added to the hg:meta example when it was added to
the metadata in d49ab47be8a6. Additionally, properties in the Differential
Revision dict is a dinctionary, not a list. While here, also alphabetize the
responses from Phabricator because that's how it is being printed with
hg debugcallconduit, and this makes it easier to compare.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

mharbison72 created this revision.Feb 26 2020, 2:51 PM
pulkit accepted this revision.Feb 27 2020, 2:41 AM
This revision is now accepted and ready to land.Feb 27 2020, 2:41 AM
mharbison72 added a commit: rHGadb93aa98c78: phabricator: update the protocol documentation.Feb 27 2020, 3:12 AM
Closed by commit rHGadb93aa98c78: phabricator: update the protocol documentation (authored by mharbison72). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext/phabricator.py (62 lines)

Diff 20353

hgext/phabricator.py

"""return a list of "Differential Revision" dicts """return a list of "Differential Revision" dicts
spec is a string using a simple query language, see docstring in phabread spec is a string using a simple query language, see docstring in phabread
for details. for details.
A "Differential Revision dict" looks like: A "Differential Revision dict" looks like:
{ {
"id": "2", "activeDiffPHID": "PHID-DIFF-xoqnjkobbm6k4dk6hi72",
"phid": "PHID-DREV-672qvysjcczopag46qty", "authorPHID": "PHID-USER-tv3ohwc4v4jeu34otlye",
"title": "example", "auxiliary": {
"uri": "https://phab.example.com/D2", "phabricator:depends-on": [
"PHID-DREV-gbapp366kutjebt7agcd"
]
"phabricator:projects": [],
},
"branch": "default",
"ccs": [],
"commits": [],
"dateCreated": "1499181406", "dateCreated": "1499181406",
"dateModified": "1499182103", "dateModified": "1499182103",
"authorPHID": "PHID-USER-tv3ohwc4v4jeu34otlye",
"status": "0",
"statusName": "Needs Review",
"properties": [],
"branch": null,
"summary": "",
"testPlan": "",
"lineCount": "2",
"activeDiffPHID": "PHID-DIFF-xoqnjkobbm6k4dk6hi72",
"diffs": [ "diffs": [
"3", "3",
"4", "4",
], ],
"commits": [],
"reviewers": [],
"ccs": [],
"hashes": [], "hashes": [],
"auxiliary": { "id": "2",
"phabricator:projects": [], "lineCount": "2",
"phabricator:depends-on": [ "phid": "PHID-DREV-672qvysjcczopag46qty",
"PHID-DREV-gbapp366kutjebt7agcd" "properties": {},
]
},
"repositoryPHID": "PHID-REPO-hub2hx62ieuqeheznasv", "repositoryPHID": "PHID-REPO-hub2hx62ieuqeheznasv",
"reviewers": [],
"sourcePath": null "sourcePath": null
"status": "0",
"statusName": "Needs Review",
"summary": "",
"testPlan": "",
"title": "example",
"uri": "https://phab.example.com/D2",
} }
""" """
# TODO: replace differential.query and differential.querydiffs with
# differential.diff.search because the former (and their output) are
# frozen, and planned to be deprecated and removed.
def fetch(params): def fetch(params):
"""params -> single drev or None""" """params -> single drev or None"""
key = (params.get(b'ids') or params.get(b'phids') or [None])[0] key = (params.get(b'ids') or params.get(b'phids') or [None])[0]
if key in prefetched: if key in prefetched:
return prefetched[key] return prefetched[key]
drevs = callconduit(repo.ui, b'differential.query', params) drevs = callconduit(repo.ui, b'differential.query', params)
# Fill prefetched with the result # Fill prefetched with the result
def getdiffmeta(diff): def getdiffmeta(diff):
"""get commit metadata (date, node, user, p1) from a diff object """get commit metadata (date, node, user, p1) from a diff object
The metadata could be "hg:meta", sent by phabsend, like: The metadata could be "hg:meta", sent by phabsend, like:
"properties": { "properties": {
"hg:meta": { "hg:meta": {
"branch": "default",
"date": "1499571514 25200", "date": "1499571514 25200",
"node": "98c08acae292b2faf60a279b4189beb6cff1414d", "node": "98c08acae292b2faf60a279b4189beb6cff1414d",
"user": "Foo Bar <foo@example.com>", "user": "Foo Bar <foo@example.com>",
"parent": "6d0abad76b30e4724a37ab8721d630394070fe16" "parent": "6d0abad76b30e4724a37ab8721d630394070fe16"
} }
} }
Or converted from "local:commits", sent by "arc", like: Or converted from "local:commits", sent by "arc", like:
"properties": { "properties": {
"local:commits": { "local:commits": {
"98c08acae292b2faf60a279b4189beb6cff1414d": { "98c08acae292b2faf60a279b4189beb6cff1414d": {
"author": "Foo Bar", "author": "Foo Bar",
"time": 1499546314, "authorEmail": "foo@example.com"
"branch": "default", "branch": "default",
"tag": "",
"commit": "98c08acae292b2faf60a279b4189beb6cff1414d", "commit": "98c08acae292b2faf60a279b4189beb6cff1414d",
"rev": "98c08acae292b2faf60a279b4189beb6cff1414d",
"local": "1000", "local": "1000",
"message": "...",
"parents": ["6d0abad76b30e4724a37ab8721d630394070fe16"], "parents": ["6d0abad76b30e4724a37ab8721d630394070fe16"],
"rev": "98c08acae292b2faf60a279b4189beb6cff1414d",
"summary": "...", "summary": "...",
"message": "...", "tag": "",
"authorEmail": "foo@example.com" "time": 1499546314,
} }
} }
} }
Note: metadata extracted from "local:commits" will lose time zone Note: metadata extracted from "local:commits" will lose time zone
information. information.
""" """
props = diff.get(b'properties') or {} props = diff.get(b'properties') or {}