Replace explicit client route registration with SPA catch-all fallback

Galaxy maintained 133 explicit add_client_route() calls in buildapp.py that had to stay in sync with the Vue router -- forget one and the route 404s on page refresh. Since all client routes serve the same static js-app.mako template with no server-side data injection, there's no reason to enumerate them.

Instead, when no server route matches a non-API path, the WSGI layer now falls back to serving the SPA directly and lets the Vue router handle routing (including showing its own 404 for truly invalid paths). API paths still 404 normally, static files are handled by URLMap before this code runs, and legacy controller routes still match via the mapper first.

This removes the clientside_routes mapper, the add_client_route() method, and all 133 route registrations from buildapp.py.

Author: dannon

lib/galaxy/web/framework/base.py

@@ -98,7 +98,6 @@ def __init__(self):
         self.controllers = {}
         self.api_controllers = {}
         self.mapper = routes.Mapper()
-        self.clientside_routes = routes.Mapper(controller_scan=None, register=False)
         # FIXME: The following two options are deprecated and should be
         # removed.  Consult the Routes documentation.
         self.mapper.minimization = True
@@ -132,9 +131,6 @@ def add_route(self, route, **kwargs):
         """
         self.mapper.connect(route, **kwargs)
 
-    def add_client_route(self, route, controller="root"):
-        self.clientside_routes.connect(route, controller=controller, action="client")
-
     def set_transaction_factory(self, transaction_factory):
         """
         Use the callable `transaction_factory` to create the transaction
