Merge pull request #8333 from sagemathinc/fix-latex-long-compile-8332

frontend/latex: fix #8332 by fixing checking for the NATS error message

Author: williamstein

src/packages/frontend/cspell.json

@@ -7,55 +7,58 @@
     "CoCalc",
     "dplyr",
     "ggplot",
+    "ipython",
     "ipywidgets",
     "katex",
+    "knitr",
     "kucalc",
     "mathjax",
     "matplotlib",
+    "Miniterm",
     "nbconvert",
     "nbgrader",
     "nbviewer",
     "Ollama",
     "onprem",
     "plotly",
+    "rclass",
     "rereturn",
     "respawns",
     "Rmarkdown",
+    "rtypes",
     "Sagemath",
     "sagews",
     "scikit",
     "statsmodels",
     "syncdb",
+    "syncdoc",
     "syncstring",
     "tidyverse",
     "timetravel",
+    "tolerations",
     "undelete",
     "undeleting",
-    "tolerations",
-    "rtypes",
-    "rclass",
-    "ipython",
-    "Miniterm"
+    "sagetex"
   ],
   "ignoreWords": [
-    "LLMs",
-    "LLM",
     "antd",
+    "immutablejs",
     "ipynb",
+    "isdir",
     "kernelspec",
+    "LLM",
+    "LLMs",
+    "MDLG",
     "medkit",
     "mesg",
+    "mintime",
     "mistralai",
     "Popconfirm",
+    "PoweroffOutlined",
+    "reuseinflight",
     "vertexai",
     "vfill",
-    "xsmall",
-    "MDLG",
-    "isdir",
-    "mintime",
-    "PoweroffOutlined",
-    "immutablejs",
-    "reuseinflight"
+    "xsmall"
   ],
   "flagWords": [],
   "ignorePaths": ["node_modules/**", "dist/**", "dist-ts/**", "build/**"],

src/packages/frontend/frame-editors/code-editor/actions.ts

@@ -35,10 +35,16 @@ import {
   redux,
 } from "@cocalc/frontend/app-framework";
 import type { PageActions } from "@cocalc/frontend/app/actions";
+import { VideoChat } from "@cocalc/frontend/chat/video/video-chat";
 import { syncAllComputeServers } from "@cocalc/frontend/compute/sync-all";
 import { get_buffer, set_buffer } from "@cocalc/frontend/copy-paste-buffer";
 import { filenameMode } from "@cocalc/frontend/file-associations";
+import {
+  chat,
+  getSideChatActions,
+} from "@cocalc/frontend/frame-editors/generic/chat";
 import { open_new_tab } from "@cocalc/frontend/misc";
