add some additional logging

Author: cs01

README.md

@@ -38,12 +38,16 @@ If you have [nox](https://github.com/theacodes/nox) you can run the following.
 ```
 > nox -s run
 ```
-Nox takes care of setting up a virtual environment and running the right command for you.
+Nox takes care of setting up a virtual environment and running the right command for you. You can pass arguments to the server like this
+```
+> nox -s run -- --debug
+```
 
 If you don't have nox, you can run the following from inside a virtual environment.
 ```
 > pip install -r requirements.txt
 > python -m pyxtermjs
+> python -m pyxtermjs --debug
 ```
 
 ### Install

pyxtermjs/app.py

@@ -11,6 +11,7 @@
 import fcntl
 import shlex
 import logging
+import sys
 
 logging.getLogger("werkzeug").setLevel(logging.ERROR)
 
@@ -20,10 +21,11 @@
 app.config["SECRET_KEY"] = "secret!"
 app.config["fd"] = None
 app.config["child_pid"] = None
-socketio = SocketIO(app, logger=False, engineio_logger=False)
+socketio = SocketIO(app)
 
 
 def set_winsize(fd, row, col, xpix=0, ypix=0):
+    logging.debug("setting window size with termios")
     winsize = struct.pack("HHHH", row, col, xpix, ypix)
     fcntl.ioctl(fd, termios.TIOCSWINSZ, winsize)
 
@@ -51,20 +53,21 @@ def pty_input(data):
     terminal.
     """
     if app.config["fd"]:
-        # print("writing to pty: %s" % data["input"])
+        logging.debug("received input from browser: %s" % data["input"])
         os.write(app.config["fd"], data["input"].encode())
 
 
 @socketio.on("resize", namespace="/pty")
 def resize(data):
     if app.config["fd"]:
+        logging.debug(f"Resizing window to {data['rows']}x{data['cols']}")
         set_winsize(app.config["fd"], data["rows"], data["cols"])
 
 
 @socketio.on("connect", namespace="/pty")
 def connect():
     """new client connected"""
-
+    logging.info("new client connected")
     if app.config["child_pid"]:
         # already started child process, don't start another
         return
@@ -83,13 +86,13 @@ def connect():
         app.config["child_pid"] = child_pid
         set_winsize(fd, 50, 50)
         cmd = " ".join(shlex.quote(c) for c in app.config["cmd"])
-        print("child pid is", child_pid)
-        print(
+        logging.info("child pid is " + child_pid)
+        logging.info(
             f"starting background task with command `{cmd}` to continously read "
             "and forward pty output to client"
         )
         socketio.start_background_task(target=read_and_forward_pty_output)
-        print("task started")
+        logging.info("task started")
 
 
 def main():
@@ -120,8 +123,16 @@ def main():
     if args.version:
         print(__version__)
         exit(0)
-    print(f"serving on http://127.0.0.1:{args.port}")
     app.config["cmd"] = [args.command] + shlex.split(args.cmd_args)
+    green = "\033[92m"
+    end = "\033[0m"
+    log_format = green + "pyxtermjs > " + end + "%(levelname)s (%(funcName)s:%(lineno)s) %(message)s"
+    logging.basicConfig(
+        format=log_format,
+        stream=sys.stdout,
+        level=logging.DEBUG if args.debug else logging.INFO,
+    )
+    logging.info(f"serving on http://127.0.0.1:{args.port}")
     socketio.run(app, debug=args.debug, port=args.port, host=args.host)
 
 

pyxtermjs/index.html

@@ -53,15 +53,15 @@
       term.writeln("Welcome to pyxterm.js!");
       term.writeln("https://github.com/cs01/pyxterm.js");
       term.onData((data) => {
-        console.log("new input data", data);
+        console.log("key pressed in browser:", data);
         socket.emit("pty-input", { input: data });
       });
 
       const socket = io.connect("/pty");
       const status = document.getElementById("status");
 
       socket.on("pty-output", function (data) {
-        console.log("new output received from server", data);
+        console.log("new output received from server:", data.output);
         term.write(data.output);
       });