Use rust side logging (#36)

- [x] Save logs to expected places on all platforms - [x] Forward logs to VSCode Output Pane
tektronix · Jul 26, 2024 · 8dc7a1b · 8dc7a1b
1 parent 39517c3
commit 8dc7a1b
Show file tree

Hide file tree

Showing 10 changed files with 523 additions and 18 deletions.
diff --git a/.eslintrc.yml b/.eslintrc.yml
@@ -40,8 +40,9 @@ settings:
 rules:
   # eslint
   indent:
-    - error
+    - "error"
     - 4
+    - SwitchCase: 1
   linebreak-style:
     - error
     - unix

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,11 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
     Security -- in case of vulnerabilities.
 -->
 
+## [0.17.0]
+
+### Added
+- Add logging for terminal and discover
+
 ## [0.16.4]
 
 ### Changed
@@ -123,7 +128,8 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 - Feature to retrieve TSP-Link network details
 
 <!-- Version Comparison Links -->
-[Unreleased]: https://github.com/tektronix/tsp-toolkit/compare/v0.16.4...HEAD
+[Unreleased]: https://github.com/tektronix/tsp-toolkit/compare/v0.17.0...HEAD
+[0.17.0]: https://github.com/tektronix/tsp-toolkit/releases/tag/v0.16.4
 [0.16.4]: https://github.com/tektronix/tsp-toolkit/releases/tag/v0.16.4
 [0.16.1]: https://github.com/tektronix/tsp-toolkit/releases/tag/v0.16.1
 [0.15.3]: https://github.com/tektronix/tsp-toolkit/releases/tag/v0.15.3

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -3,7 +3,7 @@
     "publisher": "Tektronix",
     "displayName": "[Beta] Keithley TSP Toolkit",
     "description": "VSCode extension for Keithley Instruments' Test Script Processor",
-    "version": "0.16.4",
+    "version": "0.17.0",
     "icon": "./resources/TSP_Toolkit_128x128.png",
     "galleryBanner": {
         "color": "#EEEEEE",
@@ -325,7 +325,7 @@
     },
     "dependencies": {
         "@tektronix/keithley_instrument_libraries": "0.16.0",
-        "@tektronix/kic-cli": "0.16.2-0",
+        "@tektronix/kic-cli": "0.17.0-1",
         "@tektronix/web-help-documents": "0.15.3",
         "@types/cheerio": "^0.22.35",
         "cheerio": "^1.0.0-rc.12",

diff --git a/src/extension.ts b/src/extension.ts
@@ -24,6 +24,8 @@ import {
     processWorkspaceFolders,
     RELATIVE_TSP_CONFIG_FILE_PATH,
 } from "./workspaceManager"
+import { LOG_DIR } from "./utility"
+import { LoggerManager } from "./logging"
 
 let _activeConnectionManager: CommunicationManager
 let _terminationMgr: TerminationManager
@@ -454,12 +456,25 @@ async function startInstrDiscovery(): Promise<void> {
     if (wait_time === undefined) {
         return
     }
+    const logger = LoggerManager.instance().add_logger("TSP Discovery")
 
     if (parseInt(wait_time)) {
         const term = vscode.window.createTerminal({
             name: "Discovery",
             shellPath: EXECUTABLE,
-            shellArgs: ["discover", "all", "--timeout", wait_time],
+            shellArgs: [
+                "--log-file",
+                path.join(
+                    LOG_DIR,
+                    `${new Date().toISOString().substring(0, 10)}-kic.log`
+                ),
+                "--log-socket",
+                `${logger.host}:${logger.port}`,
+                "discover",
+                "all",
+                "--timeout",
+                wait_time,
+            ],
             iconPath: vscode.Uri.file("/keithley-logo.ico"),
         })
         term.show()

diff --git a/src/instruments.ts b/src/instruments.ts
@@ -1,4 +1,5 @@
 import * as cp from "node:child_process"
+import path = require("path")
 
 import * as vscode from "vscode"
 import {
@@ -17,6 +18,8 @@ import {
     IoType,
     KicProcessMgr,
 } from "./resourceManager"
+import { LOG_DIR } from "./utility"
+import { LoggerManager } from "./logging"
 
 const DISCOVERY_TIMEOUT = 300
 
@@ -1283,10 +1286,25 @@ export class InstrumentsExplorer {
     }
 
     private startDiscovery() {
+        const logger = LoggerManager.instance().add_logger("TSP Discovery")
         if (this.InstrumentsDiscoveryViewer.message == "") {
             cp.spawn(
                 DISCOVER_EXECUTABLE,
-                ["all", "--timeout", DISCOVERY_TIMEOUT.toString(), "--exit"]
+                [
+                    "--log-file",
+                    path.join(
+                        LOG_DIR,
+                        `${new Date()
+                            .toISOString()
+                            .substring(0, 10)}-kic-discover.log`
+                    ),
+                    "--log-socket",
+                    `${logger.host}:${logger.port}`,
+                    "all",
+                    "--timeout",
+                    DISCOVERY_TIMEOUT.toString(),
+                    "--exit",
+                ]
                 //,
                 // {
                 //     detached: true,