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
$ cat >> $HGRCPATH << EOF
> [extensions]
> fastannotate=
> [fastannotate]
> mainbranch=main
> EOF
$ hg init repo
$ cd repo
add or rename files on top of the master branch
$ echo a1 > a
$ echo b1 > b
$ hg commit -qAm 1
$ hg bookmark -i main
$ hg fastannotate --debug -nf b
fastannotate: b: 1 new changesets in the main branch
0 b: b1
$ hg fastannotate --debug -nf a
fastannotate: a: 1 new changesets in the main branch
0 a: a1
$ echo a2 >> a
$ cat > b << EOF
> b0
> b1
> EOF
$ hg mv a t
$ hg mv b a
$ hg mv t b
$ hg commit -m 'swap names'
existing linelogs are not helpful with such renames in side branches
$ hg fastannotate --debug -nf a
fastannotate: a: linelog cannot help in annotating this revision
1 a: b0
0 b: b1
$ hg fastannotate --debug -nf b
fastannotate: b: linelog cannot help in annotating this revision
0 a: a1
1 b: a2
move main branch forward, rebuild should happen
$ hg bookmark -i main -r . -q
$ hg fastannotate --debug -nf b
fastannotate: b: cache broken and deleted
fastannotate: b: 2 new changesets in the main branch
0 a: a1
1 b: a2
$ hg fastannotate --debug -nf b
fastannotate: b: using fast path (resolved fctx: True)
0 a: a1
1 b: a2
for rev 0, the existing linelog is still useful for a, but not for b
$ hg fastannotate --debug -nf a -r 0
fastannotate: a: using fast path (resolved fctx: True)
0 a: a1
$ hg fastannotate --debug -nf b -r 0
fastannotate: b: linelog cannot help in annotating this revision
0 b: b1
a rebuild can also be triggered if "the main branch last time" mismatches
$ echo a3 >> a
$ hg commit -m a3
$ cat >> b << EOF
> b3
> b4
> EOF
$ hg commit -m b4
$ hg bookmark -i main -q
$ hg fastannotate --debug -nf a
fastannotate: a: cache broken and deleted
fastannotate: a: 3 new changesets in the main branch
1 a: b0
0 b: b1
2 a: a3
$ hg fastannotate --debug -nf a
fastannotate: a: using fast path (resolved fctx: True)
1 a: b0
0 b: b1
2 a: a3
linelog can be updated without being helpful
$ hg mv a t
$ hg mv b a
$ hg mv t b
$ hg commit -m 'swap names again'
$ hg fastannotate --debug -nf b
fastannotate: b: 1 new changesets in the main branch
1 a: b0
0 b: b1
2 a: a3
$ hg fastannotate --debug -nf b
fastannotate: b: linelog cannot help in annotating this revision
1 a: b0
0 b: b1
2 a: a3
move main branch forward again, rebuilds are one-time
$ hg bookmark -i main -q
$ hg fastannotate --debug -nf a
fastannotate: a: cache broken and deleted
fastannotate: a: 4 new changesets in the main branch
0 a: a1
1 b: a2
3 b: b3
3 b: b4
$ hg fastannotate --debug -nf b
fastannotate: b: cache broken and deleted
fastannotate: b: 4 new changesets in the main branch
1 a: b0
0 b: b1
2 a: a3
$ hg fastannotate --debug -nf a
fastannotate: a: using fast path (resolved fctx: True)
0 a: a1
1 b: a2
3 b: b3
3 b: b4
$ hg fastannotate --debug -nf b
fastannotate: b: using fast path (resolved fctx: True)
1 a: b0
0 b: b1
2 a: a3
list changeset hashes to improve readability
$ hg log -T '{rev}:{node}\n'
4:980e1ab8c516350172928fba95b49ede3b643dca
3:14e123fedad9f491f5dde0beca2a767625a0a93a
2:96495c41e4c12218766f78cdf244e768d7718b0f
1:35c2b781234c994896aba36bd3245d3104e023df
0:653e95416ebb5dbcc25bbc7f75568c9e01f7bd2f
annotate a revision not in the linelog. linelog cannot be used, but does not get rebuilt either
$ hg fastannotate --debug -nf a -r 96495c41e4c12218766f78cdf244e768d7718b0f
fastannotate: a: linelog cannot help in annotating this revision
1 a: b0
0 b: b1
2 a: a3
$ hg fastannotate --debug -nf a -r 2
fastannotate: a: linelog cannot help in annotating this revision
1 a: b0
0 b: b1
2 a: a3
$ hg fastannotate --debug -nf a -r .
fastannotate: a: using fast path (resolved fctx: True)
0 a: a1
1 b: a2
3 b: b3
3 b: b4
annotate an ancient revision where the path matches. linelog can be used
$ hg fastannotate --debug -nf a -r 0
fastannotate: a: using fast path (resolved fctx: True)
0 a: a1
$ hg fastannotate --debug -nf a -r 653e95416ebb5dbcc25bbc7f75568c9e01f7bd2f
fastannotate: a: using fast path (resolved fctx: False)
0 a: a1