Fix default eel routes not being added to custom app instances

Sentinent · samuelhwilliams · commit 474fe7e6fa96 · 2023-02-05T16:34:14.000Z
diff --git a/eel/__init__.py b/eel/__init__.py
@@ -169,9 +169,11 @@ def run_lambda():
             HOST = _start_args['host']
 
         app = _start_args['app']  # type: btl.Bottle
-        for route_path, route_params in BOTTLE_ROUTES.items():
-            route_func, route_kwargs = route_params
-            btl.route(path=route_path, callback=route_func, **route_kwargs)
+
+        if isinstance(app, btl.Bottle):
+            add_eel_routes(app)
+        else:
+            add_eel_routes(btl.default_app())
 
         return btl.run(
             host=HOST,
@@ -264,6 +266,19 @@ def _websocket(ws):
     "/eel": (_websocket, dict(apply=[wbs.websocket]))
 }
 
+def add_eel_routes(app):
+    '''
+    Adds eel routes to `app`. Only needed if you are passing something besides `bottle.Bottle` to `eel.start()`.
+    Ex:
+    app = bottle.Bottle()
+    eel.add_eel_routes(app)
+    middleware = beaker.middleware.SessionMiddleware(app)
+    eel.start(app=middleware)
+    '''
+    for route_path, route_params in BOTTLE_ROUTES.items():
+        route_func, route_kwargs = route_params
+        app.route(path=route_path, callback=route_func, **route_kwargs)
+
 # Private functions
 
 def _safe_json(obj):
diff --git a/examples/10 - custom_app_routes/custom_app.py b/examples/10 - custom_app_routes/custom_app.py
@@ -0,0 +1,15 @@
+import eel
+import bottle
+from beaker.middleware import SessionMiddleware
+
+app = bottle.Bottle()
+@app.route('/custom')
+def custom_route():
+    return 'Hello, World!'
+
+# need to manually add eel routes if we are wrapping our Bottle instance with middleware
+eel.add_eel_routes(app)
+middleware = SessionMiddleware(app)
+
+eel.init('web')
+eel.start('index.html', app=middleware)
diff --git a/examples/10 - custom_app_routes/web/index.html b/examples/10 - custom_app_routes/web/index.html
@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+    <title>Hello, World!</title>
+</head>
+
+</html>
diff --git a/tests/integration/test_examples.py b/tests/integration/test_examples.py
@@ -61,3 +61,17 @@ def test_06_jinja_templates(driver: webdriver.Remote):
 
         driver.find_element_by_css_selector('a').click()
         WebDriverWait(driver, 2.0).until(expected_conditions.presence_of_element_located((By.XPATH, '//h1[text()="This is page 2"]')))
+
+
+def test_10_custom_app(driver: webdriver.Remote):
+    # test default eel routes are working
+    with get_eel_server('examples/10 - custom_app_routes/custom_app.py', 'index.html') as eel_url:
+        driver.get(eel_url)
+        # we really need to test if the page 404s, but selenium has no support for status codes
+        # so we just test if we can get our page title
+        assert driver.title == 'Hello, World!'
+
+    # test default eel routes are working
+    with get_eel_server('examples/10 - custom_app_routes/custom_app.py', 'custom') as eel_url:
+        driver.get(eel_url)
+        assert 'Hello, World!' in driver.page_source

-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
 +<!DOCTYPE html>
 +<html>
++
 +<head>
 +    <title>Hello, World!</title>
 +</head>
++
 +</html>