comparison tests/test-wireproto-serverreactor.py @ 37056:861e9d37e56e

wireproto: buffer output frames when in half duplex mode

Previously, when told that a response was ready, the server reactor
would instruct the caller to send frames immediately. This was OK
as an initial implementation. But it would not work for half-duplex
connections where the sender can't receive until all data has been
transmitted - such as httplib based clients.

In this commit, we teach the reactor that output frames should
be buffered until end of input is seen. This required a new
event to inform the reactor of end of input. The result from that
event will instruct the consumer to send all buffered frames.

The HTTP server is buffered by default.

This change effectively hides the complexity of buffering within
the reactor so that transports need not be concerned about it.
This helps keep the transports "dumb" and will make implementing
multiple requests-responses per atomic exchange (like an HTTP
request) much simpler.

Differential Revision: https://phab.mercurial-scm.org/D2860

37055:61393f888dfe

    wireprotoframing as framing,
)

ffs = framing.makeframefromhumanstring

def makereactor():
    return framing.serverreactor()

def sendframes(reactor, gen):
    """Send a generator of frame bytearray to a reactor.

    Emits a generator of results from ``onframerecv()`` calls.

            'command': b'mycommand',
            'args': {},
            'data': None,
        })

    def test1argument(self):
        reactor = makereactor()
        results = list(sendcommandframes(reactor, b'mycommand',
                                         {b'foo': b'bar'}))
        self.assertEqual(len(results), 2)

        self.assertaction(result, 'sendframes')
        self.assertframesequal(result[1]['framegen'], [
            b'error-response application some message',
        ])

if __name__ == '__main__':
    import silenttestrunner
    silenttestrunner.main(__name__)

37056:861e9d37e56e

    wireprotoframing as framing,
)

ffs = framing.makeframefromhumanstring

def makereactor(deferoutput=False):
    return framing.serverreactor(deferoutput=deferoutput)

def sendframes(reactor, gen):
    """Send a generator of frame bytearray to a reactor.

    Emits a generator of results from ``onframerecv()`` calls.

            'command': b'mycommand',
            'args': {},
            'data': None,
        })

        result = reactor.oninputeof()
        self.assertaction(result, 'noop')

    def test1argument(self):
        reactor = makereactor()
        results = list(sendcommandframes(reactor, b'mycommand',
                                         {b'foo': b'bar'}))
        self.assertEqual(len(results), 2)

        self.assertaction(result, 'sendframes')
        self.assertframesequal(result[1]['framegen'], [
            b'error-response application some message',
        ])

    def test1commanddeferresponse(self):
        """Responses when in deferred output mode are delayed until EOF."""
        reactor = makereactor(deferoutput=True)
        results = list(sendcommandframes(reactor, b'mycommand', {}))
        self.assertEqual(len(results), 1)
        self.assertaction(results[0], 'runcommand')

        result = reactor.onbytesresponseready(b'response')
        self.assertaction(result, 'noop')
        result = reactor.oninputeof()
        self.assertaction(result, 'sendframes')
        self.assertframesequal(result[1]['framegen'], [
            b'bytes-response eos response',
        ])

    def testmultiplecommanddeferresponse(self):
        reactor = makereactor(deferoutput=True)
        list(sendcommandframes(reactor, b'command1', {}))
        list(sendcommandframes(reactor, b'command2', {}))

        result = reactor.onbytesresponseready(b'response1')
        self.assertaction(result, 'noop')
        result = reactor.onbytesresponseready(b'response2')
        self.assertaction(result, 'noop')
        result = reactor.oninputeof()
        self.assertaction(result, 'sendframes')
        self.assertframesequal(result[1]['framegen'], [
            b'bytes-response eos response1',
            b'bytes-response eos response2'
        ])

if __name__ == '__main__':
    import silenttestrunner
    silenttestrunner.main(__name__)