// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. use crate::colors; use crate::inspector::InspectorSession; use crate::program_state::ProgramState; use crate::worker::MainWorker; use crate::worker::Worker; use deno_core::error::AnyError; use deno_core::serde_json::json; use deno_core::serde_json::Value; use regex::Captures; use regex::Regex; use rustyline::error::ReadlineError; use rustyline::highlight::Highlighter; use rustyline::validate::MatchingBracketValidator; use rustyline::validate::ValidationContext; use rustyline::validate::ValidationResult; use rustyline::validate::Validator; use rustyline::Editor; use rustyline_derive::{Completer, Helper, Hinter}; use std::borrow::Cow; use std::sync::Arc; use std::sync::Mutex; // Provides syntax specific helpers to the editor like validation for multi-line edits. #[derive(Completer, Helper, Hinter)] struct Helper { highlighter: LineHighlighter, validator: MatchingBracketValidator, } impl Validator for Helper { fn validate( &self, ctx: &mut ValidationContext, ) -> Result { self.validator.validate(ctx) } } impl Highlighter for Helper { fn highlight_hint<'h>(&self, hint: &'h str) -> Cow<'h, str> { hint.into() } fn highlight<'l>(&self, line: &'l str, pos: usize) -> Cow<'l, str> { self.highlighter.highlight(line, pos) } fn highlight_candidate<'c>( &self, candidate: &'c str, _completion: rustyline::CompletionType, ) -> Cow<'c, str> { self.highlighter.highlight(candidate, 0) } fn highlight_char(&self, line: &str, _: usize) -> bool { !line.is_empty() } } struct LineHighlighter { regex: Regex, } impl LineHighlighter { fn new() -> Self { let regex = Regex::new( r#"(?x) (?P(?:/\*[\s\S]*?\*/|//[^\n]*)) | (?P(?:"([^"\\]|\\.)*"|'([^'\\]|\\.)*'|`([^`\\]|\\.)*`)) | (?P/(?:(?:\\/|[^\n/]))*?/[gimsuy]*) | (?P\d+(?:\.\d+)*(?:e[+-]?\d+)*n?) | (?P\b(?:true|false)\b) | (?P\b(?:null)\b) | (?P\b(?:undefined)\b) | (?P\b(?:await|async|var|let|for|if|else|in|of|class|const|function|yield|return|with|case|break|switch|import|export|new|while|do|throw|catch)\b) | "#, ) .unwrap(); Self { regex } } } impl Highlighter for LineHighlighter { fn highlight<'l>(&self, line: &'l str, _: usize) -> Cow<'l, str> { self .regex .replace_all(&line.to_string(), |caps: &Captures<'_>| { if let Some(cap) = caps.name("comment") { format!("{}", colors::gray(cap.as_str())) } else if let Some(cap) = caps.name("string") { format!("{}", colors::green(cap.as_str())) } else if let Some(cap) = caps.name("regexp") { format!("{}", colors::red(cap.as_str())) } else if let Some(cap) = caps.name("number") { format!("{}", colors::yellow(cap.as_str())) } else if let Some(cap) = caps.name("boolean") { format!("{}", colors::yellow(cap.as_str())) } else if let Some(cap) = caps.name("null") { format!("{}", colors::yellow(cap.as_str())) } else if let Some(cap) = caps.name("undefined") { format!("{}", colors::gray(cap.as_str())) } else if let Some(cap) = caps.name("keyword") { format!("{}", colors::cyan(cap.as_str())) } else { caps[0].to_string() } }) .to_string() .into() } } async fn post_message_and_poll( worker: &mut Worker, session: &mut InspectorSession, method: &str, params: Option, ) -> Result { let response = session.post_message(method, params); tokio::pin!(response); loop { tokio::select! { result = &mut response => { return result } _ = worker.run_event_loop() => { // A zero delay is long enough to yield the thread in order to prevent the loop from // running hot for messages that are taking longer to resolve like for example an // evaluation of top level await. tokio::time::delay_for(tokio::time::Duration::from_millis(0)).await; } } } } async fn read_line_and_poll( worker: &mut Worker, editor: Arc>>, ) -> Result { let mut line = tokio::task::spawn_blocking(move || editor.lock().unwrap().readline("> ")); let mut poll_worker = true; loop { // Because an inspector websocket client may choose to connect at anytime when we have an // inspector server we need to keep polling the worker to pick up new connections. let mut timeout = tokio::time::delay_for(tokio::time::Duration::from_millis(1000)); tokio::select! { result = &mut line => { return result.unwrap(); } _ = worker.run_event_loop(), if poll_worker => { poll_worker = false; } _ = &mut timeout => { poll_worker = true } } } } static PRELUDE: &str = r#" Object.defineProperty(globalThis, "_", { configurable: true, get: () => Deno[Deno.internal].lastEvalResult, set: (value) => { Object.defineProperty(globalThis, "_", { value: value, writable: true, enumerable: true, configurable: true, }); console.log("Last evaluation result is no longer saved to _."); }, }); Object.defineProperty(globalThis, "_error", { configurable: true, get: () => Deno[Deno.internal].lastThrownError, set: (value) => { Object.defineProperty(globalThis, "_error", { value: value, writable: true, enumerable: true, configurable: true, }); console.log("Last thrown error is no longer saved to _error."); }, }); "#; async fn inject_prelude( worker: &mut MainWorker, session: &mut InspectorSession, context_id: u64, ) -> Result<(), AnyError> { post_message_and_poll( worker, session, "Runtime.evaluate", Some(json!({ "expression": PRELUDE, "contextId": context_id, })), ) .await?; Ok(()) } pub async fn run( program_state: &ProgramState, mut worker: MainWorker, ) -> Result<(), AnyError> { let mut session = worker.create_inspector_session(); let history_file = program_state.dir.root.join("deno_history.txt"); post_message_and_poll(&mut *worker, &mut session, "Runtime.enable", None) .await?; // Enabling the runtime domain will always send trigger one executionContextCreated for each // context the inspector knows about so we grab the execution context from that since // our inspector does not support a default context (0 is an invalid context id). let mut context_id: u64 = 0; for notification in session.notifications() { let method = notification.get("method").unwrap().as_str().unwrap(); let params = notification.get("params").unwrap(); if method == "Runtime.executionContextCreated" { context_id = params .get("context") .unwrap() .get("id") .unwrap() .as_u64() .unwrap(); } } let helper = Helper { highlighter: LineHighlighter::new(), validator: MatchingBracketValidator::new(), }; let editor = Arc::new(Mutex::new(Editor::new())); editor.lock().unwrap().set_helper(Some(helper)); editor .lock() .unwrap() .load_history(history_file.to_str().unwrap()) .unwrap_or(()); println!("Deno {}", crate::version::DENO); println!("exit using ctrl+d or close()"); inject_prelude(&mut worker, &mut session, context_id).await?; loop { let line = read_line_and_poll(&mut *worker, editor.clone()).await; match line { Ok(line) => { // It is a bit unexpected that { "foo": "bar" } is interpreted as a block // statement rather than an object literal so we interpret it as an expression statement // to match the behavior found in a typical prompt including browser developer tools. let wrapped_line = if line.trim_start().starts_with('{') && !line.trim_end().ends_with(';') { format!("({})", &line) } else { line.clone() }; let evaluate_response = post_message_and_poll( &mut *worker, &mut session, "Runtime.evaluate", Some(json!({ "expression": format!("'use strict'; void 0;\n{}", &wrapped_line), "contextId": context_id, "replMode": true, })), ) .await?; // If that fails, we retry it without wrapping in parens letting the error bubble up to the // user if it is still an error. let evaluate_response = if evaluate_response.get("exceptionDetails").is_some() && wrapped_line != line { post_message_and_poll( &mut *worker, &mut session, "Runtime.evaluate", Some(json!({ "expression": format!("'use strict'; void 0;\n{}", &line), "contextId": context_id, "replMode": true, })), ) .await? } else { evaluate_response }; let is_closing = post_message_and_poll( &mut *worker, &mut session, "Runtime.evaluate", Some(json!({ "expression": "(globalThis.closed)", "contextId": context_id, })), ) .await? .get("result") .unwrap() .get("value") .unwrap() .as_bool() .unwrap(); if is_closing { break; } let evaluate_result = evaluate_response.get("result").unwrap(); let evaluate_exception_details = evaluate_response.get("exceptionDetails"); if evaluate_exception_details.is_some() { post_message_and_poll( &mut *worker, &mut session, "Runtime.callFunctionOn", Some(json!({ "executionContextId": context_id, "functionDeclaration": "function (object) { Deno[Deno.internal].lastThrownError = object; }", "arguments": [ evaluate_result, ], })), ).await?; } else { post_message_and_poll( &mut *worker, &mut session, "Runtime.callFunctionOn", Some(json!({ "executionContextId": context_id, "functionDeclaration": "function (object) { Deno[Deno.internal].lastEvalResult = object; }", "arguments": [ evaluate_result, ], })), ).await?; } // TODO(caspervonb) we should investigate using previews here but to keep things // consistent with the previous implementation we just get the preview result from // Deno.inspectArgs. let inspect_response = post_message_and_poll( &mut *worker, &mut session, "Runtime.callFunctionOn", Some(json!({ "executionContextId": context_id, "functionDeclaration": "function (object) { return Deno[Deno.internal].inspectArgs(['%o', object], { colors: !Deno.noColor }); }", "arguments": [ evaluate_result, ], })), ).await?; let inspect_result = inspect_response.get("result").unwrap(); match evaluate_exception_details { Some(_) => eprintln!( "Uncaught {}", inspect_result.get("value").unwrap().as_str().unwrap() ), None => println!( "{}", inspect_result.get("value").unwrap().as_str().unwrap() ), } editor.lock().unwrap().add_history_entry(line.as_str()); } Err(ReadlineError::Interrupted) => { break; } Err(ReadlineError::Eof) => { break; } Err(err) => { println!("Error: {:?}", err); break; } } } std::fs::create_dir_all(history_file.parent().unwrap())?; editor .lock() .unwrap() .save_history(history_file.to_str().unwrap())?; Ok(()) }