Fix: better error reporting

     Add units to variable names.

Author: bjones1

client/src/CodeChatEditor.mts

@@ -187,6 +187,9 @@ export const page_init = () => {
             on_navigate,
         );
         document.addEventListener("click", on_click);
+        // Provide basic error reporting for uncaught errors. However, enabling either of these makes the Client not work. ???
+        //window.addEventListener("unhandledrejection", on_error);
+        //window.addEventListener("error", on_error);
 
         window.CodeChatEditor = {
             open_lp,
@@ -204,7 +207,7 @@ export const set_is_dirty = (value: boolean = true) => {
 
 // This is copied
 // from[MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document/DOMContentLoaded_event#checking_whether_loading_is_already_complete).
-const on_dom_content_loaded = (on_load_func: () => void) => {
+export const on_dom_content_loaded = (on_load_func: () => void) => {
     if (document.readyState === "loading") {
         // Loading hasn't finished yet.
         document.addEventListener("DOMContentLoaded", on_load_func);
@@ -553,6 +556,8 @@ const save_then_navigate = (codeChatEditorUrl: URL) => {
     });
 };
 
+// This can be called by the framework. Therefore, make no assumptions
+// about variables being valid; it be called before a file is loaded, etc.
 const scroll_to_line = (line: number) => {
     if (is_doc_only()) {
         // TODO.
@@ -567,6 +572,19 @@ export const console_log = (...args: any) => {
     }
 };
 
+// A global error handler: this is called on any uncaught exception.
+export const on_error = (event: Event) => {
+    let err_str: string;
+    if (event instanceof ErrorEvent) {
+        err_str = `${event.filename}:${event.lineno}: ${event.message}`;
+    } else if (event instanceof PromiseRejectionEvent) {
+        err_str = `${event.promise} rejected: ${event.reason}`;
+    } else {
+        err_str = `Unexpected error ${typeof(event)}: ${event}`
+    }
+    show_toast(`Error: ${err_str}`);
+};
+
 // Testing
 // -------
 //

client/src/CodeChatEditorFramework.mts

@@ -41,7 +41,11 @@ import {
     MessageResult,
     UpdateMessageContents,
 } from "./shared_types.mjs";
-import { console_log } from "./CodeChatEditor.mjs";
+import {
+    console_log,
+    on_error,
+    on_dom_content_loaded,
+} from "./CodeChatEditor.mjs";
 
 // Websocket
 // ---------
@@ -51,8 +55,8 @@ import { console_log } from "./CodeChatEditor.mjs";
 //
 // The max length of a message to show in the console.
 const MAX_MESSAGE_LENGTH = 200;
-// The timeout for a websocket `Response`.
-const RESPONSE_TIMEOUT = 15000;
+// The timeout for a websocket `Response`, in ms.
+const RESPONSE_TIMEOUT_MS = 1500000;
 
 // An instance of the websocket communication class.
 let webSocketComm: WebSocketComm;
@@ -141,10 +145,10 @@ class WebSocketComm {
                     const cursor_position = current_update.cursor_position;
                     if (contents !== undefined) {
                         if (
-                            root_iframe!.contentDocument?.readyState !==
-                            "loading"
+                            root_iframe!.contentDocument?.readyState ===
+                            "complete"
                         ) {
-                            // The page is ready; load in the provided content.
+                            // Wait until after the DOM is ready, since we rely on content set in `on_dom_content_loaded` in the Client.
                             this.promise = this.promise.finally(
                                 async () =>
                                     await set_content(
@@ -293,7 +297,7 @@ class WebSocketComm {
         this.pending_messages[id] = {
             timer_id: window.setTimeout(
                 this.report_server_timeout,
-                RESPONSE_TIMEOUT,
+                RESPONSE_TIMEOUT_MS,
                 id,
             ),
             callback,
@@ -384,6 +388,10 @@ export const page_init = (
 ) => {
     testMode = testMode_;
     on_dom_content_loaded(() => {
+        // Provide basic error reporting for uncaught errors.
+        window.addEventListener("unhandledrejection", on_error);
+        window.addEventListener("error", on_error);
+
         // If the hosting page uses HTTPS, then use a secure websocket (WSS
         // protocol); otherwise, use an insecure websocket (WS).
         const protocol = window.location.protocol === "http:" ? "ws:" : "wss:";
@@ -400,18 +408,6 @@ export const page_init = (
     });
 };
 
-// This is copied from
-// [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document/DOMContentLoaded_event#checking_whether_loading_is_already_complete).
-const on_dom_content_loaded = (on_load_func: () => void) => {
-    if (document.readyState === "loading") {
-        // Loading hasn't finished yet.
-        document.addEventListener("DOMContentLoaded", on_load_func);
-    } else {
-        // `DOMContentLoaded` has already fired.
-        on_load_func();
-    }
-};
-
 // Tell TypeScript about the global namespace this program defines.
 declare global {
     interface Window {

client/src/assert.mts

@@ -1,6 +1,6 @@
 // `assert.mts`
 // ============
-// Provide a simple `assert` function to check conditions at runtime. Using things like [assert](https://nodejs.org/api/assert.html) causes problems -- somehow, this indicates that the code in running in a development environment (see [this](https://github.com/micromark/micromark/issues/87#issuecomment-908924233)).
+// Provide a simple `assert` function to check conditions at runtime. Using things like [assert](https://nodejs.org/api/assert.html) causes problems -- somehow, this indicates that the code is running in a development environment (see [this](https://github.com/micromark/micromark/issues/87#issuecomment-908924233)).
 //
 // Taken from the TypeScript
 // [docs](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#assertion-functions).

extensions/VSCode/src/extension.ts

@@ -49,8 +49,8 @@ enum CodeChatEditorClientLocation {
 }
 // The max length of a message to show in the console.
 const MAX_MESSAGE_LENGTH = 200;
-// The timeout for a websocket `Response`.
-const RESPONSE_TIMEOUT = 15000;
+// The timeout for a websocket `Response`, in ms.
+const RESPONSE_TIMEOUT_MS = 1500000;
 // True to enable additional debug logging.
 const DEBUG_ENABLED = false;
 
@@ -622,7 +622,7 @@ const send_message = (
     );
     websocket.send(JSON.stringify(jm));
     pending_messages[id] = {
-        timer_id: setTimeout(report_server_timeout, RESPONSE_TIMEOUT, id),
+        timer_id: setTimeout(report_server_timeout, RESPONSE_TIMEOUT_MS, id),
         callback,
     };
 };

server/src/webserver.rs

@@ -341,9 +341,9 @@ macro_rules! queue_send {
 
 /// Globals
 /// -------
-// The timeout for a reply from a websocket. Use a short timeout to speed up
+// The timeout for a reply from a websocket, in ms. Use a short timeout to speed up
 // unit tests.
-const REPLY_TIMEOUT: Duration = if cfg!(test) {
+const REPLY_TIMEOUT_MS: Duration = if cfg!(test) {
     Duration::from_millis(500)
 } else {
     Duration::from_millis(15000)
@@ -1246,7 +1246,7 @@ pub async fn client_websocket(
                         _ => {
                             let timeout_tx = from_websocket_tx.clone();
                             let waiting_task = actix_rt::spawn(async move {
-                                sleep(REPLY_TIMEOUT).await;
+                                sleep(REPLY_TIMEOUT_MS).await;
                                 let msg = format!("Timeout: message id {} unacknowledged.", m.id);
                                 error!("{msg}");
                                 // Since the websocket failed to send a