feat: Make UI accessible behind proxy (feast-dev#3428)

* feat: Make UI runnable behind proxy Signed-off-by: Hai Nguyen <[email protected]> * chore: root_path is optional for type hint Signed-off-by: Hai Nguyen <[email protected]> Signed-off-by: Hai Nguyen <[email protected]>
Affirm · Jan 6, 2023 · 753d8db · 753d8db
1 parent 01ab462
commit 753d8db
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 5 deletions.
diff --git a/sdk/python/feast/cli.py b/sdk/python/feast/cli.py
@@ -151,12 +151,24 @@ def version():
     "--registry_ttl_sec",
     "-r",
     help="Number of seconds after which the registry is refreshed",
-    type=int,
+    type=click.INT,
     default=5,
     show_default=True,
 )
+@click.option(
+    "--root_path",
+    help="Provide root path to make the UI working behind proxy",
+    type=click.STRING,
+    default="",
+)
 @click.pass_context
-def ui(ctx: click.Context, host: str, port: int, registry_ttl_sec: int):
+def ui(
+    ctx: click.Context,
+    host: str,
+    port: int,
+    registry_ttl_sec: int,
+    root_path: Optional[str] = "",
+):
     """
     Shows the Feast UI over the current directory
     """
@@ -170,6 +182,7 @@ def ui(ctx: click.Context, host: str, port: int, registry_ttl_sec: int):
         port=port,
         get_registry_dump=registry_dump,
         registry_ttl_sec=registry_ttl_sec,
+        root_path=root_path,
     )
 
 

diff --git a/sdk/python/feast/feature_store.py b/sdk/python/feast/feature_store.py
@@ -2319,7 +2319,12 @@ def get_feature_server_endpoint(self) -> Optional[str]:
 
     @log_exceptions_and_usage
     def serve_ui(
-        self, host: str, port: int, get_registry_dump: Callable, registry_ttl_sec: int
+        self,
+        host: str,
+        port: int,
+        get_registry_dump: Callable,
+        registry_ttl_sec: int,
+        root_path: Optional[str] = "",
     ) -> None:
         """Start the UI server locally"""
         if flags_helper.is_test():
@@ -2335,6 +2340,7 @@ def serve_ui(
             get_registry_dump=get_registry_dump,
             project_id=self.config.project,
             registry_ttl_sec=registry_ttl_sec,
+            root_path=root_path,
         )
 
     @log_exceptions_and_usage

diff --git a/sdk/python/feast/ui_server.py b/sdk/python/feast/ui_server.py
@@ -101,6 +101,14 @@ def start_server(
     get_registry_dump: Callable,
     project_id: str,
     registry_ttl_sec: int,
+    root_path: Optional[str] = "",
 ):
-    app = get_app(store, get_registry_dump, project_id, registry_ttl_sec, host, port)
-    uvicorn.run(app, host=host, port=port)
+    app = get_app(
+        store,
+        get_registry_dump,
+        project_id,
+        registry_ttl_sec,
+        host,
+        port,
+    )
+    uvicorn.run(app, host=host, port=port, root_path=root_path)