mirror of
https://github.com/GSA/notifications-api.git
synced 2026-06-03 12:58:09 -04:00
67019fc5a1
we should be very careful with when we get data from NotificationHistory - this should probably only be from scheduled tasks. `dao_get_template_usage` is only called from the template statistics rest endpoint, so shouldn't ever hit template history. also, moved tests out to new file to break up the 2k test file a bit
101 lines
3.7 KiB
Python
101 lines
3.7 KiB
Python
from flask import (
|
|
Blueprint,
|
|
jsonify,
|
|
request,
|
|
current_app)
|
|
|
|
from app import redis_store
|
|
from app.dao.notifications_dao import (
|
|
dao_get_template_usage,
|
|
dao_get_last_template_usage
|
|
)
|
|
from app.dao.templates_dao import (
|
|
dao_get_templates_for_cache,
|
|
dao_get_template_by_id_and_service_id
|
|
)
|
|
|
|
from app.schemas import notification_with_template_schema
|
|
from app.utils import cache_key_for_service_template_counter
|
|
from app.errors import register_errors, InvalidRequest
|
|
|
|
template_statistics = Blueprint('template-statistics',
|
|
__name__,
|
|
url_prefix='/service/<service_id>/template-statistics')
|
|
|
|
register_errors(template_statistics)
|
|
|
|
|
|
@template_statistics.route('')
|
|
def get_template_statistics_for_service_by_day(service_id):
|
|
if request.args.get('limit_days'):
|
|
try:
|
|
limit_days = int(request.args['limit_days'])
|
|
except ValueError as e:
|
|
error = '{} is not an integer'.format(request.args['limit_days'])
|
|
message = {'limit_days': [error]}
|
|
raise InvalidRequest(message, status_code=400)
|
|
else:
|
|
limit_days = 7
|
|
|
|
if limit_days == 7:
|
|
stats = get_template_statistics_for_7_days(limit_days, service_id)
|
|
else:
|
|
stats = dao_get_template_usage(service_id, limit_days=limit_days)
|
|
|
|
def serialize(data):
|
|
return {
|
|
'count': data.count,
|
|
'template_id': str(data.template_id),
|
|
'template_name': data.name,
|
|
'template_type': data.template_type,
|
|
'is_precompiled_letter': data.is_precompiled_letter
|
|
}
|
|
|
|
return jsonify(data=[serialize(row) for row in stats])
|
|
|
|
|
|
@template_statistics.route('/<template_id>')
|
|
def get_template_statistics_for_template_id(service_id, template_id):
|
|
template = dao_get_template_by_id_and_service_id(template_id, service_id)
|
|
if not template:
|
|
message = 'No template found for id {}'.format(template_id)
|
|
errors = {'template_id': [message]}
|
|
raise InvalidRequest(errors, status_code=404)
|
|
|
|
data = None
|
|
notification = dao_get_last_template_usage(template_id, template.template_type)
|
|
if notification:
|
|
data = notification_with_template_schema.dump(notification).data
|
|
|
|
return jsonify(data=data)
|
|
|
|
|
|
def get_template_statistics_for_7_days(limit_days, service_id):
|
|
cache_key = cache_key_for_service_template_counter(service_id)
|
|
template_stats_by_id = redis_store.get_all_from_hash(cache_key)
|
|
if not template_stats_by_id:
|
|
stats = dao_get_template_usage(service_id, limit_days=limit_days)
|
|
cache_values = dict([(x.template_id, x.count) for x in stats])
|
|
if cache_values:
|
|
redis_store.set_hash_and_expire(cache_key,
|
|
cache_values,
|
|
current_app.config['EXPIRE_CACHE_TEN_MINUTES'])
|
|
else:
|
|
stats = dao_get_templates_for_cache(template_stats_by_id.items())
|
|
return stats
|
|
|
|
# TODO: can only switch to this code when redis has been populated (either through time passing or a manual step)
|
|
# from collections import Counter
|
|
# from notifications_utils.redis_client import RedisException
|
|
# template_stats_by_id = Counter()
|
|
# for day in last_7_days:
|
|
# # "<SERVICE_ID>-template-usage-{YYYY-MM-DD}"
|
|
# key = cache_key_for_service_templates_used_per_day(service_id, limit_days)
|
|
# try:
|
|
# template_stats_by_id += Counter(redis_store.get_all_from_hash(key, raise_exception=True))
|
|
# except RedisException:
|
|
# # TODO: ????
|
|
#
|
|
# # TODO: streamline db query and avoid weird unions if possible.
|
|
# return dao_get_templates_for_cache(template_stats_by_id.items())
|