Ensure that bots are always served the control page on live experiments

Author: gasman

experiments/wagtail_hooks.py

@@ -4,12 +4,13 @@
 from django.contrib.admin.utils import quote
 from django.core.urlresolvers import reverse
 from django.utils.translation import ugettext_lazy as _
-from experiments import admin_urls
+import user_agents
 from wagtail.contrib.modeladmin.helpers import ButtonHelper
 from wagtail.contrib.modeladmin.options import ModelAdmin, modeladmin_register
 from wagtail.contrib.modeladmin.views import CreateView, EditView
 from wagtail.wagtailcore import hooks
 
+from experiments import admin_urls
 from .models import Experiment
 from .utils import get_user_id, impersonate_other_page
 
@@ -91,6 +92,13 @@ def check_experiments(page, request, serve_args, serve_kwargs):
         if experiment.status == 'completed' and experiment.winning_variation is not None:
             variation = experiment.winning_variation
         else:
+            # always serve bots the control page
+            ua_string = request.META.get('HTTP_USER_AGENT')
+            if ua_string:
+                ua = user_agents.parse(ua_string)
+                if ua.is_bot:
+                    return
+
             user_id = get_user_id(request)
             variation = experiment.start_experiment_for_user(user_id, request)
 

setup.py

@@ -10,6 +10,9 @@
     author_email='[email protected]',
     url='https://github.com/torchbox/wagtail-experiments',
     packages=find_packages(),
+    install_requires=[
+        'user-agents>=1.0,<2.0',
+    ],
     license='BSD',
     long_description=open('README.rst').read(),
     classifiers=[

tests/tests.py

@@ -51,6 +51,27 @@ def test_selected_variation_depends_on_user_id(self):
             self.assertEqual(response.status_code, 200)
             self.assertContains(response, '<p>Welcome to our site! It&#39;s lovely to meet you.</p>')
 
+    def test_bot_user_agent_gets_control_page(self):
+        session = self.client.session
+
+        # non-bot user agent string
+        for x in range(0, 5):
+            session.clear()
+            session['experiment_user_id'] = '33333333-3333-3333-3333-333333333333'
+            session.save()
+            response = self.client.get('/', HTTP_USER_AGENT="Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0")
+            self.assertEqual(response.status_code, 200)
+            self.assertContains(response, '<p>Welcome to our site! It&#39;s lovely to meet you.</p>')
+
+        # bot user agent string
+        for x in range(0, 5):
+            session.clear()
+            session['experiment_user_id'] = '33333333-3333-3333-3333-333333333333'
+            session.save()
+            response = self.client.get('/', HTTP_USER_AGENT="Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)")
+            self.assertEqual(response.status_code, 200)
+            self.assertContains(response, '<p>Welcome to our site!</p>')
+
     def test_participant_is_logged(self):
         # initially there should be no experiment history
         self.assertEqual(ExperimentHistory.objects.filter(experiment=self.experiment).count(), 0)