@@ -149,7 +145,6 @@ def finalize_config(self):
         """
         # Create/compile the regular expressions for route mapping
         self.mapper.create_regs(list(self.controllers.keys()))
-        self.clientside_routes.create_regs()
 
     def trace(self, **fields):
         if self.trace_logger:
@@ -212,16 +207,18 @@ def _resolve_map_match(self, map_match, path_info, controllers, use_default=True
 
     def handle_request(self, request_id, path_info, environ, start_response, body_renderer=None):
         # Map url using routes
-        client_match = self.clientside_routes.match(path_info, environ)
-        map_match = self.mapper.match(path_info, environ) or client_match
+        map_match = self.mapper.match(path_info, environ)
         if path_info.startswith("/api"):
             environ["is_api_request"] = True
             controllers = self.api_controllers
         else:
             environ["is_api_request"] = False
             controllers = self.controllers
         if map_match is None:
-            raise webob.exc.HTTPNotFound(f"No route for {path_info}")
+            if environ["is_api_request"]:
+                raise webob.exc.HTTPNotFound(f"No route for {path_info}")
+            # Unmatched non-API path: serve the SPA and let the Vue router handle it
+            map_match = {"controller": "root", "action": "client"}
         self.trace(path_info=path_info, map_match=map_match)
         # Setup routes
         rc = routes.request_config()
@@ -239,20 +236,7 @@ def handle_request(self, request_id, path_info, environ, start_response, body_re
         trans.request_id = request_id
         rc.redirect = trans.response.send_redirect
         # Resolve mapping to controller/method
-        try:
-            # We don't use default methods if there's a clientside match for this route.
-            use_default = client_match is None
-            controller_name, controller, action, method = self._resolve_map_match(
-                map_match, path_info, controllers, use_default=use_default
-            )
-        except webob.exc.HTTPNotFound:
-            # Failed, let's check client routes
-            if not environ["is_api_request"] and client_match is not None:
-                controller_name, controller, action, method = self._resolve_map_match(
-                    client_match, path_info, controllers
-                )
-            else:
-                raise
+        controller_name, controller, action, method = self._resolve_map_match(map_match, path_info, controllers)
         trans.controller = controller_name
         trans.action = action
 

lib/galaxy/webapps/galaxy/buildapp.py

@@ -189,144 +189,6 @@ def app_pair(global_conf, load_app_kwds=None, wsgi_preflight=True, **kwargs):
             conditions={"method": ["OPTIONS"]},
         )
 
-    # CLIENTSIDE ROUTES
-    # The following are routes that are handled completely on the clientside.
-    # The following routes don't bootstrap any information, simply provide the
-    # base analysis interface at which point the application takes over.
-    webapp.add_client_route("/")
-    webapp.add_client_route("/index")
-    webapp.add_client_route("/about")
-    webapp.add_client_route("/admin")
-    webapp.add_client_route("/admin/data_tables")
-    webapp.add_client_route("/admin/data_types")
-    webapp.add_client_route("/admin/jobs")
-    webapp.add_client_route("/admin/invocations")
-    webapp.add_client_route("/admin/toolbox_dependencies")
-    webapp.add_client_route("/admin/data_manager{path_info:.*}")
-    webapp.add_client_route("/admin/notifications{path_info:.*}")
-    webapp.add_client_route("/admin/error_stack")
-    webapp.add_client_route("/admin/users")
-    webapp.add_client_route("/admin/users/create")
-    webapp.add_client_route("/admin/display_applications")
-    webapp.add_client_route("/admin/reset_metadata")
-    webapp.add_client_route("/admin/roles")
-    webapp.add_client_route("/admin/forms")
-    webapp.add_client_route("/admin/notifications")
-    webapp.add_client_route("/admin/groups")
-    webapp.add_client_route("/admin/repositories")
-    webapp.add_client_route("/admin/sanitize_allow")
-    webapp.add_client_route("/admin/tool_versions")
-    webapp.add_client_route("/admin/toolshed")
-    webapp.add_client_route("/admin/quotas")
-    webapp.add_client_route("/admin/form/{form_id}")
-    webapp.add_client_route("/admin/api_keys")
-    webapp.add_client_route("/carbon_emissions_calculations")
-    webapp.add_client_route("/help/terms/{term_id}")
-    webapp.add_client_route("/datatypes")
-    webapp.add_client_route("/login/start")
-    webapp.add_client_route("/register/start")
-    webapp.add_client_route("/tools/list")
-    webapp.add_client_route("/tools/list/ontologies")
-    webapp.add_client_route("/tools/json")
-    webapp.add_client_route("/tools/editor")
-    webapp.add_client_route("/tools/editor/{uuid}")
-    webapp.add_client_route("/tool_landings/{uuid}")
-    webapp.add_client_route("/workflow_landings/{uuid}")
-    webapp.add_client_route("/tours")
-    webapp.add_client_route("/tours/{tour_id}")
-    webapp.add_client_route("/chatgxy")
-    webapp.add_client_route("/chatgxy/{exchange_id}")
-    webapp.add_client_route("/user")
-    webapp.add_client_route("/user/notifications{path:.*?}")
-    webapp.add_client_route("/user/{form_id}")
-    webapp.add_client_route("/object_store_instances/create")
-    webapp.add_client_route("/object_store_instances/index")
-    webapp.add_client_route("/object_store_instances/{user_object_store_id}/edit")
-    webapp.add_client_route("/object_store_instances/{user_object_store_id}/upgrade")
-    webapp.add_client_route("/object_store_templates/{template_id}/new")
-    webapp.add_client_route("/file_source_instances/create")
-    webapp.add_client_route("/file_source_instances/index")
-    webapp.add_client_route("/file_source_instances/{user_file_source_id}/edit")
-    webapp.add_client_route("/file_source_instances/{user_file_source_id}/upgrade")
-    webapp.add_client_route("/file_source_templates/{template_id}/new")
-    webapp.add_client_route("/welcome/new")
-    webapp.add_client_route("/visualizations")
-    webapp.add_client_route("/visualizations/create/{visualization}")
-    webapp.add_client_route("/visualizations/display{path:.*?}")
-    webapp.add_client_route("/visualizations/edit")
-    webapp.add_client_route("/visualizations/sharing")
-    webapp.add_client_route("/visualizations/list_published")
-    webapp.add_client_route("/visualizations/list_shared")
-    webapp.add_client_route("/visualizations/list")
-    webapp.add_client_route("/pages/list")
-    webapp.add_client_route("/pages/list_published")
-    webapp.add_client_route("/pages/create")
-    webapp.add_client_route("/pages/edit")
-    webapp.add_client_route("/pages/editor")
-    webapp.add_client_route("/pages/sharing")
-    webapp.add_client_route("/published/history")
-    webapp.add_client_route("/published/page")
-    webapp.add_client_route("/published/visualization")
-    webapp.add_client_route("/published/workflow")
-    webapp.add_client_route("/histories/citations")
-    webapp.add_client_route("/histories/list")
-    webapp.add_client_route("/histories/import")
-    webapp.add_client_route("/histories/{history_id}/export")
-    webapp.add_client_route("/histories/{history_id}/archive")
-    webapp.add_client_route("/histories/{history_id}/invocations")
-    webapp.add_client_route("/histories/archived")
-    webapp.add_client_route("/histories/list_published")
-    webapp.add_client_route("/histories/list_shared")
-    webapp.add_client_route("/histories/rename")
-    webapp.add_client_route("/histories/sharing")
-    webapp.add_client_route("/histories/permissions")
-    webapp.add_client_route("/histories/view")
-    webapp.add_client_route("/histories/view_multiple")
-    webapp.add_client_route("/datasets/copy")
-    webapp.add_client_route("/datasets/list")
-    webapp.add_client_route("/datasets/{dataset_id}/edit")
-    webapp.add_client_route("/datasets/{dataset_id}/error")
-    webapp.add_client_route("/datasets/{dataset_id}/details")
-    webapp.add_client_route("/datasets/{dataset_id}/preview")
-    webapp.add_client_route("/datasets/{dataset_id}/raw")
-    webapp.add_client_route("/datasets/{dataset_id}/report")
-    webapp.add_client_route("/datasets/{dataset_id}/show_params")
-    webapp.add_client_route("/datasets/{dataset_id}/visualize")
-    webapp.add_client_route("/datasets/{dataset_id}")
-    webapp.add_client_route("/display_applications/{path:.*?}")
-    webapp.add_client_route("/collection/{collection_id}/edit")
-    webapp.add_client_route("/collection/{collection_id}/sheet")
-    webapp.add_client_route("/collection/new_list")
-    webapp.add_client_route("/jobs/submission/success")
-    webapp.add_client_route("/jobs/{job_id}/view")
-    webapp.add_client_route("/rules")
-    webapp.add_client_route("/workflows/list")
-    webapp.add_client_route("/workflows/list_published")
-    webapp.add_client_route("/workflows/list_shared_with_me")
-    webapp.add_client_route("/workflows/edit")
-    webapp.add_client_route("/workflows/export")
-    webapp.add_client_route("/workflows/create")
-    webapp.add_client_route("/workflows/rerun")
-    webapp.add_client_route("/workflows/run")
-    webapp.add_client_route("/workflows/import")
-    webapp.add_client_route("/workflows/trs_import")
-    webapp.add_client_route("/workflows/trs_search")
-    webapp.add_client_route("/workflows/invocations")
-    webapp.add_client_route("/workflows/invocations/{invocation_id}")
-    webapp.add_client_route("/workflows/invocations/{invocation_id}/{tab:.*?}")
-    webapp.add_client_route("/workflows/invocations/import")
-    webapp.add_client_route("/workflows/sharing")
-    webapp.add_client_route("/workflows/{stored_workflow_id}/invocations")
-    webapp.add_client_route("/workflows/invocations/report")
-    # webapp.add_client_route('/workflows/invocations/view_bco')
-    webapp.add_client_route("/custom_builds")
-    webapp.add_client_route("/interactivetool_entry_points/list")
-    webapp.add_client_route("/libraries{path:.*?}")
-    webapp.add_client_route("/storage{path:.*?}")
-    webapp.add_client_route("/import/zip")
-    webapp.add_client_route("/downloads")
-    webapp.add_client_route("/upload{path:.*?}")
-
     # ==== Done
     # Indicate that all configuration settings have been provided
     webapp.finalize_config()