Merge pull request #4568 from springfall2008/fix/local-logo-images

fix(web): serve the Predbat logo locally instead of from GitHub

Author: springfall2008

.gitignore

@@ -87,6 +87,8 @@ plan_*.html
 
 # Generated PNG files
 *.png
+!apps/predbat/bat_logo_light.png
+!apps/predbat/bat_logo_dark.png
 
 # Build artifacts
 a.out

docs/images/bat_logo.svg apps/predbat/bat_logo.svgdocs/images/bat_logo.svg renamed to apps/predbat/bat_logo.svg

@@ -9,6 +9,7 @@
 # pylint: disable=attribute-defined-outside-init
 
 import asyncio
+import os
 
 from web import WebInterface
 from web_helper import get_plan_renderer_js
@@ -346,3 +347,80 @@ def run_currency_unit_tests(my_predbat, web):
         my_predbat.num_cars = original_num_cars
 
     return failed
+
+
+class FakeImageRequest:
+    """A minimal aiohttp-request stand-in exposing only ``match_info``."""
+
+    def __init__(self, filename=None):
+        """Store the route parameter a handler will read."""
+        self.match_info = {} if filename is None else {"filename": filename}
+
+
+def run_web_logo_image_tests(my_predbat):
+    """Unit tests for the local logo image route (issue #4562).
+
+    The Predbat logo used to be fetched from raw.githubusercontent.com on every page
+    load, so a GitHub outage or rate limit left the dashboard hanging for ~15s. The
+    images now ship alongside the app and are served locally, with no network
+    dependency at all.
+    """
+    failed = 0
+    print("**** Running web logo image tests ****")
+
+    web = make_web(my_predbat)
+
+    print("Test: each bundled logo file is served with the right content type")
+    expected_content_types = {
+        "bat_logo.svg": "image/svg+xml",
+        "bat_logo_light.png": "image/png",
+        "bat_logo_dark.png": "image/png",
+    }
+    for filename, content_type in expected_content_types.items():
+        response = asyncio.run(web.html_logo_image(FakeImageRequest(filename)))
+        if response.status != 200:
+            print(f"  ERROR: {filename} should serve with status 200, got {response.status}")
+            failed += 1
+        if response.content_type != content_type:
+            print(f"  ERROR: {filename} should serve as {content_type}, got {response.content_type}")
+            failed += 1
+        if not response.body:
+            print(f"  ERROR: {filename} should have a non-empty body")
+            failed += 1
+
+    print("Test: an unknown or missing filename 404s rather than leaking the app directory")
+    for request in [FakeImageRequest("predbat.py"), FakeImageRequest("../predbat.py"), FakeImageRequest()]:
+        response = asyncio.run(web.html_logo_image(request))
+        if response.status != 404:
+            print(f"  ERROR: request for {request.match_info} should 404, got {response.status}")
+            failed += 1
+
+    print("Test: a whitelisted filename whose file is genuinely absent on disk 404s cleanly")
+    # Regression for issue #4568: when an install has updated predbat.py before its self-updater has
+    # fetched these newly-added logo files (an old download.py running against a new release), the
+    # image genuinely won't exist yet. This should degrade to a missing image, not raise.
+    filename = "bat_logo_light.png"
+    file_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", filename)
+    moved_path = file_path + ".test_moved"
+    os.rename(file_path, moved_path)
+    try:
+        response = asyncio.run(web.html_logo_image(FakeImageRequest(filename)))
+        if response.status != 404:
+            print(f"  ERROR: {filename} missing from disk should 404, got {response.status}")
+            failed += 1
+    finally:
+        os.rename(moved_path, file_path)
+
+    print("Test: the page header no longer depends on GitHub for the logo")
+    from web_helper import get_header_html
+
+    header = get_header_html("Test", False, "./dash", [], "v1.0", "")
+    if "githubusercontent" in header:
+        print("  ERROR: the page header should not reference githubusercontent.com any more")
+        failed += 1
+    if "./images/bat_logo" not in header:
+        print("  ERROR: the page header should reference the local logo route")
+        failed += 1
+
+    print("**** Web logo image tests completed ****")
+    return failed

docs/images/bat_logo_dark.png apps/predbat/bat_logo_dark.pngdocs/images/bat_logo_dark.png renamed to apps/predbat/bat_logo_dark.png

@@ -90,7 +90,7 @@
 from tests.test_web_if import run_test_web_if
 from tests.test_web_chart_currency import test_rates_chart_series_names_use_currency_symbol
 from tests.test_metrics_dashboard_soc_refresh import test_soc_chart_center_text_reads_live_data
-from tests.test_web_functions import run_web_functions_tests
+from tests.test_web_functions import run_web_functions_tests, run_web_logo_image_tests
 from tests.test_web_history_table import run_web_history_table_tests
 from tests.test_web_charts import run_web_charts_tests
 from tests.test_web_chart_grouping import run_web_chart_grouping_tests
