Skip to content

handle more iterable types for messaging tokens #977

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

Open
pawel-steto wants to merge 1 commit into
base: main
Choose a base branch
from
Open

handle more iterable types for messaging tokens #977

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions firebase_admin/_messaging_encoder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import numbers
import re
import warnings
from collections.abc import Collection

from firebase_admin import _messaging_utils

Expand Down Expand Up @@ -165,7 +166,7 @@ def check_string_list(cls, label, value):
"""Checks if the given value is a list comprised only of strings."""
if value is None or value == []:
return None
if not isinstance(value, list):
if not isinstance(value, Collection) or isinstance(value, str) or isinstance(value, dict):
raise ValueError(f'{label} must be a list of strings.')
non_str = [k for k in value if not isinstance(k, str)]
if non_str:
Expand All @@ -177,7 +178,7 @@ def check_number_list(cls, label, value):
"""Checks if the given value is a list comprised only of numbers."""
if value is None or value == []:
return None
if not isinstance(value, list):
if not isinstance(value, Collection) or isinstance(value, str) or isinstance(value, dict):
raise ValueError(f'{label} must be a list of numbers.')
non_number = [k for k in value if not isinstance(k, numbers.Number)]
if non_number:
Expand Down
8 changes: 7 additions & 1 deletion tests/test_messaging.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
NON_STRING_ARGS = [[], tuple(), {}, True, False, 1, 0]
NON_DICT_ARGS = ['', [], tuple(), True, False, 1, 0, {1: 'foo'}, {'foo': 1}]
NON_OBJECT_ARGS = [[], tuple(), {}, 'foo', 0, 1, True, False]
NON_LIST_ARGS = ['', tuple(), {}, True, False, 1, 0, [1], ['foo', 1]]
NON_LIST_ARGS = ['', {}, True, False, 1, 0, [1], ['foo', 1], iter([])]
NON_UINT_ARGS = ['1.23s', [], tuple(), {}, -1.23]
NON_BOOL_ARGS = ['', [], tuple(), {}, 1, 0, [1], ['foo', 1], {1: 'foo'}, {'foo': 1}]
HTTP_ERROR_CODES = {
Expand Down Expand Up @@ -129,6 +129,12 @@ def test_tokens_type(self):
message = messaging.MulticastMessage(tokens=['token' for _ in range(0, 500)])
assert len(message.tokens) == 500

message = messaging.MulticastMessage(tokens=tuple(['token' for _ in range(0, 500)]))
assert len(message.tokens) == 500

message = messaging.MulticastMessage(tokens=set(['token']))
assert len(message.tokens) == 1

@pytest.mark.parametrize('fids', NON_LIST_ARGS)
def test_invalid_fids_type(self, fids):
with pytest.raises(ValueError) as excinfo:
Expand Down