mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-20 15:31:15 -05:00
In addition to the existing provider data, we also want return the number of billable units (muliplied by the rate multiplier) that each SMS provider sent this month. This will be used on the platform admin providers page. Since we can no longer get all the information we need from the provider details schema, this makes a new DAO function to get all the data for the endpoint.
149 lines
4.8 KiB
Python
149 lines
4.8 KiB
Python
from datetime import datetime
|
|
|
|
from notifications_utils.timezones import convert_utc_to_bst
|
|
from sqlalchemy import asc, desc, func
|
|
|
|
from app.dao.dao_utils import transactional
|
|
from app.provider_details.switch_providers import (
|
|
provider_is_inactive,
|
|
provider_is_primary,
|
|
switch_providers
|
|
)
|
|
from app.models import FactBilling, ProviderDetails, ProviderDetailsHistory, SMS_TYPE, User
|
|
from app import db
|
|
|
|
|
|
def get_provider_details_by_id(provider_details_id):
|
|
return ProviderDetails.query.get(provider_details_id)
|
|
|
|
|
|
def get_provider_details_by_identifier(identifier):
|
|
return ProviderDetails.query.filter_by(identifier=identifier).one()
|
|
|
|
|
|
def get_alternative_sms_provider(identifier):
|
|
alternate_provider = None
|
|
if identifier == 'firetext':
|
|
alternate_provider = 'mmg'
|
|
elif identifier == 'mmg':
|
|
alternate_provider = 'firetext'
|
|
|
|
return ProviderDetails.query.filter_by(identifier=alternate_provider).one()
|
|
|
|
|
|
def get_current_provider(notification_type):
|
|
return ProviderDetails.query.filter_by(
|
|
notification_type=notification_type,
|
|
active=True
|
|
).order_by(
|
|
asc(ProviderDetails.priority)
|
|
).first()
|
|
|
|
|
|
def dao_get_provider_versions(provider_id):
|
|
return ProviderDetailsHistory.query.filter_by(
|
|
id=provider_id
|
|
).order_by(
|
|
desc(ProviderDetailsHistory.version)
|
|
).all()
|
|
|
|
|
|
@transactional
|
|
def dao_toggle_sms_provider(identifier):
|
|
alternate_provider = get_alternative_sms_provider(identifier)
|
|
dao_switch_sms_provider_to_provider_with_identifier(alternate_provider.identifier)
|
|
|
|
|
|
@transactional
|
|
def dao_switch_sms_provider_to_provider_with_identifier(identifier):
|
|
new_provider = get_provider_details_by_identifier(identifier)
|
|
|
|
if provider_is_inactive(new_provider):
|
|
return
|
|
|
|
# Check first to see if there is another provider with the same priority
|
|
# as this needs to be updated differently
|
|
conflicting_provider = dao_get_sms_provider_with_equal_priority(new_provider.identifier, new_provider.priority)
|
|
providers_to_update = []
|
|
|
|
if conflicting_provider:
|
|
switch_providers(conflicting_provider, new_provider)
|
|
else:
|
|
current_provider = get_current_provider('sms')
|
|
if not provider_is_primary(current_provider, new_provider, identifier):
|
|
providers_to_update = switch_providers(current_provider, new_provider)
|
|
|
|
for provider in providers_to_update:
|
|
dao_update_provider_details(provider)
|
|
|
|
|
|
def get_provider_details_by_notification_type(notification_type, supports_international=False):
|
|
|
|
filters = [ProviderDetails.notification_type == notification_type]
|
|
|
|
if supports_international:
|
|
filters.append(ProviderDetails.supports_international == supports_international)
|
|
|
|
return ProviderDetails.query.filter(*filters).order_by(asc(ProviderDetails.priority)).all()
|
|
|
|
|
|
@transactional
|
|
def dao_update_provider_details(provider_details):
|
|
provider_details.version += 1
|
|
provider_details.updated_at = datetime.utcnow()
|
|
history = ProviderDetailsHistory.from_original(provider_details)
|
|
db.session.add(provider_details)
|
|
db.session.add(history)
|
|
|
|
|
|
def dao_get_sms_provider_with_equal_priority(identifier, priority):
|
|
provider = db.session.query(ProviderDetails).filter(
|
|
ProviderDetails.identifier != identifier,
|
|
ProviderDetails.notification_type == 'sms',
|
|
ProviderDetails.priority == priority,
|
|
ProviderDetails.active
|
|
).order_by(
|
|
asc(ProviderDetails.priority)
|
|
).first()
|
|
|
|
return provider
|
|
|
|
|
|
def dao_get_provider_stats():
|
|
# this query does not include the current day since the task to populate ft_billing runs overnight
|
|
|
|
current_bst_datetime = convert_utc_to_bst(datetime.utcnow())
|
|
first_day_of_the_month = current_bst_datetime.date().replace(day=1)
|
|
|
|
subquery = db.session.query(
|
|
FactBilling.provider,
|
|
func.sum(FactBilling.billable_units * FactBilling.rate_multiplier).label('current_month_billable_sms')
|
|
).filter(
|
|
FactBilling.notification_type == SMS_TYPE,
|
|
FactBilling.bst_date >= first_day_of_the_month
|
|
).group_by(
|
|
FactBilling.provider
|
|
).subquery()
|
|
|
|
result = db.session.query(
|
|
ProviderDetails.id,
|
|
ProviderDetails.display_name,
|
|
ProviderDetails.identifier,
|
|
ProviderDetails.priority,
|
|
ProviderDetails.notification_type,
|
|
ProviderDetails.active,
|
|
ProviderDetails.updated_at,
|
|
ProviderDetails.supports_international,
|
|
User.name.label('created_by_name'),
|
|
func.coalesce(subquery.c.current_month_billable_sms, 0).label('current_month_billable_sms')
|
|
).outerjoin(
|
|
subquery, ProviderDetails.identifier == subquery.c.provider
|
|
).outerjoin(
|
|
User, ProviderDetails.created_by_id == User.id
|
|
).order_by(
|
|
ProviderDetails.notification_type,
|
|
ProviderDetails.priority,
|
|
).all()
|
|
|
|
return result
|