Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor(core): convert core.print() to a builtin op #10436

Merged
merged 8 commits into from
May 2, 2021
Merged

refactor(core): convert core.print() to a builtin op #10436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3fbe176
refactor(core): convert core.print() to a builtin op
AaronO Apr 30, 2021
6d9b2b4
tweak
AaronO Apr 30, 2021
c93960b
tweak
AaronO Apr 30, 2021
e9f4ed1
tweak
AaronO Apr 30, 2021
b43a326
Merge branch 'main' into core/print-op
AaronO May 1, 2021
c852cd9
declare op_print in builtin extension
AaronO May 1, 2021
b834a7e
cli/tsc: fix core.print() usage
AaronO May 1, 2021
018141e
Merge branch 'main' into core/print-op
AaronO May 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions cli/tsc/99_main_compiler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,16 @@ delete Object.prototype.__proto__;
}
}

function printStderr(msg) {
core.print(msg, true);
}

function debug(...args) {
if (logDebug) {
const stringifiedArgs = args.map((arg) =>
typeof arg === "string" ? arg : JSON.stringify(arg)
).join(" ");
// adding a non-zero integer value to the end of the debug string causes
// the message to be printed to stderr instead of stdout, which is better
// aligned to the behaviour of debug messages
core.print(`DEBUG ${logSource} - ${stringifiedArgs}\n`, 1);
printStderr(`DEBUG ${logSource} - ${stringifiedArgs}\n`);
}
}

Expand All @@ -52,7 +53,7 @@ delete Object.prototype.__proto__;
? String(arg)
: JSON.stringify(arg)
).join(" ");
core.print(`ERROR ${logSource} = ${stringifiedArgs}\n`, 1);
printStderr(`ERROR ${logSource} = ${stringifiedArgs}\n`);
}

class AssertionError extends Error {
Expand Down
2 changes: 1 addition & 1 deletion cli/tsc/compiler.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ declare global {
// deno-lint-ignore no-explicit-any
opSync<T>(name: string, params: T): any;
ops(): void;
print(msg: string, code?: number): void;
print(msg: string, stderr: bool): void;
registerErrorClass(
name: string,
Ctor: typeof Error,
Expand Down
40 changes: 0 additions & 40 deletions core/bindings.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,13 @@ use serde::Serialize;
use serde_v8::to_v8;
use std::convert::TryFrom;
use std::convert::TryInto;
use std::io::{stdout, Write};
use std::option::Option;
use url::Url;
use v8::MapFnTo;

lazy_static::lazy_static! {
pub static ref EXTERNAL_REFERENCES: v8::ExternalReferences =
v8::ExternalReferences::new(&[
v8::ExternalReference {
function: print.map_fn_to()
},
v8::ExternalReference {
function: opcall.map_fn_to()
},
Expand Down Expand Up @@ -117,7 +113,6 @@ pub fn initialize_context<'s>(
deno_val.set(scope, core_key.into(), core_val.into());

// Bind functions to Deno.core.*
set_func(scope, core_val, "print", print);
set_func(scope, core_val, "opcall", opcall);
set_func(
scope,
Expand Down Expand Up @@ -268,41 +263,6 @@ pub extern "C" fn promise_reject_callback(message: v8::PromiseRejectMessage) {
};
}

fn print(
scope: &mut v8::HandleScope,
args: v8::FunctionCallbackArguments,
_rv: v8::ReturnValue,
) {
let arg_len = args.length();
if !(0..=2).contains(&arg_len) {
return throw_type_error(scope, "Expected a maximum of 2 arguments.");
}

let obj = args.get(0);
let is_err_arg = args.get(1);

let mut is_err = false;
if arg_len == 2 {
let int_val = match is_err_arg.integer_value(scope) {
Some(v) => v,
None => return throw_type_error(scope, "Invalid argument. Argument 2 should indicate whether or not to print to stderr."),
};
is_err = int_val != 0;
};
let tc_scope = &mut v8::TryCatch::new(scope);
let str_ = match obj.to_string(tc_scope) {
Some(s) => s,
None => v8::String::new(tc_scope, "").unwrap(),
};
if is_err {
eprint!("{}", str_.to_rust_string_lossy(tc_scope));
stdout().flush().unwrap();
} else {
print!("{}", str_.to_rust_string_lossy(tc_scope));
stdout().flush().unwrap();
}
}

fn opcall<'s>(
scope: &mut v8::HandleScope<'s>,
args: v8::FunctionCallbackArguments,
Expand Down
5 changes: 5 additions & 0 deletions core/core.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,10 @@
opSync("op_close", rid);
}

function print(str, isErr = false) {
opSync("op_print", [str, isErr]);
}

// Provide bootstrap namespace
window.__bootstrap = {};
// Extra Deno.core.* exports
Expand All @@ -132,6 +136,7 @@
opSync,
ops,
close,
print,
resources,
registerErrorClass,
handleAsyncMsgFromRust,
Expand Down
1 change: 1 addition & 0 deletions core/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ pub use crate::ops::OpState;
pub use crate::ops::OpTable;
pub use crate::ops::PromiseId;
pub use crate::ops_builtin::op_close;
pub use crate::ops_builtin::op_print;
pub use crate::ops_builtin::op_resources;
pub use crate::ops_json::op_async;
pub use crate::ops_json::op_sync;
Expand Down
19 changes: 19 additions & 0 deletions core/ops_builtin.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use crate::resources::ResourceId;
use crate::Extension;
use crate::OpState;
use crate::ZeroCopyBuf;
use std::io::{stdout, Write};

pub(crate) fn init_builtins() -> Extension {
Extension::builder()
Expand All @@ -17,6 +18,7 @@ pub(crate) fn init_builtins() -> Extension {
))
.ops(vec![
("op_close", op_sync(op_close)),
("op_print", op_sync(op_print)),
("op_resources", op_sync(op_resources)),
])
.build()
Expand Down Expand Up @@ -52,3 +54,20 @@ pub fn op_close(

Ok(())
}

/// Builtin utility to print to stdout/stderr
pub fn op_print(
_state: &mut OpState,
args: (String, bool),
_zero_copy: Option<ZeroCopyBuf>,
) -> Result<(), AnyError> {
let (msg, is_err) = args;
if is_err {
eprint!("{}", msg);
stdout().flush().unwrap();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't it be stderr().flush().unwrap() ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you're right, but it's not 100% clear if the original intention was to flush stdout when writing to stderr. IIRC stderr is unbuffered on Linux and macOS, but I don't think that's true on Windows.

The original intention might have been to flush both stderr/stdout (all output streams) assuming stderr was unbuffered and thus didn't need flushing.

I've submitted a PR (#10480), so we can continue the conversation over there.

It seems like this should only matter on Windows, could make sense to always flush both regardless of where we're writing to, something like this:

/// Builtin utility to print to stdout/stderr
pub fn op_print(
  _state: &mut OpState,
  args: (String, bool),
  _zero_copy: Option<ZeroCopyBuf>,
) -> Result<(), AnyError> {
  let (msg, is_err) = args;
  if is_err {
    eprint!("{}", msg);
  } else {
    print!("{}", msg);
  }
  // Flush all output streams (stderr & stdout)
  stdout().flush().unwrap();
  stderr().flush().unwrap();
  Ok(())
}

} else {
print!("{}", msg);
stdout().flush().unwrap();
}
Ok(())
}