bugfix(appimage): use standard tmp path resolution functions on non-macOS systems

Author: Madman10K

src/backend-manager/src/paths.rs

@@ -9,13 +9,9 @@ pub struct Paths {
 impl Default for Paths {
     fn default() -> Self {
         let tmpdir: PathBuf = if cfg!(target_os = "macos") {
-            PathBuf::from(env::var("HOME").unwrap_or("/".to_string()))
-                .join("Library/Caches/com.codetracer.CodeTracer/")
+            PathBuf::from(env::var("HOME").unwrap_or("/".to_string())).join("Library/Caches/com.codetracer.CodeTracer/")
         } else {
-            PathBuf::from(env::var("TMPDIR").unwrap_or(env::var("TEMPDIR").unwrap_or(
-                env::var("TMP").unwrap_or(env::var("TEMP").unwrap_or("/tmp".to_string())),
-            )))
-            .join("codetracer/")
+            env::temp_dir().join("codetracer/")
         };
         Self {
             tmp_path: PathBuf::from(&tmpdir),

src/ct/stylus/arb_node_utils.nim

@@ -1,11 +1,12 @@
 import std/[httpclient, json, net, strutils, parseutils, times, sets, os]
-import ../../common/[types]
+import ../../common/[types, paths]
 
 const DEFAULT_NODE_URL* = "http://localhost:8547"
 
 # TODO: get name from config? Maybe use SQLite?
-let CONTRACT_WASM_PATH* = getHomeDir() / ".local" / "share" / "codetracer" / "contract-debug-wasm"
-let EVM_TRACE_DIR_PATH* = getTempDir() / "codetracer"
+let 
+  CONTRACT_WASM_PATH* = getHomeDir() / ".local" / "share" / "codetracer" / "contract-debug-wasm"
+  EVM_TRACE_DIR_PATH* = codetracerTmpPath
 
 proc jsonRpcRequest(methodParam: string, params: JsonNode): JsonNode {.raises: [IOError, ValueError].} =
   # TODO: add random/uniqie stuff to id

src/ct/utilities/zip_test.nim

@@ -1,12 +1,13 @@
-import std/[unittest, os, strutils, streams]
-import ../utilities/zip
+import 
+  std/[unittest, os, strutils, streams]
+  ../utilities/zip
+  ../../common/paths
 
 suite "zipFolder / unzipIntoFolder":
   test "zip and unzip with progress":
-    let tmp = getTempDir()
-    let inputDir = tmp / "zip_test_input"
-    let outputDir = tmp / "zip_test_output"
-    let unzipDir = tmp / "zip_test_unzipped"
+    let inputDir = codetracerTmpPath / "zip_test_input"
+    let outputDir = codetracerTmpPath / "zip_test_output"
+    let unzipDir = codetracerTmpPath / "zip_test_unzipped"
     createDir(inputDir)
 
     let testFile = inputDir / "test.txt"

src/db-backend/src/paths.rs

@@ -13,13 +13,7 @@ impl Default for Paths {
         let tmpdir: PathBuf = if cfg!(target_os = "macos") {
             PathBuf::from(env::var("HOME").unwrap_or("/".to_string())).join("Library/Caches/com.codetracer.CodeTracer/")
         } else {
-            PathBuf::from(
-                env::var("TMPDIR").unwrap_or(
-                    env::var("TEMPDIR")
-                        .unwrap_or(env::var("TMP").unwrap_or(env::var("TEMP").unwrap_or("/tmp".to_string()))),
-                ),
-            )
-            .join("codetracer/")
+            env::temp_dir().join("codetracer/")
         };
         Self {
             tmp_path: PathBuf::from(&tmpdir),

src/frontend/index.nim

@@ -1,15 +1,36 @@
 import
   std/jsffi,
   lib,
-  index/[ args, ipc_utils, electron_vars, server_config, config ]
+  index/[ args, ipc_utils, electron_vars, server_config, config, window ]
 
 data.start = now()
 parseArgs()
 
 when not defined(server):
   electron_vars.app.on("window-all-closed") do ():
+    stopBackendManager()
     electron_vars.app.quit(0)
 
+  electron_vars.app.on("before-quit") do ():
+    stopBackendManager()
+
+  # Ensure signal-driven exits also terminate the backend-manager.
+  nodeProcess.on(cstring"SIGINT") do ():
+    stopBackendManager()
+    electron_vars.app.quit(0)
+
+  nodeProcess.on(cstring"SIGTERM") do ():
+    stopBackendManager()
+    electron_vars.app.quit(0)
+
+  nodeProcess.on(cstring"SIGHUP") do ():
+    stopBackendManager()
+    electron_vars.app.quit(0)
+
+  # As a last resort, cleanup on process exit as well.
+  nodeProcess.on(cstring"exit") do (code: int):
+    stopBackendManager()
+
   electron_vars.app.on("ready") do ():
     electron_vars.app.js.setName "CodeTracer"
     electron_vars.app.js.setAppUserModelId "com.codetracer.CodeTracer"

src/frontend/index/traces.nim

@@ -105,7 +105,7 @@ proc prepareForLoadingTrace*(traceId: int, pid: int) {.async.} =
   let packet = wrapJsonForSending js{
     "type": cstring"request",
     "command": cstring"ct/start-replay",
-    "arguments": [cstring"db-backend"]
+    "arguments": [cstring(dbBackendExe)]
   }
   backendManagerSocket.write(packet)
 
@@ -207,4 +207,4 @@ proc onNewRecord*(sender: js, response: jsobject(args=seq[cstring], options=JsOb
     let errorSpecificText = if not processResult.error.isNil: cast[cstring](processResult.error.code) else: cstring""
     let errorText = cstring"record start process error: " & errorSpecificText
     mainWindow.webContents.send "CODETRACER::failed-record",
-      js{errorMessage: errorText}
+      js{errorMessage: errorText}

src/frontend/index/window.nim

@@ -7,6 +7,17 @@ import
 var
   close = false
   backendManagerProcess*: NodeSubProcess = nil
+  backendManagerCleanedUp = false
+
+
+proc stopBackendManager* =
+  # Ensure we only attempt cleanup once and guard against nil.
+  if backendManagerCleanedUp:
+    return
+  backendManagerCleanedUp = true
+  if not backendManagerProcess.isNil:
+    backendManagerProcess.stopProcess()
+    backendManagerProcess = nil
 
 proc duration*(name: string) =
   infoPrint fmt"index: TIME for {name}: {now() - data.start}ms"
@@ -68,8 +79,7 @@ proc createMainWindow*: js =
 
 
 proc onCloseApp*(sender: js, response: js) {.async.} =
-  if not backendManagerProcess.isNil:
-    backendManagerProcess.stopProcess()
+  stopBackendManager()
   mainWindow.close()
 
 proc onRestart*(sender: js, response: js) {.async.} =

src/frontend/vscode.nim

@@ -88,8 +88,6 @@ when defined(ctInExtension):
     newMediatorWithSubscribers(name, isRemote=true, singleSubscriber=false, transport=transport)
 
   when defined(ctInCentralExtensionContext):
-    # let EVM_TRACE_DIR_PATH* = getTempDir() / "codetracer"
-
     proc parseCTJson(raw: cstring): js =
       let rawString = $raw
       let idx = rawString.find(".AppImage installed")