cborutil: implement sans I/O decoder
The vendored CBOR package decodes by calling read(n) on an object.
There are a number of disadvantages to this:
* Uses blocking I/O. If sufficient data is not available, the decoder
will hang until it is.
* No support for partial reads. If the read(n) returns less data than
requested, the decoder raises an error.
* Requires the use of a file like object. If the original data is in
say a buffer, we need to "cast" it to e.g. a BytesIO to appease the
decoder.
In addition, the vendored CBOR decoder doesn't provide flexibility
that we desire. Specifically:
* It buffers indefinite length bytestrings instead of streaming them.
* It doesn't allow limiting the set of types that can be decoded. This
property is useful when implementing a "hardened" decoder that is
less susceptible to abusive input.
* It doesn't provide sufficient "hook points" and introspection to
institute checks around behavior. These are useful for implementing
a "hardened" decoder.
This all adds up to a reasonable set of justifications for writing our
own decoder.
So, this commit implements our own CBOR decoder.
At the heart of the decoder is a function that decodes a single "item"
from a buffer. This item can be a complete simple value or a special
value, such as "start of array." Using this function, we can build a
decoder that effectively iterates over the stream of decoded items and
builds up higher-level values, such as arrays, maps, sets, and indefinite
length bytestrings. And we can do this without performing I/O in the
decoder itself.
The core of the sans I/O decoder will probably not be used directly.
Instead, it is expected that we'll build utility functions for invoking
the decoder given specific input types. This will allow extreme
flexibility in how data is delivered to the decoder.
I'm pretty happy with the state of the decoder modulo the TODO items
to track wanted features to help with a "hardened" decoder. The one
thing I could be convinced to change is the handling of semantic tags.
Since we only support a single semantic tag (sets), I thought it would
be easier to handle them inline in decodeitem(). This is simpler now.
But if we add support for other semantic tags, it will likely be easier
to move semantic tag handling outside of decodeitem(). But, properly
supporting semantic tags opens up a whole can of worms, as many
semantic tags imply new types. I'm optimistic we won't need these in
Mercurial. But who knows.
I'm also pretty happy with the test coverage. Writing comprehensive
tests for partial decoding did flush out a handful of bugs. One
general improvement to testing would be fuzz testing for partial
decoding. I may implement that later. I also anticipate switching the
wire protocol code to this new decoder will flush out any lingering
bugs.
Differential Revision: https://phab.mercurial-scm.org/D4414
# init
$ hg init
$ echo a > a
$ hg add a
$ hg commit -m'a'
$ echo b > b
$ hg add b
$ hg commit -m'b'
$ hg up -C 0
0 files updated, 0 files merged, 1 files removed, 0 files unresolved
$ echo c > c
$ hg add c
$ hg commit -m'c'
created new head
# test merging of diverged bookmarks
$ hg bookmark -r 1 "c@diverge"
$ hg bookmark -r 1 b
$ hg bookmark c
$ hg bookmarks
b 1:d2ae7f538514
* c 2:d36c0562f908
c@diverge 1:d2ae7f538514
$ hg merge "c@diverge"
1 files updated, 0 files merged, 0 files removed, 0 files unresolved
(branch merge, don't forget to commit)
$ hg commit -m'merge'
$ hg bookmarks
b 1:d2ae7f538514
* c 3:b8f96cf4688b
$ hg up -C 3
0 files updated, 0 files merged, 0 files removed, 0 files unresolved
(leaving bookmark c)
$ echo d > d
$ hg add d
$ hg commit -m'd'
$ hg up -C 3
0 files updated, 0 files merged, 1 files removed, 0 files unresolved
$ echo e > e
$ hg add e
$ hg commit -m'e'
created new head
$ hg up -C 5
0 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ hg bookmark e
$ hg bookmarks
b 1:d2ae7f538514
c 3:b8f96cf4688b
* e 5:26bee9c5bcf3
# the picked side is bookmarked
$ hg up -C 4
1 files updated, 0 files merged, 1 files removed, 0 files unresolved
(leaving bookmark e)
$ hg merge
abort: heads are bookmarked - please merge with an explicit rev
(run 'hg heads' to see all heads)
[255]
# our revision is bookmarked
$ hg up -C e
1 files updated, 0 files merged, 1 files removed, 0 files unresolved
(activating bookmark e)
$ hg merge
abort: no matching bookmark to merge - please merge with an explicit rev or bookmark
(run 'hg heads' to see all heads)
[255]
# merge bookmark heads
$ hg up -C 4
1 files updated, 0 files merged, 1 files removed, 0 files unresolved
(leaving bookmark e)
$ echo f > f
$ hg commit -Am "f"
adding f
$ hg bookmarks -r 4 "e@diverged"
$ hg up -q -C "e@diverged"
$ hg merge
1 files updated, 0 files merged, 0 files removed, 0 files unresolved
(branch merge, don't forget to commit)
$ hg parents
changeset: 4:a0546fcfe0fb
bookmark: e@diverged
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: d
changeset: 5:26bee9c5bcf3
bookmark: e
parent: 3:b8f96cf4688b
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: e
$ hg up -C e
1 files updated, 0 files merged, 1 files removed, 0 files unresolved
(activating bookmark e)
$ hg bookmarks
b 1:d2ae7f538514
c 3:b8f96cf4688b
* e 5:26bee9c5bcf3
e@diverged 4:a0546fcfe0fb
$ hg merge
1 files updated, 0 files merged, 0 files removed, 0 files unresolved
(branch merge, don't forget to commit)
$ hg commit -m'merge'
$ hg bookmarks
b 1:d2ae7f538514
c 3:b8f96cf4688b
* e 7:ca784329f0ba
# test warning when all heads are inactive bookmarks
$ hg up -C 6
1 files updated, 0 files merged, 1 files removed, 0 files unresolved
(leaving bookmark e)
$ echo g > g
$ hg commit -Am 'g'
adding g
$ hg bookmark -i g
$ hg bookmarks
b 1:d2ae7f538514
c 3:b8f96cf4688b
e 7:ca784329f0ba
g 8:04dd21731d95
$ hg heads
changeset: 8:04dd21731d95
bookmark: g
tag: tip
parent: 6:be381d1126a0
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: g
changeset: 7:ca784329f0ba
bookmark: e
parent: 5:26bee9c5bcf3
parent: 4:a0546fcfe0fb
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: merge
$ hg merge
abort: heads are bookmarked - please merge with an explicit rev
(run 'hg heads' to see all heads)
[255]