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 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
//! Boa's implementation of JavaScript's `console` Web API object.
//!
//! The `console` object can be accessed from any global object.
//!
//! The specifics of how it works varies from browser to browser, but there is a de facto set of features that are typically provided.
//!
//! More information:
//! - [MDN documentation][mdn]
//! - [WHATWG `console` specification][spec]
//!
//! [spec]: https://console.spec.whatwg.org/
//! [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/Console
#[cfg(test)]
mod tests;
use boa_engine::{
js_str, js_string,
native_function::NativeFunction,
object::{JsObject, ObjectInitializer},
value::{JsValue, Numeric},
Context, JsArgs, JsData, JsResult, JsStr, JsString,
};
use boa_gc::{Finalize, Trace};
use rustc_hash::FxHashMap;
use std::{cell::RefCell, collections::hash_map::Entry, rc::Rc, time::SystemTime};
/// This represents the different types of log messages.
#[derive(Debug)]
enum LogMessage {
Log(String),
Info(String),
Warn(String),
Error(String),
}
/// Helper function for logging messages.
fn logger(msg: LogMessage, console_state: &Console) {
let indent = 2 * console_state.groups.len();
match msg {
LogMessage::Error(msg) => {
eprintln!("{msg:>indent$}");
}
LogMessage::Log(msg) | LogMessage::Info(msg) | LogMessage::Warn(msg) => {
println!("{msg:>indent$}");
}
}
}
/// This represents the `console` formatter.
fn formatter(data: &[JsValue], context: &mut Context) -> JsResult<String> {
match data {
[] => Ok(String::new()),
[val] => Ok(val.to_string(context)?.to_std_string_escaped()),
data => {
let mut formatted = String::new();
let mut arg_index = 1;
let target = data
.get_or_undefined(0)
.to_string(context)?
.to_std_string_escaped();
let mut chars = target.chars();
while let Some(c) = chars.next() {
if c == '%' {
let fmt = chars.next().unwrap_or('%');
match fmt {
/* integer */
'd' | 'i' => {
let arg = match data.get_or_undefined(arg_index).to_numeric(context)? {
Numeric::Number(r) => (r.floor() + 0.0).to_string(),
Numeric::BigInt(int) => int.to_string(),
};
formatted.push_str(&arg);
arg_index += 1;
}
/* float */
'f' => {
let arg = data.get_or_undefined(arg_index).to_number(context)?;
formatted.push_str(&format!("{arg:.6}"));
arg_index += 1;
}
/* object, FIXME: how to render this properly? */
'o' | 'O' => {
let arg = data.get_or_undefined(arg_index);
formatted.push_str(&arg.display().to_string());
arg_index += 1;
}
/* string */
's' => {
let arg = data
.get_or_undefined(arg_index)
.to_string(context)?
.to_std_string_escaped();
formatted.push_str(&arg);
arg_index += 1;
}
'%' => formatted.push('%'),
/* TODO: %c is not implemented */
c => {
formatted.push('%');
formatted.push(c);
}
}
} else {
formatted.push(c);
};
}
/* unformatted data */
for rest in data.iter().skip(arg_index) {
formatted.push_str(&format!(
" {}",
rest.to_string(context)?.to_std_string_escaped()
));
}
Ok(formatted)
}
}
}
/// This is the internal console object state.
#[derive(Debug, Default, Trace, Finalize, JsData)]
pub struct Console {
count_map: FxHashMap<JsString, u32>,
timer_map: FxHashMap<JsString, u128>,
groups: Vec<String>,
}
impl Console {
/// Name of the built-in `console` property.
pub const NAME: JsStr<'static> = js_str!("console");
/// Initializes the `console` built-in object.
#[allow(clippy::too_many_lines)]
pub fn init(context: &mut Context) -> JsObject {
fn console_method(
f: fn(&JsValue, &[JsValue], &Console, &mut Context) -> JsResult<JsValue>,
state: Rc<RefCell<Console>>,
) -> NativeFunction {
// SAFETY: `Console` doesn't contain types that need tracing.
unsafe {
NativeFunction::from_closure(move |this, args, context| {
f(this, args, &state.borrow(), context)
})
}
}
fn console_method_mut(
f: fn(&JsValue, &[JsValue], &mut Console, &mut Context) -> JsResult<JsValue>,
state: Rc<RefCell<Console>>,
) -> NativeFunction {
// SAFETY: `Console` doesn't contain types that need tracing.
unsafe {
NativeFunction::from_closure(move |this, args, context| {
f(this, args, &mut state.borrow_mut(), context)
})
}
}
// let _timer = Profiler::global().start_event(std::any::type_name::<Self>(), "init");
let state = Rc::new(RefCell::new(Self::default()));
ObjectInitializer::with_native_data(Self::default(), context)
.function(
console_method(Self::assert, state.clone()),
js_string!("assert"),
0,
)
.function(
console_method_mut(Self::clear, state.clone()),
js_string!("clear"),
0,
)
.function(
console_method(Self::debug, state.clone()),
js_string!("debug"),
0,
)
.function(
console_method(Self::error, state.clone()),
js_string!("error"),
0,
)
.function(
console_method(Self::info, state.clone()),
js_string!("info"),
0,
)
.function(
console_method(Self::log, state.clone()),
js_string!("log"),
0,
)
.function(
console_method(Self::trace, state.clone()),
js_string!("trace"),
0,
)
.function(
console_method(Self::warn, state.clone()),
js_string!("warn"),
0,
)
.function(
console_method_mut(Self::count, state.clone()),
js_string!("count"),
0,
)
.function(
console_method_mut(Self::count_reset, state.clone()),
js_string!("countReset"),
0,
)
.function(
console_method_mut(Self::group, state.clone()),
js_string!("group"),
0,
)
.function(
console_method_mut(Self::group_collapsed, state.clone()),
js_string!("groupCollapsed"),
0,
)
.function(
console_method_mut(Self::group_end, state.clone()),
js_string!("groupEnd"),
0,
)
.function(
console_method_mut(Self::time, state.clone()),
js_string!("time"),
0,
)
.function(
console_method(Self::time_log, state.clone()),
js_string!("timeLog"),
0,
)
.function(
console_method_mut(Self::time_end, state.clone()),
js_string!("timeEnd"),
0,
)
.function(
console_method(Self::dir, state.clone()),
js_string!("dir"),
0,
)
.function(console_method(Self::dir, state), js_string!("dirxml"), 0)
.build()
}
/// `console.assert(condition, ...data)`
///
/// Prints a JavaScript value to the standard error if first argument evaluates to `false` or there
/// were no arguments.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#assert
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/assert
fn assert(
_: &JsValue,
args: &[JsValue],
console: &Self,
context: &mut Context,
) -> JsResult<JsValue> {
let assertion = args.first().map_or(false, JsValue::to_boolean);
if !assertion {
let mut args: Vec<JsValue> = args.iter().skip(1).cloned().collect();
let message = js_string!("Assertion failed");
if args.is_empty() {
args.push(JsValue::new(message));
} else if !args[0].is_string() {
args.insert(0, JsValue::new(message));
} else {
let value = JsString::from(args[0].display().to_string());
let concat = js_string!(message.as_str(), js_str!(": "), &value);
args[0] = JsValue::new(concat);
}
logger(LogMessage::Error(formatter(&args, context)?), console);
}
Ok(JsValue::undefined())
}
/// `console.clear()`
///
/// Removes all groups and clears console if possible.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#clear
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/clear
#[allow(clippy::unnecessary_wraps)]
fn clear(_: &JsValue, _: &[JsValue], console: &mut Self, _: &mut Context) -> JsResult<JsValue> {
console.groups.clear();
Ok(JsValue::undefined())
}
/// `console.debug(...data)`
///
/// Prints a JavaScript values with "debug" logLevel.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#debug
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/debug
fn debug(
_: &JsValue,
args: &[JsValue],
console: &Self,
context: &mut Context,
) -> JsResult<JsValue> {
logger(LogMessage::Log(formatter(args, context)?), console);
Ok(JsValue::undefined())
}
/// `console.error(...data)`
///
/// Prints a JavaScript values with "error" logLevel.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#error
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/error
fn error(
_: &JsValue,
args: &[JsValue],
console: &Self,
context: &mut Context,
) -> JsResult<JsValue> {
logger(LogMessage::Error(formatter(args, context)?), console);
Ok(JsValue::undefined())
}
/// `console.info(...data)`
///
/// Prints a JavaScript values with "info" logLevel.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#info
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/info
fn info(
_: &JsValue,
args: &[JsValue],
console: &Self,
context: &mut Context,
) -> JsResult<JsValue> {
logger(LogMessage::Info(formatter(args, context)?), console);
Ok(JsValue::undefined())
}
/// `console.log(...data)`
///
/// Prints a JavaScript values with "log" logLevel.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#log
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/log
fn log(
_: &JsValue,
args: &[JsValue],
console: &Self,
context: &mut Context,
) -> JsResult<JsValue> {
logger(LogMessage::Log(formatter(args, context)?), console);
Ok(JsValue::undefined())
}
/// `console.trace(...data)`
///
/// Prints a stack trace with "trace" logLevel, optionally labelled by data.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#trace
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/trace
fn trace(
_: &JsValue,
args: &[JsValue],
console: &Self,
context: &mut Context,
) -> JsResult<JsValue> {
if !args.is_empty() {
logger(LogMessage::Log(formatter(args, context)?), console);
}
let stack_trace_dump = context
.stack_trace()
.map(|frame| frame.code_block().name())
.collect::<Vec<_>>()
.into_iter()
.map(JsString::to_std_string_escaped)
.collect::<Vec<_>>()
.join("\n");
logger(LogMessage::Log(stack_trace_dump), console);
Ok(JsValue::undefined())
}
/// `console.warn(...data)`
///
/// Prints a JavaScript values with "warn" logLevel.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#warn
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/warn
fn warn(
_: &JsValue,
args: &[JsValue],
console: &Self,
context: &mut Context,
) -> JsResult<JsValue> {
logger(LogMessage::Warn(formatter(args, context)?), console);
Ok(JsValue::undefined())
}
/// `console.count(label)`
///
/// Prints number of times the function was called with that particular label.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#count
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/count
fn count(
_: &JsValue,
args: &[JsValue],
console: &mut Self,
context: &mut Context,
) -> JsResult<JsValue> {
let label = match args.first() {
Some(value) => value.to_string(context)?,
None => "default".into(),
};
let msg = format!("count {}:", label.to_std_string_escaped());
let c = console.count_map.entry(label).or_insert(0);
*c += 1;
logger(LogMessage::Info(format!("{msg} {c}")), console);
Ok(JsValue::undefined())
}
/// `console.countReset(label)`
///
/// Resets the counter for label.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#countreset
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/countReset
fn count_reset(
_: &JsValue,
args: &[JsValue],
console: &mut Self,
context: &mut Context,
) -> JsResult<JsValue> {
let label = match args.first() {
Some(value) => value.to_string(context)?,
None => "default".into(),
};
console.count_map.remove(&label);
logger(
LogMessage::Warn(format!("countReset {}", label.to_std_string_escaped())),
console,
);
Ok(JsValue::undefined())
}
/// Returns current system time in ms.
fn system_time_in_ms() -> u128 {
let now = SystemTime::now();
now.duration_since(SystemTime::UNIX_EPOCH)
.expect("negative duration")
.as_millis()
}
/// `console.time(label)`
///
/// Starts the timer for given label.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#time
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/time
fn time(
_: &JsValue,
args: &[JsValue],
console: &mut Self,
context: &mut Context,
) -> JsResult<JsValue> {
let label = match args.first() {
Some(value) => value.to_string(context)?,
None => "default".into(),
};
if let Entry::Vacant(e) = console.timer_map.entry(label.clone()) {
let time = Self::system_time_in_ms();
e.insert(time);
} else {
logger(
LogMessage::Warn(format!(
"Timer '{}' already exist",
label.to_std_string_escaped()
)),
console,
);
}
Ok(JsValue::undefined())
}
/// `console.timeLog(label, ...data)`
///
/// Prints elapsed time for timer with given label.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#timelog
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/timeLog
fn time_log(
_: &JsValue,
args: &[JsValue],
console: &Self,
context: &mut Context,
) -> JsResult<JsValue> {
let label = match args.first() {
Some(value) => value.to_string(context)?,
None => "default".into(),
};
console.timer_map.get(&label).map_or_else(
|| {
logger(
LogMessage::Warn(format!(
"Timer '{}' doesn't exist",
label.to_std_string_escaped()
)),
console,
);
},
|t| {
let time = Self::system_time_in_ms();
let mut concat = format!("{}: {} ms", label.to_std_string_escaped(), time - t);
for msg in args.iter().skip(1) {
concat = concat + " " + &msg.display().to_string();
}
logger(LogMessage::Log(concat), console);
},
);
Ok(JsValue::undefined())
}
/// `console.timeEnd(label)`
///
/// Removes the timer with given label.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#timeend
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/timeEnd
fn time_end(
_: &JsValue,
args: &[JsValue],
console: &mut Self,
context: &mut Context,
) -> JsResult<JsValue> {
let label = match args.first() {
Some(value) => value.to_string(context)?,
None => "default".into(),
};
console.timer_map.remove(&label).map_or_else(
|| {
logger(
LogMessage::Warn(format!(
"Timer '{}' doesn't exist",
label.to_std_string_escaped()
)),
console,
);
},
|t| {
let time = Self::system_time_in_ms();
logger(
LogMessage::Info(format!(
"{}: {} ms - timer removed",
label.to_std_string_escaped(),
time - t
)),
console,
);
},
);
Ok(JsValue::undefined())
}
/// `console.group(...data)`
///
/// Adds new group with name from formatted data to stack.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#group
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/group
fn group(
_: &JsValue,
args: &[JsValue],
console: &mut Self,
context: &mut Context,
) -> JsResult<JsValue> {
let group_label = formatter(args, context)?;
logger(LogMessage::Info(format!("group: {group_label}")), console);
console.groups.push(group_label);
Ok(JsValue::undefined())
}
/// `console.groupCollapsed(...data)`
///
/// Adds new group collapsed with name from formatted data to stack.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#groupcollapsed
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/groupcollapsed_static
fn group_collapsed(
_: &JsValue,
args: &[JsValue],
console: &mut Self,
context: &mut Context,
) -> JsResult<JsValue> {
Console::group(&JsValue::Undefined, args, console, context)
}
/// `console.groupEnd(label)`
///
/// Removes the last group from the stack.
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#groupend
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/groupEnd
#[allow(clippy::unnecessary_wraps)]
fn group_end(
_: &JsValue,
_: &[JsValue],
console: &mut Self,
_: &mut Context,
) -> JsResult<JsValue> {
console.groups.pop();
Ok(JsValue::undefined())
}
/// `console.dir(item, options)`
///
/// Prints info about item
///
/// More information:
/// - [MDN documentation][mdn]
/// - [WHATWG `console` specification][spec]
///
/// [spec]: https://console.spec.whatwg.org/#dir
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/API/console/dir
#[allow(clippy::unnecessary_wraps)]
fn dir(_: &JsValue, args: &[JsValue], console: &Self, _: &mut Context) -> JsResult<JsValue> {
logger(
LogMessage::Info(args.get_or_undefined(0).display_obj(true)),
console,
);
Ok(JsValue::undefined())
}
}