lfs: add git to the User-Agent header for blob transfers
As we were trying to transition off of the non production lfs-test-server for
further experimenting, one of the problems we ran into was interoperability. A
coworker setup gitbucket[1] to act as the blob server, tested with git, and
passed it off to me. But push failed with a message saying "abort: LFS server
returns invalid JSON:", and then proceeded to dump a huge HTML page to the
screen. It turns out that it is assuming that git is the only thing that wants
to do a blob transfer, and everything else is a web browser wanting HTML.
It's only a single data point, but I suspect other things may be doing this too.
RFC7231 gives an example [2] of listing multiple products in decreasing order of
significance. Since the standard provides for this, and since it works with the
one problematic server I found, I'm just enabling this by default for a better
UX.
There's nothing significant about the version of git chosen, other than it is
the current version.
[1] https://github.com/gitbucket/gitbucket/
[2] https://tools.ietf.org/html/rfc7231#page-46
--- a/hgext/lfs/blobstore.py Thu Dec 14 15:03:55 2017 -0800
+++ b/hgext/lfs/blobstore.py Thu Dec 14 13:04:08 2017 -0500
@@ -125,7 +125,8 @@
self.ui = ui
baseurl, authinfo = url.authinfo()
self.baseurl = baseurl.rstrip('/')
- self.urlopener = urlmod.opener(ui, authinfo)
+ useragent = 'mercurial/%s git/2.15.1' % util.version()
+ self.urlopener = urlmod.opener(ui, authinfo, useragent)
self.retry = ui.configint('lfs', 'retry')
def writebatch(self, pointers, fromstore):
--- a/mercurial/url.py Thu Dec 14 15:03:55 2017 -0800
+++ b/mercurial/url.py Thu Dec 14 13:04:08 2017 -0500
@@ -466,7 +466,7 @@
handlerfuncs = []
-def opener(ui, authinfo=None):
+def opener(ui, authinfo=None, useragent=None):
'''
construct an opener suitable for urllib2
authinfo will be added to the password manager
@@ -512,8 +512,14 @@
# own distribution name. Since servers should not be using the user
# agent string for anything, clients should be able to define whatever
# user agent they deem appropriate.
- agent = 'mercurial/proto-1.0 (Mercurial %s)' % util.version()
- opener.addheaders = [(r'User-agent', pycompat.sysstr(agent))]
+ #
+ # The custom user agent is for lfs, because unfortunately some servers
+ # do look at this value.
+ if not useragent:
+ agent = 'mercurial/proto-1.0 (Mercurial %s)' % util.version()
+ opener.addheaders = [(r'User-agent', pycompat.sysstr(agent))]
+ else:
+ opener.addheaders = [(r'User-agent', pycompat.sysstr(useragent))]
# This header should only be needed by wire protocol requests. But it has
# been sent on all requests since forever. We keep sending it for backwards