+import type { FragmentId } from "@cocalc/frontend/misc/fragment-id";
 import Fragment from "@cocalc/frontend/misc/fragment-id";
 import {
   delete_local_storage,
@@ -59,7 +65,7 @@ import {
   syntax2tool,
 } from "@cocalc/util/code-formatter";
 import {
-  TIMEOUT_CALLING_PROJECT,
+  IS_TIMEOUT_CALLING_PROJECT,
   TIMEOUT_CALLING_PROJECT_MSG,
 } from "@cocalc/util/consts/project";
 import {
@@ -103,12 +109,6 @@ import * as cm_doc_cache from "./doc";
 import { SHELLS } from "./editor";
 import { test_line } from "./simulate_typing";
 import { misspelled_words } from "./spell-check";
-import { VideoChat } from "@cocalc/frontend/chat/video/video-chat";
-import type { FragmentId } from "@cocalc/frontend/misc/fragment-id";
-import {
-  chat,
-  getSideChatActions,
-} from "@cocalc/frontend/frame-editors/generic/chat";
 
 interface gutterMarkerParams {
   line: number;
@@ -388,7 +388,7 @@ export class Actions<
     });
 
     this._syncstring.on("save-to-disk", () => {
-      // incremenet save_to_disk counter, so that react components can
+      // increment save_to_disk counter, so that react components can
       // react to save_to_disk event happening.
       this.set_reload("save_to_disk");
     });
@@ -1134,7 +1134,7 @@ export class Actions<
     // need to check since this can get called by the close.
     if (!this._syncstring) return;
     // TODO: for now, just for the one syncstring obviously
-    // TOOD: this is probably naive and slow too...
+    // TOO: this is probably naive and slow too...
     let cursors: Map<string, List<Map<string, any>>> = Map();
     this._syncstring
       .get_cursors({
@@ -1157,7 +1157,7 @@ export class Actions<
   }
 
   // Set the location of all of OUR cursors.  This serves many purposes:
-  //  -- propogate to other users via the syncstring.
+  //  -- propagate to other users via the syncstring.
   //  -- setting uri fragment page= at top of browser, so URL link is useful
   //  -- don't delete trailing whitespace in lines with cursors
   set_cursor_locs(locs: any[]): void {
@@ -1765,7 +1765,7 @@ export class Actions<
       return;
     }
 
-    // This implentation of goto_line only supports integer line numbers.
+    // This implementation of goto_line only supports integer line numbers.
     // However, derived classes may support id's or other types of more general "lines".
     try {
       if (typeof line == "string") {
@@ -1912,7 +1912,7 @@ export class Actions<
         if (typeof e != "string") throw Error("bug"); // make typescript happy
         error = e;
       }
-      if (error === TIMEOUT_CALLING_PROJECT) {
+      if (IS_TIMEOUT_CALLING_PROJECT(error)) {
         error = TIMEOUT_CALLING_PROJECT_MSG;
       }
       this.setState({ error });
@@ -2100,7 +2100,7 @@ export class Actions<
     const before = gutter_markers;
     gutter_markers.map((info, id) => {
       if (info !== undefined && info.get("gutter_id") === gutter_id && id) {
-        /* && id is to satify typescript */
+        /* && id is to satisfy typescript */
         gutter_markers = gutter_markers.delete(id);
       }
     });
@@ -2622,7 +2622,7 @@ export class Actions<
     if (type == "terminal") {
       this.clear_terminal_command(id);
       if (node.get("command") == "jupyter") {
-        // not reseting jupyter
+        // not resetting jupyter
         return;
       }
       // we also wait until it is "back again with a prompt"

src/packages/frontend/frame-editors/latex-editor/actions.ts

@@ -197,7 +197,7 @@ export class Actions extends BaseActions<LatexEditorState> {
 
   private init_ext_path(): void {
     if (this.knitr) {
-      // changing the path to the (to be generated) tex file makes everyting else
+      // changing the path to the (to be generated) tex file makes everything else
       // here compatible with the latex commands
       this.path = change_filename_extension(this.path, "tex");
       this.setState({ knitr: this.knitr, knitr_error: false });
@@ -225,7 +225,7 @@ export class Actions extends BaseActions<LatexEditorState> {
         ) {
           this._last_syncstring_hash = hash;
           // there are two cases: the parent "master" file triggers the build (usual case)
-          // or an included depdenency – i.e. where parent_file is set
+          // or an included dependency – i.e. where parent_file is set
           if (this.parent_file != null && this.parent_file != this.path) {
             const parent_actions = this.redux.getEditorActions(
               this.project_id,
@@ -672,7 +672,7 @@ export class Actions extends BaseActions<LatexEditorState> {
       // kicks off a save of all relevant files
       // Obviously, do not make this save_all(true), because
       // that would end up calling this very function again
-      // crashing the browser in an INFINITE RECURSSION
+      // crashing the browser in an INFINITE RECURSION
       // (this was a bug for a while!).
       // Also, the save of the related files is NOT
       // explicit -- the user is only explicitly saving this

src/packages/frontend/frame-editors/latex-editor/knitr.ts

@@ -42,7 +42,7 @@ export async function knitr(
     project_id,
     command: R_CMD,
     args: [...R_ARGS, expr],
-    rundir: directory,
+    runDir: directory,
     aggregate: time ? { value: time } : undefined,
     set_job_info,
     path,

src/packages/frontend/frame-editors/latex-editor/latexmk.ts

@@ -40,7 +40,7 @@ export async function latexmk(
     project_id,
     command,
     args,
-    rundir: head,
+    runDir: head,
     aggregate: time,
     set_job_info,
     path,

src/packages/frontend/frame-editors/latex-editor/pythontex.ts

@@ -46,7 +46,7 @@ export async function pythontex(
     project_id,
     aggregate,
     command,
-    rundir: output_directory || directory,
+    runDir: output_directory || directory,
     set_job_info,
     // for python plots -- https://github.com/sagemathinc/cocalc/issues/4203
     env: { MPLBACKEND: "Agg" },

src/packages/frontend/frame-editors/latex-editor/sagetex.ts

@@ -65,7 +65,7 @@ export async function sagetex(
     command: "sage",
     args: [s],
     set_job_info,
-    rundir: output_directory || directory,
+    runDir: output_directory || directory,
     aggregate: hash ? { value: hash } : undefined,
     path,
   });

src/packages/frontend/frame-editors/latex-editor/util.ts

@@ -10,11 +10,10 @@ import {
   ExecOpts,
   ExecOutput,
 } from "@cocalc/frontend/frame-editors/generic/client";
+import { IS_TIMEOUT_CALLING_PROJECT } from "@cocalc/util/consts/project";
+import { ExecOptsBlocking } from "@cocalc/util/db-schema/projects";
 import { separate_file_extension } from "@cocalc/util/misc";
 import { ExecuteCodeOutputAsync } from "@cocalc/util/types/execute-code";
-// import { TIMEOUT_CALLING_PROJECT } from "@cocalc/util/consts/project";
-import { TIMEOUT_CALLING_PROJECT } from "@cocalc/util/consts/project";
-import { ExecOptsBlocking } from "@cocalc/util/db-schema/projects";
 import { TIMEOUT_LATEX_JOB_S } from "./constants";
 
 export function pdf_path(path: string): string {
@@ -112,7 +111,7 @@ interface RunJobOpts {
   command: string;
   env?: { [key: string]: string };
   project_id: string;
-  rundir: string; // a directory! (output_directory if in /tmp, or the directory of the file's path)
+  runDir: string; // a directory! (output_directory if in /tmp, or the directory of the file's path)
   set_job_info: (info: ExecuteCodeOutputAsync) => void;
   timeout?: number;
   path: string;
@@ -125,7 +124,7 @@ export async function runJob(opts: RunJobOpts): Promise<ExecOutput> {
     command,
     env,
     project_id,
-    rundir,
+    runDir,
     set_job_info,
     path,
   } = opts;
@@ -140,7 +139,7 @@ export async function runJob(opts: RunJobOpts): Promise<ExecOutput> {
     command,
     env,
     err_on_exit: false,
-    path: rundir,
+    path: runDir,
     project_id,
     timeout: TIMEOUT_LATEX_JOB_S,
   };
@@ -177,12 +176,12 @@ export async function runJob(opts: RunJobOpts): Promise<ExecOutput> {
       set_job_info(output);
       return output;
     } catch (err) {
-      if (err === TIMEOUT_CALLING_PROJECT) {
+      if (IS_TIMEOUT_CALLING_PROJECT(err)) {
         // This will eventually be fine, hopefully. We continue trying to get a reply.
         await new Promise((done) => setTimeout(done, 100));
       } else {
         throw new Error(
-          "Unable to complete compilation. Check the project and try again...",
+          "Unable to run the compilation. Please check up on the project.",
         );
       }
     }

src/packages/util/consts/project.ts

@@ -6,5 +6,22 @@ export const DOC_CLOUD_STORAGE_URL =
 export const PROJECT_EXEC_DEFAULT_TIMEOUT_S = 60;
 
 export const TIMEOUT_CALLING_PROJECT = "timeout";
+
+const NATS_TIMEOUT_MSG = "NatsError: TIMEOUT";
+
 export const TIMEOUT_CALLING_PROJECT_MSG =
   "Timeout communicating with project.";
+
+export const IS_TIMEOUT_CALLING_PROJECT = (err) => {
+  if (err === TIMEOUT_CALLING_PROJECT || err === NATS_TIMEOUT_MSG) {
+    return true;
+  }
+
+  if (
+    typeof err?.toString === "function" &&
+    err?.toString() === NATS_TIMEOUT_MSG
+  ) {
+    return true;
+  }
+  return false;
+};