denoland-deno/cli/tools/lint/plugins.rs

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.

use deno_ast::ModuleSpecifier;
use deno_ast::ParsedSource;
use deno_ast::SourceRange;
use deno_ast::SourceTextInfo;
use deno_ast::SourceTextProvider;
use deno_core::anyhow::Context;
use deno_core::error::custom_error;
use deno_core::error::AnyError;
use deno_core::futures::FutureExt;
use deno_core::op2;
use deno_core::resolve_url_or_path;
use deno_core::serde_json;
use deno_core::serde_v8;
use deno_core::v8;
use deno_core::OpState;
use deno_core::PollEventLoopOptions;
use deno_lint::diagnostic::LintDiagnostic;
use deno_lint::diagnostic::LintDiagnosticDetails;
use deno_lint::diagnostic::LintDiagnosticRange;
use deno_runtime::deno_permissions::Permissions;
use deno_runtime::deno_permissions::PermissionsContainer;
use deno_runtime::tokio_util;
use deno_runtime::worker::MainWorker;
use deno_runtime::WorkerExecutionMode;
use indexmap::IndexMap;
use serde::Deserialize;
use std::path::PathBuf;
use std::sync::Arc;
use tokio::sync::mpsc::channel;
use tokio::sync::mpsc::Receiver;
use tokio::sync::mpsc::Sender;

use crate::args::DenoSubcommand;
use crate::args::Flags;
use crate::args::LintFlags;
use crate::factory::CliFactory;

#[derive(Debug)]
pub enum PluginRunnerRequest {
  LoadPlugins(Vec<ModuleSpecifier>),
  Run(String, PathBuf, SourceTextInfo),
}

pub enum PluginRunnerResponse {
  LoadPlugin(Result<(), AnyError>),
  Run(Result<Vec<LintDiagnostic>, AnyError>),
}

impl std::fmt::Debug for PluginRunnerResponse {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    match self {
      Self::LoadPlugin(_arg0) => f.debug_tuple("LoadPlugin").finish(),
      Self::Run(_arg0) => f.debug_tuple("Run").finish(),
    }
  }
}

#[derive(Debug)]
pub struct PluginRunnerProxy {
  tx: Sender<PluginRunnerRequest>,
  rx: Arc<tokio::sync::Mutex<Receiver<PluginRunnerResponse>>>,
  #[allow(unused)]
  join_handle: std::thread::JoinHandle<Result<(), AnyError>>,
}

pub struct PluginRunner {
  worker: MainWorker,
  run_plugin_rule_fn: v8::Global<v8::Function>,
  install_plugins_fn: v8::Global<v8::Function>,
  run_plugins_for_file_fn: v8::Global<v8::Function>,
  tx: Sender<PluginRunnerResponse>,
  rx: Receiver<PluginRunnerRequest>,
}

