Mercurial > hg
view tests/test-win32text.t @ 24545:9e0c67e84896
json: implement {tags} template
Tags is pretty easy to implement. Let's start there.
The output is slightly different from `hg tags -Tjson`. For reference,
the CLI has the following output:
[
{
"node": "e2049974f9a23176c2addb61d8f5b86e0d620490",
"rev": 29880,
"tag": "tip",
"type": ""
},
...
]
Our output has the format:
{
"node": "0aeb19ea57a6d223bacddda3871cb78f24b06510",
"tags": [
{
"node": "e2049974f9a23176c2addb61d8f5b86e0d620490",
"tag": "tag1",
"date": [1427775457.0, 25200]
},
...
]
}
"rev" is omitted because it isn't a reliable identifier. We shouldn't
be exposing them in web APIs and giving the impression it remotely
resembles a stable identifier. Perhaps we could one day hide this behind
a config option (it might be useful to expose when running servers
locally).
The "type" of the tag isn't defined because this information isn't yet
exposed to the hgweb templater (it could be in a follow-up) and because
it is questionable whether different types should be exposed at all.
(Should the web interface really be exposing "local" tags?)
We use an object for the outer type instead of Array for a few reasons.
First, it is extensible. If we ever need to throw more global properties
into the output, we can do that without breaking backwards compatibility
(property additions should be backwards compatible). Second, uniformity
in web APIs is nice. Having everything return objects seems much saner than
a mix of array and object. Third, there are security issues with arrays
in older browsers. The JSON web services world almost never uses arrays
as the main type for this reason.
Another possibly controversial part about this patch is how dates are
defined. While JSON has a Date type, it is based on the JavaScript Date
type, which is widely considered a pile of garbage. It is a non-starter
for this reason.
Many of Mercurial's built-in date filters drop seconds resolution. So
that's a non-starter as well, since we want the API to be lossless where
possible. rfc3339date, rfc822date, isodatesec, and date are all lossless.
However, they each require the client to perform string parsing on top of
JSON decoding. While date parsing libraries are pretty ubiquitous, some
languages don't have them out of the box. However, pretty much every
programming language can deal with UNIX timestamps (which are just
integers or floats). So, we choose to use Mercurial's internal date
representation, which in JSON is modeled as float seconds since UNIX
epoch and an integer timezone offset from UTC (keep in mind
JavaScript/JSON models all "Numbers" as double prevision floating point
numbers, so there isn't a difference between ints and floats in JSON).
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Tue, 31 Mar 2015 14:52:21 -0700 |
parents | c63a09b6b337 |
children | 4b0fc75f9403 |
line wrap: on
line source
$ hg init t $ cd t $ cat > unix2dos.py <<EOF > import sys > > for path in sys.argv[1:]: > data = file(path, 'rb').read() > data = data.replace('\n', '\r\n') > file(path, 'wb').write(data) > EOF $ echo '[hooks]' >> .hg/hgrc $ echo 'pretxncommit.crlf = python:hgext.win32text.forbidcrlf' >> .hg/hgrc $ echo 'pretxnchangegroup.crlf = python:hgext.win32text.forbidcrlf' >> .hg/hgrc $ cat .hg/hgrc [hooks] pretxncommit.crlf = python:hgext.win32text.forbidcrlf pretxnchangegroup.crlf = python:hgext.win32text.forbidcrlf $ echo hello > f $ hg add f commit should succeed $ hg ci -m 1 $ hg clone . ../zoz updating to branch default 1 files updated, 0 files merged, 0 files removed, 0 files unresolved $ cp .hg/hgrc ../zoz/.hg $ python unix2dos.py f commit should fail $ hg ci -m 2.1 attempt to commit or push text file(s) using CRLF line endings in f583ea08d42a: f transaction abort! rollback completed abort: pretxncommit.crlf hook failed [255] $ mv .hg/hgrc .hg/hgrc.bak commits should succeed $ hg ci -m 2 $ hg cp f g $ hg ci -m 2.2 push should fail $ hg push ../zoz pushing to ../zoz searching for changes adding changesets adding manifests adding file changes added 2 changesets with 2 changes to 2 files attempt to commit or push text file(s) using CRLF line endings in bc2d09796734: g in b1aa5cde7ff4: f To prevent this mistake in your local repository, add to Mercurial.ini or .hg/hgrc: [hooks] pretxncommit.crlf = python:hgext.win32text.forbidcrlf and also consider adding: [extensions] win32text = [encode] ** = cleverencode: [decode] ** = cleverdecode: transaction abort! rollback completed abort: pretxnchangegroup.crlf hook failed [255] $ mv .hg/hgrc.bak .hg/hgrc $ echo hello > f $ hg rm g commit should succeed $ hg ci -m 2.3 push should succeed $ hg push ../zoz pushing to ../zoz searching for changes adding changesets adding manifests adding file changes added 3 changesets with 3 changes to 2 files and now for something completely different $ mkdir d $ echo hello > d/f2 $ python unix2dos.py d/f2 $ hg add d/f2 $ hg ci -m 3 attempt to commit or push text file(s) using CRLF line endings in 053ba1a3035a: d/f2 transaction abort! rollback completed abort: pretxncommit.crlf hook failed [255] $ hg revert -a forgetting d/f2 (glob) $ rm d/f2 $ hg rem f $ hg ci -m 4 $ $PYTHON -c 'file("bin", "wb").write("hello\x00\x0D\x0A")' $ hg add bin $ hg ci -m 5 $ hg log -v changeset: 5:f0b1c8d75fce tag: tip user: test date: Thu Jan 01 00:00:00 1970 +0000 files: bin description: 5 changeset: 4:77796dbcd4ad user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f description: 4 changeset: 3:7c1b5430b350 user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f g description: 2.3 changeset: 2:bc2d09796734 user: test date: Thu Jan 01 00:00:00 1970 +0000 files: g description: 2.2 changeset: 1:b1aa5cde7ff4 user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f description: 2 changeset: 0:fcf06d5c4e1d user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f description: 1 $ hg clone . dupe updating to branch default 1 files updated, 0 files merged, 0 files removed, 0 files unresolved $ for x in a b c d; do echo content > dupe/$x; done $ hg -R dupe add adding dupe/a (glob) adding dupe/b (glob) adding dupe/c (glob) adding dupe/d (glob) $ python unix2dos.py dupe/b dupe/c dupe/d $ hg -R dupe ci -m a dupe/a $ hg -R dupe ci -m b/c dupe/[bc] $ hg -R dupe ci -m d dupe/d $ hg -R dupe log -v changeset: 8:67ac5962ab43 tag: tip user: test date: Thu Jan 01 00:00:00 1970 +0000 files: d description: d changeset: 7:68c127d1834e user: test date: Thu Jan 01 00:00:00 1970 +0000 files: b c description: b/c changeset: 6:adbf8bf7f31d user: test date: Thu Jan 01 00:00:00 1970 +0000 files: a description: a changeset: 5:f0b1c8d75fce user: test date: Thu Jan 01 00:00:00 1970 +0000 files: bin description: 5 changeset: 4:77796dbcd4ad user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f description: 4 changeset: 3:7c1b5430b350 user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f g description: 2.3 changeset: 2:bc2d09796734 user: test date: Thu Jan 01 00:00:00 1970 +0000 files: g description: 2.2 changeset: 1:b1aa5cde7ff4 user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f description: 2 changeset: 0:fcf06d5c4e1d user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f description: 1 $ hg pull dupe pulling from dupe searching for changes adding changesets adding manifests adding file changes added 3 changesets with 4 changes to 4 files attempt to commit or push text file(s) using CRLF line endings in 67ac5962ab43: d in 68c127d1834e: b in 68c127d1834e: c To prevent this mistake in your local repository, add to Mercurial.ini or .hg/hgrc: [hooks] pretxncommit.crlf = python:hgext.win32text.forbidcrlf and also consider adding: [extensions] win32text = [encode] ** = cleverencode: [decode] ** = cleverdecode: transaction abort! rollback completed abort: pretxnchangegroup.crlf hook failed [255] $ hg log -v changeset: 5:f0b1c8d75fce tag: tip user: test date: Thu Jan 01 00:00:00 1970 +0000 files: bin description: 5 changeset: 4:77796dbcd4ad user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f description: 4 changeset: 3:7c1b5430b350 user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f g description: 2.3 changeset: 2:bc2d09796734 user: test date: Thu Jan 01 00:00:00 1970 +0000 files: g description: 2.2 changeset: 1:b1aa5cde7ff4 user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f description: 2 changeset: 0:fcf06d5c4e1d user: test date: Thu Jan 01 00:00:00 1970 +0000 files: f description: 1 $ rm .hg/hgrc $ (echo some; echo text) > f3 $ $PYTHON -c 'file("f4.bat", "wb").write("rem empty\x0D\x0A")' $ hg add f3 f4.bat $ hg ci -m 6 $ cat bin hello\x00\r (esc) $ cat f3 some text $ cat f4.bat rem empty\r (esc) $ echo '[extensions]' >> .hg/hgrc $ echo 'win32text = ' >> .hg/hgrc $ echo '[decode]' >> .hg/hgrc $ echo '** = cleverdecode:' >> .hg/hgrc $ echo '[encode]' >> .hg/hgrc $ echo '** = cleverencode:' >> .hg/hgrc $ cat .hg/hgrc [extensions] win32text = [decode] ** = cleverdecode: [encode] ** = cleverencode: Trigger deprecation warning: $ hg id -t win32text is deprecated: http://mercurial.selenic.com/wiki/Win32TextExtension tip Disable warning: $ echo '[win32text]' >> .hg/hgrc $ echo 'warn = no' >> .hg/hgrc $ hg id -t tip $ rm f3 f4.bat bin $ hg co -C WARNING: f4.bat already has CRLF line endings and does not need EOL conversion by the win32text plugin. Before your next commit, please reconsider your encode/decode settings in Mercurial.ini or $TESTTMP/t/.hg/hgrc. (glob) 3 files updated, 0 files merged, 0 files removed, 0 files unresolved $ cat bin hello\x00\r (esc) $ cat f3 some\r (esc) text\r (esc) $ cat f4.bat rem empty\r (esc) $ $PYTHON -c 'file("f5.sh", "wb").write("# empty\x0D\x0A")' $ hg add f5.sh $ hg ci -m 7 $ cat f5.sh # empty\r (esc) $ hg cat f5.sh # empty $ echo '% just linefeed' > linefeed $ hg ci -qAm 8 linefeed $ cat linefeed % just linefeed $ hg cat linefeed % just linefeed $ hg st -q $ hg revert -a linefeed no changes needed to linefeed $ cat linefeed % just linefeed $ hg st -q $ echo modified >> linefeed $ hg st -q M linefeed $ hg revert -a reverting linefeed $ hg st -q $ cat linefeed % just linefeed\r (esc) $ cd ..