Merge ~twom/launchpad:stats-fix-pageid-doctests into launchpad:master

[Tom Wardill]

Fix publication doctests for change in pageid generation

[Colin Watson (cjwatson)]

review: Approve

0bfb200... by Tom Wardill on 2020-09-23

Remove duplicate import

bd21869... by Tom Wardill on 2020-09-23

Allow callObject to calculate pageid directly

diff --git a/lib/lp/services/webapp/doc/webapp-publication.txt b/lib/lp/services/webapp/doc/webapp-publication.txt
index 046ae2f..ffe6a69 100644
--- a/lib/lp/services/webapp/doc/webapp-publication.txt
+++ b/lib/lp/services/webapp/doc/webapp-publication.txt
@@ -595,8 +595,9 @@ Originally, this variable isn't set.
 
     >>> 'launchpad.pageid' in request._orig_env
     False
+    >>> logout()
 
-It is set during the callObject() hook. The pageid is made of the
+It is set during the afterTraversal() hook. The pageid is made of the
 name of the context class and the view class name.
 
     >>> class TestView(object):
@@ -613,10 +614,13 @@ name of the context class and the view class name.
     ...     """Test context object."""
 
     >>> view = TestView(TestContext(), request)
-    >>> publication.callObject(request, view)
-    u'Result'
+    >>> publication.beforeTraversal(request)
+    >>> publication.afterTraversal(request, view)
     >>> print request._orig_env['launchpad.pageid']
     TestContext:TestView
+    >>> from lp.services.webapp.adapter import (
+    ...     clear_request_started, set_request_started)
+    >>> clear_request_started()
 
 
 Durations
@@ -682,8 +686,6 @@ some calls to prepare that code to what handleException expects.)
 If the exception is raised before we even start the traversal, then
 there's nothing to store.
 
-    >>> from lp.services.webapp.adapter import (
-    ...     clear_request_started, set_request_started)
     >>> logger.setLevel(logging.CRITICAL)
     >>> request, publication = get_request_and_publication()
     >>> request.setPrincipal(auth_utility.unauthenticatedPrincipal())
diff --git a/lib/lp/services/webapp/publication.py b/lib/lp/services/webapp/publication.py
index b76eec7..5c3e473 100644
--- a/lib/lp/services/webapp/publication.py
+++ b/lib/lp/services/webapp/publication.py
@@ -427,8 +427,12 @@ class LaunchpadBrowserPublication(
         request.setInWSGIEnvironment(
             'launchpad.userid', request.principal.id)
 
-        # pageid is calculated at `afterTraversal`
-        pageid = request._orig_env['launchpad.pageid']
+        # pageid is calculated at `afterTraversal`, but can be missing
+        # if callObject is used directly, so either use the one we've got
+        # or work it out.
+        pageid = request._orig_env.get(
+            'launchpad.pageid',
+            self._setPageIDInEnvironment(request, ob))
         # And spit the pageid out to our tracelog.
         tracelog(request, 'p', pageid)
 
@@ -552,6 +556,16 @@ class LaunchpadBrowserPublication(
             request.traversed_objects.append(ob)
         notify(BeforeTraverseEvent(ob, request))
 
+    def _setPageIDInEnvironment(self, request, view):
+        # The view may be security proxied
+        view = removeSecurityProxy(view)
+        # It's possible that the view is a bound method.
+        view = getattr(view, '__self__', view)
+        context = removeSecurityProxy(getattr(view, 'context', None))
+        pageid = self.constructPageID(view, context)
+        request.setInWSGIEnvironment('launchpad.pageid', pageid)
+        return pageid
+
     def afterTraversal(self, request, ob):
         """See zope.publisher.interfaces.IPublication.
 
@@ -562,13 +576,7 @@ class LaunchpadBrowserPublication(
         # Log the URL including vhost information to the ZServer tracelog.
         tracelog(request, 'u', request.getURL())
 
-        # The view may be security proxied
-        view = removeSecurityProxy(ob)
-        # It's possible that the view is a bound method.
-        view = getattr(view, '__self__', view)
-        context = removeSecurityProxy(getattr(view, 'context', None))
-        pageid = self.constructPageID(view, context)
-        request.setInWSGIEnvironment('launchpad.pageid', pageid)
+        pageid = self._setPageIDInEnvironment(request, ob)
 
         assert hasattr(request, '_traversal_start'), (
             'request._traversal_start, which should have been set by '