impl PluginRunner {
  fn create() -> Result<PluginRunnerProxy, AnyError> {
    let (tx_req, rx_req) = channel(10);
    let (tx_res, rx_res) = channel(10);

    log::info!("spawning thread");
    let join_handle = std::thread::spawn(move || {
      log::info!("thread spawned");
      let fut = async move {
        let mut flags = Flags::default();
        flags.subcommand = DenoSubcommand::Lint(LintFlags::default());
        let flags = Arc::new(flags);
        let factory = CliFactory::from_flags(flags);
        let cli_options = factory.cli_options()?;
        let main_module =
          resolve_url_or_path("./$deno$lint.mts", cli_options.initial_cwd())
            .unwrap();
        // TODO(bartlomieju): should we run with all permissions?
        let permissions = PermissionsContainer::new(
          factory.permission_desc_parser()?.clone(),
          Permissions::none(false),
        );
        // let npm_resolver = factory.npm_resolver().await?.clone();
        // let resolver = factory.resolver().await?.clone();
        let worker_factory = factory.create_cli_main_worker_factory().await?;

        let worker = worker_factory
          .create_custom_worker(
            // TODO(bartlomieju): add "lint" execution mode
            WorkerExecutionMode::Run,
            main_module.clone(),
            permissions,
            vec![deno_lint_ext::init_ops()],
            Default::default(),
          )
          .await?;

        let mut worker = worker.into_main_worker();
        let runtime = &mut worker.js_runtime;

        log::info!("before loaded");

        let obj_result = runtime.lazy_load_es_module_with_code(
          "ext:cli/lint.js",
          deno_core::ascii_str_include!(concat!("../../js/40_lint.js")),
        );

        let obj = match obj_result {
          Ok(obj) => obj,
          Err(err) => {
            eprintln!("after load error {:#?}", err);
            return Err(err);
          }
        };

        let (install_plugins_fn, run_plugins_for_file_fn, run_plugin_rule_fn) = {
          let scope = &mut runtime.handle_scope();
          let module_exports: v8::Local<v8::Object> =
            v8::Local::new(scope, obj).try_into().unwrap();

          // TODO(bartlomieju): use v8::OneByteConst and `v8_static_strings!` macro from `deno_core`.
          let run_plugin_rule_fn_name =
            v8::String::new(scope, "runPluginRule").unwrap();
          let run_plugin_rule_fn_val = module_exports
            .get(scope, run_plugin_rule_fn_name.into())
            .unwrap();
          let run_plugin_rule_fn: v8::Local<v8::Function> =
            run_plugin_rule_fn_val.try_into().unwrap();

          // TODO(bartlomieju): use v8::OneByteConst and `v8_static_strings!` macro from `deno_core`.
          let install_plugins_fn_name =
            v8::String::new(scope, "installPlugins").unwrap();
          let install_plugins_fn_val = module_exports
            .get(scope, install_plugins_fn_name.into())
            .unwrap();
          let install_plugins_fn: v8::Local<v8::Function> =
            install_plugins_fn_val.try_into().unwrap();

          // TODO(bartlomieju): use v8::OneByteConst and `v8_static_strings!` macro from `deno_core`.
          let run_plugins_for_file_fn_name =
            v8::String::new(scope, "runPluginRule").unwrap();
          let run_plugins_for_file_fn_val = module_exports
            .get(scope, run_plugins_for_file_fn_name.into())
            .unwrap();
          let run_plugins_for_file_fn: v8::Local<v8::Function> =
            run_plugins_for_file_fn_val.try_into().unwrap();

          (
            v8::Global::new(scope, run_plugin_rule_fn),
            v8::Global::new(scope, install_plugins_fn),
            v8::Global::new(scope, run_plugins_for_file_fn),
          )
        };

        let runner = Self {
          worker,
          run_plugin_rule_fn,
          install_plugins_fn,
          run_plugins_for_file_fn,
          tx: tx_res,
          rx: rx_req,
        };
        // TODO(bartlomieju): send "host ready" message to the proxy
        log::info!("running host loop");
        runner.run_loop().await?;
        Ok(())
      }
      .boxed_local();
      tokio_util::create_and_run_current_thread(fut)
    });

    log::info!("is thread finished {}", join_handle.is_finished());
    let proxy = PluginRunnerProxy {
      tx: tx_req,
      rx: Arc::new(tokio::sync::Mutex::new(rx_res)),
      join_handle,
    };

    Ok(proxy)
  }

  async fn run_loop(mut self) -> Result<(), AnyError> {
    log::info!("waiting for message");
    while let Some(req) = self.rx.recv().await {
      log::info!("received message");
      match req {
        PluginRunnerRequest::LoadPlugins(specifiers) => {
          let r = self.load_plugins(specifiers).await;
          let _ = self.tx.send(PluginRunnerResponse::LoadPlugin(r)).await;
        }
        PluginRunnerRequest::Run(
          serialized_ast,
          specifier,
          source_text_info,
        ) => {
          let rules_to_run = self.get_rules_to_run();

          log::info!("Loaded plugins:");
          for (plugin_name, rules) in rules_to_run.iter() {
            log::info!(" - {}", plugin_name);
            for rule in rules {
              log::info!("   - {}", rule);
            }
          }

          let start = std::time::Instant::now();
          let r = match self
            .run_rules(
              &specifier,
              rules_to_run,
              serialized_ast,
              source_text_info,
            )
            .await
          {
            Ok(()) => Ok(self.take_diagnostics()),
            Err(err) => Err(err),
          };
          log::info!(
            "Running rules took {:?}",
            std::time::Instant::now() - start
          );
          let _ = self.tx.send(PluginRunnerResponse::Run(r)).await;
        }
      }
    }
    log::info!("breaking loop");
    Ok(())
  }

