feat: Make BaseBlockingOptions and use it with new email and sms triggers

Author: exaby73

samples/identity/functions/main.py

@@ -39,3 +39,17 @@ def beforeusersignedin(
         return identity_fn.BeforeSignInResponse(session_claims={"emoji": "🐕"})
 
     return None
+
+
+@identity_fn.before_email_sent()
+def beforeemailsent(
+    event: identity_fn.AuthBlockingEvent
+) -> identity_fn.BeforeEmailSentResponse | None:
+    print(event)
+    return None
+
+
+@identity_fn.before_sms_sent()
+def beforesmssent(event: identity_fn.AuthBlockingEvent) -> identity_fn.BeforeSmsSentResponse | None:
+    print(event)
+    return None

samples/identity/functions/requirements.txt

@@ -1,8 +1,8 @@
 # Not published yet,
 # firebase-functions-python >= 0.0.1
 # so we use a relative path during development:
-./../../../
+# ./../../../
 # Or switch to git ref for deployment testing:
-# git+https://github.com/firebase/firebase-functions-python.git@main#egg=firebase-functions
+git+https://github.com/firebase/firebase-functions-python.git@feat/before_email_sms_sent_blocking_fn#egg=firebase-functions
 
 firebase-admin >= 6.0.1

src/firebase_functions/identity_fn.py

@@ -489,7 +489,7 @@ def before_user_created_wrapped(request: _Request) -> _Response:
     return before_user_created_decorator
 
 
-@_util.copy_func_kwargs(_options.BlockingOptions)
+@_util.copy_func_kwargs(_options.BaseBlockingOptions)
 def before_email_sent(
     **kwargs,
 ) -> _typing.Callable[[BeforeEmailSentCallable], BeforeEmailSentCallable]:
@@ -509,14 +509,14 @@ def example(
           pass
 
     :param \\*\\*kwargs: Options.
-    :type \\*\\*kwargs: as :exc:`firebase_functions.options.BlockingOptions`
+    :type \\*\\*kwargs: as :exc:`firebase_functions.options.BaseBlockingOptions`
     :rtype: :exc:`typing.Callable`
             \\[ \\[ :exc:`firebase_functions.identity_fn.AuthBlockingEvent` \\],
             :exc:`firebase_functions.identity_fn.BeforeEmailSentResponse` \\| `None` \\]
             A function that takes a AuthBlockingEvent and optionally returns 
             BeforeEmailSentResponse.
     """
-    options = _options.BlockingOptions(**kwargs)
+    options = _options.BaseBlockingOptions(**kwargs)
 
     def before_email_sent_decorator(func: BeforeEmailSentCallable):
         from firebase_functions.private._identity_fn_event_types import event_type_before_email_sent
@@ -546,7 +546,7 @@ def before_email_sent_wrapped(request: _Request) -> _Response:
     return before_email_sent_decorator
 
 
-@_util.copy_func_kwargs(_options.BlockingOptions)
+@_util.copy_func_kwargs(_options.BaseBlockingOptions)
 def before_sms_sent(
     **kwargs,
 ) -> _typing.Callable[[BeforeSmsSentCallable], BeforeSmsSentCallable]:
@@ -564,13 +564,13 @@ def example(event: identity_fn.AuthBlockingEvent) -> identity_fn.BeforeSmsSentRe
           pass
 
     :param \\*\\*kwargs: Options.
-    :type \\*\\*kwargs: as :exc:`firebase_functions.options.BlockingOptions`
+    :type \\*\\*kwargs: as :exc:`firebase_functions.options.BaseBlockingOptions`
     :rtype: :exc:`typing.Callable`
             \\[ \\[ :exc:`firebase_functions.identity_fn.AuthBlockingEvent` \\],
             :exc:`firebase_functions.identity_fn.BeforeSmsSentResponse` \\| `None` \\]
             A function that takes a AuthBlockingEvent and optionally returns BeforeSmsSentResponse.
     """
-    options = _options.BlockingOptions(**kwargs)
+    options = _options.BaseBlockingOptions(**kwargs)
 
     def before_sms_sent_decorator(func: BeforeSmsSentCallable):
         from firebase_functions.private._identity_fn_event_types import event_type_before_sms_sent

src/firebase_functions/options.py

@@ -969,27 +969,12 @@ def _endpoint(
 
 
 @_dataclasses.dataclass(frozen=True, kw_only=True)
-class BlockingOptions(RuntimeOptions):
+class BaseBlockingOptions(RuntimeOptions):
     """
-    Options that can be set on an Auth Blocking trigger.
+    Base class for options that can be set on an Auth Blocking trigger.
     Internal use only.
     """
 
-    id_token: bool | None = None
-    """
-    Pass the ID Token credential to the function.
-    """
-
-    access_token: bool | None = None
-    """
-    Pass the access token credential to the function.
-    """
-
-    refresh_token: bool | None = None
-    """
-    Pass the refresh token credential to the function.
-    """
-
     def _endpoint(
         self,
         **kwargs,
@@ -1034,6 +1019,29 @@ def _required_apis(self) -> list[_manifest.ManifestRequiredApi]:
         ]
 
 
+@_dataclasses.dataclass(frozen=True, kw_only=True)
+class BlockingOptions(BaseBlockingOptions):
+    """
+    Options that can be set on an Auth Blocking trigger.
+    Internal use only.
+    """
+
+    id_token: bool | None = None
+    """
+    Pass the ID Token credential to the function.
+    """
+
+    access_token: bool | None = None
+    """
+    Pass the access token credential to the function.
+    """
+
+    refresh_token: bool | None = None
+    """
+    Pass the refresh token credential to the function.
+    """
+
+
 @_dataclasses.dataclass(frozen=True, kw_only=True)
 class FirestoreOptions(RuntimeOptions):
     """