Implement debug mode (#14)

* implement debug mode flag

* Update jupyter_ai_tutor/handlers.py

Co-authored-by: Nicolas Brichet <32258950+brichet@users.noreply.github.com>

* Update jupyter_ai_tutor/handlers.py

Co-authored-by: Nicolas Brichet <32258950+brichet@users.noreply.github.com>

* Update jupyter_ai_tutor/handlers.py

Co-authored-by: Nicolas Brichet <32258950+brichet@users.noreply.github.com>

* Update jupyter_ai_tutor/handlers.py

Co-authored-by: Nicolas Brichet <32258950+brichet@users.noreply.github.com>

* Update jupyter_ai_tutor/handlers.py

Co-authored-by: Nicolas Brichet <32258950+brichet@users.noreply.github.com>

* Refactor debug code

---------

Co-authored-by: Nicolas Brichet <32258950+brichet@users.noreply.github.com>

Author: Yahiewi

.gitignore

@@ -129,3 +129,6 @@ dmypy.json
 
 # Yarn cache
 .yarn/
+
+# Ignore secrets in '.env' (API keys)
+.env

jupyter_ai_tutor/app.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 from jupyter_server.extension.application import ExtensionApp
-from traitlets import Unicode
+from traitlets import Bool, Unicode
 
 from .handlers import ExplainHandler
 
@@ -20,12 +20,19 @@ class JupyterAITutorApp(ExtensionApp):
         ),
     ).tag(config=True)
 
+    debug = Bool(
+        default_value=False,
+        help="Whether to log prompts and replies to /tmp for debugging.",
+    ).tag(config=True)
+
     def initialize_settings(self):
         path = Path(self.agent_md) if self.agent_md else _DEFAULT_AGENT_MD
         self.settings["jupyter_ai_tutor.system_prompt"] = path.read_text(
             encoding="utf-8"
         ).strip()
-        self.log.info("jupyter_ai_tutor: loaded system prompt from %s", path)
+        self.settings["jupyter_ai_tutor.debug"] = self.debug
+        self.log.info("jupyter_ai_tutor: loaded system prompt from %s (debug=%s)", path, self.debug)
+
 
     def initialize_handlers(self):
         self.handlers = [

jupyter_ai_tutor/handlers.py

@@ -1,4 +1,7 @@
 import json
+import tempfile
+from datetime import datetime
+from pathlib import Path
 
 import tornado
 from jupyter_server.base.handlers import APIHandler
@@ -36,6 +39,28 @@ async def post(self):
         self.set_header("X-Accel-Buffering", "no")
 
         system_prompt = self.settings.get("jupyter_ai_tutor.system_prompt", "")
+        debug_mode = self.settings.get("jupyter_ai_tutor.debug", False)
+        prompt_file = None
+        answer_file = None
+        accumulated_response = ""
+
+        if debug_mode:
+            debug_dir = Path(tempfile.gettempdir()) / "jupyter-ai-tutor"
+            try:
+                debug_dir.mkdir(parents=True, exist_ok=True)
+            except Exception as e:
+                self.log.error(f"Failed to create debug directory {debug_dir}: {e}")
+            timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+            prompt_file = debug_dir / f"{timestamp}_jupyter_tutor_prompt.txt"
+            answer_file = debug_dir / f"{timestamp}_jupyter_tutor_answer.txt"
+            try:
+                with prompt_file.open("w", encoding="utf-8") as f:
+                    f.write("=== SYSTEM PROMPT ===\n\n")
+                    f.write(system_prompt)
+                    f.write("\n\n=== USER MESSAGE ===\n\n")
+                    f.write(message_body)
+            except Exception as e:
+                self.log.error(f"Failed to write tutor debug prompt: {e}")
 
         try:
             from jupyter_ai_jupyternaut.jupyternaut.chat_models import ChatLiteLLM
@@ -63,10 +88,27 @@ async def post(self):
                     )
                 )
                 if text:
+                    if debug_mode:
+                        accumulated_response += text
                     self.write(f"data: {json.dumps({'text': text})}\n\n")
                     self.flush()
 
+            if debug_mode and answer_file:
+                try:
+                    with answer_file.open("w", encoding="utf-8") as f:
+                        f.write(accumulated_response)
+                        f.write("\n")
+                except Exception as e:
+                    self.log.error(f"Failed to write tutor debug answer: {e}")
+
         except StreamClosedError:
+            if debug_mode and answer_file and accumulated_response:
+                try:
+                    with answer_file.open("w", encoding="utf-8") as f:
+                        f.write(accumulated_response)
+                        f.write("\n")
+                except Exception as e:
+                    pass
             return  # Client disconnected; stop streaming
         except Exception as e:
             self.log.exception("Error during tutor LLM call")