  fn take_diagnostics(&mut self) -> Vec<LintDiagnostic> {
    let op_state = self.worker.js_runtime.op_state();
    let mut state = op_state.borrow_mut();
    let container = state.borrow_mut::<LintPluginContainer>();
    std::mem::take(&mut container.diagnostics)
  }

  fn get_rules_to_run(&mut self) -> IndexMap<String, Vec<String>> {
    let op_state = self.worker.js_runtime.op_state();
    let state = op_state.borrow();
    let container = state.borrow::<LintPluginContainer>();

    let mut to_run = IndexMap::with_capacity(container.plugins.len());
    for (plugin_name, plugin) in container.plugins.iter() {
      let rules = plugin
        .rules
        .keys()
        .map(String::from)
        .collect::<Vec<String>>();
      to_run.insert(plugin_name.to_string(), rules);
    }

    to_run
  }

  async fn run_rules(
    &mut self,
    specifier: &PathBuf,
    rules_to_run: IndexMap<String, Vec<String>>,
    ast_string: String,
    source_text_info: SourceTextInfo,
  ) -> Result<(), AnyError> {
    {
      let state = self.worker.js_runtime.op_state();
      let mut state = state.borrow_mut();
      let container = state.borrow_mut::<LintPluginContainer>();
      container.source_text_info = Some(source_text_info);
    }

    let (file_name_v8, ast_string_v8) = {
      let scope = &mut self.worker.js_runtime.handle_scope();
      let file_name_v8: v8::Local<v8::Value> =
        v8::String::new(scope, &specifier.display().to_string())
          .unwrap()
          .into();
      let ast_string_v8: v8::Local<v8::Value> =
        v8::String::new(scope, &ast_string).unwrap().into();
      (
        v8::Global::new(scope, file_name_v8),
        v8::Global::new(scope, ast_string_v8),
      )
    };

    // TODO(bartlomieju): this could be optimized by having JS side keep track of all plugins and rules and only
    // forwarding file name and ast string.
    for (plugin_name, rules) in rules_to_run {
      for rule_name in rules {
        let (plugin_name_v8, rule_name_v8) = {
          let scope = &mut self.worker.js_runtime.handle_scope();
          let plugin_name_v8: v8::Local<v8::Value> =
            v8::String::new(scope, &plugin_name).unwrap().into();
          let rule_name_v8: v8::Local<v8::Value> =
            v8::String::new(scope, &rule_name).unwrap().into();
          (
            v8::Global::new(scope, plugin_name_v8),
            v8::Global::new(scope, rule_name_v8),
          )
        };
        let call = self.worker.js_runtime.call_with_args(
          &self.run_plugin_rule_fn,
          &[
            file_name_v8.clone(),
            plugin_name_v8,
            rule_name_v8,
            ast_string_v8.clone(),
          ],
        );
        let result = self
          .worker
          .js_runtime
          .with_event_loop_promise(call, PollEventLoopOptions::default())
          .await;
        match result {
          Ok(_r) => {
            log::info!("plugin finished")
          }
          Err(error) => {
            log::info!("error running plugin {}", error);
          }
        }
      }
    }

    Ok(())
  }

