Clean: word wrap.

Author: bjones1

client/src/CodeChatEditor.mts

@@ -222,8 +222,8 @@ export const on_dom_content_loaded = (on_load_func: () => void) => {
 //
 // True if this is a CodeChat Editor document (not a source file).
 const is_doc_only = () => {
-    // This might be called by the framework before a document is loaded.
-    // So, make sure `current_metadata` exists first.
+    // This might be called by the framework before a document is loaded. So,
+    // make sure `current_metadata` exists first.
     return current_metadata?.["mode"] === "markdown";
 };
 
@@ -372,8 +372,8 @@ const save_lp = (is_dirty: boolean) => {
                 "CodeChat-body",
             ) as HTMLDivElement;
             mathJaxUnTypeset(codechat_body);
-            // To save a document only, simply get the HTML from the only Tiny MCE
-            // div.
+            // To save a document only, simply get the HTML from the only Tiny
+            // MCE div.
             tinymce.activeEditor!.save();
             const html = tinymce.activeEditor!.getContent();
             (
@@ -556,8 +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.
+// 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.

client/src/CodeChatEditorFramework.mts

@@ -89,7 +89,10 @@ class WebSocketComm {
     // the `Update` may be applied immediately.
     is_loading = false;
 
-    // A promise to serialize calls to `set_content`.
+    // A promise to serialize calls to and from the Client. This is important: a
+    // `CurrentFile` requires the Client to save, then switch to a new web page.
+    // If an `Update` comes in, it should be applied after the `CurrentFile` is
+    // finished executing.
     promise = Promise.resolve();
 
     constructor(ws_url: string) {
@@ -138,7 +141,8 @@ class WebSocketComm {
                 case "Update":
                     // Load this data in.
                     const current_update = value as UpdateMessageContents;
-                    // The rest of this should run after all other messages have been processed.
+                    // The rest of this should run after all other messages have
+                    // been processed.
                     this.promise = this.promise.finally(async () => {
                         // Check or update the `current_filename`.
                         if (this.current_filename === undefined) {
@@ -154,19 +158,24 @@ class WebSocketComm {
                         const contents = current_update.contents;
                         const cursor_position = current_update.cursor_position;
                         if (contents !== undefined) {
-                            // I'd prefer to use a system-maintained value to determine the ready state of the iframe,
-                            // such as `readyState`. However, this value only applies to the initial load of the iframe;
-                            // it doesn't change when the iframe's `src` attribute is changed. So, we have to track
-                            // this manually instead.
+                            // I'd prefer to use a system-maintained value to
+                            // determine the ready state of the iframe, such as
+                            // `readyState`. However, this value only applies to
+                            // the initial load of the iframe; it doesn't change
+                            // when the iframe's `src` attribute is changed. So,
+                            // we have to track this manually instead.
                             if (!this.is_loading) {
-                                // Wait until after the DOM is ready, since we rely on content set in `on_dom_content_loaded` in the Client.
+                                // Wait until after the DOM is ready, since we
+                                // rely on content set in
+                                // `on_dom_content_loaded` in the Client.
                                 await set_content(
                                     contents,
                                     current_update.cursor_position,
                                 );
                             } else {
-                                // If the page is still loading, wait until the load
-                                // completes before updating the editable contents.
+                                // If the page is still loading, wait until the
+                                // load completes before updating the editable
+                                // contents.
                                 //
                                 // Construct the promise to use; this causes the
                                 // `onload` callback to be set immediately.
@@ -184,8 +193,8 @@ class WebSocketComm {
                             }
                         } else if (cursor_position !== undefined) {
                             // We might receive a message while the Client is
-                            // reloading; during this period, `scroll_to_line` isn't
-                            // defined.
+                            // reloading; during this period, `scroll_to_line`
+                            // isn't defined.
                             root_iframe!.contentWindow?.CodeChatEditor?.scroll_to_line?.(
                                 cursor_position,
                             );
@@ -206,15 +215,16 @@ class WebSocketComm {
                             ? "?test"
                             : "&test"
                         : "";
-                    // Execute this after all other messages have been processed.
+                    // Execute this after all other messages have been
+                    // processed.
                     this.promise = this.promise.finally(async () => {
-                        // If the page is still loading, then don't save. Otherwise,
-                        // save the editor contents if necessary.
+                        // If the page is still loading, then don't save.
+                        // Otherwise, save the editor contents if necessary.
                         const cce = get_client();
                         await cce?.on_save(true);
-                        // Now, it's safe to load a new file.
-                        // Tell the client to allow this navigation -- the
-                        // document it contains has already been saved.
+                        // Now, it's safe to load a new file. Tell the client to
+                        // allow this navigation -- the document it contains has
+                        // already been saved.
                         if (cce !== undefined) {
                             cce.allow_navigation = true;
                         }
@@ -313,7 +323,8 @@ class WebSocketComm {
     current_file = (url: URL) => {
         this.promise = this.promise.finally(() => {
             if (url.host === window.location.host) {
-                // If this points to the Server, then tell the IDE to load a new file.
+                // If this points to the Server, then tell the IDE to load a new
+                // file.
                 this.send_message(
                     { CurrentFile: [url.toString(), null] },
                     () => {

client/src/assert.mts

@@ -1,7 +1,11 @@
 // `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 is 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).
 export function assert(condition: any, msg?: string): asserts condition {

docs/changelog.md

@@ -22,8 +22,10 @@ Changelog
 [Github master](https://github.com/bjones1/CodeChat_Editor)
 -----------------------------------------------------------
 
-*   Fix and improve test framework.
+*   Correct ordering of messages sent to and from the Framework to the Client.
+*   Fix and improve test framework and error reporting.
 *   Improve MathJax bundling.
+*   Update PDF viewer.
 
 Version 0.1.29 -- 2025-23-Aug
 -----------------------------

server/src/webserver.rs

@@ -341,8 +341,8 @@ macro_rules! queue_send {
 
 /// Globals
 /// -------
-// The timeout for a reply from a websocket, in ms. Use a short timeout to speed up
-// unit tests.
+// The timeout for a reply from a websocket, in ms. Use a short timeout to speed
+// up unit tests.
 const REPLY_TIMEOUT_MS: Duration = if cfg!(test) {
     Duration::from_millis(500)
 } else {
@@ -353,7 +353,8 @@ const REPLY_TIMEOUT_MS: Duration = if cfg!(test) {
 /// this server.
 const WEBSOCKET_PING_DELAY: Duration = Duration::from_secs(2);
 
-/// A message ID which won't be used by anything but a `Result` produced by an error not produced in response to a message.
+/// A message ID which won't be used by anything but a `Result` produced by an
+/// error not produced in response to a message.
 pub const RESERVED_MESSAGE_ID: f64 = if cfg!(test) {
     // A simpler value when testing.
     0.0
@@ -392,7 +393,8 @@ const MATHJAX_TAGS: &str = concatdoc!(
     r#"
     <script>
         MathJax = {"#,
-    // See the [docs](https://docs.mathjax.org/en/latest/options/output/chtml.html#option-descriptions).
+    // See the
+    // [docs](https://docs.mathjax.org/en/latest/options/output/chtml.html#option-descriptions).
     r#"
             chtml: {
                 fontURL: "/static/mathjax-newcm-font/chtml/woff2",
@@ -402,7 +404,9 @@ const MATHJAX_TAGS: &str = concatdoc!(
             },
         };
     </script>"#,
-    // Per the [MathJax docs](https://docs.mathjax.org/en/latest/web/components/combined.html#tex-chtml), enable tex input and HTML output.
+    // Per the [MathJax
+    // docs](https://docs.mathjax.org/en/latest/web/components/combined.html#tex-chtml),
+    // enable tex input and HTML output.
     r#"
     <script defer src="/static/mathjax/tex-chtml.js"></script>"#
 );