Assorted backend fixes/cleanup (#1432)

* Suppress: Possible hardcoded password (bandit B105)
* Fix: Redefinition of unused `on_action` (Ruff F811)
* Use `importlib.util.find_spec` to check if a package is installed
* Raise from Exception
* Fixed undefined variable
* Fixed error message

---------

Authored-by: EWouters <6179932+EWouters@users.noreply.github.com>

backend/chainlit/auth.py

@@ -69,8 +69,10 @@ async def authenticate_user(token: str = Depends(reuseable_oauth)):
         )
         del dict["exp"]
         user = User(**dict)
-    except Exception:
-        raise HTTPException(status_code=401, detail="Invalid authentication token")
+    except Exception as e:
+        raise HTTPException(
+            status_code=401, detail="Invalid authentication token"
+        ) from e
     if data_layer := get_data_layer():
         try:
             persisted_user = await data_layer.get_user(user.identifier)

backend/chainlit/cache.py

@@ -1,3 +1,4 @@
+import importlib.util
 import os
 import threading
 
@@ -8,11 +9,7 @@
 def init_lc_cache():
     use_cache = config.project.cache is True and config.run.no_cache is False
 
-    if use_cache:
-        try:
-            import langchain
-        except ImportError:
-            return
+    if use_cache and importlib.util.find_spec("langchain") is not None:
         from langchain.cache import SQLiteCache
         from langchain.globals import set_llm_cache
 

backend/chainlit/cli/__init__.py

@@ -186,7 +186,7 @@ def chainlit_run(
         # This is required to have OpenAI LLM providers available for the CI run
         os.environ["OPENAI_API_KEY"] = "sk-FAKE-OPENAI-API-KEY"
         # This is required for authentication tests
-        os.environ["CHAINLIT_AUTH_SECRET"] = "SUPER_SECRET"
+        os.environ["CHAINLIT_AUTH_SECRET"] = "SUPER_SECRET"  # nosec B105
     else:
         trace_event("chainlit run")
 

backend/chainlit/context.py

@@ -103,8 +103,8 @@ def init_http_context(
 def get_context() -> ChainlitContext:
     try:
         return context_var.get()
-    except LookupError:
-        raise ChainlitContextException()
+    except LookupError as e:
+        raise ChainlitContextException() from e
 
 
 context: ChainlitContext = LazyProxy(get_context, enable_cache=False)

backend/chainlit/discord/__init__.py

@@ -1,6 +1,6 @@
-try:
-    import discord
-except ModuleNotFoundError:
+import importlib.util
+
+if importlib.util.find_spec("discord") is None:
     raise ValueError(
-        "The discord package is required to integrate Chainlit with a Slack app. Run `pip install discord --upgrade`"
+        "The discord package is required to integrate Chainlit with a Discord app. Run `pip install discord --upgrade`"
     )

backend/chainlit/server.py

@@ -730,7 +730,7 @@ async def update_feedback(
     try:
         feedback_id = await data_layer.upsert_feedback(feedback=update.feedback)
     except Exception as e:
-        raise HTTPException(detail=str(e), status_code=500)
+        raise HTTPException(detail=str(e), status_code=500) from e
 
     return JSONResponse(content={"success": True, "feedbackId": feedback_id})
 

backend/chainlit/slack/__init__.py

@@ -1,6 +1,6 @@
-try:
-    import slack_bolt
-except ModuleNotFoundError:
+import importlib.util
+
+if importlib.util.find_spec("slack_bolt") is None:
     raise ValueError(
         "The slack_bolt package is required to integrate Chainlit with a Slack app. Run `pip install slack_bolt --upgrade`"
     )

backend/chainlit/step.py

@@ -140,7 +140,7 @@ def sync_wrapper(*args, **kwargs):
                     try:
                         if result and not step.output:
                             step.output = result
-                    except:
+                    except Exception as e:
                         step.is_error = True
                         step.output = str(e)
                     return result

backend/chainlit/teams/__init__.py

@@ -1,6 +1,6 @@
-try:
-    import botbuilder
-except ModuleNotFoundError:
+import importlib.util
+
+if importlib.util.find_spec("botbuilder") is None:
     raise ValueError(
         "The botbuilder-core package is required to integrate Chainlit with a Slack app. Run `pip install botbuilder-core --upgrade`"
     )

backend/tests/test_callbacks.py

@@ -19,7 +19,7 @@ def test_config(monkeypatch: pytest.MonkeyPatch):
 async def test_password_auth_callback(test_config):
     @password_auth_callback
     async def auth_func(username: str, password: str) -> User | None:
-        if username == "testuser" and password == "testpass":
+        if username == "testuser" and password == "testpass":  # nosec B105
             return User(identifier="testuser")
         return None
 
@@ -86,7 +86,7 @@ async def auth_func(
             default_app_user: User,
             id_token: str | None = None,
         ) -> User | None:
-            if provider_id == "google" and token == "valid_token":
+            if provider_id == "google" and token == "valid_token":  # nosec B105
                 return User(identifier="oauth_user")
             return None
 

cypress/e2e/action/main.py

@@ -2,24 +2,24 @@
 
 
 @cl.action_callback("test action")
-async def on_action():
+async def on_test_action():
     await cl.Message(content="Executed test action!").send()
 
 
 @cl.action_callback("removable action")
-async def on_action(action: cl.Action):
+async def on_removable_action(action: cl.Action):
     await cl.Message(content="Executed removable action!").send()
     await action.remove()
 
 
 @cl.action_callback("multiple actions")
-async def on_action(action: cl.Action):
+async def on_multiple_actions(action: cl.Action):
     await cl.Message(content=f"Action(id={action.id}) has been removed!").send()
     await action.remove()
 
 
 @cl.action_callback("all actions removed")
-async def on_action(_: cl.Action):
+async def on_all_actions_removed(_: cl.Action):
     await cl.Message(content="All actions have been removed!").send()
     to_remove = cl.user_session.get("to_remove")  # type: cl.Message
     await to_remove.remove_actions()