  async fn load_plugins(
    &mut self,
    plugin_specifiers: Vec<ModuleSpecifier>,
  ) -> Result<(), AnyError> {
    let mut load_futures = Vec::with_capacity(plugin_specifiers.len());
    for specifier in plugin_specifiers {
      let mod_id = self
        .worker
        .js_runtime
        .load_side_es_module(&specifier)
        .await?;
      let mod_future =
        self.worker.js_runtime.mod_evaluate(mod_id).boxed_local();
      load_futures.push((mod_future, mod_id));
    }

    self
      .worker
      .js_runtime
      .run_event_loop(PollEventLoopOptions::default())
      .await?;

    let state = self.worker.js_runtime.op_state();

    for (fut, mod_id) in load_futures {
      fut.await?;
      let module = self.worker.js_runtime.get_module_namespace(mod_id).unwrap();
      let scope = &mut self.worker.js_runtime.handle_scope();
      let module_local = v8::Local::new(scope, module);
      let default_export_str = v8::String::new(scope, "default").unwrap();
      log::info!(
        "has default export {:?}",
        module_local.has_own_property(scope, default_export_str.into())
      );
      let default_export =
        module_local.get(scope, default_export_str.into()).unwrap();
      let name_str = v8::String::new(scope, "name").unwrap();
      let name_val: v8::Local<v8::Object> = default_export.try_into().unwrap();

      let name_val = name_val.get(scope, name_str.into()).unwrap();

      log::info!(
        "default export name {:?}",
        name_val.to_rust_string_lossy(scope)
      );
      log::info!("deserializing plugin");

      let def: PluginDefinition = serde_v8::from_v8(scope, default_export)
        .context("Failed to deserialize plugin")?;

      log::info!("deserialized plugin {} {:?}", def.name, def.rules.keys());

      let mut state = state.borrow_mut();
      let container = state.borrow_mut::<LintPluginContainer>();
      let mut plugin_desc = LintPluginDesc {
        rules: IndexMap::with_capacity(def.rules.len()),
      };
      for (name, rule_def) in def.rules.into_iter() {
        let local_val = v8::Local::new(scope, rule_def.create.v8_value);
        let local_fn: v8::Local<v8::Function> = local_val.try_into().unwrap();
        let global_fn = v8::Global::new(scope, local_fn);
        plugin_desc.rules.insert(name, global_fn);
      }
      let _ = container.register(def.name, plugin_desc);
    }

    Ok(())
  }
}

#[derive(Deserialize)]
struct RuleDefinition {
  create: serde_v8::GlobalValue,
}

#[derive(Deserialize)]
struct PluginDefinition {
  name: String,
  rules: IndexMap<String, RuleDefinition>,
}

impl PluginRunnerProxy {
  pub async fn load_plugins(
    &self,
    plugin_specifiers: Vec<ModuleSpecifier>,
  ) -> Result<(), AnyError> {
    self
      .tx
      .send(PluginRunnerRequest::LoadPlugins(plugin_specifiers))
      .await?;
    let mut rx = self.rx.lock().await;
    log::info!("receiving load plugins");
    if let Some(val) = rx.recv().await {
      let PluginRunnerResponse::LoadPlugin(result) = val else {
        unreachable!()
      };
      log::info!("load plugins response {:#?}", result);
      return Ok(());
    }
    Err(custom_error("AlreadyClosed", "Plugin host has closed"))
  }

  pub async fn run_rules(
    &self,
    specifier: &PathBuf,
    serialized_ast: String,
    source_text_info: SourceTextInfo,
  ) -> Result<Vec<LintDiagnostic>, AnyError> {
    self
      .tx
      .send(PluginRunnerRequest::Run(
        serialized_ast,
        specifier.to_path_buf(),
        source_text_info,
      ))
      .await?;
    let mut rx = self.rx.lock().await;
    log::info!("receiving diagnostics");
    if let Some(PluginRunnerResponse::Run(diagnostics_result)) = rx.recv().await
    {
      return diagnostics_result;
    }
    Err(custom_error("AlreadyClosed", "Plugin host has closed"))
  }
}

pub async fn create_runner_and_load_plugins(
  plugin_specifiers: Vec<ModuleSpecifier>,
) -> Result<PluginRunnerProxy, AnyError> {
  let runner_proxy = PluginRunner::create()?;
  runner_proxy.load_plugins(plugin_specifiers).await?;
  Ok(runner_proxy)
}

