Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Filtering heartbeats #1755

Merged
merged 6 commits into from
Feb 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions app/main/views/index.py
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ def welcome():

@main.route("/activity", endpoint="activity")
def activity():
return render_template("views/activity.html", **get_latest_stats(get_current_locale(current_app)))
return render_template("views/activity.html", **get_latest_stats(get_current_locale(current_app), filter_heartbeats=True))


@main.route("/activity/download", endpoint="activity_download")
Expand Down Expand Up @@ -386,7 +386,7 @@ def _render_articles_page(response):
nav_items=nav_items,
slug=slug_en,
lang_url=get_lang_url(response, bool(page_id)),
stats=get_latest_stats(get_current_locale(current_app)) if slug_en == "home" else None,
stats=get_latest_stats(get_current_locale(current_app), filter_heartbeats=True) if slug_en == "home" else None,
isHome=True if slug_en == "home" else None,
)

Expand Down
4 changes: 2 additions & 2 deletions app/notify_client/service_api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,11 @@ def get_services(self, params_dict=None):
"""
return self.get("/service", params=params_dict)

def get_stats_by_month(self):
def get_stats_by_month(self, filter_heartbeats=False):
"""
Retrieve notifications stats by month.
"""
return self.get("/service/delivered-notifications-stats-by-month-data")
return self.get("/service/delivered-notifications-stats-by-month-data", params={"filter_heartbeats": filter_heartbeats})

def find_services_by_name(self, service_name):
return self.get("/service/find-services-by-name", params={"service_name": service_name})
Expand Down
6 changes: 3 additions & 3 deletions app/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ def from_lambda_api(line):


@cache.memoize(timeout=3600)
def get_latest_stats(lang):
results = service_api_client.get_stats_by_month()["data"]
def get_latest_stats(lang, filter_heartbeats=None):
results = service_api_client.get_stats_by_month(filter_heartbeats=filter_heartbeats)["data"]

monthly_stats = {}
emails_total = 0
Expand All @@ -119,7 +119,7 @@ def get_latest_stats(lang):
elif notification_type == "email":
emails_total += count

live_services = len(service_api_client.get_live_services_data()["data"])
live_services = len(service_api_client.get_live_services_data({"filter_heartbeats": True})["data"])

return {
"monthly_stats": monthly_stats,
Expand Down
93 changes: 84 additions & 9 deletions tests/app/main/views/test_index.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from app.utils import documentation_url
from tests.conftest import a11y_test, normalize_spaces, sample_uuid

service = [
services = [
{
"service_id": 1,
"service_name": "jessie the oak tree",
Expand All @@ -25,12 +25,30 @@
"email_totals": 1200,
"letter_totals": 0,
"free_sms_fragment_limit": 100,
}
},
{
"service_id": 2,
"service_name": "jessie the birch tree",
"organisation_name": "Forest",
"consent_to_research": True,
"contact_name": "Forest fairy",
"organisation_type": "Ecosystem",
"contact_email": "forest.fairy@digital.cabinet-office.canada.ca",
"contact_mobile": "+16132532223",
"live_date": "Sat, 29 Mar 2014 00:00:00 GMT",
"sms_volume_intent": 100,
"email_volume_intent": 50,
"letter_volume_intent": 20,
"sms_totals": 300,
"email_totals": 1200,
"letter_totals": 0,
"free_sms_fragment_limit": 100,
},
]


def test_non_logged_in_user_can_see_homepage(mocker, client, mock_calls_out_to_GCA):
mocker.patch("app.service_api_client.get_live_services_data", return_value={"data": service})
mocker.patch("app.service_api_client.get_live_services_data", return_value={"data": services[0]})
mocker.patch(
"app.service_api_client.get_stats_by_month",
return_value={"data": [("2020-11-01", "email", 20)]},
Expand All @@ -50,7 +68,7 @@ def test_non_logged_in_user_can_see_homepage(mocker, client, mock_calls_out_to_G

@pytest.mark.skip(reason="TODO: a11y test")
def test_home_page_a11y(mocker, client, mock_calls_out_to_GCA):
mocker.patch("app.service_api_client.get_live_services_data", return_value={"data": service})
mocker.patch("app.service_api_client.get_live_services_data", return_value={"data": services[0]})
mocker.patch(
"app.service_api_client.get_stats_by_month",
return_value={"data": [("2020-11-01", "email", 20)]},
Expand Down Expand Up @@ -130,15 +148,72 @@ def test_static_pages(
assert not page.select_one("meta[name=description]")


def test_activity_page(mocker, client):
mocker.patch("app.service_api_client.get_live_services_data", return_value={"data": service})
@pytest.mark.parametrize(
"stats, services",
[
(
[ # Heartbeat's filtered
("2020-11-01", "email", 20),
("2020-11-01", "sms", 20),
],
[
services[0],
],
),
(
[ # Heartbeat's not filtered
("2020-11-01", "email", 170),
("2020-11-01", "sms", 150),
],
services,
),
],
)
def test_activity_page(mocker, client, stats, services):
mocker.patch("app.service_api_client.get_live_services_data", return_value={"data": services})
mocker.patch(
"app.service_api_client.get_stats_by_month",
return_value={"data": [("2020-11-01", "email", 20)]},
return_value={"data": stats},
)

response = client.get(url_for("main.activity"))
page = BeautifulSoup(response.data.decode("utf-8"), "html.parser")
assert response.status_code == 200
assert page.select("div[class~='lg:text-xxl']")[0].text == str(sum(x[2] for x in stats))
assert page.select("div[class~='lg:text-xxl']")[1].text == str(len(services))


@pytest.mark.parametrize(
"stats, services",
[
(
[ # Heartbeat's filtered
("2020-11-01", "email", 20),
("2020-11-01", "sms", 20),
],
[
services[0],
],
),
(
[ # Heartbeat's not filtered
("2020-11-01", "email", 170),
("2020-11-01", "sms", 150),
],
services,
),
],
)
def test_home_page_displays_activity(mocker, client, stats, services):
mocker.patch("app.service_api_client.get_live_services_data", return_value={"data": services})
mocker.patch(
"app.service_api_client.get_stats_by_month",
return_value={"data": stats},
)
response = client.get(url_for("main.index"))
page = BeautifulSoup(response.data.decode("utf-8"), "html.parser")
assert response.status_code == 200
assert page.select("span[class~='xs:text-lg']")[0].text == str(len(services))
assert page.select("span[class~='xs:text-lg']")[1].text == str(sum(x[2] for x in stats))


@pytest.mark.parametrize(
Expand Down Expand Up @@ -269,7 +344,7 @@ def test_letter_template_preview_headers(
],
)
def test_query_params(client, query_key, query_value, heading, mocker, mock_calls_out_to_GCA):
mocker.patch("app.service_api_client.get_live_services_data", return_value={"data": service})
mocker.patch("app.service_api_client.get_live_services_data", return_value={"data": services[0]})
mocker.patch(
"app.service_api_client.get_stats_by_month",
return_value={"data": [("2020-11-01", "email", 20)]},
Expand Down
14 changes: 14 additions & 0 deletions tests/app/notify_client/test_service_api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,20 @@ def test_client_gets_service_statistics(mocker, today_only, limit_days):
)


@pytest.mark.parametrize("filter_heartbeat", [True, False])
def test_client_gets_stats_by_month(mocker, filter_heartbeat):
client = ServiceAPIClient()
mock_get = mocker.patch.object(client, "get", return_value={"data": {"a": "b"}})

ret = client.get_stats_by_month(filter_heartbeat)

assert ret["data"] == {"a": "b"}
mock_get.assert_called_once_with(
"/service/delivered-notifications-stats-by-month-data",
params={"filter_heartbeats": filter_heartbeat},
)


def test_client_only_updates_allowed_attributes(mocker):
mocker.patch("app.notify_client.current_user", id="1")
with pytest.raises(TypeError) as error:
Expand Down
Loading