@@ -411,6 +411,7 @@ def main():
         ("web_chart_currency", test_rates_chart_series_names_use_currency_symbol, "Rates chart series names follow currency_symbols tests", False),
         ("metrics_dashboard_soc_refresh", test_soc_chart_center_text_reads_live_data, "Metrics dashboard SoC chart live-refresh tests", False),
         ("web_functions", run_web_functions_tests, "Web function unit tests", False),
+        ("web_logo_image", run_web_logo_image_tests, "Local logo image route tests (issue #4562)", False),
         ("web_annual", test_web_annual, "Annual web tab prefill tests", False),
         ("web_annual_form", test_web_annual_form, "Annual web tab form tests", False),
         ("web_annual_fast_mode", test_web_annual_fast_mode, "Annual web tab fast mode tests", False),

docs/images/bat_logo_light.png apps/predbat/bat_logo_light.pngdocs/images/bat_logo_light.png renamed to apps/predbat/bat_logo_light.png

@@ -476,6 +476,7 @@ async def start(self):
         app.router.add_post("/api/login", self.html_api_login)
         app.router.add_get("/browse", self.html_browse)
         app.router.add_get("/download", self.html_download_file)
+        app.router.add_get("/images/{filename}", self.html_logo_image)
         app.router.add_get("/internals", self.html_internals)
         app.router.add_get("/api/internals", self.html_api_internals)
         app.router.add_get("/api/internals/download", self.html_api_internals_download)
@@ -5211,6 +5212,34 @@ async def html_download_file(self, request):
             self.log(f"Error downloading file: {str(e)}")
             return web.Response(text=f"Error downloading file: {str(e)}", status=500)
 
+    async def html_logo_image(self, request):
+        """
+        Serve the bundled Predbat logo images locally.
+
+        The logos used to be loaded from raw.githubusercontent.com, which left the
+        dashboard hanging for ~15s whenever GitHub was unreachable or rate-limiting
+        (issue #4562). They now ship alongside the other app files so the page never
+        depends on internet access to render.
+        """
+        content_types = {
+            "bat_logo.svg": "image/svg+xml",
+            "bat_logo_light.png": "image/png",
+            "bat_logo_dark.png": "image/png",
+        }
+        filename = request.match_info.get("filename")
+        content_type = content_types.get(filename)
+        if not content_type:
+            return web.Response(text="Not found", status=404)
+
+        file_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), filename)
+        try:
+            with open(file_path, "rb") as handle:
+                content = handle.read()
+        except OSError:
+            return web.Response(text="Not found", status=404)
+
+        return web.Response(body=content, content_type=content_type, headers={"Cache-Control": "public, max-age=604800"})
+
     async def html_metrics_dashboard(self, request):
         """
         Return the Metrics Dashboard page rendered inside the standard PredBat web shell.

apps/predbat/tests/test_web_functions.py

@@ -7349,8 +7349,8 @@ def get_header_html(title, calculating, default_page, arg_errors, THIS_VERSION,
     """
 
     text = '<!doctype html><html><head><meta charset="utf-8"><title>{}</title>'.format(title)
-    text += '<link rel="icon" type="image/svg+xml" href="https://raw.githubusercontent.com/springfall2008/batpred/refs/heads/main/docs/images/bat_logo.svg">'
-    text += '<link rel="icon" type="image/png" href="https://raw.githubusercontent.com/springfall2008/batpred/refs/heads/main/docs/images/bat_logo_light.png">'
+    text += '<link rel="icon" type="image/svg+xml" href="./images/bat_logo.svg">'
+    text += '<link rel="icon" type="image/png" href="./images/bat_logo_light.png">'
 
     text += """
 <script>
@@ -7704,8 +7704,8 @@ def get_header_html(title, calculating, default_page, arg_errors, THIS_VERSION,
     // Get the appropriate bat image based on dark/light mode
     const isDarkMode = document.body.classList.contains('dark-mode');
     const batImage = isDarkMode
-        ? 'https://raw.githubusercontent.com/springfall2008/batpred/refs/heads/main/docs/images/bat_logo_dark.png'
-        : 'https://raw.githubusercontent.com/springfall2008/batpred/refs/heads/main/docs/images/bat_logo_light.png';
+        ? './images/bat_logo_dark.png'
+        : './images/bat_logo_light.png';
 
     bat.style.backgroundImage = `url('${batImage}')`;
 
@@ -8180,9 +8180,9 @@ def get_menu_html(calculating, default_page, arg_errors, THIS_VERSION, battery_s
 <div class="menu-bar">
 <div class="logo">
     <img id="logo-image"
-            src="https://raw.githubusercontent.com/springfall2008/batpred/refs/heads/main/docs/images/bat_logo_light.png"
-            data-light-src="https://raw.githubusercontent.com/springfall2008/batpred/refs/heads/main/docs/images/bat_logo_light.png"
-            data-dark-src="https://raw.githubusercontent.com/springfall2008/batpred/refs/heads/main/docs/images/bat_logo_dark.png"
+            src="./images/bat_logo_light.png"
+            data-light-src="./images/bat_logo_light.png"
+            data-dark-src="./images/bat_logo_dark.png"
             alt="Predbat Logo"
             onclick="flyBat()"
             style="cursor: pointer;"