1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
//! the console feature enables the script to use various cansole.log variants
//! see also: [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Console)
//! the following methods are available
//! * console.log()
//! * console.info()
//! * console.error()
//! * console.warning()
//! * console.trace()
//!
//! The methods use rust's log crate to output messages. e.g. console.info() uses the log::info!() macro
//! so the console messages should appear in the log you initialized from rust
//!
//! All methods accept a single message string and optional substitution values
//!
//! e.g.
//! ```javascript
//! console.log('Oh dear %s totaly failed %i times because of a %.4f variance in the space time continuum', 'some guy', 12, 2.46)
//! ```
//! will output 'Oh dear some guy totaly failed 12 times because of a 2.4600 variance in the space time continuum'
//!
//! The string substitution you can use are
//! * %o or %O Outputs a JavaScript object (serialized)
//! * %d or %i Outputs an integer. Number formatting is supported, for example console.log("Foo %.2d", 1.1) will output the number as two significant figures with a leading 0: Foo 01
//! * %s Outputs a string (will attempt to call .toString() on objects, use %o to output a serialized JSON string)
//! * %f Outputs a floating-point value. Formatting is supported, for example console.log("Foo %.2f", 1.1) will output the number to 2 decimal places: Foo 1.10
//! # Example
//! ```rust
//! use quickjs_runtime::builder::QuickJsRuntimeBuilder;
//! use log::LevelFilter;
//! use quickjs_runtime::jsutils::Script;
//! simple_logging::log_to_file("console_test.log", LevelFilter::max())
//! .ok()
//! .expect("could not init logger");
//! let rt = QuickJsRuntimeBuilder::new().build();
//! rt.eval_sync(None, Script::new(
//! "console.es",
//! "console.log('the %s %s %s jumped over %i fences with a accuracy of %.2f', 'quick', 'brown', 'fox', 32, 0.512);"
//! )).expect("script failed");
//! ```
//!
//! which will result in a log entry like
//! ```[00:00:00.012] (7f44e7d24700) INFO the quick brown fox jumped over 32 fences with a accuracy of 0.51```
use crate::jsutils::{JsError, JsValueType};
use crate::quickjs_utils;
use crate::quickjs_utils::functions::call_to_string;
use crate::quickjs_utils::json::stringify;
use crate::quickjs_utils::{functions, json, parse_args, primitives};
use crate::quickjsrealmadapter::QuickJsRealmAdapter;
use crate::quickjsruntimeadapter::QuickJsRuntimeAdapter;
use crate::quickjsvalueadapter::QuickJsValueAdapter;
use crate::reflection::Proxy;
use libquickjs_sys as q;
use log::LevelFilter;
use std::str::FromStr;
pub fn init(q_js_rt: &QuickJsRuntimeAdapter) -> Result<(), JsError> {
q_js_rt.add_context_init_hook(|_q_js_rt, q_ctx| init_ctx(q_ctx))
}
pub(crate) fn init_ctx(q_ctx: &QuickJsRealmAdapter) -> Result<(), JsError> {
Proxy::new()
.name("console")
.static_native_method("log", Some(console_log))
.static_native_method("trace", Some(console_trace))
.static_native_method("info", Some(console_info))
.static_native_method("warn", Some(console_warn))
.static_native_method("error", Some(console_error))
//.static_native_method("assert", Some(console_assert)) // todo
.static_native_method("debug", Some(console_debug))
.install(q_ctx, true)
.map(|_| {})
}
#[allow(clippy::or_fun_call)]
unsafe fn parse_field_value(
ctx: *mut q::JSContext,
field: &str,
value: &QuickJsValueAdapter,
) -> String {
// format ints
// only support ,2 / .3 to declare the number of digits to display, e.g. $.3i turns 3 to 003
// format floats
// only support ,2 / .3 to declare the number of decimals to display, e.g. $.3f turns 3.1 to 3.100
if field.eq(&"%.0f".to_string()) {
return parse_field_value(ctx, "%i", value);
}
if field.ends_with('d') || field.ends_with('i') {
let mut i_val: String = call_to_string(ctx, value).unwrap_or_default();
// remove chars behind .
if let Some(i) = i_val.find('.') {
let _ = i_val.split_off(i);
}
if let Some(dot_in_field_idx) = field.find('.') {
let mut m_field = field.to_string();
// get part behind dot
let mut num_decimals_str = m_field.split_off(dot_in_field_idx + 1);
// remove d or i at end
let _ = num_decimals_str.split_off(num_decimals_str.len() - 1);
// see if we have a number
if !num_decimals_str.is_empty() {
let ct_res = usize::from_str(num_decimals_str.as_str());
// check if we can parse the number to a usize
if let Ok(ct) = ct_res {
// and if so, make i_val longer
while i_val.len() < ct {
i_val = format!("0{i_val}");
}
}
}
}
return i_val;
} else if field.ends_with('f') {
let mut f_val: String = call_to_string(ctx, value).unwrap_or_default();
if let Some(dot_in_field_idx) = field.find('.') {
let mut m_field = field.to_string();
// get part behind dot
let mut num_decimals_str = m_field.split_off(dot_in_field_idx + 1);
// remove d or i at end
let _ = num_decimals_str.split_off(num_decimals_str.len() - 1);
// see if we have a number
if !num_decimals_str.is_empty() {
let ct_res = usize::from_str(num_decimals_str.as_str());
// check if we can parse the number to a usize
if let Ok(ct) = ct_res {
// and if so, make i_val longer
if ct > 0 {
if !f_val.contains('.') {
f_val.push('.');
}
let dot_idx = f_val.find('.').unwrap();
while f_val.len() - dot_idx <= ct {
f_val.push('0');
}
if f_val.len() - dot_idx > ct {
let _ = f_val.split_off(dot_idx + ct + 1);
}
}
}
}
return f_val;
}
} else if field.ends_with('o') || field.ends_with('O') {
let json_str_res = json::stringify(ctx, value, None);
let json = match json_str_res {
Ok(json_str) => {
if json_str.is_undefined() {
// if undefined is passed tp json.stringify it returns undefined, else always a string
"undefined".to_string()
} else {
primitives::to_string(ctx, &json_str).unwrap_or_default()
}
}
Err(_e) => "".to_string(),
};
return json;
}
call_to_string(ctx, value).unwrap_or_default()
}
unsafe fn stringify_log_obj(ctx: *mut q::JSContext, arg: &QuickJsValueAdapter) -> String {
match stringify(ctx, arg, None) {
Ok(r) => match primitives::to_string(ctx, &r) {
Ok(s) => s,
Err(e) => format!("Error: {e}"),
},
Err(e) => format!("Error: {e}"),
}
}
#[allow(clippy::or_fun_call)]
unsafe fn parse_line(ctx: *mut q::JSContext, args: Vec<QuickJsValueAdapter>) -> String {
let mut output = String::new();
output.push_str("JS_REALM:");
QuickJsRealmAdapter::with_context(ctx, |realm| {
output.push('[');
output.push_str(realm.id.as_str());
output.push_str("][");
if let Ok(script_or_module_name) = quickjs_utils::get_script_or_module_name_q(realm) {
output.push_str(script_or_module_name.as_str());
}
output.push_str("]: ");
});
if args.is_empty() {
return output;
}
let message = match &args[0].get_js_type() {
JsValueType::Object => stringify_log_obj(ctx, &args[0]),
JsValueType::Function => stringify_log_obj(ctx, &args[0]),
JsValueType::Array => stringify_log_obj(ctx, &args[0]),
_ => functions::call_to_string(ctx, &args[0]).unwrap_or_default(),
};
let mut field_code = String::new();
let mut in_field = false;
let mut x = 1;
let mut filled = 1;
if args[0].is_string() {
for chr in message.chars() {
if in_field {
field_code.push(chr);
if chr.eq(&'s') || chr.eq(&'d') || chr.eq(&'f') || chr.eq(&'o') || chr.eq(&'i') {
// end field
if x < args.len() {
output.push_str(
parse_field_value(ctx, field_code.as_str(), &args[x]).as_str(),
);
x += 1;
filled += 1;
}
in_field = false;
field_code = String::new();
}
} else if chr.eq(&'%') {
in_field = true;
} else {
output.push(chr);
}
}
} else {
output.push_str(message.as_str());
}
for arg in args.iter().skip(filled) {
// add args which we're not filled in str
output.push(' ');
let tail_arg = match arg.get_js_type() {
JsValueType::Object => stringify_log_obj(ctx, arg),
JsValueType::Function => stringify_log_obj(ctx, arg),
JsValueType::Array => stringify_log_obj(ctx, arg),
_ => call_to_string(ctx, arg).unwrap_or_default(),
};
output.push_str(tail_arg.as_str());
}
output
}
unsafe extern "C" fn console_log(
ctx: *mut q::JSContext,
_this_val: q::JSValue,
argc: ::std::os::raw::c_int,
argv: *mut q::JSValue,
) -> q::JSValue {
if log::max_level() >= LevelFilter::Info {
let args = parse_args(ctx, argc, argv);
log::info!("{}", parse_line(ctx, args));
}
quickjs_utils::new_null()
}
unsafe extern "C" fn console_trace(
ctx: *mut q::JSContext,
_this_val: q::JSValue,
argc: ::std::os::raw::c_int,
argv: *mut q::JSValue,
) -> q::JSValue {
if log::max_level() >= LevelFilter::Trace {
let args = parse_args(ctx, argc, argv);
log::trace!("{}", parse_line(ctx, args));
}
quickjs_utils::new_null()
}
unsafe extern "C" fn console_debug(
ctx: *mut q::JSContext,
_this_val: q::JSValue,
argc: ::std::os::raw::c_int,
argv: *mut q::JSValue,
) -> q::JSValue {
if log::max_level() >= LevelFilter::Debug {
let args = parse_args(ctx, argc, argv);
log::debug!("{}", parse_line(ctx, args));
}
quickjs_utils::new_null()
}
unsafe extern "C" fn console_info(
ctx: *mut q::JSContext,
_this_val: q::JSValue,
argc: ::std::os::raw::c_int,
argv: *mut q::JSValue,
) -> q::JSValue {
if log::max_level() >= LevelFilter::Info {
let args = parse_args(ctx, argc, argv);
log::info!("{}", parse_line(ctx, args));
}
quickjs_utils::new_null()
}
unsafe extern "C" fn console_warn(
ctx: *mut q::JSContext,
_this_val: q::JSValue,
argc: ::std::os::raw::c_int,
argv: *mut q::JSValue,
) -> q::JSValue {
if log::max_level() >= LevelFilter::Warn {
let args = parse_args(ctx, argc, argv);
log::warn!("{}", parse_line(ctx, args));
}
quickjs_utils::new_null()
}
unsafe extern "C" fn console_error(
ctx: *mut q::JSContext,
_this_val: q::JSValue,
argc: ::std::os::raw::c_int,
argv: *mut q::JSValue,
) -> q::JSValue {
if log::max_level() >= LevelFilter::Error {
let args = parse_args(ctx, argc, argv);
log::error!("{}", parse_line(ctx, args));
}
quickjs_utils::new_null()
}
#[cfg(test)]
pub mod tests {
use crate::builder::QuickJsRuntimeBuilder;
use crate::jsutils::Script;
use std::thread;
use std::time::Duration;
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
pub async fn test_console() {
eprintln!("> test_console");
/*
let loglevel = log::LevelFilter::Info;
tracing_log::LogTracer::builder()
//.ignore_crate("swc_ecma_codegen")
//.ignore_crate("swc_ecma_transforms_base")
.with_max_level(loglevel)
.init()
.expect("could not init LogTracer");
// Graylog address
let address = format!("{}:{}", "192.168.10.43", 12201);
// Start tracing
let mut conn_handle = tracing_gelf::Logger::builder()
.init_udp(address)
.expect("could not init udp con for logger");
// Spawn background task
// Any futures executor can be used
println!("> init");
tokio::runtime::Handle::current().spawn(async move {
//
conn_handle.connect().await
//
});
println!("< init");
log::error!("Logger initialized");
tracing::error!("via tracing");
*/
// Send log using a macro defined in the create log
log::info!("> test_console");
let rt = QuickJsRuntimeBuilder::new().build();
rt.eval_sync(
None,
Script::new(
"test_console.es",
"console.log('one %s', 'two', 3);\
console.error('two %s %s', 'two', 3);\
console.error('date:', new Date());\
console.error('err:', new Error('testpoof'));\
console.error('array:', [1, 2, true, {a: 1}]);\
console.error('obj: %o', {a: 1});\
console.error({obj: true}, {obj: false});",
),
)
.expect("test_console.es failed");
log::info!("< test_console");
thread::sleep(Duration::from_secs(1));
}
}