Skip to content

Add support for content_available for apns async #761

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 18, 2025
Merged

Add support for content_available for apns async #761

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff084e9
Add support for `content_available` for apns async
pomali Feb 13, 2025
17f2f7a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 13, 2025
ec2c1f6
Merge branch 'master' into apns-async-content-available
pomali Feb 16, 2025
63885f7
type content_available as bool only
pomali Feb 17, 2025
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
127 changes: 73 additions & 54 deletions push_notifications/apns_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,7 @@ def _create_notification_request_from_args(
notification_request_kwargs_out = notification_request_kwargs.copy()

if expiration is not None:
notification_request_kwargs_out["time_to_live"] = expiration - int(
time.time()
)
notification_request_kwargs_out["time_to_live"] = expiration - int(time.time())
if priority is not None:
notification_request_kwargs_out["priority"] = priority

Expand Down Expand Up @@ -216,6 +214,7 @@ def apns_send_message(
topic: str = None,
badge: int = None,
sound: str = None,
content_available: bool | int = None,
extra: dict = {},
expiration: int = None,
thread_id: str = None,
Expand All @@ -240,13 +239,14 @@ def apns_send_message(
:param alert: The alert message to send
:param application_id: The application_id to use
:param creds: The credentials to use
:param mutable_content: If True, enables the "mutable-content" flag in the payload.
This allows the app's Notification Service Extension to modify
the notification before it is displayed.
:param mutable_content: If True, enables the "mutable-content" flag in the payload.
This allows the app's Notification Service Extension to modify
the notification before it is displayed.
:param category: The category identifier for actionable notifications.
This should match a category identifier defined in the app's
Notification Content Extension or UNNotificationCategory configuration.
It allows the app to display custom actions with the notification.
This should match a category identifier defined in the app's
Notification Content Extension or UNNotificationCategory configuration.
It allows the app to display custom actions with the notification.
:param content_available: If True or 1 the `content-available` flag will be set to 1, allowing the app to be woken up in the background
"""
results = apns_send_bulk_message(
registration_ids=[registration_id],
Expand All @@ -256,14 +256,15 @@ def apns_send_message(
topic=topic,
badge=badge,
sound=sound,
content_available=content_available,
extra=extra,
expiration=expiration,
thread_id=thread_id,
loc_key=loc_key,
priority=priority,
collapse_id=collapse_id,
mutable_content=mutable_content,
category = category,
category=category,
err_func=err_func,
)

Expand All @@ -282,6 +283,7 @@ def apns_send_bulk_message(
topic: str = None,
badge: int = None,
sound: str = None,
content_available: bool | int = None,
extra: dict = {},
expiration: int = None,
thread_id: str = None,
Expand All @@ -304,37 +306,41 @@ def apns_send_bulk_message(
:param alert: The alert message to send
:param application_id: The application_id to use
:param creds: The credentials to use
:param mutable_content: If True, enables the "mutable-content" flag in the payload.
This allows the app's Notification Service Extension to modify
the notification before it is displayed.
:param mutable_content: If True, enables the "mutable-content" flag in the payload.
This allows the app's Notification Service Extension to modify
the notification before it is displayed.
:param category: The category identifier for actionable notifications.
This should match a category identifier defined in the app's
Notification Content Extension or UNNotificationCategory configuration.
It allows the app to display custom actions with the notification.
This should match a category identifier defined in the app's
Notification Content Extension or UNNotificationCategory configuration.
It allows the app to display custom actions with the notification.
:param content_available: If True or 1 the `content-available` flag will be set to 1, allowing the app to be woken up in the background
"""
try:
topic = get_manager().get_apns_topic(application_id)
results: Dict[str, str] = {}
inactive_tokens = []

responses = asyncio.run(_send_bulk_request(
registration_ids=registration_ids,
alert=alert,
application_id=application_id,
creds=creds,
topic=topic,
badge=badge,
sound=sound,
extra=extra,
expiration=expiration,
thread_id=thread_id,
loc_key=loc_key,
priority=priority,
collapse_id=collapse_id,
mutable_content=mutable_content,
category=category,
err_func=err_func,
))
responses = asyncio.run(
_send_bulk_request(
registration_ids=registration_ids,
alert=alert,
application_id=application_id,
creds=creds,
topic=topic,
badge=badge,
sound=sound,
content_available=content_available,
extra=extra,
expiration=expiration,
thread_id=thread_id,
loc_key=loc_key,
priority=priority,
collapse_id=collapse_id,
mutable_content=mutable_content,
category=category,
err_func=err_func,
)
)

results = {}
errors = []
Expand All @@ -344,14 +350,17 @@ def apns_send_bulk_message(
)
if not result.is_successful:
errors.append(result.description)
if result.description in ["Unregistered", "BadDeviceToken",
"DeviceTokenNotForTopic"]:
if result.description in [
"Unregistered",
"BadDeviceToken",
"DeviceTokenNotForTopic",
]:
inactive_tokens.append(registration_id)

if len(inactive_tokens) > 0:
models.APNSDevice.objects.filter(registration_id__in=inactive_tokens).update(
active=False
)
models.APNSDevice.objects.filter(
registration_id__in=inactive_tokens
).update(active=False)

if len(errors) > 0:
msg = "One or more errors failed with errors: {}".format(", ".join(errors))
Expand All @@ -371,6 +380,7 @@ async def _send_bulk_request(
topic: str = None,
badge: int = None,
sound: str = None,
content_available: bool | int = None,
extra: dict = {},
expiration: int = None,
thread_id: str = None,
Expand All @@ -391,19 +401,28 @@ async def _send_bulk_request(
if category:
aps_kwargs["category"] = category

requests = [_create_notification_request_from_args(
registration_id,
alert,
badge=badge,
sound=sound,
extra=extra,
expiration=expiration,
thread_id=thread_id,
loc_key=loc_key,
priority=priority,
collapse_id=collapse_id,
aps_kwargs=aps_kwargs
) for registration_id in registration_ids]
if content_available is not None:
if isinstance(content_available, bool):
aps_kwargs["content-available"] = int(content_available)
else:
aps_kwargs["content-available"] = content_available

requests = [
_create_notification_request_from_args(
registration_id,
alert,
badge=badge,
sound=sound,
extra=extra,
expiration=expiration,
thread_id=thread_id,
loc_key=loc_key,
priority=priority,
collapse_id=collapse_id,
aps_kwargs=aps_kwargs,
)
for registration_id in registration_ids
]

send_requests = [_send_request(client, request) for request in requests]
return await asyncio.gather(*send_requests)
Expand All @@ -417,11 +436,11 @@ async def _send_request(apns, request):
return request.device_token, NotificationResult(
notification_id=request.notification_id,
status="failed",
description="TimeoutError"
description="TimeoutError",
)
except:
return request.device_token, NotificationResult(
notification_id=request.notification_id,
status="failed",
description="CommunicationError"
description="CommunicationError",
)
53 changes: 53 additions & 0 deletions tests/test_apns_async_push_payload.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,3 +226,56 @@ def test_push_payload_with_category(self, mock_apns):
# self.assertRaises(APNSUnsupportedPriority, _apns_send, "123",
# "_" * 2049, priority=24)
# s.assert_has_calls([])

@mock.patch("push_notifications.apns_async.APNs", autospec=True)
def test_push_payload_with_content_available_bool_true(self, mock_apns):
apns_send_message(
"123",
"Hello world",
content_available=True,
creds=TokenCredentials(key="aaa", key_id="bbb", team_id="ccc"),
extra={"custom_data": 12345},
expiration=int(time.time()) + 3,
)

args, kwargs = mock_apns.return_value.send_notification.call_args
req = args[0]

assert "content-available" in req.message["aps"]
assert req.message["aps"]["content-available"] == 1


@mock.patch("push_notifications.apns_async.APNs", autospec=True)
def test_push_payload_with_content_available_bool_false(self, mock_apns):
apns_send_message(
"123",
"Hello world",
content_available=False,
creds=TokenCredentials(key="aaa", key_id="bbb", team_id="ccc"),
extra={"custom_data": 12345},
expiration=int(time.time()) + 3,
)

args, kwargs = mock_apns.return_value.send_notification.call_args
req = args[0]

assert "content-available" in req.message["aps"]
assert req.message["aps"]["content-available"] == 0


@mock.patch("push_notifications.apns_async.APNs", autospec=True)
def test_push_payload_with_content_available_int(self, mock_apns):
apns_send_message(
"123",
"Hello world",
content_available=5,
creds=TokenCredentials(key="aaa", key_id="bbb", team_id="ccc"),
extra={"custom_data": 12345},
expiration=int(time.time()) + 3,
)

args, kwargs = mock_apns.return_value.send_notification.call_args
req = args[0]

assert "content-available" in req.message["aps"]
assert req.message["aps"]["content-available"] == 5
Loading