enable sitemap plugin by default (#5558)

* enable sitemap plugin by default

* add prefix comment

* make it a function on its own

* adjust docstring for disable_plugins

Author: adhami3310

reflex/config.py

@@ -25,6 +25,7 @@
 from reflex.environment import env_var as env_var
 from reflex.environment import environment as environment
 from reflex.plugins import Plugin
+from reflex.plugins.sitemap import SitemapPlugin
 from reflex.utils import console
 from reflex.utils.exceptions import ConfigError
 
@@ -235,9 +236,17 @@ class BaseConfig:
     # List of plugins to use in the app.
     plugins: list[Plugin] = dataclasses.field(default_factory=list)
 
+    # List of fully qualified import paths of plugins to disable in the app (e.g. reflex.plugins.sitemap.SitemapPlugin).
+    disable_plugins: list[str] = dataclasses.field(default_factory=list)
+
     _prefixes: ClassVar[list[str]] = ["REFLEX_"]
 
 
+_PLUGINS_ENABLED_BY_DEFAULT = [
+    SitemapPlugin,
+]
+
+
 @dataclasses.dataclass(kw_only=True, init=False)
 class Config(BaseConfig):
     """The config defines runtime settings for the app.
@@ -254,8 +263,8 @@ class Config(BaseConfig):
     )
     ```
 
-    Every config value can be overridden by an environment variable with the same name in uppercase.
-    For example, `db_url` can be overridden by setting the `DB_URL` environment variable.
+    Every config value can be overridden by an environment variable with the same name in uppercase and a REFLEX_ prefix.
+    For example, `db_url` can be overridden by setting the `REFLEX_DB_URL` environment variable.
 
     See the [configuration](https://reflex.dev/docs/getting-started/configuration/) docs for more info.
     """
@@ -285,6 +294,9 @@ def _post_init(self, **kwargs):
         if env_loglevel or self.loglevel != LogLevel.DEFAULT:
             console.set_log_level(env_loglevel or self.loglevel)
 
+        # Add builtin plugins if not disabled.
+        self._add_builtin_plugins()
+
         # Update the config from environment variables.
         env_kwargs = self.update_from_env()
         for key, env_value in env_kwargs.items():
@@ -302,6 +314,39 @@ def _post_init(self, **kwargs):
             msg = f"{self._prefixes[0]}REDIS_URL is required when using the redis state manager."
             raise ConfigError(msg)
 
+    def _add_builtin_plugins(self):
+        """Add the builtin plugins to the config."""
+        for plugin in _PLUGINS_ENABLED_BY_DEFAULT:
+            plugin_name = plugin.__module__ + "." + plugin.__qualname__
+            if plugin_name not in self.disable_plugins:
+                if not any(isinstance(p, plugin) for p in self.plugins):
+                    console.warn(
+                        f"`{plugin_name}` plugin is enabled by default, but not explicitly added to the config. "
+                        "If you want to use it, please add it to the `plugins` list in your config inside of `rxconfig.py`. "
+                        f"To disable this plugin, set `disable_plugins` to `{[plugin_name, *self.disable_plugins]!r}`.",
+                    )
+                    self.plugins.append(plugin())
+            else:
+                if any(isinstance(p, plugin) for p in self.plugins):
+                    console.warn(
+                        f"`{plugin_name}` is disabled in the config, but it is still present in the `plugins` list. "
+                        "Please remove it from the `plugins` list in your config inside of `rxconfig.py`.",
+                    )
+
+        for disabled_plugin in self.disable_plugins:
+            if not isinstance(disabled_plugin, str):
+                console.warn(
+                    f"reflex.Config.disable_plugins should only contain strings, but got {disabled_plugin!r}. "
+                )
+            if not any(
+                plugin.__module__ + "." + plugin.__qualname__ == disabled_plugin
+                for plugin in _PLUGINS_ENABLED_BY_DEFAULT
+            ):
+                console.warn(
+                    f"`{disabled_plugin}` is disabled in the config, but it is not a built-in plugin. "
+                    "Please remove it from the `disable_plugins` list in your config inside of `rxconfig.py`.",
+                )
+
     @classmethod
     def class_fields(cls) -> set[str]:
         """Get the fields of the config class.

reflex/plugins/__init__.py

@@ -1,8 +1,15 @@
 """Reflex Plugin System."""
 
-from .base import CommonContext as CommonContext
-from .base import Plugin as Plugin
-from .base import PreCompileContext as PreCompileContext
-from .sitemap import Plugin as SitemapPlugin
-from .tailwind_v3 import TailwindV3Plugin as TailwindV3Plugin
-from .tailwind_v4 import TailwindV4Plugin as TailwindV4Plugin
+from .base import CommonContext, Plugin, PreCompileContext
+from .sitemap import SitemapPlugin
+from .tailwind_v3 import TailwindV3Plugin
+from .tailwind_v4 import TailwindV4Plugin
+
+__all__ = [
+    "CommonContext",
+    "Plugin",
+    "PreCompileContext",
+    "SitemapPlugin",
+    "TailwindV3Plugin",
+    "TailwindV4Plugin",
+]

reflex/plugins/sitemap.py

@@ -193,7 +193,7 @@ def sitemap_task(unevaluated_pages: Sequence["UnevaluatedPage"]) -> tuple[str, s
     )
 
 
-class Plugin(PluginBase):
+class SitemapPlugin(PluginBase):
     """Sitemap plugin for Reflex."""
 
     def pre_compile(self, **context):
@@ -204,3 +204,6 @@ def pre_compile(self, **context):
         """
         unevaluated_pages = context.get("unevaluated_pages", [])
         context["add_save_task"](sitemap_task, unevaluated_pages)
+
+
+Plugin = SitemapPlugin

reflex/utils/console.py

@@ -79,7 +79,7 @@ def is_debug() -> bool:
     return _LOG_LEVEL <= LogLevel.DEBUG
 
 
-def print(msg: str, dedupe: bool = False, **kwargs):
+def print(msg: str, *, dedupe: bool = False, **kwargs):
     """Print a message.
 
     Args:
@@ -128,7 +128,7 @@ def should_use_log_file_console() -> bool:
     return environment.REFLEX_ENABLE_FULL_LOGGING.get()
 
 
-def print_to_log_file(msg: str, dedupe: bool = False, **kwargs):
+def print_to_log_file(msg: str, *, dedupe: bool = False, **kwargs):
     """Print a message to the log file.
 
     Args:
@@ -139,7 +139,7 @@ def print_to_log_file(msg: str, dedupe: bool = False, **kwargs):
     log_file_console().print(msg, **kwargs)
 
 
-def debug(msg: str, dedupe: bool = False, **kwargs):
+def debug(msg: str, *, dedupe: bool = False, **kwargs):
     """Print a debug message.
 
     Args:
@@ -161,7 +161,7 @@ def debug(msg: str, dedupe: bool = False, **kwargs):
         print_to_log_file(f"[purple]Debug: {msg}[/purple]", **kwargs)
 
 
-def info(msg: str, dedupe: bool = False, **kwargs):
+def info(msg: str, *, dedupe: bool = False, **kwargs):
     """Print an info message.
 
     Args:
@@ -179,7 +179,7 @@ def info(msg: str, dedupe: bool = False, **kwargs):
         print_to_log_file(f"[cyan]Info: {msg}[/cyan]", **kwargs)
 
 
-def success(msg: str, dedupe: bool = False, **kwargs):
+def success(msg: str, *, dedupe: bool = False, **kwargs):
     """Print a success message.
 
     Args:
@@ -197,7 +197,7 @@ def success(msg: str, dedupe: bool = False, **kwargs):
         print_to_log_file(f"[green]Success: {msg}[/green]", **kwargs)
 
 
-def log(msg: str, dedupe: bool = False, **kwargs):
+def log(msg: str, *, dedupe: bool = False, **kwargs):
     """Takes a string and logs it to the console.
 
     Args:
@@ -225,7 +225,7 @@ def rule(title: str, **kwargs):
     _console.rule(title, **kwargs)
 
 
-def warn(msg: str, dedupe: bool = False, **kwargs):
+def warn(msg: str, *, dedupe: bool = False, **kwargs):
     """Print a warning message.
 
     Args:
@@ -312,7 +312,7 @@ def deprecate(
             _EMITTED_DEPRECATION_WARNINGS.add(dedupe_key)
 
 
-def error(msg: str, dedupe: bool = False, **kwargs):
+def error(msg: str, *, dedupe: bool = False, **kwargs):
     """Print an error message.
 
     Args: