Merge branch 'main' into feat/auth-context

Author: exaby73

Diff for: samples/basic_params/functions/main.py

@@ -28,6 +28,18 @@
     default="/images/processed",
 )
 
+image_type = params.ListParam(
+    "IMAGE_TYPE",
+    label="convert image to preferred types",
+    description="The image types you'd like your source image to convert to.",
+    input=params.MultiSelectInput([
+        params.SelectOption(value="jpeg", label="jpeg"),
+        params.SelectOption(value="png", label="png"),
+        params.SelectOption(value="webp", label="webp"),
+    ]),
+    default=["jpeg", "png"],
+)
+
 delete_original = params.BoolParam(
     "DELETE_ORIGINAL_FILE",
     label="delete the original file",
@@ -56,6 +68,7 @@ def resize_images(event: storage_fn.CloudEvent[storage_fn.StorageObjectData]):
     This function will be triggered when a new object is created in the bucket.
     """
     print("Got a new image:", event)
+    print("Selected image types:", image_type.value)
     print("Selected bucket resource:", bucket.value)
     print("Selected output location:", output_path.value)
     print("Testing a not so secret api key:", image_resize_api_secret.value)

Diff for: src/firebase_functions/https_fn.py

@@ -135,6 +135,9 @@ class FunctionsErrorCode(str, _enum.Enum):
     Unrecoverable data loss or corruption.
     """
 
+    def __str__(self) -> str:
+        return self.value
+
 
 class _CanonicalErrorCodeName(str, _enum.Enum):
     """The canonical error code name for a given error code."""
@@ -157,6 +160,9 @@ class _CanonicalErrorCodeName(str, _enum.Enum):
     UNAVAILABLE = "UNAVAILABLE"
     DATA_LOSS = "DATA_LOSS"
 
+    def __str__(self) -> str:
+        return self.value
+
 
 @_dataclasses.dataclass(frozen=True)
 class _HttpErrorCode:

Diff for: src/firebase_functions/logger.py

@@ -24,6 +24,9 @@ class LogSeverity(str, _enum.Enum):
     ALERT = "ALERT"
     EMERGENCY = "EMERGENCY"
 
+    def __str__(self) -> str:
+        return self.value
+
 
 class LogEntry(_typing.TypedDict):
     """

Diff for: src/firebase_functions/options.py

@@ -41,6 +41,9 @@ class VpcEgressSetting(str, _enum.Enum):
     PRIVATE_RANGES_ONLY = "PRIVATE_RANGES_ONLY"
     ALL_TRAFFIC = "ALL_TRAFFIC"
 
+    def __str__(self) -> str:
+        return self.value
+
 
 class IngressSetting(str, _enum.Enum):
     """What kind of traffic can access the function."""
@@ -49,6 +52,9 @@ class IngressSetting(str, _enum.Enum):
     ALLOW_INTERNAL_ONLY = "ALLOW_INTERNAL_ONLY"
     ALLOW_INTERNAL_AND_GCLB = "ALLOW_INTERNAL_AND_GCLB"
 
+    def __str__(self) -> str:
+        return self.value
+
 
 @_dataclasses.dataclass(frozen=True)
 class CorsOptions:
@@ -88,6 +94,9 @@ class MemoryOption(int, _enum.Enum):
     GB_16 = 16 << 10
     GB_32 = 32 << 10
 
+    def __str__(self) -> str:
+        return f"{self.value}MB"
+
 
 class SupportedRegion(str, _enum.Enum):
     """
@@ -120,6 +129,9 @@ class SupportedRegion(str, _enum.Enum):
     US_WEST3 = "us-west3"
     US_WEST4 = "us-west4"
 
+    def __str__(self) -> str:
+        return self.value
+
 
 @_dataclasses.dataclass(frozen=True)
 class RateLimits():
@@ -587,6 +599,9 @@ class AlertType(str, _enum.Enum):
     Performance threshold alerts.
     """
 
+    def __str__(self) -> str:
+        return self.value
+
 
 @_dataclasses.dataclass(frozen=True, kw_only=True)
 class FirebaseAlertOptions(EventHandlerOptions):

Diff for: src/firebase_functions/params.py

@@ -14,6 +14,7 @@
 """Module for params that can make Cloud Functions codebases generic."""
 
 import abc as _abc
+import json as _json
 import dataclasses as _dataclasses
 import os as _os
 import re as _re
@@ -139,6 +140,18 @@ class SelectInput(_typing.Generic[_T]):
     """A list of user selectable options."""
 
 
+@_dataclasses.dataclass(frozen=True)
+class MultiSelectInput():
+    """
+    Specifies that a Param's value should be determined by having the user select
+    a subset from a list of pre-canned options interactively at deploy-time.
+    Will result in errors if used on Params of type other than string[].
+    """
+
+    options: list[SelectOption[str]]
+    """A list of user selectable options."""
+
+
 @_dataclasses.dataclass(frozen=True)
 class TextInput:
     """
@@ -168,6 +181,9 @@ class ResourceType(str, _enum.Enum):
     """The type of resource that a picker should pick."""
     STORAGE_BUCKET = "storage.googleapis.com/Bucket"
 
+    def __str__(self) -> str:
+        return self.value
+
 
 @_dataclasses.dataclass(frozen=True)
 class ResourceInput:
@@ -215,7 +231,8 @@ class Param(Expression[_T]):
     deployments.
     """
 
-    input: TextInput | ResourceInput | SelectInput[_T] | None = None
+    input: TextInput | ResourceInput | SelectInput[
+        _T] | MultiSelectInput | None = None
     """
     The type of input that is required for this param, e.g. TextInput.
     """
@@ -355,6 +372,32 @@ def value(self) -> bool:
         return False
 
 
+@_dataclasses.dataclass(frozen=True)
+class ListParam(Param[list]):
+    """A parameter as a list of strings."""
+
+    @property
+    def value(self) -> list[str]:
+        if _os.environ.get(self.name) is not None:
+            # If the environment variable starts with "[" and ends with "]",
+            # then assume it is a JSON array and try to parse it.
+            # (This is for Cloud Run (v2 Functions), the environment variable is a JSON array.)
+            if _os.environ[self.name].startswith("[") and _os.environ[
+                    self.name].endswith("]"):
+                try:
+                    return _json.loads(_os.environ[self.name])
+                except _json.JSONDecodeError:
+                    return []
+            # Otherwise, split the string by commas.
+            # (This is for emulator & the Firebase CLI generated .env file, the environment
+            # variable is a comma-separated list.)
+            return list(filter(len, _os.environ[self.name].split(",")))
+        if self.default is not None:
+            return self.default.value if isinstance(
+                self.default, Expression) else self.default
+        return []
+
+
 @_dataclasses.dataclass(frozen=True)
 class _DefaultStringParam(StringParam):
     """

Diff for: src/firebase_functions/private/manifest.py

@@ -181,7 +181,8 @@ class ManifestStack:
 
 
 def _param_input_to_spec(
-    param_input: _params.TextInput | _params.ResourceInput | _params.SelectInput
+    param_input: _params.TextInput | _params.ResourceInput |
+    _params.SelectInput | _params.MultiSelectInput
 ) -> dict[str, _typing.Any]:
     if isinstance(param_input, _params.TextInput):
         return {
@@ -204,9 +205,11 @@ def _param_input_to_spec(
             },
         }
 
-    if isinstance(param_input, _params.SelectInput):
+    if isinstance(param_input, (_params.MultiSelectInput, _params.SelectInput)):
+        key = "select" if isinstance(param_input,
+                                     _params.SelectInput) else "multiSelect"
         return {
-            "select": {
+            key: {
                 "options": [{
                     key: value for key, value in {
                         "value": option.value,
@@ -242,6 +245,8 @@ def _param_to_spec(
         spec_dict["type"] = "float"
     elif isinstance(param, _params.SecretParam):
         spec_dict["type"] = "secret"
+    elif isinstance(param, _params.ListParam):
+        spec_dict["type"] = "list"
     elif isinstance(param, _params.StringParam):
         spec_dict["type"] = "string"
     else:

Diff for: src/firebase_functions/private/path_pattern.py

@@ -37,11 +37,14 @@ def trim_param(param: str) -> str:
 _WILDCARD_CAPTURE_REGEX = re.compile(r"{[^/{}]+}", re.IGNORECASE)
 
 
-class SegmentName(Enum):
+class SegmentName(str, Enum):
     SEGMENT = "segment"
     SINGLE_CAPTURE = "single-capture"
     MULTI_CAPTURE = "multi-capture"
 
+    def __str__(self) -> str:
+        return self.value
+
 
 class PathSegment:
     """

Diff for: src/firebase_functions/private/util.py

@@ -187,6 +187,9 @@ class OnCallTokenState(_enum.Enum):
     The token is invalid.
     """
 
+    def __str__(self) -> str:
+        return self.value
+
 
 @_dataclasses.dataclass()
 class _OnCallTokenVerification:
@@ -388,6 +391,9 @@ class PrecisionTimestamp(_enum.Enum):
 
     SECONDS = "SECONDS"
 
+    def __str__(self) -> str:
+        return self.value
+
 
 def get_precision_timestamp(time: str) -> PrecisionTimestamp:
     """Return a bool which indicates if the timestamp is in nanoseconds"""

Diff for: src/firebase_functions/remote_config_fn.py

@@ -75,6 +75,9 @@ class ConfigUpdateOrigin(str, _enum.Enum):
     The update came from the Firebase Admin Node SDK.
     """
 
+    def __str__(self) -> str:
+        return self.value
+
 
 class ConfigUpdateType(str, _enum.Enum):
     """
@@ -102,6 +105,9 @@ class ConfigUpdateType(str, _enum.Enum):
     A rollback to a previous Remote Config template.
     """
 
+    def __str__(self) -> str:
+        return self.value
+
 
 @_dataclasses.dataclass(frozen=True)
 class ConfigUpdateData:

Diff for: src/firebase_functions/test_lab_fn.py

@@ -63,6 +63,9 @@ class TestState(str, _enum.Enum):
     The test matrix was not run because the provided inputs are not valid.
     """
 
+    def __str__(self) -> str:
+        return self.value
+
 
 class OutcomeSummary(str, _enum.Enum):
     """
@@ -101,6 +104,9 @@ class OutcomeSummary(str, _enum.Enum):
     All tests were skipped.
     """
 
+    def __str__(self) -> str:
+        return self.value
+
 
 @_dataclasses.dataclass(frozen=True)
 class ResultStorage:

Diff for: tests/test_manifest.py

@@ -68,43 +68,41 @@
         _params.FloatParam("FLOAT_TEST", immutable=True),
         _params.SecretParam("SECRET_TEST"),
         _params.StringParam("STRING_TEST"),
+        _params.ListParam("LIST_TEST", default=["1", "2", "3"]),
     ],
     requiredAPIs=[{
         "api": "test_api",
         "reason": "testing"
-    }],
-)
+    }])
 
 full_stack_dict = {
     "specVersion": "v1alpha1",
     "endpoints": {
         "test": full_endpoint_dict
     },
-    "params": [
-        {
-            "name": "BOOL_TEST",
-            "type": "boolean",
-            "default": False,
-        },
-        {
-            "name": "INT_TEST",
-            "type": "int",
-            "description": "int_description"
-        },
-        {
-            "name": "FLOAT_TEST",
-            "type": "float",
-            "immutable": True,
-        },
-        {
-            "name": "SECRET_TEST",
-            "type": "secret"
-        },
-        {
-            "name": "STRING_TEST",
-            "type": "string"
-        },
-    ],
+    "params": [{
+        "name": "BOOL_TEST",
+        "type": "boolean",
+        "default": False,
+    }, {
+        "name": "INT_TEST",
+        "type": "int",
+        "description": "int_description"
+    }, {
+        "name": "FLOAT_TEST",
+        "type": "float",
+        "immutable": True,
+    }, {
+        "name": "SECRET_TEST",
+        "type": "secret"
+    }, {
+        "name": "STRING_TEST",
+        "type": "string"
+    }, {
+        "default": ["1", "2", "3"],
+        "name": "LIST_TEST",
+        "type": "list"
+    }],
     "requiredAPIs": [{
         "api": "test_api",
         "reason": "testing"