Refactor reporting task so that methods can be used for the annual usage page.

Still a work in progress, tests are coming.

app/dao/fact_billing_dao.py

@@ -1,9 +1,16 @@
 from datetime import datetime, timedelta
-from sqlalchemy import func
+from sqlalchemy import func, case, desc, extract
 
 from app import db
 from app.dao.date_util import get_month_start_and_end_date_in_utc, get_financial_year
-from app.models import FactBilling
+from app.models import (
+    FactBilling, Notification, Service, NOTIFICATION_CREATED, NOTIFICATION_TECHNICAL_FAILURE,
+    KEY_TYPE_TEST,
+    LETTER_TYPE,
+    SMS_TYPE,
+    Rate,
+    LetterRate
+)
 from app.utils import convert_utc_to_bst
 
 
@@ -35,50 +42,143 @@ def fetch_annual_billing_by_month(service_id, billing_month, notification_type):
     return monthly_data, start_date
 
 
-def need_deltas(start_date, end_date, service_id, notification_type):
-    max_fact_billing_date = db.session.query(
-        func.max(FactBilling.bst_date)
-    ).filter(
-        FactBilling.notification_type == notification_type,
-        FactBilling.service_id == service_id,
-        FactBilling.bst_date >= start_date,
-        FactBilling.bst_date <= end_date
-    ).one()
-    print(max_fact_billing_date)
-    return max_fact_billing_date < end_date
-
-
 def fetch_annual_billing_for_year(service_id, year):
     year_start_date, year_end_date = get_financial_year(year)
     utcnow = datetime.utcnow()
     today = convert_utc_to_bst(utcnow)
-    last_2_days = utcnow - timedelta(days=2)
-    last_bst_date_for_ft = convert_utc_to_bst(last_2_days)
     # if year end date is less than today, we are calculating for data in the past and have no need for deltas.
     if year_end_date >= today:
-        todays_data = get_deltas(service_id, last_2_days, today)
-        year_end_date = last_bst_date_for_ft
-
-
+        last_2_days = utcnow - timedelta(days=2)
+        data = fetch_billing_data(start_date=last_2_days, end_date=today, service_id=service_id)
+        inserted_records = 0
+        updated_records = 0
+        for d in data:
+            update_fact_billing(data=data,
+                                inserted_records=inserted_records,
+                                process_day=d.created_at,
+                                updated_records=updated_records)
     yearly_data = db.session.query(
-        FactBilling.notifications_sent,
-        FactBilling.billable_units,
+        extract('month', FactBilling.bst_date).label("Month"),
+        func.sum(FactBilling.notifications_sent).label("notifications_sent"),
+        func.sum(FactBilling.billable_units).label("billable_units"),
         FactBilling.service_id,
-        FactBilling.notification_type,
         FactBilling.rate,
         FactBilling.rate_multiplier,
         FactBilling.international
     ).filter(
         FactBilling.service_id == service_id,
         FactBilling.bst_date >= year_start_date,
-        FactBilling.bst_date <= last_bst_date_for_ft
+        FactBilling.bst_date <= year_end_date
+    ).group_by(
+        extract('month', FactBilling.bst_date),
+        FactBilling.service_id,
+        FactBilling.rate,
+        FactBilling.rate_multiplier,
+        FactBilling.international
     ).all()
 
-    # today_data + yearly_data and aggregate by month
+    return yearly_data
 
 
-def get_deltas(service_id, start_date_end_date):
-    # query ft_billing data using queries from create_nightly_billing
-    return []
+def fetch_billing_data(start_date, end_date, service_id=None):
+    transit_data = db.session.query(
+        Notification.template_id,
+        Notification.service_id,
+        Notification.notification_type,
+        func.coalesce(Notification.sent_by,
+                      case(
+                          [
+                              (Notification.notification_type == 'letter', 'dvla'),
+                              (Notification.notification_type == 'sms', 'unknown'),
+                              (Notification.notification_type == 'email', 'ses')
+                          ]),
+                      ).label('sent_by'),
+        func.coalesce(Notification.rate_multiplier, 1).label('rate_multiplier'),
+        func.coalesce(Notification.international, False).label('international'),
+        func.sum(Notification.billable_units).label('billable_units'),
+        func.count().label('notifications_sent'),
+        Service.crown,
+    ).filter(
+        Notification.status != NOTIFICATION_CREATED,  # at created status, provider information is not available
+        Notification.status != NOTIFICATION_TECHNICAL_FAILURE,
+        Notification.key_type != KEY_TYPE_TEST,
+        Notification.created_at >= start_date,
+        Notification.created_at < end_date
+    ).group_by(
+        Notification.template_id,
+        Notification.service_id,
+        Notification.notification_type,
+        'sent_by',
+        Notification.rate_multiplier,
+        Notification.international,
+        Service.crown
+    ).join(
+        Service
+    )
+    if service_id:
+        transit_data.filter(Notification.service_id == service_id)
+    return transit_data.all()
 
 
+def get_rates_for_billing():
+    non_letter_rates = [(r.notification_type, r.valid_from, r.rate) for r in
+                        Rate.query.order_by(desc(Rate.valid_from)).all()]
+    letter_rates = [(r.start_date, r.crown, r.sheet_count, r.rate) for r in
+                    LetterRate.query.order_by(desc(LetterRate.start_date)).all()]
+    return non_letter_rates, letter_rates
+
+
+def get_rate(non_letter_rates, letter_rates, notification_type, date, crown=None, rate_multiplier=None):
+    if notification_type == LETTER_TYPE:
+        return next(r[3] for r in letter_rates if date > r[0] and crown == r[1] and rate_multiplier == r[2])
+    elif notification_type == SMS_TYPE:
+        return next(r[2] for r in non_letter_rates if notification_type == r[0] and date > r[1])
+    else:
+        return 0
+
+
+def update_fact_billing(data, inserted_records, process_day, updated_records):
+    non_letter_rates, letter_rates = get_rates_for_billing()
+
+    update_count = FactBilling.query.filter(
+        FactBilling.bst_date == datetime.date(process_day),
+        FactBilling.template_id == data.template_id,
+        FactBilling.service_id == data.service_id,
+        FactBilling.provider == data.sent_by,  # This could be zero - this is a bug that needs to be fixed.
+        FactBilling.rate_multiplier == data.rate_multiplier,
+        FactBilling.notification_type == data.notification_type,
+        FactBilling.international == data.international
+    ).update(
+        {"notifications_sent": data.notifications_sent,
+         "billable_units": data.billable_units},
+        synchronize_session=False)
+
+    if update_count == 0:
+        rate = get_rate(non_letter_rates,
+                        letter_rates,
+                        data.notification_type,
+                        process_day,
+                        data.crown,
+                        data.rate_multiplier)
+        billing_record = create_billing_record(data, rate, process_day)
+        db.session.add(billing_record)
+        inserted_records += 1
+    updated_records += update_count
+    db.session.commit()
+    return inserted_records, updated_records
+
+
+def create_billing_record(data, rate, process_day):
+    billing_record = FactBilling(
+        bst_date=process_day,
+        template_id=data.template_id,
+        service_id=data.service_id,
+        notification_type=data.notification_type,
+        provider=data.sent_by,
+        rate_multiplier=data.rate_multiplier,
+        international=data.international,
+        billable_units=data.billable_units,
+        notifications_sent=data.notifications_sent,
+        rate=rate
+    )
+    return billing_record