Initial work for day of the week targeting

adserver/decisionengine/backends.py

@@ -4,6 +4,7 @@
 
 from django.conf import settings
 from django.db import models
+from django.utils import timezone
 from user_agents import parse
 
 from ..analyzer.models import AnalyzedUrl
@@ -292,6 +293,10 @@ def filter_flight(self, flight):
         if flight.weighted_clicks_needed_this_interval() <= 0:
             return False
 
+        # Skip if the flight is not meant to show on these days
+        if not flight.show_to_day(timezone.now().strftime("%A").lower()):
+            return False
+
         return True
 
     def select_flight(self):

adserver/models.py

@@ -978,6 +978,12 @@ def excluded_domains(self):
             return []
         return self.targeting_parameters.get("exclude_domains", [])
 
+    @property
+    def days(self):
+        if not self.targeting_parameters:
+            return []
+        return self.targeting_parameters.get("days", [])
+
     @property
     def state(self):
         today = get_ad_day().date()
@@ -1032,6 +1038,9 @@ def get_exclude_countries_display(self):
         excluded_country_codes = self.excluded_countries
         return [COUNTRY_DICT.get(cc, "Unknown") for cc in excluded_country_codes]
 
+    def get_days_display(self):
+        return [day.capitalize() for day in self.days]
+
     def show_to_geo(self, geo_data):
         """
         Check if a flight is valid for a given country code.
@@ -1151,6 +1160,17 @@ def show_to_mobile(self, is_mobile):
 
         return True
 
+    def show_to_day(self, day):
+        """Check if a flight is valid for this traffic based on the day."""
+        if not self.targeting_parameters:
+            return True
+
+        days_targeting = self.targeting_parameters.get("days")
+        if days_targeting and day not in days_targeting:
+            return False
+
+        return True
+
     def show_on_publisher(self, publisher):
         if self.included_publishers:
             return publisher.slug in self.included_publishers

adserver/templates/adserver/includes/flight-metadata.html

@@ -128,6 +128,9 @@
         {% if flight.campaign.publisher_group_display %}
           <li>{% blocktrans with value=flight.campaign.publisher_group_display|join:", " %}Networks: {{ value }}{% endblocktrans %}</li>
         {% endif %}
+        {% if flight.targeting_parameters.days %}
+          <li>{% blocktrans with value=flight.get_days_display|join:', ' %}Days: {{ value }}{% endblocktrans %}</li>
+        {% endif %}
       </ul>
     </dd>
   {% endif %}

adserver/tests/test_advertiser_dashboard.py

@@ -273,6 +273,7 @@ def test_flight_detail_metadata(self):
             "exclude_publishers": ["readthedocs"],
             "exclude_domains": ["example.com"],
             "mobile_traffic": "exclude",
+            "days": ["saturday", "sunday"],
         }
         self.flight.save()
 
@@ -281,6 +282,7 @@ def test_flight_detail_metadata(self):
         self.assertContains(resp, "Exclude publishers")
         self.assertContains(resp, "Exclude domains")
         self.assertContains(resp, "Mobile traffic: exclude")
+        self.assertContains(resp, "Days: Saturday, Sunday")
 
     def test_flight_create_view(self):
         url = reverse(

adserver/tests/test_decision_engine.py

@@ -350,6 +350,47 @@ def test_flight_mobile_targeting(self):
         ad, _ = self.backend.get_ad_and_placement()
         self.assertIsNone(ad)
 
+    def test_flight_days_targeting(self):
+        # Remove existing flights
+        for flight in Flight.objects.all():
+            flight.live = False
+            flight.save()
+
+        # Setup a new flight and ad
+        flight = get(
+            Flight,
+            campaign=self.campaign,
+            live=True,
+            sold_clicks=100,
+            targeting_parameters={"days": "monday"},
+        )
+
+        self.advertisement1.flight = flight
+        self.advertisement1.save()
+
+        # Fun times with dates
+        with mock.patch("adserver.decisionengine.backends.timezone") as tz:
+
+            tz.now.return_value = datetime.datetime(2020, 6, 1, 0, 0, 0)  # Monday
+
+            # Monday targeting works
+            ad, _ = self.backend.get_ad_and_placement()
+            self.assertEqual(ad, self.advertisement1)
+
+            tz.now.return_value = datetime.datetime(2020, 6, 2, 0, 0, 0)  # Tuesday
+
+            # Ad is excluded
+            ad, _ = self.backend.get_ad_and_placement()
+            self.assertIsNone(ad)
+
+            # Set to target Tuesday
+            flight.targeting_parameters = {"days": ["tuesday"]}
+            flight.save()
+
+            # Ad is back
+            ad, _ = self.backend.get_ad_and_placement()
+            self.assertEqual(ad, self.advertisement1)
+
     def test_clicks_needed(self):
         self.assertEqual(self.include_flight.clicks_needed_this_interval(), 33)
 

adserver/validators.py

@@ -58,6 +58,15 @@ class TargetingParametersValidator(BaseValidator):
     limit_value = None  # required for classes extending BaseValidator
 
     mobile_traffic_values = ("exclude", "only")
+    days_values = (
+        "monday",
+        "tuesday",
+        "wednesday",
+        "thursday",
+        "friday",
+        "saturday",
+        "sunday",
+    )
 
     messages = {
         "invalid_type": _("Value must be a dict, not %(type)s"),
@@ -70,6 +79,7 @@ class TargetingParametersValidator(BaseValidator):
         "mobile": _(f"%(value)s must be one of {mobile_traffic_values}"),
         "str": _("%(word)s must be a string"),
         "percent": _("%(value)s must be a float between [0.0, 1.0]"),
+        "days": _(f"%(value)s must be one of {days_values}"),
     }
 
     validators = {
@@ -87,6 +97,7 @@ class TargetingParametersValidator(BaseValidator):
         "include_domains": "_validate_strs",
         "exclude_domains": "_validate_strs",
         "mobile_traffic": "_validate_mobile",
+        "days": "_validate_days",
     }
 
     def __init__(self, message=None):
@@ -137,6 +148,11 @@ def _validate_mobile(self, value):
         if value not in self.mobile_traffic_values:
             raise ValidationError(self.messages["mobile"], params={"value": value})
 
+    def _validate_days(self, values):
+        for value in values:
+            if value not in self.days_values:
+                raise ValidationError(self.messages["days"], params={"value": value})
+
     def _validate_regions(self, region_values):
         # Avoid a circular import since the models use these validators
         from .models import Region  # noqa

docker-compose.yml

@@ -25,6 +25,9 @@ services:
       - postgres
     volumes:
       - .:/app
+      # Make it so we can edit the start script dynamically,
+      # for example to install dependencies
+      - ./docker-compose/django/start:/start
     env_file:
       - ./.envs/local/django
       - ./.envs/local/postgres

docker-compose/django/start

@@ -4,6 +4,8 @@ set -o errexit
 set -o pipefail
 set -o nounset
 
+# Reinstall dependencies without rebuilding docker image
+# pip install -r /app/requirements/production.txt
 
 # Don't auto-migrate locally because this can cause weird issues when testing migrations
 # python manage.py migrate

docs/user-guide/administration.rst

@@ -67,7 +67,8 @@ The valid options here are:
 ``include_metro_codes``
     An allowlist of 3 digit DMA codes that can be combined with ``include_countries``.
     Not all of our geo targeting middlewares support targeting by metro.
-
+``days``
+    A lowercase list of days of the week where the flight should be shown. Generally used for weekdays or weekends.
 
 For a campaign that targets data science pages visited by users in the US & Canada not on mobile,
 an example targeting JSON would be::

requirements/production.txt

@@ -4,7 +4,7 @@
 gunicorn==20.0.4
 
 # Database driver
-psycopg2-binary==2.9.3
+psycopg2-binary==2.9.6 # Required for macOS
 
 # Email sending
 django-anymail==8.5