tests/hgweberror.py
author Gregory Szorc <gregory.szorc@gmail.com>
Sat, 10 Mar 2018 20:16:20 -0800
changeset 36876 97f44b0720e2
parent 36865 3d60a22e27f5
child 36887 4daa22071d5d
permissions -rw-r--r--
hgweb: port archive command to modern response API Well, I tried to go with PEP 3333's recommendations and only allow our WSGI application to emit data via a response generator. Unfortunately, the "archive" command calls into the zipfile and tarfile modules and these operator on file objects and must send their data to an object with write(). There's no easy way turn these write() calls into a generator. So, we teach our response type how to expose a file object like object that can be used to write() output. We try to keep the API consistent with how things work currently: callers must call a setbody*(), then sendresponse() to trigger sending of headers, and only then can they get a handle on the object to perform writing. This required overloading the return value of @webcommand functions even more. Fortunately, we're almost completely ported off the legacy API. So we should be able to simplify matters in the near future. A test relying on this functionality has also been updated to use the new API. Differential Revision: https://phab.mercurial-scm.org/D2792
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
23409
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     1
# A dummy extension that installs an hgweb command that throws an Exception.
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     2
27299
74e6de99ce7f tests: use absolute_import in hgweberror.py
Gregory Szorc <gregory.szorc@gmail.com>
parents: 23409
diff changeset
     3
from __future__ import absolute_import
74e6de99ce7f tests: use absolute_import in hgweberror.py
Gregory Szorc <gregory.szorc@gmail.com>
parents: 23409
diff changeset
     4
74e6de99ce7f tests: use absolute_import in hgweberror.py
Gregory Szorc <gregory.szorc@gmail.com>
parents: 23409
diff changeset
     5
from mercurial.hgweb import (
74e6de99ce7f tests: use absolute_import in hgweberror.py
Gregory Szorc <gregory.szorc@gmail.com>
parents: 23409
diff changeset
     6
    webcommands,
74e6de99ce7f tests: use absolute_import in hgweberror.py
Gregory Szorc <gregory.szorc@gmail.com>
parents: 23409
diff changeset
     7
)
23409
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     8
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     9
def raiseerror(web, req, tmpl):
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    10
    '''Dummy web command that raises an uncaught Exception.'''
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    11
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    12
    # Simulate an error after partial response.
36876
97f44b0720e2 hgweb: port archive command to modern response API
Gregory Szorc <gregory.szorc@gmail.com>
parents: 36865
diff changeset
    13
    if 'partialresponse' in web.req.qsparams:
97f44b0720e2 hgweb: port archive command to modern response API
Gregory Szorc <gregory.szorc@gmail.com>
parents: 36865
diff changeset
    14
        web.res.status = b'200 Script output follows'
97f44b0720e2 hgweb: port archive command to modern response API
Gregory Szorc <gregory.szorc@gmail.com>
parents: 36865
diff changeset
    15
        web.res.headers[b'Content-Type'] = b'text/plain'
97f44b0720e2 hgweb: port archive command to modern response API
Gregory Szorc <gregory.szorc@gmail.com>
parents: 36865
diff changeset
    16
        web.res.setbodywillwrite()
97f44b0720e2 hgweb: port archive command to modern response API
Gregory Szorc <gregory.szorc@gmail.com>
parents: 36865
diff changeset
    17
        list(web.res.sendresponse())
97f44b0720e2 hgweb: port archive command to modern response API
Gregory Szorc <gregory.szorc@gmail.com>
parents: 36865
diff changeset
    18
        web.res.getbodyfile().write(b'partial content\n')
23409
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    19
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    20
    raise AttributeError('I am an uncaught error!')
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    21
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    22
def extsetup(ui):
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    23
    setattr(webcommands, 'raiseerror', raiseerror)
dc4d2cd3aa3e hgweb: send proper HTTP response after uncaught exception
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    24
    webcommands.__all__.append('raiseerror')