Merge branch 'main' of https://github.com/invertase/firebase-functions-python2 into 8-storage

Author: Salakar

.vscode/settings.json

@@ -2,13 +2,16 @@
   "python.linting.enabled": true,
   "python.linting.pylintEnabled": false,
   "python.formatting.provider": "yapf",
-  "python.formatting.yapfArgs": ["--style", "{based_on_style: google, indent_width: 4}"],
+  "python.formatting.yapfArgs": [
+    "--style",
+    "{based_on_style: google, indent_width: 4}"
+  ],
   "python.linting.pylintPath": "pylint",
-  "python.envFile": "${workspaceFolder}/.env",
-  "python.defaultInterpreterPath": "${workspaceFolder}/.env/bin/python3.10",
+  "python.envFile": "${workspaceFolder}/venv",
+  "python.defaultInterpreterPath": "${workspaceFolder}/venv/bin/python3.10",
   "editor.formatOnSave": true,
   "python.linting.lintOnSave": true,
   "python.linting.mypyEnabled": true,
-  "mypy.dmypyExecutable": "${workspaceFolder}/.env/bin/dmypy",
+  "mypy.dmypyExecutable": "${workspaceFolder}/venv/bin/dmypy",
   "files.autoSave": "afterDelay"
 }

src/firebase_functions/db.py

@@ -77,7 +77,7 @@ def _db_endpoint_handler(
     raw: _ce.CloudEvent,
 ) -> None:
     event_attributes = raw._get_attributes()
-    event_data = raw._get_data()
+    event_data: _typing.Any = raw.get_data()
     # TODO Params are built locally via path pattern which is currently unimplemented
     params: dict[str, str] = {}
     database_event_data = event_data["data"]

src/firebase_functions/params.py

@@ -209,6 +209,8 @@ def __str__(self) -> str:
         return f"params.{self.name}"
 
     def __post_init__(self):
+        if isinstance(self, _DefaultStringParam):
+            return
         if not _re.match(r"^[A-Z0-9_]+$", self.name):
             raise ValueError(
                 "Parameter names must only use uppercase letters, numbers and "
@@ -339,24 +341,36 @@ def value(self) -> list[str]:
         return []
 
 
-PROJECT_ID = StringParam("GCLOUD_PROJECT",
-                         description="The active Firebase project")
+@_dataclasses.dataclass(frozen=True)
+class _DefaultStringParam(StringParam):
+    """
+    Internal use only.
+    This is a parameter that is available by default in all functions.
+    These are excluded from the list of parameters that are prompted to the user.
+    """
+
 
-STORAGE_BUCKET = StringParam(
+PROJECT_ID = _DefaultStringParam(
+    "GCLOUD_PROJECT",
+    description="The active Firebase project",
+)
+
+STORAGE_BUCKET = _DefaultStringParam(
     "STORAGE_BUCKET",
-    description="The default Cloud Storage for Firebase bucket")
+    description="The default Cloud Storage for Firebase bucket",
+)
 
-DATABASE_URL = StringParam(
+DATABASE_URL = _DefaultStringParam(
     "DATABASE_URL",
     description="The Firebase project's default Realtime Database instance URL",
 )
 
-DATABASE_INSTANCE = StringParam(
+DATABASE_INSTANCE = _DefaultStringParam(
     "DATABASE_INSTANCE",
     description="The Firebase project's default Realtime Database instance name",
 )
 
-EXTENSION_ID = StringParam(
+EXTENSION_ID = _DefaultStringParam(
     "EXT_INSTANCE_ID",
     label="Extension instance ID",
     description="When a function is running as part of an extension, "

src/firebase_functions/pubsub.py

@@ -99,7 +99,7 @@ def _message_handler(
     raw: _ce.CloudEvent,
 ) -> None:
     event_attributes = raw._get_attributes()
-    event_data = raw.get_data()
+    event_data: _typing.Any = raw.get_data()
     event_dict = {"data": event_data, **event_attributes}
     data = event_dict["data"]
     message_dict = data["message"]

tests/test_params.py

@@ -189,3 +189,30 @@ def test_list_param_equality(self):
             ["123"]).value() is True), "Failure, equality check returned False"
         assert (params.ListParam("LIST_TEST2", default=["456"]).equals(
             ["123"]).value() is False), "Failure, equality check returned False"
+
+
+class TestParamsManifest:
+    """
+    Tests any created params are tracked for the purposes
+    of outputting to the generated manifest.
+    """
+
+    def test_params_stored(self):
+        """Testing if params are internally stored."""
+        environ["TEST_STORING"] = "TEST_STORING_VALUE"
+        param = params.StringParam("TEST_STORING")
+        assert param.value() == "TEST_STORING_VALUE", \
+            'Failure, params value != "TEST_STORING_VALUE"'
+        # pylint: disable=protected-access
+        assert params._params["TEST_STORING"] == param, \
+            "Failure, param was not stored"
+
+    def test_default_params_not_stored(self):
+        """Testing if default params are skipped from being stored."""
+        environ["GCLOUD_PROJECT"] = "python-testing-project"
+
+        assert params.PROJECT_ID.value() == "python-testing-project", \
+            'Failure, params value != "python-testing-project"'
+        # pylint: disable=protected-access
+        assert params._params.get("GCLOUD_PROJECT") is None, \
+            "Failure, default param was stored when it should not have been"