Merge pull request #2676 from alphagov/add-returned-letters-table

Add returned letters table

app/celery/tasks.py

@@ -43,6 +43,7 @@ from app.dao.notifications_dao import (
     dao_get_notification_history_by_reference,
 )
 from app.dao.provider_details_dao import get_provider_details_by_notification_type
+from app.dao.returned_letters_dao import insert_or_update_returned_letters
 from app.dao.service_email_reply_to_dao import dao_get_reply_to_by_id
 from app.dao.service_inbound_api_dao import get_service_inbound_api_for_service
 from app.dao.service_sms_sender_dao import dao_get_service_sms_senders_by_id
@@ -619,6 +620,8 @@ def process_returned_letters_list(notification_references):
         {"status": NOTIFICATION_RETURNED_LETTER}
     )
 
+    insert_or_update_returned_letters(notification_references)
+
     current_app.logger.info(
         "Updated {} letter notifications ({} history notifications, from {} references) to returned-letter".format(
             updated, updated_history, len(notification_references)

app/dao/returned_letters_dao.py

@@ -0,0 +1,56 @@
+from datetime import datetime
+
+from sqlalchemy import func, desc
+from sqlalchemy.dialects.postgresql import insert
+
+from app import db
+from app.dao.dao_utils import transactional
+from app.models import Notification, NotificationHistory, ReturnedLetter
+
+
+def _get_notification_ids_for_references(references):
+    notification_ids = db.session.query(Notification.id, Notification.service_id).filter(
+        Notification.reference.in_(references)
+    ).all()
+
+    notification_history_ids = db.session.query(NotificationHistory.id, NotificationHistory.service_id).filter(
+        NotificationHistory.reference.in_(references)
+    ).all()
+
+    return notification_ids + notification_history_ids
+
+
+@transactional
+def insert_or_update_returned_letters(references):
+    data = _get_notification_ids_for_references(references)
+    for row in data:
+        table = ReturnedLetter.__table__
+
+        stmt = insert(table).values(
+            reported_at=datetime.utcnow().date(),
+            service_id=row.service_id,
+            notification_id=row.id,
+            created_at=datetime.utcnow()
+        )
+
+        stmt = stmt.on_conflict_do_update(
+            index_elements=[table.c.notification_id],
+            set_={
+                'reported_at': datetime.utcnow().date(),
+                'updated_at': datetime.utcnow()
+            }
+        )
+        db.session.connection().execute(stmt)
+
+
+def get_returned_letter_summary(service_id):
+    return db.session.query(
+        func.count(ReturnedLetter.notification_id).label('returned_letter_count'),
+        ReturnedLetter.reported_at
+    ).filter(
+        ReturnedLetter.service_id == service_id,
+    ).group_by(
+        ReturnedLetter.reported_at
+    ).order_by(
+        desc(ReturnedLetter.reported_at)
+    ).all()

app/models.py

@@ -2019,8 +2019,7 @@ class Complaint(db.Model):
     __tablename__ = 'complaints'
 
     id = db.Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
-    notification_id = db.Column(UUID(as_uuid=True), db.ForeignKey('notification_history.id'),
-                                index=True, nullable=False)
+    notification_id = db.Column(UUID(as_uuid=True), index=True, nullable=False)
     service_id = db.Column(UUID(as_uuid=True), db.ForeignKey('services.id'), unique=False, index=True, nullable=False)
     service = db.relationship(Service, backref=db.backref('complaints'))
     ses_feedback_id = db.Column(db.Text, nullable=True)
@@ -2072,3 +2071,15 @@ class ServiceDataRetention(db.Model):
             "created_at": self.created_at.strftime(DATETIME_FORMAT),
             "updated_at": self.updated_at.strftime(DATETIME_FORMAT) if self.updated_at else None,
         }
+
+
+class ReturnedLetter(db.Model):
+    __tablename__ = 'returned_letters'
+
+    id = db.Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
+    reported_at = db.Column(db.Date, nullable=False)
+    service_id = db.Column(UUID(as_uuid=True), db.ForeignKey('services.id'), unique=False, index=True, nullable=False)
+    service = db.relationship(Service, backref=db.backref('returned_letters'))
+    notification_id = db.Column(UUID(as_uuid=True), unique=True, nullable=False)
+    created_at = db.Column(db.DateTime, nullable=False)
+    updated_at = db.Column(db.DateTime, nullable=True, onupdate=datetime.datetime.utcnow)

app/service/rest.py

@@ -12,6 +12,7 @@ from notifications_utils.timezones import convert_utc_to_bst
 from sqlalchemy.exc import IntegrityError
 from sqlalchemy.orm.exc import NoResultFound
 
+from app import DATE_FORMAT
 from app.config import QueueNames
 from app.dao import fact_notification_status_dao, notifications_dao
 from app.dao.dao_utils import dao_rollback
@@ -29,6 +30,7 @@ from app.dao.fact_notification_status_dao import (
 )
 from app.dao.inbound_numbers_dao import dao_allocate_number_for_service
 from app.dao.organisation_dao import dao_get_organisation_by_service_id
+from app.dao.returned_letters_dao import get_returned_letter_summary
 from app.dao.service_data_retention_dao import (
     fetch_service_data_retention,
     fetch_service_data_retention_by_id,
@@ -939,3 +941,14 @@ def check_if_reply_to_address_already_in_use(service_id, email_address):
         raise InvalidRequest(
             "Your service already uses ‘{}’ as an email reply-to address.".format(email_address), status_code=400
         )
+
+
+@service_blueprint.route('/<uuid:service_id>/returned-letter-summary', methods=['GET'])
+def returned_letter_summary(service_id):
+    results = get_returned_letter_summary(service_id)
+
+    json_results = [{'returned_letter_count': x.returned_letter_count,
+                     'reported_at': x.reported_at.strftime(DATE_FORMAT)
+                     } for x in results]
+
+    return jsonify(json_results)