Merge pull request #401 from palazzem/pyramid-exceptions

Use pyramid HTTPExceptions as valid response types

Author: Emanuele Palazzetti

.circleci/config.yml

@@ -449,8 +449,8 @@ jobs:
       - restore_cache:
           keys:
               - tox-cache-pyramid-{{ checksum "tox.ini" }}
-      - run: tox -e '{py27,py34,py35,py36}-pyramid{17,18}-webtest' --result-json /tmp/pyramid.1.results
-      - run: tox -e '{py27,py34,py35,py36}-pyramid-autopatch{17,18}-webtest' --result-json /tmp/pyramid.2.results
+      - run: tox -e '{py27,py34,py35,py36}-pyramid{17,18,19}-webtest' --result-json /tmp/pyramid.1.results
+      - run: tox -e '{py27,py34,py35,py36}-pyramid-autopatch{17,18,19}-webtest' --result-json /tmp/pyramid.2.results
       - persist_to_workspace:
           root: /tmp
           paths:

ddtrace/contrib/pyramid/trace.py

@@ -3,6 +3,7 @@
 import logging
 import pyramid.renderers
 from pyramid.settings import asbool
+from pyramid.httpexceptions import HTTPException
 import wrapt
 
 # project
@@ -63,6 +64,14 @@ def trace_tween(request):
                 response = None
                 try:
                     response = handler(request)
+                except HTTPException as e:
+                    # If the exception is a pyramid HTTPException,
+                    # that's still valuable information that isn't necessarily
+                    # a 500. For instance, HTTPFound is a 302.
+                    # As described in docs, Pyramid exceptions are all valid
+                    # response types
+                    response = e
+                    raise
                 except BaseException:
                     span.set_tag(http.STATUS_CODE, 500)
                     raise

tests/contrib/pyramid/app/__init__.py

@@ -0,0 +1 @@
+from .web import create_app  # noqa

tests/contrib/pyramid/app/web.py

@@ -0,0 +1,71 @@
+from ddtrace.contrib.pyramid import trace_pyramid
+
+from pyramid.response import Response
+from pyramid.config import Configurator
+from pyramid.renderers import render_to_response
+from pyramid.httpexceptions import (
+    HTTPInternalServerError,
+    HTTPFound,
+    HTTPNotFound,
+    HTTPException,
+    HTTPNoContent,
+)
+
+
+def create_app(settings, instrument):
+    """Return a pyramid wsgi app"""
+
+    def index(request):
+        return Response('idx')
+
+    def error(request):
+        raise HTTPInternalServerError("oh no")
+
+    def exception(request):
+        1 / 0
+
+    def json(request):
+        return {'a': 1}
+
+    def renderer(request):
+        return render_to_response('template.pt', {'foo': 'bar'}, request=request)
+
+    def raise_redirect(request):
+        raise HTTPFound()
+
+    def raise_no_content(request):
+        raise HTTPNoContent()
+
+    def custom_exception_view(context, request):
+        """Custom view that forces a HTTPException when no views
+        are found to handle given request
+        """
+        if 'raise_exception' in request.url:
+            raise HTTPNotFound()
+        else:
+            return HTTPNotFound()
+
+    config = Configurator(settings=settings)
+    config.add_route('index', '/')
+    config.add_route('error', '/error')
+    config.add_route('exception', '/exception')
+    config.add_route('json', '/json')
+    config.add_route('renderer', '/renderer')
+    config.add_route('raise_redirect', '/redirect')
+    config.add_route('raise_no_content', '/nocontent')
+    config.add_view(index, route_name='index')
+    config.add_view(error, route_name='error')
+    config.add_view(exception, route_name='exception')
+    config.add_view(json, route_name='json', renderer='json')
+    config.add_view(renderer, route_name='renderer', renderer='template.pt')
+    config.add_view(raise_redirect, route_name='raise_redirect')
+    config.add_view(raise_no_content, route_name='raise_no_content')
+    # required to reproduce a regression test
+    config.add_notfound_view(custom_exception_view)
+    # required for rendering tests
+    renderer = config.testing_add_renderer('template.pt')
+
+    if instrument:
+        trace_pyramid(config)
+
+    return config.make_wsgi_app(), renderer