( )⚙ D4772 wireprotov2: define type to represent pre-encoded object

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D4772

wireprotov2: define type to represent pre-encoded object
ClosedPublic

Authored by indygreg on Sep 26 2018, 9:09 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGed919b90acda: wireprotov2: define type to represent pre-encoded object
Summary

An upcoming commit will introduce a caching layer to command
serving. This will require the ability to cache pre-encoded data.

This commit introduces a type to represent pre-encoded data and
teaches the output layer to not CBOR encode an instance of that
type.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

indygreg created this revision.Sep 26 2018, 9:09 PM
Closed by commit rHGed919b90acda: wireprotov2: define type to represent pre-encoded object (authored by indygreg). · Explain WhyOct 3 2018, 11:29 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 11443

mercurial/wireprotoframing.py

from .i18n import _ from .i18n import _
from .thirdparty import ( from .thirdparty import (
attr, attr,
) )
from . import ( from . import (
encoding, encoding,
error, error,
util, util,
wireprototypes,
) )
from .utils import ( from .utils import (
cborutil, cborutil,
stringutil, stringutil,
) )
FRAME_HEADER_SIZE = 8 FRAME_HEADER_SIZE = 8
DEFAULT_MAX_FRAME_SIZE = 32768 DEFAULT_MAX_FRAME_SIZE = 32768
break break
try: try:
if not emitted: if not emitted:
yield createcommandresponseokframe(stream, requestid) yield createcommandresponseokframe(stream, requestid)
emitted = True emitted = True
# Objects emitted by command functions can be serializable
# data structures or special types.
# TODO consider extracting the content normalization to a
# standalone function, as it may be useful for e.g. cachers.
# A pre-encoded object is sent directly to the emitter.
if isinstance(o, wireprototypes.encodedresponse):
for frame in emitter.send(o.data):
yield frame
# A regular object is CBOR encoded.
else:
for chunk in cborutil.streamencode(o): for chunk in cborutil.streamencode(o):
for frame in emitter.send(chunk): for frame in emitter.send(chunk):
yield frame yield frame
except Exception as e: except Exception as e:
for frame in createerrorframe(stream, requestid, for frame in createerrorframe(stream, requestid,
'%s' % e, '%s' % e,
errtype='server'): errtype='server'):
yield frame yield frame
break break

mercurial/wireprototypes.py

# Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com> # Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
from .node import ( from .node import (
bin, bin,
hex, hex,
) )
from .i18n import _ from .i18n import _
from .thirdparty import (
attr,
)
from . import ( from . import (
error, error,
util, util,
) )
from .utils import ( from .utils import (
interfaceutil, interfaceutil,
) )
if not compengines: if not compengines:
raise error.Abort(_('%s config option does not specify any known ' raise error.Abort(_('%s config option does not specify any known '
'compression engines') % config, 'compression engines') % config,
hint=_('usable compression engines: %s') % hint=_('usable compression engines: %s') %
', '.sorted(validnames)) ', '.sorted(validnames))
return compengines return compengines
@attr.s
class encodedresponse(object):
"""Represents response data that is already content encoded.
Wire protocol version 2 only.
Commands typically emit Python objects that are encoded and sent over the
wire. If commands emit an object of this type, the encoding step is bypassed
and the content from this object is used instead.
"""
data = attr.ib()