pick up env vars prefixed by REFLEX_ (#5312)

* pick up env vars prefixed by REFLEX_

* type annotate to ClassVar and fix warning

* forgot backticks

* fix an issue with loglevel not triggering deprecation message

Author: Lendemor

reflex/config.py

@@ -22,6 +22,7 @@
     TYPE_CHECKING,
     Annotated,
     Any,
+    ClassVar,
     Generic,
     TypeVar,
     get_args,
@@ -894,6 +895,8 @@ class Config:  # pyright: ignore [reportIncompatibleVariableOverride]
     # Extra overlay function to run after the app is built. Formatted such that `from path_0.path_1... import path[-1]`, and calling it with no arguments would work. For example, "reflex.components.moment.moment".
     extra_overlay_function: str | None = None
 
+    _prefixes: ClassVar[list[str]] = ["REFLEX_"]
+
     def __init__(self, *args, **kwargs):
         """Initialize the config values.
 
@@ -906,19 +909,32 @@ def __init__(self, *args, **kwargs):
         """
         super().__init__(*args, **kwargs)
 
-        # Set the log level for this process
-        env_loglevel = os.environ.get("LOGLEVEL")
+        # Clean up this code when we remove plain envvar in 0.8.0
+        show_deprecation = False
+        env_loglevel = os.environ.get("REFLEX_LOGLEVEL")
+        if not env_loglevel:
+            env_loglevel = os.environ.get("LOGLEVEL")
+            if env_loglevel:
+                show_deprecation = True
         if env_loglevel is not None:
             env_loglevel = LogLevel(env_loglevel.lower())
         if env_loglevel or self.loglevel != LogLevel.DEFAULT:
             console.set_log_level(env_loglevel or self.loglevel)
 
+        if show_deprecation:
+            console.deprecate(
+                "Usage of deprecated LOGLEVEL env var detected.",
+                reason="Prefer `REFLEX_` prefix when setting env vars.",
+                deprecation_version="0.7.13",
+                removal_version="0.8.0",
+            )
+
         # Update the config from environment variables.
         env_kwargs = self.update_from_env()
         for key, env_value in env_kwargs.items():
             setattr(self, key, env_value)
 
-        # Update default URLs if ports were set
+        #   Update default URLs if ports were set
         kwargs.update(env_kwargs)
         self._non_default_attributes.update(kwargs)
         self._replace_defaults(**kwargs)
@@ -928,7 +944,7 @@ def __init__(self, *args, **kwargs):
             and not self.redis_url
         ):
             raise ConfigError(
-                "REDIS_URL is required when using the redis state manager."
+                f"{self._prefixes[0]}REDIS_URL is required when using the redis state manager."
             )
 
     @property
@@ -969,7 +985,18 @@ def update_from_env(self) -> dict[str, Any]:
         # Iterate over the fields.
         for key, field in self.__fields__.items():
             # The env var name is the key in uppercase.
-            env_var = os.environ.get(key.upper())
+            for prefix in self._prefixes:
+                if env_var := os.environ.get(f"{prefix}{key.upper()}"):
+                    break
+            else:
+                # Default to non-prefixed env var if other are not found.
+                if env_var := os.environ.get(key.upper()):
+                    console.deprecate(
+                        f"Usage of deprecated {key.upper()} env var detected.",
+                        reason=f"Prefer `{self._prefixes[0]}` prefix when setting env vars.",
+                        deprecation_version="0.7.13",
+                        removal_version="0.8.0",
+                    )
 
             # If the env var is set, override the config value.
             if env_var and env_var.strip():
@@ -989,7 +1016,6 @@ def update_from_env(self) -> dict[str, Any]:
                         f"Overriding config value {key} with env var {key.upper()}={env_var}",
                         dedupe=True,
                     )
-
         return updated_values
 
     def get_event_namespace(self) -> str:
@@ -1041,7 +1067,7 @@ def _set_persistent(self, **kwargs):
         """
         for key, value in kwargs.items():
             if value is not None:
-                os.environ[key.upper()] = str(value)
+                os.environ[self._prefixes[0] + key.upper()] = str(value)
             setattr(self, key, value)
         self._non_default_attributes.update(kwargs)
         self._replace_defaults(**kwargs)

reflex/utils/console.py

@@ -65,7 +65,7 @@ def set_log_level(log_level: LogLevel | None):
     global _LOG_LEVEL
     if log_level != _LOG_LEVEL:
         # Set the loglevel persistenly for subprocesses.
-        os.environ["LOGLEVEL"] = log_level.value
+        os.environ["REFLEX_LOGLEVEL"] = log_level.value
     _LOG_LEVEL = log_level