feat: add logging instrumentation to LSP server and GUI

Author: rohanku

Cargo.lock

@@ -24,6 +24,9 @@ lrlex = "0.13"
 lrpar = "0.13"
 bytes = "1"
 futures = "0.3"
+tracing = "0.1"
+tracing-subscriber = { version = "0.3", features = ["env-filter"] }
+tracing-appender = "0.2"
 
 geometry = { version = "0.7", registry = "substrate" }
 enumify = { version = "0.2", registry = "substrate" }

Cargo.toml

@@ -71,7 +71,7 @@ in both Neovim and the GUI.
 To use VS Code as your code editor, you will additionally need:
 - [Node JS (tested on 25.0.0)](https://nodejs.org/en/download)
 
-First, open your VS Code user settings using Command Palette > Preferences: Open User Settings (JSON).
+First, open your VS Code user settings using `Command Palette > Preferences: Open User Settings (JSON)`.
 Add the following key:
 
 ```json
@@ -107,7 +107,7 @@ With this alias defined, you can now run:
 codear core/compiler/examples/argon_workspace
 ```
 
-Open the `lib.ar` file within the workspace. You can then start the GUI by running Command Palette > Argon LSP: Start GUI.
+Open the `lib.ar` file within the workspace. You can then start the GUI by running `Command Palette > Argon LSP: Start GUI`.
 
 > [!WARNING]
 > If you cannot find the command for starting the GUI but did not notice any obvious errors, you may be on an old version of VS Code.
@@ -202,6 +202,47 @@ After saving, try opening this cell from the GUI by running `:openCell triple_re
 should be able to constrain the instances relative to one another based on their
 constituent rectangles.
 
+## Logs
+
+<!-- TODO: Implement commands to open GUI log -->
+Argon writes log messages to `~/.local/state/argon/lsp.log` (LSP server) and `~/local/state/argon/gui.log` (GUI).
+Log level can be set using the `ARGON_LOG` environment variable
+or in editor-specific configuration. If no configuration is specified, only errors will be logged.
+Log level configuration follows [`RUST_LOG`](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/fmt/index.html#filtering-events-with-environment-variables) syntax.
+
+For performance, it is recommended to use `ARGON_LOG=warn` or `ARGON_LOG=error` unless you are troubleshooting an issue.
+
+### Neovim
+
+While the LSP is running, you can open the LSP logs using the `:ArgonLsp log` command 
+
+To configure the log level, you can use the `vim.g.argon_lsp.log.level` key:
+
+```lua
+vim.g.argon_lsp = {
+    -- ...
+    log = {
+        level = "debug"
+    }
+}
+```
+
+The Neovim plugin will supply `ARGON_LOG=debug` when starting the LSP server and GUI.
+
+### VS Code
+
+While the LSP is running, you can open the LSP logs using the `Command Palette > Argon LSP: Open Log` command.
+
+To configure the log level, you can use the `argonLsp.log.level` key:
+
+```json
+{
+    "argonLsp.log.level": "debug"
+}
+```
+
+The VS Code plugin will supply `ARGON_LOG=debug` when starting the LSP server and GUI.
+
 ## Contributing
 
 If you'd like to contribute to Argon, please let us know. You can:
@@ -213,7 +254,7 @@ Documentation updates, tests, and bugfixes are always welcome.
 For larger feature additions, please discuss your ideas with us before implementing them.
 
 Contributions can be submitted by opening a pull request against the `main` branch
-of this repository.
+of this repository. Developer documentation can be found in the [`docs/`](docs/developers.md) folder.
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion
 in the work by you shall be licensed under the BSD 3-Clause license, without any additional terms or conditions.

README.md

@@ -26,3 +26,6 @@ indexmap = { workspace = true }
 rgb = { version = "0.8", features = ["serde"] }
 unicode-segmentation = "1"
 tower-lsp = "0.20"
+tracing = { workspace = true }
+tracing-subscriber = { workspace = true }
+tracing-appender = { workspace = true }

core/gui/Cargo.toml

@@ -665,7 +665,6 @@ impl Render for TextInput {
             .track_focus(&self.focus_handle(cx))
             .cursor(CursorStyle::IBeam)
             .on_action(cx.listener(move |input, _: &EditDim, _window, cx| {
-                println!("test");
                 if let ToolState::EditDim(EditDimToolState { original_value, .. }) =
                     input.state.read(cx).tool.read(cx)
                 {

core/gui/src/editor/input.rs

@@ -339,7 +339,6 @@ impl Editor {
         let tool_bar = cx.new(|_cx| ToolBar::new(&state));
         let canvas_focus_handle = cx.focus_handle();
         let text_input_focus_handle = cx.focus_handle();
-        println!("{canvas_focus_handle:?}");
         window.focus(&canvas_focus_handle);
         let canvas = cx.new(|cx| {
             LayoutCanvas::new(

core/gui/src/editor/mod.rs

@@ -4,6 +4,9 @@ use std::{borrow::Cow, net::SocketAddr};
 use clap::Parser;
 use editor::Editor;
 use gpui::*;
+use lsp_server::config::default_argon_home;
+use tracing::info;
+use tracing_subscriber::EnvFilter;
 
 use crate::actions::*;
 use crate::assets::{ZED_PLEX_MONO, ZED_PLEX_SANS};
@@ -50,6 +53,15 @@ impl AssetSource for Assets {
 pub fn main() {
     let args = Args::parse();
 
+    // TODO: Allow configuration via ARGON_HOME environment variable.
+    if let Some(log_dir) = default_argon_home() {
+        tracing_subscriber::fmt()
+            .with_env_filter(EnvFilter::from_env("ARGON_LOG"))
+            .with_writer(tracing_appender::rolling::never(log_dir, "gui.log"))
+            .with_ansi(false)
+            .init();
+    }
+
     Application::new()
         .with_assets(Assets {
             base: PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("assets"),
@@ -151,6 +163,6 @@ pub fn main() {
 
 // Define the quit function that is registered with the App
 fn quit(_: &Quit, cx: &mut App) {
-    println!("Gracefully quitting the application . . .");
+    info!("Gracefully quitting the application . . .");
     cx.quit();
 }

core/gui/src/lib.rs

@@ -18,8 +18,9 @@ lrlex = { workspace = true }
 lrpar = { workspace = true }
 itertools = { workspace = true }
 tarpc = { workspace = true }
-env_logger = "0.11"
-log = "0.4"
 lsp-document = "0.6"
 arcstr = { workspace = true }
 indexmap = { workspace = true }
+tracing = { workspace = true }
+tracing-subscriber = { workspace = true }
+tracing-appender = { workspace = true }

core/lsp-server/Cargo.toml

@@ -0,0 +1,18 @@
+use std::path::PathBuf;
+
+#[cfg(windows)]
+fn home_dir() -> Option<PathBuf> {
+    env::var_os("USERPROFILE")
+        .filter(|s| !s.is_empty())
+        .map(PathBuf::from)
+        .or_else(home_dir_crt)
+}
+#[cfg(unix)]
+fn home_dir() -> Option<PathBuf> {
+    std::env::home_dir()
+}
+
+// TODO: Allow configuration via ARGON_HOME environment variable.
+pub fn default_argon_home() -> Option<PathBuf> {
+    Some(home_dir()?.join(".local/state/argon"))
+}