pub async fn run_rules_for_ast(
  runner_proxy: &mut PluginRunnerProxy,
  specifier: &PathBuf,
  serialized_ast: String,
  source_text_info: SourceTextInfo,
) -> Result<Vec<LintDiagnostic>, AnyError> {
  let d = runner_proxy
    .run_rules(specifier, serialized_ast, source_text_info)
    .await?;
  Ok(d)
}

pub fn serialize_ast(parsed_source: ParsedSource) -> Result<String, AnyError> {
  let start = std::time::Instant::now();
  let r = serde_json::to_string(&parsed_source.program())?;
  log::info!(
    "serialize using serde_json took {:?}",
    std::time::Instant::now() - start
  );
  Ok(r)
}

struct LintPluginDesc {
  rules: IndexMap<String, v8::Global<v8::Function>>,
}

#[derive(Default)]
struct LintPluginContainer {
  plugins: IndexMap<String, LintPluginDesc>,
  diagnostics: Vec<LintDiagnostic>,
  source_text_info: Option<SourceTextInfo>,
}

impl LintPluginContainer {
  fn register(
    &mut self,
    name: String,
    desc: LintPluginDesc,
  ) -> Result<(), AnyError> {
    if self.plugins.contains_key(&name) {
      return Err(custom_error(
        "AlreadyExists",
        format!("{} plugin already exists", name),
      ));
    }

    self.plugins.insert(name, desc);
    Ok(())
  }

  fn report(
    &mut self,
    id: String,
    specifier: String,
    message: String,
    start: usize,
    end: usize,
  ) {
    let source_text_info = self.source_text_info.as_ref().unwrap();
    let start_pos = source_text_info.start_pos();
    let source_range = SourceRange::new(start_pos + start, start_pos + end);
    let range = LintDiagnosticRange {
      range: source_range,
      description: None,
      text_info: source_text_info.clone(),
    };
    let lint_diagnostic = LintDiagnostic {
      // TODO: fix
      specifier: ModuleSpecifier::parse(&format!("file:///{}", specifier))
        .unwrap(),
      range: Some(range),
      details: LintDiagnosticDetails {
        message,
        code: id,
        hint: None,
        fixes: vec![],
        custom_docs_url: None,
        info: vec![],
      },
    };
    self.diagnostics.push(lint_diagnostic);
  }
}

deno_core::extension!(
  deno_lint_ext,
  ops = [op_lint_get_rule, op_lint_report, op_lint_get_source],
  state = |state| {
    state.put(LintPluginContainer::default());
  },
);

#[op2]
#[global]
fn op_lint_get_rule(
  state: &mut OpState,
  #[string] plugin_name: &str,
  #[string] rule_name: &str,
) -> Result<v8::Global<v8::Function>, AnyError> {
  let container = state.borrow::<LintPluginContainer>();
  let Some(plugin) = container.plugins.get(plugin_name) else {
    return Err(custom_error(
      "NotFound",
      format!("{} plugin is not registered", plugin_name),
    ));
  };
  let Some(rule) = plugin.rules.get(rule_name) else {
    return Err(custom_error(
      "NotFound",
      format!("Plugin {}, does not have {} rule", plugin_name, rule_name),
    ));
  };
  Ok(rule.clone())
}

#[op2(fast)]
fn op_lint_report(
  state: &mut OpState,
  #[string] id: String,
  #[string] specifier: String,
  #[string] message: String,
  #[smi] start: usize,
  #[smi] end: usize,
) {
  let container = state.borrow_mut::<LintPluginContainer>();
  container.report(id, specifier, message, start, end);
}

#[op2]
#[string]
fn op_lint_get_source(state: &mut OpState) -> String {
  let container = state.borrow_mut::<LintPluginContainer>();
  container
    .source_text_info
    .as_ref()
    .unwrap()
    .text_str()
    .to_string()
}