add an option to disable ssr for export and deploy (#5821)

Author: adhami3310

reflex/app.py

@@ -113,7 +113,12 @@
     prerequisites,
     types,
 )
-from reflex.utils.exec import get_compile_context, is_prod_mode, is_testing_env
+from reflex.utils.exec import (
+    get_compile_context,
+    is_prod_mode,
+    is_testing_env,
+    should_prerender_routes,
+)
 from reflex.utils.imports import ImportVar
 from reflex.utils.token_manager import TokenManager
 from reflex.utils.types import ASGIApp, Message, Receive, Scope, Send
@@ -607,7 +612,7 @@ def __call__(self) -> ASGIApp:
         """
         from reflex.vars.base import GLOBAL_CACHE
 
-        self._compile(prerender_routes=is_prod_mode())
+        self._compile(prerender_routes=should_prerender_routes())
 
         config = get_config()
 

reflex/environment.py

@@ -657,6 +657,9 @@ class EnvironmentVariables:
     # Whether to force a full reload on changes.
     VITE_FORCE_FULL_RELOAD: EnvVar[bool] = env_var(False)
 
+    # Whether to enable SSR for the frontend.
+    REFLEX_SSR: EnvVar[bool] = env_var(True)
+
 
 environment = EnvironmentVariables()
 

reflex/reflex.py

@@ -204,7 +204,7 @@ def _run(
     args = (frontend,)
     kwargs = {
         "check_if_schema_up_to_date": True,
-        "prerender_routes": env == constants.Env.PROD,
+        "prerender_routes": exec.should_prerender_routes(),
     }
 
     # Granian fails if the app is already imported.
@@ -432,6 +432,14 @@ def compile(dry: bool, rich: bool):
     type=click.Path(exists=True, path_type=Path, resolve_path=True),
     help="Files or directories to exclude from the backend zip. Can be used multiple times.",
 )
+@click.option(
+    "--server-side-rendering/--no-server-side-rendering",
+    "--ssr/--no-ssr",
+    "ssr",
+    default=True,
+    is_flag=True,
+    help="Whether to enable server side rendering for the frontend.",
+)
 def export(
     zip: bool,
     frontend_only: bool,
@@ -440,11 +448,17 @@ def export(
     upload_db_file: bool,
     env: LITERAL_ENV,
     backend_excluded_dirs: tuple[Path, ...] = (),
+    ssr: bool = True,
 ):
     """Export the app to a zip file."""
     from reflex.utils import export as export_utils
     from reflex.utils import prerequisites
 
+    if not environment.REFLEX_SSR.is_set():
+        environment.REFLEX_SSR.set(ssr)
+    elif environment.REFLEX_SSR.get() != ssr:
+        ssr = environment.REFLEX_SSR.get()
+
     environment.REFLEX_COMPILE_CONTEXT.set(constants.CompileContext.EXPORT)
 
     should_frontend_run, should_backend_run = prerequisites.check_running_mode(
@@ -467,6 +481,7 @@ def export(
         env=constants.Env.DEV if env == constants.Env.DEV else constants.Env.PROD,
         loglevel=config.loglevel.subprocess_level(),
         backend_excluded_dirs=backend_excluded_dirs,
+        prerender_routes=ssr,
     )
 
 
@@ -679,6 +694,14 @@ def makemigrations(message: str | None):
     type=click.Path(exists=True, path_type=Path, resolve_path=True),
     help="Files or directories to exclude from the backend zip. Can be used multiple times.",
 )
+@click.option(
+    "--server-side-rendering/--no-server-side-rendering",
+    "--ssr/--no-ssr",
+    "ssr",
+    default=True,
+    is_flag=True,
+    help="Whether to enable server side rendering for the frontend.",
+)
 def deploy(
     app_name: str | None,
     app_id: str | None,
@@ -693,6 +716,7 @@ def deploy(
     token: str | None,
     config_path: str | None,
     backend_excluded_dirs: tuple[Path, ...] = (),
+    ssr: bool = True,
 ):
     """Deploy the app to the Reflex hosting service."""
     from reflex_cli.utils import dependency
@@ -710,6 +734,11 @@ def deploy(
 
     environment.REFLEX_COMPILE_CONTEXT.set(constants.CompileContext.DEPLOY)
 
+    if not environment.REFLEX_SSR.is_set():
+        environment.REFLEX_SSR.set(ssr)
+    elif environment.REFLEX_SSR.get() != ssr:
+        ssr = environment.REFLEX_SSR.get()
+
     # Only check requirements if interactive.
     # There is user interaction for requirements update.
     if interactive:
@@ -742,6 +771,7 @@ def deploy(
                 loglevel=config.loglevel.subprocess_level(),
                 upload_db_file=upload_db,
                 backend_excluded_dirs=backend_excluded_dirs,
+                prerender_routes=ssr,
             )
         ),
         regions=list(region),

reflex/utils/build.py

@@ -215,10 +215,16 @@ def build():
     )
     processes.show_progress("Creating Production Build", process, checkpoints)
     _duplicate_index_html_to_parent_directory(wdir / constants.Dirs.STATIC)
-    path_ops.cp(
-        wdir / constants.Dirs.STATIC / constants.ReactRouter.SPA_FALLBACK,
-        wdir / constants.Dirs.STATIC / "404.html",
-    )
+
+    spa_fallback = wdir / constants.Dirs.STATIC / constants.ReactRouter.SPA_FALLBACK
+    if not spa_fallback.exists():
+        spa_fallback = wdir / constants.Dirs.STATIC / "index.html"
+
+    if spa_fallback.exists():
+        path_ops.cp(
+            spa_fallback,
+            wdir / constants.Dirs.STATIC / "404.html",
+        )
 
     config = get_config()
 

reflex/utils/exec.py

@@ -743,6 +743,17 @@ def is_prod_mode() -> bool:
     return current_mode == constants.Env.PROD
 
 
+def should_prerender_routes() -> bool:
+    """Check if the app should prerender routes.
+
+    Returns:
+        True if the app should prerender routes.
+    """
+    if not environment.REFLEX_SSR.is_set():
+        return is_prod_mode()
+    return environment.REFLEX_SSR.get()
+
+
 def get_compile_context() -> constants.CompileContext:
     """Check if the app is compiled for deploy.
 

reflex/utils/export.py

@@ -19,6 +19,7 @@ def export(
     env: constants.Env = constants.Env.PROD,
     loglevel: constants.LogLevel = console._LOG_LEVEL,
     backend_excluded_dirs: tuple[Path, ...] = (),
+    prerender_routes: bool = True,
 ):
     """Export the app to a zip file.
 
@@ -33,6 +34,7 @@ def export(
         env: The environment to use. Defaults to constants.Env.PROD.
         loglevel: The log level to use. Defaults to console._LOG_LEVEL.
         backend_excluded_dirs: A tuple of files or directories to exclude from the backend zip.  Defaults to ().
+        prerender_routes: Whether to prerender the routes. Defaults to True.
     """
     config = get_config()
 
@@ -58,7 +60,7 @@ def export(
 
     if frontend:
         # Ensure module can be imported and app.compile() is called.
-        prerequisites.get_compiled_app(prerender_routes=True)
+        prerequisites.get_compiled_app(prerender_routes=prerender_routes)
         # Set up .web directory and install frontend dependencies.
         build.setup_frontend(Path.cwd())