feat: include rust debug logs (#46)

Author: dsherret

src/mod.ts

@@ -59,7 +59,13 @@ export interface WorkspaceOptions {
   platform?: "node" | "browser";
   /** Whether to force using the cache. */
   cachedOnly?: boolean;
-  /** Enable debug logs. */
+  /**
+   * Enable debug logs.
+   *
+   * @remarks Note that the Rust debug logs are enabled globally
+   * and can only be enabled by the first workspace that gets
+   * created. This is a limitation of how the Rust logging works.
+   */
   debug?: boolean;
   /** Whether to preserve JSX syntax in the loaded output. */
   preserveJsx?: boolean;
@@ -205,14 +211,14 @@ export class Loader implements Disposable {
   ): string {
     if (this.#debug) {
       console.error(
-        `Resolving '${specifier}' from '${referrer ?? "<undefined>"}' (${
-          resolutionModeToString(resolutionMode)
-        })`,
+        `DEBUG - Resolving '${specifier}' from '${
+          referrer ?? "<undefined>"
+        }' (${resolutionModeToString(resolutionMode)})`,
       );
     }
     const value = this.#inner.resolve_sync(specifier, referrer, resolutionMode);
     if (this.#debug) {
-      console.error(`Resolved to '${value}'`);
+      console.error(`DEBUG - Resolved to '${value}'`);
     }
     return value;
   }
@@ -232,9 +238,9 @@ export class Loader implements Disposable {
   ): Promise<string> {
     if (this.#debug) {
       console.error(
-        `Resolving '${specifier}' from '${referrer ?? "<undefined>"}' (${
-          resolutionModeToString(resolutionMode)
-        })`,
+        `DEBUG - Resolving '${specifier}' from '${
+          referrer ?? "<undefined>"
+        }' (${resolutionModeToString(resolutionMode)})`,
       );
     }
     const value = await this.#inner.resolve(
@@ -243,7 +249,7 @@ export class Loader implements Disposable {
       resolutionMode,
     );
     if (this.#debug) {
-      console.error(`Resolved to '${value}'`);
+      console.error(`DEBUG - Resolved to '${value}'`);
     }
     return value;
   }
@@ -255,7 +261,7 @@ export class Loader implements Disposable {
   ): Promise<LoadResponse> {
     if (this.#debug) {
       console.error(
-        `Loading '${specifier}' with type '${
+        `DEBUG - Loading '${specifier}' with type '${
           requestedModuleTypeToString(requestedModuleType) ?? "<default>"
         }'`,
       );

src/rs_lib/Cargo.lock

@@ -12,6 +12,7 @@ path = "lib.rs"
 anyhow = "1.0.57"
 console_error_panic_hook = "0.1.6"
 js-sys = "=0.3.77"
+log = "0.4"
 serde = "1.0.149"
 serde-wasm-bindgen = "=0.6.5"
 wasm-bindgen = "=0.2.100"

src/rs_lib/Cargo.toml

@@ -6,6 +6,7 @@ use std::path::Path;
 use std::path::PathBuf;
 use std::rc::Rc;
 use std::sync::Arc;
+use std::sync::OnceLock;
 
 use anyhow::Context;
 use anyhow::bail;
@@ -56,6 +57,9 @@ use deno_semver::jsr::JsrPackageReqReference;
 use deno_semver::npm::NpmPackageReqReference;
 use js_sys::Object;
 use js_sys::Uint8Array;
+use log::LevelFilter;
+use log::Metadata;
+use log::Record;
 use node_resolver::NodeConditionOptions;
 use node_resolver::NodeResolverOptions;
 use node_resolver::PackageJsonThreadLocalCache;
@@ -79,6 +83,31 @@ extern "C" {
   fn error(s: &JsValue);
 }
 
+static GLOBAL_LOGGER: OnceLock<Logger> = OnceLock::new();
+
+struct Logger {
+  debug: bool,
+}
+
+impl log::Log for Logger {
+  fn enabled(&self, metadata: &Metadata) -> bool {
+    metadata.level() <= log::Level::Info
+      || metadata.level() == log::Level::Debug && self.debug
+  }
+
+  fn log(&self, record: &Record) {
+    if self.enabled(record.metadata()) {
+      error(&JsValue::from(format!(
+        "{} RS - {}",
+        record.level(),
+        record.args()
+      )));
+    }
+  }
+
+  fn flush(&self) {}
+}
+
 #[derive(Debug, Clone)]
 pub struct ConsoleLogReporter;
 
@@ -133,6 +162,8 @@ pub struct DenoWorkspaceOptions {
   pub preserve_jsx: Option<bool>,
   #[serde(default)]
   pub no_transpile: Option<bool>,
+  #[serde(default)]
+  pub debug: Option<bool>,
 }
 
 #[wasm_bindgen]
@@ -176,6 +207,16 @@ impl DenoWorkspace {
       })
     }
 
+    let debug = options.debug.unwrap_or(false);
+    let logger = GLOBAL_LOGGER.get_or_init(|| Logger { debug });
+    _ = log::set_logger(logger).map(|()| {
+      log::set_max_level(if debug {
+        LevelFilter::Debug
+      } else {
+        LevelFilter::Info
+      })
+    });
+
     let sys = RealSys;
     let cwd = sys.env_current_dir()?;
     let is_browser_platform = resolve_is_browser_platform(&options)?;