firebase-admin 7.5.0__tar.gz → 7.6.0__tar.gz

{firebase_admin-7.5.0 → firebase_admin-7.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: firebase_admin
-Version: 7.5.0
+Version: 7.6.0
 Summary: Firebase Admin Python SDK
 Home-page: https://firebase.google.com/docs/admin/setup/
 Author: Firebase

{firebase_admin-7.5.0 → firebase_admin-7.6.0}/firebase_admin/__about__.py

@@ -14,7 +14,7 @@
 
 """About information (version, etc) for Firebase Admin SDK."""
 
-__version__ = '7.5.0'
+__version__ = '7.6.0'
 __title__ = 'firebase_admin'
 __author__ = 'Firebase'
 __license__ = 'Apache License 2.0'

{firebase_admin-7.5.0 → firebase_admin-7.6.0}/firebase_admin/app_check.py

@@ -15,38 +15,47 @@
 """Firebase App Check module."""
 
 from typing import Any, Dict
+import requests
 import jwt
 from jwt import PyJWKClient, ExpiredSignatureError, InvalidTokenError, DecodeError
 from jwt import InvalidAudienceError, InvalidIssuerError, InvalidSignatureError
-from firebase_admin import _utils
+from firebase_admin import _http_client, _utils, exceptions
 
 _APP_CHECK_ATTRIBUTE = '_app_check'
 
 def _get_app_check_service(app) -> Any:
     return _utils.get_app_service(app, _APP_CHECK_ATTRIBUTE, _AppCheckService)
 
-def verify_token(token: str, app=None) -> Dict[str, Any]:
-    """Verifies a Firebase App Check token.
+def verify_token(token: str, app=None, consume: bool = False) -> Dict[str, Any]:
+    """Verifies a Firebase App Check token, optionally consuming limited-use tokens.
 
     Args:
         token: A token from App Check.
         app: An App instance (optional).
+        consume: Set to ``True`` only if the token is a limited-use (one-time) token
+            that should be consumed upon verification (optional, defaults to ``False``).
 
     Returns:
-        Dict[str, Any]: The token's decoded claims.
+        Dict[str, Any]: The token's decoded claims. If ``consume`` is ``True``, the dictionary
+            also includes an ``already_consumed`` boolean key indicating whether the token was
+            previously consumed.
 
     Raises:
-        ValueError: If the app's ``project_id`` is invalid or unspecified,
-        or if the token's headers or payload are invalid.
+        ValueError: If ``consume`` is not a boolean, or if the app's ``project_id``
+            is invalid or unspecified, or if the token's headers or payload are invalid.
+        FirebaseError: If an error occurs while communicating with the App Check service.
         PyJWKClientError: If PyJWKClient fails to fetch a valid signing key.
     """
-    return _get_app_check_service(app).verify_token(token)
+    return _get_app_check_service(app).verify_token(token, consume=consume)
 
 class _AppCheckService:
     """Service class that implements Firebase App Check functionality."""
 
     _APP_CHECK_ISSUER = 'https://firebaseappcheck.googleapis.com/'
     _JWKS_URL = 'https://firebaseappcheck.googleapis.com/v1/jwks'
+    _VERIFY_URL_FORMAT = (
+        'https://firebaseappcheck.googleapis.com/v1/projects/{project_id}:verifyAppCheckToken'
+    )
     _project_id = None
     _scoped_project_id = None
     _jwks_client = None
@@ -68,11 +77,15 @@ class _AppCheckService:
         # Default lifespan is 300 seconds (5 minutes) so we change it to 21600 seconds (6 hours).
         self._jwks_client = PyJWKClient(
             self._JWKS_URL, lifespan=21600, headers=self._APP_CHECK_HEADERS)
+        timeout = app.options.get('httpTimeout', _http_client.DEFAULT_TIMEOUT_SECONDS)
+        self._http_client = _http_client.JsonHttpClient(
+            credential=app.credential.get_credential(), timeout=timeout)
 
 
-    def verify_token(self, token: str) -> Dict[str, Any]:
-        """Verifies a Firebase App Check token."""
+    def verify_token(self, token: str, consume: bool = False) -> Dict[str, Any]:
+        """Verifies a Firebase App Check token, optionally consuming limited-use tokens."""
         _Validators.check_string("app check token", token)
+        _Validators.check_boolean("consume", consume)
 
         # Obtain the Firebase App Check Public Keys
         # Note: It is not recommended to hard code these keys as they rotate,
@@ -87,8 +100,32 @@ class _AppCheckService:
                 ) from exception
 
         verified_claims['app_id'] = verified_claims.get('sub')
+
+        if consume:
+            verified_claims['already_consumed'] = self._verify_replay_protection(token)
+
         return verified_claims
 
+    def _verify_replay_protection(self, token: str) -> bool:
+        """Verifies replay protection with the backend and returns the alreadyConsumed status."""
+        url = self._VERIFY_URL_FORMAT.format(project_id=self._project_id)
+        try:
+            body = self._http_client.body('post', url, json={'app_check_token': token})
+        except requests.exceptions.RequestException as error:
+            raise _utils.handle_platform_error_from_requests(error)
+        except ValueError as error:
+            raise exceptions.UnknownError(
+                f'Unexpected response from App Check service: {error}'
+            ) from error
+
+        if not isinstance(body, dict):
+            raise exceptions.UnknownError(
+                'Unexpected response from App Check service. '
+                f'Expected a JSON object, but got {type(body).__name__}.'
+            )
+
+        return bool(body.get('alreadyConsumed', False))
+
     def _has_valid_token_headers(self, headers: Any) -> None:
         """Checks whether the token has valid headers for App Check."""
         # Ensure the token's header has type JWT
@@ -159,3 +196,10 @@ class _Validators:
             raise ValueError(f'{label} "{value}" must be a non-empty string.')
         if not isinstance(value, str):
             raise ValueError(f'{label} "{value}" must be a string.')
+
+    @classmethod
+    def check_boolean(cls, label: str, value: Any):
+        """Checks if the given value is a boolean."""
+        if not isinstance(value, bool):
+            raise ValueError(f'{label} must be a boolean.')
+        return value

{firebase_admin-7.5.0 → firebase_admin-7.6.0}/firebase_admin/ml.py

@@ -14,16 +14,25 @@
 
 """Firebase ML module.
 
+.. deprecated::
+    Firebase ML is deprecated and will be shut down on June 15, 2027.
+    To host custom models, you must migrate to another solution. You can use Cloud Storage for
+    Firebase as an alternative for hosting custom models. For more info, see
+    https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+
 This module contains functions for creating, updating, getting, listing,
 deleting, publishing and unpublishing Firebase ML models.
 """
 
+# pylint: disable=too-many-lines
 
 import datetime
+import os
 import re
+import sys
 import time
-import os
 from urllib import parse
+import warnings
 
 import requests
 
@@ -46,6 +55,30 @@ try:
 except ImportError:
     _TF_ENABLED = False
 
+_DEPRECATION_WARNING = (
+    'Firebase ML is deprecated and will be shut down on June 15, 2027. '
+    'To host custom models, you must migrate to another solution. You can use Cloud Storage for '
+    'Firebase as an alternative for hosting custom models. For more info, see '
+    'https://firebase.google.com/docs/ml/migrate-to-cloud-storage'
+)
+
+
+def _is_internal_call():
+    """Checks if the current call originated from within the ML module."""
+    try:
+        # pylint: disable=protected-access
+        frame = sys._getframe(2)
+        while frame:
+            if frame.f_code.co_name in (
+                'from_dict', '_update_from_dict', 'handle_operation', 'list_models'
+            ):
+                return True
+            frame = frame.f_back
+    except (AttributeError, ValueError):
+        pass
+    return False
+
+
 _ML_ATTRIBUTE = '_ml'
 _MAX_PAGE_SIZE = 100
 _MODEL_ID_PATTERN = re.compile(r'^[A-Za-z0-9_-]{1,60}$')
@@ -77,6 +110,12 @@ def _get_ml_service(app):
 def create_model(model, app=None):
     """Creates a model in the current Firebase project.
 
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+
     Args:
         model: An ml.Model to create.
         app: A Firebase app instance (or None to use the default app).
@@ -84,6 +123,8 @@ def create_model(model, app=None):
     Returns:
         Model: The model that was created in Firebase ML.
     """
+    if not _is_internal_call():
+        warnings.warn(_DEPRECATION_WARNING, DeprecationWarning, stacklevel=2)
     ml_service = _get_ml_service(app)
     return Model.from_dict(ml_service.create_model(model), app=app)
 
@@ -91,6 +132,12 @@ def create_model(model, app=None):
 def update_model(model, app=None):
     """Updates a model's metadata or model file.
 
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+
     Args:
         model: The ml.Model to update.
         app: A Firebase app instance (or None to use the default app).
@@ -98,6 +145,8 @@ def update_model(model, app=None):
     Returns:
         Model: The updated model.
     """
+    if not _is_internal_call():
+        warnings.warn(_DEPRECATION_WARNING, DeprecationWarning, stacklevel=2)
     ml_service = _get_ml_service(app)
     return Model.from_dict(ml_service.update_model(model), app=app)
 
@@ -105,6 +154,12 @@ def update_model(model, app=None):
 def publish_model(model_id, app=None):
     """Publishes a Firebase ML model.
 
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+
     A published model can be downloaded to client apps.
 
     Args:
@@ -114,6 +169,8 @@ def publish_model(model_id, app=None):
     Returns:
         Model: The published model.
     """
+    if not _is_internal_call():
+        warnings.warn(_DEPRECATION_WARNING, DeprecationWarning, stacklevel=2)
     ml_service = _get_ml_service(app)
     return Model.from_dict(ml_service.set_published(model_id, publish=True), app=app)
 
@@ -121,6 +178,12 @@ def publish_model(model_id, app=None):
 def unpublish_model(model_id, app=None):
     """Unpublishes a Firebase ML model.
 
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+
     Args:
         model_id: The id of the model to unpublish.
         app: A Firebase app instance (or None to use the default app).
@@ -128,6 +191,8 @@ def unpublish_model(model_id, app=None):
     Returns:
         Model: The unpublished model.
     """
+    if not _is_internal_call():
+        warnings.warn(_DEPRECATION_WARNING, DeprecationWarning, stacklevel=2)
     ml_service = _get_ml_service(app)
     return Model.from_dict(ml_service.set_published(model_id, publish=False), app=app)
 
@@ -135,6 +200,12 @@ def unpublish_model(model_id, app=None):
 def get_model(model_id, app=None):
     """Gets the model specified by the given ID.
 
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+
     Args:
         model_id: The id of the model to get.
         app: A Firebase app instance (or None to use the default app).
@@ -142,6 +213,8 @@ def get_model(model_id, app=None):
     Returns:
      Model: The requested model.
     """
+    if not _is_internal_call():
+        warnings.warn(_DEPRECATION_WARNING, DeprecationWarning, stacklevel=2)
     ml_service = _get_ml_service(app)
     return Model.from_dict(ml_service.get_model(model_id), app=app)
 
@@ -149,6 +222,12 @@ def get_model(model_id, app=None):
 def list_models(list_filter=None, page_size=None, page_token=None, app=None):
     """Lists the current project's models.
 
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+
     Args:
         list_filter: a list filter string such as ``tags:'tag_1'``. None will return all models.
         page_size: A number between 1 and 100 inclusive that specifies the maximum
@@ -160,6 +239,8 @@ def list_models(list_filter=None, page_size=None, page_token=None, app=None):
     Returns:
         ListModelsPage: A (filtered) list of models.
     """
+    if not _is_internal_call():
+        warnings.warn(_DEPRECATION_WARNING, DeprecationWarning, stacklevel=2)
     ml_service = _get_ml_service(app)
     return ListModelsPage(
         ml_service.list_models, list_filter, page_size, page_token, app=app)
@@ -168,10 +249,18 @@ def list_models(list_filter=None, page_size=None, page_token=None, app=None):
 def delete_model(model_id, app=None):
     """Deletes a model from the current project.
 
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+
     Args:
         model_id: The id of the model you wish to delete.
         app: A Firebase app instance (or None to use the default app).
     """
+    if not _is_internal_call():
+        warnings.warn(_DEPRECATION_WARNING, DeprecationWarning, stacklevel=2)
     ml_service = _get_ml_service(app)
     ml_service.delete_model(model_id)
 
@@ -179,12 +268,20 @@ def delete_model(model_id, app=None):
 class Model:
     """A Firebase ML Model object.
 
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+
     Args:
         display_name: The display name of your model - used to identify your model in code.
         tags: Optional list of strings associated with your model. Can be used in list queries.
         model_format: A subclass of ModelFormat. (e.g. TFLiteFormat) Specifies the model details.
     """
     def __init__(self, display_name=None, tags=None, model_format=None):
+        if not _is_internal_call():
+            warnings.warn(_DEPRECATION_WARNING, DeprecationWarning, stacklevel=2)
         self._app = None  # Only needed for wait_for_unlo
         self._data = {}
         self._model_format = None
@@ -342,7 +439,14 @@ class Model:
 
 
 class ModelFormat:
-    """Abstract base class representing a Model Format such as TFLite."""
+    """Abstract base class representing a Model Format such as TFLite.
+
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+    """
     def as_dict(self, for_upload=False):
         """Returns a serializable representation of the object."""
         raise NotImplementedError
@@ -351,10 +455,18 @@ class ModelFormat:
 class TFLiteFormat(ModelFormat):
     """Model format representing a TFLite model.
 
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+
     Args:
         model_source: A TFLiteModelSource sub class. Specifies the details of the model source.
     """
     def __init__(self, model_source=None):
+        if not _is_internal_call():
+            warnings.warn(_DEPRECATION_WARNING, DeprecationWarning, stacklevel=2)
         self._data = {}
         self._model_source = None
 
@@ -412,7 +524,14 @@ class TFLiteFormat(ModelFormat):
 
 
 class TFLiteModelSource:
-    """Abstract base class representing a model source for TFLite format models."""
+    """Abstract base class representing a model source for TFLite format models.
+
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+    """
     def as_dict(self, for_upload=False):
         """Returns a serializable representation of the object."""
         raise NotImplementedError
@@ -466,11 +585,20 @@ class _CloudStorageClient:
 
 
 class TFLiteGCSModelSource(TFLiteModelSource):
-    """TFLite model source representing a tflite model file stored in GCS."""
+    """TFLite model source representing a tflite model file stored in GCS.
+
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+    """
 
     _STORAGE_CLIENT = _CloudStorageClient()
 
     def __init__(self, gcs_tflite_uri, app=None):
+        if not _is_internal_call():
+            warnings.warn(_DEPRECATION_WARNING, DeprecationWarning, stacklevel=2)
         self._app = app
         self._gcs_tflite_uri = _validate_gcs_tflite_uri(gcs_tflite_uri)
 
@@ -600,12 +728,20 @@ class TFLiteGCSModelSource(TFLiteModelSource):
 class ListModelsPage:
     """Represents a page of models in a Firebase project.
 
+    .. deprecated::
+        Firebase ML is deprecated and will be shut down on June 15, 2027.
+        To host custom models, you must migrate to another solution. You can use Cloud Storage for
+        Firebase as an alternative for hosting custom models. For more info, see
+        https://firebase.google.com/docs/ml/migrate-to-cloud-storage
+
     Provides methods for traversing the models included in this page, as well as
     retrieving subsequent pages of models. The iterator returned by
     ``iterate_all()`` can be used to iterate through all the models in the
     Firebase project starting from this page.
     """
     def __init__(self, list_models_func, list_filter, page_size, page_token, app):
+        if not _is_internal_call():
+            warnings.warn(_DEPRECATION_WARNING, DeprecationWarning, stacklevel=2)
         self._list_models_func = list_models_func
         self._list_filter = list_filter
         self._page_size = page_size

{firebase_admin-7.5.0 → firebase_admin-7.6.0}/firebase_admin.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: firebase_admin
-Version: 7.5.0
+Version: 7.6.0
 Summary: Firebase Admin Python SDK
 Home-page: https://firebase.google.com/docs/admin/setup/
 Author: Firebase

{firebase_admin-7.5.0 → firebase_admin-7.6.0}/tests/test_app_check.py

@@ -15,11 +15,12 @@
 """Test cases for the firebase_admin.app_check module."""
 import base64
 import pytest
+import requests
 
 from jwt import PyJWK, InvalidAudienceError, InvalidIssuerError
 from jwt import ExpiredSignatureError, InvalidSignatureError
 import firebase_admin
-from firebase_admin import app_check
+from firebase_admin import app_check, exceptions
 from tests import testutils
 
 NON_STRING_ARGS = [[], tuple(), {}, True, False, 1, 0]
@@ -58,6 +59,15 @@ class TestBatch:
     def teardown_class(cls):
         testutils.cleanup_apps()
 
+
+@pytest.fixture
+def mock_jwt(mocker):
+    """Mocks JWT decoding and JWKS key retrieval for a valid App Check token."""
+    mocker.patch("jwt.decode", return_value=JWT_PAYLOAD_SAMPLE)
+    mocker.patch("jwt.PyJWKClient.get_signing_key_from_jwt", return_value=PyJWK(signing_key))
+    mocker.patch("jwt.get_unverified_header", return_value=JWT_PAYLOAD_SAMPLE.get("headers"))
+
+
 class TestVerifyToken(TestBatch):
 
     def test_no_project_id(self):
@@ -74,6 +84,12 @@ class TestVerifyToken(TestBatch):
         expected = f'app check token "{token}" must be a string.'
         assert str(excinfo.value) == expected
 
+    @pytest.mark.parametrize('consume', [[], tuple(), {}, 1, 0, 'true', 'false', None])
+    def test_verify_token_with_non_boolean_consume_raises_error(self, consume):
+        with pytest.raises(ValueError) as excinfo:
+            app_check.verify_token('app_check_token', consume=consume)
+        assert str(excinfo.value) == 'consume must be a boolean.'
+
     def test_has_valid_token_headers(self):
         app = firebase_admin.get_app()
         app_check_service = app_check._get_app_check_service(app)
@@ -221,10 +237,8 @@ class TestVerifyToken(TestBatch):
             f'"{sub_number}" must be a string.')
         assert str(excinfo.value) == expected
 
-    def test_verify_token(self, mocker):
-        mocker.patch("jwt.decode", return_value=JWT_PAYLOAD_SAMPLE)
-        mocker.patch("jwt.PyJWKClient.get_signing_key_from_jwt", return_value=PyJWK(signing_key))
-        mocker.patch("jwt.get_unverified_header", return_value=JWT_PAYLOAD_SAMPLE.get("headers"))
+    @pytest.mark.usefixtures("mock_jwt")
+    def test_verify_token(self):
         app = firebase_admin.get_app()
 
         payload = app_check.verify_token("encoded", app)
@@ -273,3 +287,120 @@ class TestVerifyToken(TestBatch):
 
         expected = 'Token does not contain the correct "iss" (issuer).'
         assert str(excinfo.value) == expected
+
+    @pytest.mark.usefixtures("mock_jwt")
+    @pytest.mark.parametrize('consume_kwargs', [{}, {'consume': False}])
+    def test_verify_token_with_consume_false_makes_no_http_call(
+        self, mocker, consume_kwargs
+    ):
+        app = firebase_admin.get_app()
+        app_check_service = app_check._get_app_check_service(app)
+        mock_body = mocker.patch.object(app_check_service._http_client, "body")
+
+        payload = app_check.verify_token("encoded", app=app, **consume_kwargs)
+        expected = JWT_PAYLOAD_SAMPLE.copy()
+        expected["app_id"] = APP_ID
+        assert payload == expected
+        assert 'already_consumed' not in payload
+        mock_body.assert_not_called()
+
+    @pytest.mark.usefixtures("mock_jwt")
+    def test_verify_token_with_consume_true_not_consumed(self, mocker):
+        app = firebase_admin.get_app()
+        app_check_service = app_check._get_app_check_service(app)
+        mock_body = mocker.patch.object(
+            app_check_service._http_client, "body", return_value={"alreadyConsumed": False}
+        )
+
+        payload = app_check.verify_token("encoded", app=app, consume=True)
+        expected = JWT_PAYLOAD_SAMPLE.copy()
+        expected["app_id"] = APP_ID
+        expected["already_consumed"] = False
+        assert payload == expected
+
+        expected_url = (
+            f"https://firebaseappcheck.googleapis.com/v1/projects/{PROJECT_ID}:verifyAppCheckToken"
+        )
+        mock_body.assert_called_once_with(
+            "post", expected_url, json={"app_check_token": "encoded"}
+        )
+
+    @pytest.mark.usefixtures("mock_jwt")
+    def test_verify_token_with_consume_true_already_consumed(self, mocker):
+        app = firebase_admin.get_app()
+        app_check_service = app_check._get_app_check_service(app)
+        mock_body = mocker.patch.object(
+            app_check_service._http_client, "body", return_value={"alreadyConsumed": True}
+        )
+
+        payload = app_check.verify_token("encoded", app=app, consume=True)
+        expected = JWT_PAYLOAD_SAMPLE.copy()
+        expected["app_id"] = APP_ID
+        expected["already_consumed"] = True
+        assert payload == expected
+
+        expected_url = (
+            f"https://firebaseappcheck.googleapis.com/v1/projects/{PROJECT_ID}:verifyAppCheckToken"
+        )
+        mock_body.assert_called_once_with(
+            "post", expected_url, json={"app_check_token": "encoded"}
+        )
+
+    @pytest.mark.usefixtures("mock_jwt")
+    def test_verify_token_with_consume_true_backend_error(self, mocker):
+        app = firebase_admin.get_app()
+        app_check_service = app_check._get_app_check_service(app)
+
+        req_exc = requests.exceptions.RequestException("Backend error")
+        mocker.patch.object(app_check_service._http_client, "body", side_effect=req_exc)
+
+        with pytest.raises(exceptions.UnknownError) as excinfo:
+            app_check.verify_token("encoded", app=app, consume=True)
+        assert "Unknown error while making a remote service call" in str(excinfo.value)
+
+    @pytest.mark.usefixtures("mock_jwt")
+    def test_verify_token_with_consume_true_http_error(self, mocker):
+        app = firebase_admin.get_app()
+        app_check_service = app_check._get_app_check_service(app)
+
+        response = requests.Response()
+        response.status_code = 403
+        response._content = (
+            b'{"error": {"status": "PERMISSION_DENIED", "message": "Permission denied."}}'
+        )
+        http_exc = requests.exceptions.HTTPError(response=response)
+        mocker.patch.object(app_check_service._http_client, "body", side_effect=http_exc)
+
+        with pytest.raises(exceptions.PermissionDeniedError) as excinfo:
+            app_check.verify_token("encoded", app=app, consume=True)
+        assert "Permission denied." in str(excinfo.value)
+
+    @pytest.mark.usefixtures("mock_jwt")
+    @pytest.mark.parametrize('malformed_body', ['string_response', [1, 2], 123, None])
+    def test_verify_token_with_consume_true_malformed_response_raises_error(
+        self, mocker, malformed_body
+    ):
+        app = firebase_admin.get_app()
+        app_check_service = app_check._get_app_check_service(app)
+        mocker.patch.object(app_check_service._http_client, "body", return_value=malformed_body)
+
+        with pytest.raises(exceptions.UnknownError) as excinfo:
+            app_check.verify_token("encoded", app=app, consume=True)
+        assert 'Unexpected response from App Check service' in str(excinfo.value)
+
+    @pytest.mark.usefixtures("mock_jwt")
+    def test_verify_token_with_consume_true_json_decode_error(self, mocker):
+        app = firebase_admin.get_app()
+        app_check_service = app_check._get_app_check_service(app)
+        mocker.patch.object(
+            app_check_service._http_client,
+            "body",
+            side_effect=ValueError("Expecting value: line 1 column 1 (char 0)"),
+        )
+
+        with pytest.raises(exceptions.UnknownError) as excinfo:
+            app_check.verify_token("encoded", app=app, consume=True)
+        expected_msg = (
+            "Unexpected response from App Check service: Expecting value: line 1 column 1 (char 0)"
+        )
+        assert expected_msg in str(excinfo.value)

{firebase_admin-7.5.0 → firebase_admin-7.6.0}/tests/test_ml.py

@@ -15,6 +15,7 @@
 """Test cases for the firebase_admin.ml module."""
 
 import json
+import warnings
 
 import pytest
 
@@ -1086,3 +1087,89 @@ class TestListModels:
         assert len(page.models) == 0
         models = list(page.iterate_all())
         assert len(models) == 0
+
+
+class TestMLDeprecation:
+    """Tests for verifying deprecation warnings in the ML module."""
+
+    DEPRECATION_MSG = (
+        r'Firebase ML is deprecated and will be shut down on June 15, 2027\. '
+        r'To host custom models, you must migrate to another solution\. '
+        r'You can use Cloud Storage for Firebase as an alternative for hosting custom models\. '
+        r'For more info, see https://firebase\.google\.com/docs/ml/migrate-to-cloud-storage'
+    )
+
+    @classmethod
+    def setup_class(cls):
+        cred = testutils.MockCredential()
+        firebase_admin.initialize_app(cred, {'projectId': PROJECT_ID})
+        ml._MLService.POLL_BASE_WAIT_TIME_SECONDS = 0.1
+        ml.TFLiteGCSModelSource._STORAGE_CLIENT = _TestStorageClient()
+
+    @classmethod
+    def teardown_class(cls):
+        testutils.cleanup_apps()
+
+    def test_model_init_deprecation_warning(self):
+        with pytest.warns(DeprecationWarning, match=self.DEPRECATION_MSG):
+            ml.Model()
+
+    def test_tflite_format_init_deprecation_warning(self):
+        with pytest.warns(DeprecationWarning, match=self.DEPRECATION_MSG):
+            ml.TFLiteFormat()
+
+    def test_tflite_gcs_model_source_init_deprecation_warning(self):
+        with pytest.warns(DeprecationWarning, match=self.DEPRECATION_MSG):
+            ml.TFLiteGCSModelSource(GCS_TFLITE_URI)
+
+    def test_get_model_deprecation_warning(self):
+        instrument_ml_service(status=200, payload=DEFAULT_GET_RESPONSE)
+        with pytest.warns(DeprecationWarning, match=self.DEPRECATION_MSG):
+            ml.get_model(MODEL_ID_1)
+
+    def test_list_models_deprecation_warning(self):
+        instrument_ml_service(status=200, payload=ONE_PAGE_LIST_RESPONSE)
+        with pytest.warns(DeprecationWarning, match=self.DEPRECATION_MSG):
+            ml.list_models()
+
+    def test_delete_model_deprecation_warning(self):
+        instrument_ml_service(status=200, payload=EMPTY_RESPONSE)
+        with pytest.warns(DeprecationWarning, match=self.DEPRECATION_MSG):
+            ml.delete_model(MODEL_ID_1)
+
+    def test_create_model_deprecation_warning(self):
+        instrument_ml_service(status=200, payload=OPERATION_DONE_RESPONSE)
+        with pytest.warns(DeprecationWarning, match=self.DEPRECATION_MSG):
+            ml.create_model(ml.Model(display_name=DISPLAY_NAME_1))
+
+    def test_update_model_deprecation_warning(self):
+        instrument_ml_service(status=200, payload=OPERATION_DONE_RESPONSE)
+        with pytest.warns(DeprecationWarning, match=self.DEPRECATION_MSG):
+            ml.update_model(ml.Model(display_name=DISPLAY_NAME_1))
+
+    def test_publish_model_deprecation_warning(self):
+        instrument_ml_service(status=200, payload=OPERATION_DONE_RESPONSE)
+        with pytest.warns(DeprecationWarning, match=self.DEPRECATION_MSG):
+            ml.publish_model(MODEL_ID_1)
+
+    def test_unpublish_model_deprecation_warning(self):
+        instrument_ml_service(status=200, payload=OPERATION_DONE_RESPONSE)
+        with pytest.warns(DeprecationWarning, match=self.DEPRECATION_MSG):
+            ml.unpublish_model(MODEL_ID_1)
+
+    def test_single_warning_on_get_model(self):
+        instrument_ml_service(status=200, payload=DEFAULT_GET_RESPONSE)
+        with warnings.catch_warnings(record=True) as captured_warnings:
+            warnings.simplefilter('always')
+            ml.get_model(MODEL_ID_1)
+            assert len(captured_warnings) == 1
+            assert issubclass(captured_warnings[0].category, DeprecationWarning)
+
+    def test_single_warning_on_list_models(self):
+        instrument_ml_service(status=200, payload=ONE_PAGE_LIST_RESPONSE)
+        with warnings.catch_warnings(record=True) as captured_warnings:
+            warnings.simplefilter('always')
+            page = ml.list_models()
+            _ = page.models
+            assert len(captured_warnings) == 1
+            assert issubclass(captured_warnings[0].category, DeprecationWarning)