Fix: Adding favicon to Kedro Demo (#1509)

* Fix: Adding favicon to Kedro Demo * Fix: Change in approach for serving favicon * Lint error fix * Lint error fix * Favicon endpoint test added * Favicon endpoint test added * Lint error fixed * Fix: Adding favicon to Kedro Demo Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com> * Fix: Change in approach for serving favicon Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com> * Lint error fix Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com> * Lint error fix Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com> * Favicon endpoint test added Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com> * Favicon endpoint test added Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com> * Lint error fixed Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com> * Fixed favicon endpoint test * Release doc updated * Update RELEASE.md Co-authored-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> * Removed pytest.fixture as per review comment --------- Signed-off-by: Jitendra Gundaniya <jitendra_gundaniya@mckinsey.com> Co-authored-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> Signed-off-by: ravi-kumar-pilla <ravi_kumar_pilla@mckinsey.com>
kedro-org · Aug 31, 2023 · 56d8162 · 56d8162
1 parent f990e25
commit 56d8162
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/RELEASE.md b/RELEASE.md
@@ -15,8 +15,10 @@ Please follow the established format:
 ## Bug fixes and other changes
 
 - Fix to search for a '<lambda' Python function in the sidebar. (#1497)
+- Add favicon to Kedro-Viz. (#1509)
 - Remove python upper-bound requirements and add KedroVizPythonVersion warning. (#1506)
 
+
 # Release 6.4.0
 
 ## Major features and improvements

diff --git a/package/kedro_viz/api/apps.py b/package/kedro_viz/api/apps.py
@@ -8,7 +8,7 @@
 import secure
 from fastapi import FastAPI, HTTPException
 from fastapi.requests import Request
-from fastapi.responses import HTMLResponse, JSONResponse, Response
+from fastapi.responses import FileResponse, HTMLResponse, JSONResponse, Response
 from fastapi.staticfiles import StaticFiles
 from jinja2 import Environment, FileSystemLoader
 
@@ -72,6 +72,11 @@ def create_api_app_from_project(
     # this is used as an etag embedded in the frontend for client to use when making requests.
     app_etag = _create_etag()
 
+    # Serve the favicon.ico file from the "html" directory
+    @app.get("/favicon.ico", include_in_schema=False)
+    async def favicon():
+        return FileResponse(_HTML_DIR / "favicon.ico")
+
     @app.get("/")
     @app.get("/experiment-tracking")
     async def index():

diff --git a/package/tests/test_api/test_apps.py b/package/tests/test_api/test_apps.py
@@ -62,3 +62,13 @@ def test_reload_endpoint_return_304_when_content_has_not_changed(
         # when the etag has changed, the server will return a 200
         response = client.get("/api/reload", headers={"If-None-Match": "new etag"})
         assert response.status_code == 200
+
+
+class TestFaviconEndpoint:
+    def test_favicon_endpoint(self, client):
+        response = client.get("/favicon.ico")
+        assert response.status_code == 200
+        assert response.headers["content-type"] in [
+            "image/x-icon",
+            "image/vnd.microsoft.icon",
+        ]