Track complaint vs delivery failure independently

Author: dstufft

tests/unit/email/ses/test_models.py

@@ -34,6 +34,8 @@ def test_can_deliver(self, db_session):
         status.deliver()
 
         assert status.save().status == "Delivered"
+        assert not email.is_having_delivery_issues
+        assert not email.spam_complaint
 
     def test_delivery_resets_transient_bounces(self, db_session):
         email = EmailFactory.create(transient_bounces=3)
@@ -66,6 +68,7 @@ def test_soft_bounced_unverifies_when_going_over(self, db_session):
         assert email.transient_bounces == MAX_TRANSIENT_BOUNCES + 1
         assert not email.verified
         assert email.is_having_delivery_issues
+        assert not email.spam_complaint
 
     def test_soft_bounce_after_delivery_does_nothing(self, db_session):
         email = EmailFactory.create(transient_bounces=3)
@@ -88,6 +91,7 @@ def test_hard_bounce_unverifies_email(self, db_session):
         assert status.save().status == "Bounced"
         assert not email.verified
         assert email.is_having_delivery_issues
+        assert not email.spam_complaint
 
     def test_hard_bounce_resets_transient_bounces(self, db_session):
         email = EmailFactory.create(transient_bounces=3)
@@ -108,7 +112,8 @@ def test_complain_unverifies_email(self, db_session):
 
         assert status.save().status == "Complained"
         assert not email.verified
-        assert email.is_having_delivery_issues
+        assert not email.is_having_delivery_issues
+        assert email.spam_complaint
 
     def test_complain_resets_transient_bounces(self, db_session):
         email = EmailFactory.create(transient_bounces=3)

warehouse/accounts/models.py

@@ -113,6 +113,11 @@ class Email(db.ModelBase):
     verified = Column(Boolean, nullable=False)
 
     # Deliverability information
+    spam_complaint = Column(
+        Boolean,
+        nullable=False,
+        server_default=sql.false(),
+    )
     is_having_delivery_issues = Column(
         Boolean,
         nullable=False,

warehouse/email/ses/models.py

@@ -94,16 +94,22 @@ def complain(self):
 
     # Outputs
     @_machine.output()
-    def _flag_email(self):
-        self._unverify_email(self._get_email())
+    def _handle_bounce(self):
+        self._unverify_for_delivery_failure(self._get_email())
+
+    @_machine.output()
+    def _handle_complaint(self):
+        email = self._get_email()
+        email.verified = False
+        email.spam_complaint = True
 
     @_machine.output()
     def _incr_transient_bounce(self):
         email = self._get_email()
         email.transient_bounces += 1
 
         if email.transient_bounces > MAX_TRANSIENT_BOUNCES:
-            self._unverify_email(email)
+            self._unverify_for_delivery_failure(email)
 
     @_machine.output()
     def _reset_transient_bounce(self):
@@ -115,7 +121,7 @@ def _reset_transient_bounce(self):
     accepted.upon(deliver, enter=delivered, outputs=[_reset_transient_bounce],
                   collector=lambda iterable: list(iterable)[-1])
     accepted.upon(bounce, enter=bounced,
-                  outputs=[_reset_transient_bounce, _flag_email],
+                  outputs=[_reset_transient_bounce, _handle_bounce],
                   collector=lambda iterable: list(iterable)[-1])
     accepted.upon(soft_bounce, enter=soft_bounced,
                   outputs=[_incr_transient_bounce],
@@ -125,7 +131,7 @@ def _reset_transient_bounce(self):
     # really want to treat this as a bounce. We'll record the event
     # for posterity though.
     delivered.upon(soft_bounce, enter=delivered, outputs=[])
-    delivered.upon(complain, enter=complained, outputs=[_flag_email],
+    delivered.upon(complain, enter=complained, outputs=[_handle_complaint],
                    collector=lambda iterable: list(iterable)[-1])
 
     # Serialization / Deserialization
@@ -155,7 +161,7 @@ def _get_email(self):
                   .filter(EmailAddress.email == self._email_message.to)
                   .one())
 
-    def _unverify_email(self, email):
+    def _unverify_for_delivery_failure(self, email):
         # Unverify the email, and mark why
         email.verified = False
         email.is_having_delivery_issues = True

warehouse/migrations/versions/7f0d1b5af8c7_add_tables_for_storing_ses_information.py

@@ -111,6 +111,16 @@ def upgrade():
         unique=True,
     )
 
+    op.add_column(
+        "accounts_email",
+        sa.Column(
+            "spam_complaint",
+            sa.Boolean(),
+            server_default=sa.false(),
+            nullable=False,
+        ),
+    )
+
     op.add_column(
         "accounts_email",
         sa.Column(
@@ -135,6 +145,7 @@ def upgrade():
 def downgrade():
     op.drop_column("accounts_email", "transient_bounces")
     op.drop_column("accounts_email", "is_having_delivery_issues")
+    op.drop_column("accounts_email", "spam_complaint")
     op.drop_index(op.f("ix_ses_events_event_id"), table_name="ses_events")
     op.drop_table("ses_events")
     op.drop_index(op.f("ix_ses_emails_message_id"), table_name="ses_emails")