naskya/napi-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #1556 from napi-rs/fix-tsfn-callback-throw

Browse source 
fix(napi): re-throw error in ThreadsafeFunction callback if we could
This commit is contained in:
LongYinan 2023-04-10 18:21:03 +08:00 committed by GitHub
commit 5624c82926
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 137 additions and 116 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.github/workflows/linux-armv7.yaml vendored
View file

@ -2,6 +2,7 @@ name: Linux-armv7
env:
DEBUG: 'napi:*'
RUST_BACKTRACE: 1
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}

42
crates/napi/src/bindgen_runtime/iterator.rs
View file

@ -50,12 +50,7 @@ pub fn create_iterator<T: Generator>(
check_status_or_throw!(
env,
unsafe {
sys::napi_get_named_property(
env,
global,
"Symbol\0".as_ptr() as *const c_char,
&mut symbol_object,
)
sys::napi_get_named_property(env, global, "Symbol\0".as_ptr().cast(), &mut symbol_object)
},
"Get global object failed",
);
@ -66,7 +61,7 @@ pub fn create_iterator<T: Generator>(
sys::napi_get_named_property(
env,
symbol_object,
"iterator\0".as_ptr() as *const c_char,
"iterator\0".as_ptr().cast(),
&mut iterator_symbol,
)
},
@ -78,7 +73,7 @@ pub fn create_iterator<T: Generator>(
unsafe {
sys::napi_create_function(
env,
"Iterator\0".as_ptr() as *const c_char,
"Iterator\0".as_ptr().cast(),
8,
Some(symbol_generator::<T>),
generator_ptr as *mut c_void,
@ -129,7 +124,7 @@ pub unsafe extern "C" fn symbol_generator<T: Generator>(
unsafe {
sys::napi_create_function(
env,
"next\0".as_ptr() as *const c_char,
"next\0".as_ptr().cast(),
4,
Some(generator_next::<T>),
generator_ptr,
@ -144,7 +139,7 @@ pub unsafe extern "C" fn symbol_generator<T: Generator>(
unsafe {
sys::napi_create_function(
env,
"return\0".as_ptr() as *const c_char,
"return\0".as_ptr().cast(),
6,
Some(generator_return::<T>),
generator_ptr,
@ -159,7 +154,7 @@ pub unsafe extern "C" fn symbol_generator<T: Generator>(
unsafe {
sys::napi_create_function(
env,
"throw\0".as_ptr() as *const c_char,
"throw\0".as_ptr().cast(),
5,
Some(generator_throw::<T>),
generator_ptr,
@ -175,7 +170,7 @@ pub unsafe extern "C" fn symbol_generator<T: Generator>(
sys::napi_set_named_property(
env,
generator_object,
"next\0".as_ptr() as *const c_char,
"next\0".as_ptr().cast(),
next_function,
)
},
@ -188,7 +183,7 @@ pub unsafe extern "C" fn symbol_generator<T: Generator>(
sys::napi_set_named_property(
env,
generator_object,
"return\0".as_ptr() as *const c_char,
"return\0".as_ptr().cast(),
return_function,
)
},
@ -201,7 +196,7 @@ pub unsafe extern "C" fn symbol_generator<T: Generator>(
sys::napi_set_named_property(
env,
generator_object,
"throw\0".as_ptr() as *const c_char,
"throw\0".as_ptr().cast(),
throw_function,
)
},
@ -216,7 +211,7 @@ pub unsafe extern "C" fn symbol_generator<T: Generator>(
);
let properties = vec![sys::napi_property_descriptor {
utf8name: GENERATOR_STATE_KEY.as_ptr() as *const c_char,
utf8name: GENERATOR_STATE_KEY.as_ptr().cast(),
name: ptr::null_mut(),
method: None,
getter: None,
@ -264,7 +259,7 @@ extern "C" fn generator_next<T: Generator>(
sys::napi_get_named_property(
env,
this,
GENERATOR_STATE_KEY.as_ptr() as *const c_char,
GENERATOR_STATE_KEY.as_ptr().cast(),
&mut generator_state,
)
},
@ -385,7 +380,7 @@ extern "C" fn generator_return<T: Generator>(
sys::napi_set_named_property(
env,
this,
GENERATOR_STATE_KEY.as_ptr() as *const c_char,
GENERATOR_STATE_KEY.as_ptr().cast(),
generator_state,
)
},
@ -498,7 +493,7 @@ extern "C" fn generator_throw<T: Generator>(
sys::napi_set_named_property(
env,
this,
GENERATOR_STATE_KEY.as_ptr() as *const c_char,
GENERATOR_STATE_KEY.as_ptr().cast(),
generator_state,
)
},
@ -530,7 +525,7 @@ extern "C" fn generator_throw<T: Generator>(
sys::napi_set_named_property(
env,
this,
GENERATOR_STATE_KEY.as_ptr() as *const c_char,
GENERATOR_STATE_KEY.as_ptr().cast(),
generator_state,
)
},
@ -538,14 +533,7 @@ extern "C" fn generator_throw<T: Generator>(
);
check_status_or_throw!(
env,
unsafe {
sys::napi_set_named_property(
env,
result,
"done\0".as_ptr() as *const c_char,
generator_state,
)
},
unsafe { sys::napi_set_named_property(env, result, "done\0".as_ptr().cast(), generator_state) },
"Get generator state failed"
);

95
crates/napi/src/bindgen_runtime/js_values/promise.rs
View file

@ -1,33 +1,30 @@
use std::ffi::{c_void, CStr};
use std::ffi::CStr;
use std::future;
use std::pin::Pin;
use std::ptr;
use std::sync::{
atomic::{AtomicBool, AtomicPtr, Ordering},
atomic::{AtomicBool, Ordering},
Arc,
};
use std::task::{Context, Poll, Waker};
use std::task::{Context, Poll};
use crate::{check_status, sys, Error, JsUnknown, NapiValue, Result};
use tokio::sync::oneshot::{channel, Receiver, Sender};
use crate::{check_status, sys, Error, JsUnknown, NapiValue, Result, Status};
use super::{FromNapiValue, TypeName, ValidateNapiValue};
struct PromiseInner<T: FromNapiValue> {
value: AtomicPtr<Result<T>>,
waker: AtomicPtr<Waker>,
aborted: AtomicBool,
pub struct Promise<T: FromNapiValue> {
value: Pin<Box<Receiver<*mut Result<T>>>>,
aborted: Arc<AtomicBool>,
}
impl<T: FromNapiValue> Drop for PromiseInner<T> {
impl<T: FromNapiValue> Drop for Promise<T> {
fn drop(&mut self) {
self.aborted.store(true, Ordering::SeqCst);
}
}
pub struct Promise<T: FromNapiValue> {
inner: Arc<PromiseInner<T>>,
}
impl<T: FromNapiValue> TypeName for Promise<T> {
fn type_name() -> &'static str {
"Promise"
@ -103,13 +100,9 @@ impl<T: FromNapiValue> FromNapiValue for Promise<T> {
)?;
let mut promise_after_then = ptr::null_mut();
let mut then_js_cb = ptr::null_mut();
let promise_inner = PromiseInner {
value: AtomicPtr::new(ptr::null_mut()),
waker: AtomicPtr::new(ptr::null_mut()),
aborted: AtomicBool::new(false),
};
let shared_inner = Arc::new(promise_inner);
let context_ptr = Arc::into_raw(shared_inner.clone());
let (tx, rx) = channel();
let aborted = Arc::new(AtomicBool::new(false));
let tx_ptr = Box::into_raw(Box::new((tx, aborted.clone())));
check_status!(
unsafe {
sys::napi_create_function(
@ -117,7 +110,7 @@ impl<T: FromNapiValue> FromNapiValue for Promise<T> {
then_c_string.as_ptr(),
4,
Some(then_callback::<T>),
context_ptr as *mut c_void,
tx_ptr.cast(),
&mut then_js_cb,
)
},
@ -152,7 +145,7 @@ impl<T: FromNapiValue> FromNapiValue for Promise<T> {
catch_c_string.as_ptr(),
5,
Some(catch_callback::<T>),
context_ptr as *mut c_void,
tx_ptr.cast(),
&mut catch_js_cb,
)
},
@ -172,7 +165,8 @@ impl<T: FromNapiValue> FromNapiValue for Promise<T> {
"Failed to call catch method"
)?;
Ok(Promise {
inner: shared_inner,
value: Box::pin(rx),
aborted,
})
}
}
@ -180,19 +174,13 @@ impl<T: FromNapiValue> FromNapiValue for Promise<T> {
impl<T: FromNapiValue> future::Future for Promise<T> {
type Output = Result<T>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
if self.inner.value.load(Ordering::Relaxed).is_null() {
if self.inner.waker.load(Ordering::Acquire).is_null() {
self.inner.waker.store(
Box::into_raw(Box::new(cx.waker().clone())),
Ordering::Release,
);
}
Poll::Pending
} else {
Poll::Ready(
unsafe { Box::from_raw(self.inner.value.load(Ordering::Relaxed)) }.map_err(Error::from),
)
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
match self.value.as_mut().poll(cx) {
Poll::Pending => Poll::Pending,
Poll::Ready(v) => Poll::Ready(
v.map_err(|e| Error::new(Status::GenericFailure, format!("{}", e)))
.and_then(|v| unsafe { *Box::from_raw(v) }.map_err(Error::from)),
),
}
}
}
@ -218,20 +206,15 @@ unsafe extern "C" fn then_callback<T: FromNapiValue>(
get_cb_status == sys::Status::napi_ok,
"Get callback info from Promise::then failed"
);
let PromiseInner {
value,
waker,
aborted,
} = &*unsafe { Arc::from_raw(data as *mut PromiseInner<T>) };
let (sender, aborted) =
*unsafe { Box::from_raw(data as *mut (Sender<*mut Result<T>>, Arc<AtomicBool>)) };
if aborted.load(Ordering::SeqCst) {
return this;
}
let resolve_value_t = Box::new(unsafe { T::from_napi_value(env, resolved_value[0]) });
value.store(Box::into_raw(resolve_value_t), Ordering::Relaxed);
let waker = waker.load(Ordering::Acquire);
if !waker.is_null() {
unsafe { Box::from_raw(waker) }.wake();
}
sender
.send(Box::into_raw(resolve_value_t))
.expect("Send Promise resolved value error");
this
}
@ -258,23 +241,15 @@ unsafe extern "C" fn catch_callback<T: FromNapiValue>(
"Get callback info from Promise::catch failed"
);
let rejected_value = rejected_value[0];
let PromiseInner {
value,
waker,
aborted,
} = &*unsafe { Arc::from_raw(data as *mut PromiseInner<T>) };
let (sender, aborted) =
*unsafe { Box::from_raw(data as *mut (Sender<*mut Result<T>>, Arc<AtomicBool>)) };
if aborted.load(Ordering::SeqCst) {
return this;
}
value.store(
Box::into_raw(Box::new(Err(Error::from(unsafe {
sender
.send(Box::into_raw(Box::new(Err(Error::from(unsafe {
JsUnknown::from_raw_unchecked(env, rejected_value)
})))),
Ordering::Relaxed,
);
let waker = waker.load(Ordering::Acquire);
if !waker.is_null() {
unsafe { Box::from_raw(waker) }.wake();
}
})))))
.expect("Send Promise resolved value error");
this
}

5
crates/napi/src/error.rs
View file

@ -81,7 +81,10 @@ impl From<JsUnknown> for Error {
let mut result = std::ptr::null_mut();
let status = unsafe { sys::napi_create_reference(value.0.env, value.0.value, 0, &mut result) };
if status != sys::Status::napi_ok {
return Error::new(Status::from(status), "".to_owned());
return Error::new(
Status::from(status),
"Create Error reference failed".to_owned(),
);
}
Self {
status: Status::GenericFailure,

12
crates/napi/src/js_values/deferred.rs
View file

@ -115,12 +115,20 @@ extern "C" fn napi_resolve_deferred<Data: ToNapiValue, Resolver: FnOnce(Env) ->
match result {
Ok(res) => {
let status = unsafe { sys::napi_resolve_deferred(env, deferred, res) };
debug_assert!(status == sys::Status::napi_ok, "Resolve promise failed");
debug_assert!(
status == sys::Status::napi_ok,
"Resolve promise failed {:?}",
crate::Status::from(status)
);
}
Err(e) => {
let status =
unsafe { sys::napi_reject_deferred(env, deferred, JsError::from(e).into_value(env)) };
debug_assert!(status == sys::Status::napi_ok, "Reject promise failed");
debug_assert!(
status == sys::Status::napi_ok,
"Reject promise failed {:?}",
crate::Status::from(status)
);
}
}
}

73
crates/napi/src/threadsafe_function.rs
View file

@ -178,7 +178,7 @@ enum ThreadsafeFunctionCallVariant {
struct ThreadsafeFunctionCallJsBackData<T> {
data: T,
call_variant: ThreadsafeFunctionCallVariant,
callback: Box<dyn FnOnce(JsUnknown) -> Result<()>>,
callback: Box<dyn FnOnce(Result<JsUnknown>) -> Result<()>>,
}
/// Communicate with the addon's main thread by invoking a JavaScript function from other threads.
@ -434,7 +434,7 @@ impl<T: 'static> ThreadsafeFunction<T, ErrorStrategy::CalleeHandled> {
ThreadsafeFunctionCallJsBackData {
data,
call_variant: ThreadsafeFunctionCallVariant::Direct,
callback: Box::new(|_d: JsUnknown| Ok(())),
callback: Box::new(|_d: Result<JsUnknown>| Ok(())),
}
})))
.cast(),
@ -463,8 +463,8 @@ impl<T: 'static> ThreadsafeFunction<T, ErrorStrategy::CalleeHandled> {
ThreadsafeFunctionCallJsBackData {
data,
call_variant: ThreadsafeFunctionCallVariant::WithCallback,
callback: Box::new(move |d: JsUnknown| {
D::from_napi_value(d.0.env, d.0.value).and_then(cb)
callback: Box::new(move |d: Result<JsUnknown>| {
d.and_then(|d| D::from_napi_value(d.0.env, d.0.value).and_then(cb))
}),
}
})))
@ -478,7 +478,7 @@ impl<T: 'static> ThreadsafeFunction<T, ErrorStrategy::CalleeHandled> {
#[cfg(feature = "tokio_rt")]
pub async fn call_async<D: 'static + FromNapiValue>(&self, value: Result<T>) -> Result<D> {
let (sender, receiver) = tokio::sync::oneshot::channel::<D>();
let (sender, receiver) = tokio::sync::oneshot::channel::<Result<D>>();
self.handle.with_read_aborted(|aborted| {
if aborted {
@ -492,12 +492,12 @@ impl<T: 'static> ThreadsafeFunction<T, ErrorStrategy::CalleeHandled> {
ThreadsafeFunctionCallJsBackData {
data,
call_variant: ThreadsafeFunctionCallVariant::WithCallback,
callback: Box::new(move |d: JsUnknown| {
D::from_napi_value(d.0.env, d.0.value).and_then(move |d| {
sender.send(d).map_err(|_| {
callback: Box::new(move |d: Result<JsUnknown>| {
sender
.send(d.and_then(|d| D::from_napi_value(d.0.env, d.0.value)))
.map_err(|_| {
crate::Error::from_reason("Failed to send return value to tokio sender")
})
})
}),
}
})))
@ -508,7 +508,13 @@ impl<T: 'static> ThreadsafeFunction<T, ErrorStrategy::CalleeHandled> {
})?;
receiver
.await
.map_err(|err| crate::Error::new(Status::GenericFailure, format!("{}", err)))
.map_err(|_| {
crate::Error::new(
Status::GenericFailure,
"Receive value from threadsafe function sender failed",
)
})
.and_then(|ret| ret)
}
}
@ -527,7 +533,7 @@ impl<T: 'static> ThreadsafeFunction<T, ErrorStrategy::Fatal> {
Box::into_raw(Box::new(ThreadsafeFunctionCallJsBackData {
data: value,
call_variant: ThreadsafeFunctionCallVariant::Direct,
callback: Box::new(|_d: JsUnknown| Ok(())),
callback: Box::new(|_d: Result<JsUnknown>| Ok(())),
}))
.cast(),
mode.into(),
@ -554,8 +560,8 @@ impl<T: 'static> ThreadsafeFunction<T, ErrorStrategy::Fatal> {
Box::into_raw(Box::new(ThreadsafeFunctionCallJsBackData {
data: value,
call_variant: ThreadsafeFunctionCallVariant::WithCallback,
callback: Box::new(move |d: JsUnknown| {
D::from_napi_value(d.0.env, d.0.value).and_then(cb)
callback: Box::new(move |d: Result<JsUnknown>| {
d.and_then(|d| D::from_napi_value(d.0.env, d.0.value).and_then(cb))
}),
}))
.cast(),
@ -581,10 +587,12 @@ impl<T: 'static> ThreadsafeFunction<T, ErrorStrategy::Fatal> {
Box::into_raw(Box::new(ThreadsafeFunctionCallJsBackData {
data: value,
call_variant: ThreadsafeFunctionCallVariant::WithCallback,
callback: Box::new(move |d: JsUnknown| {
D::from_napi_value(d.0.env, d.0.value).and_then(move |d| {
sender.send(d).map_err(|_| {
crate::Error::from_reason("Failed to send return value to tokio sender")
callback: Box::new(move |d: Result<JsUnknown>| {
d.and_then(|d| {
D::from_napi_value(d.0.env, d.0.value).and_then(move |d| {
sender.send(d).map_err(|_| {
crate::Error::from_reason("Failed to send return value to tokio sender")
})
})
})
}),
@ -677,7 +685,7 @@ unsafe extern "C" fn call_js_cb<T: 'static, V: ToNapiValue, R, ES>(
values.collect()
};
let mut return_value = ptr::null_mut();
let status = match args {
let mut status = match args {
Ok(args) => unsafe {
sys::napi_call_function(
raw_env,
@ -705,11 +713,26 @@ unsafe extern "C" fn call_js_cb<T: 'static, V: ToNapiValue, R, ES>(
},
};
if let ThreadsafeFunctionCallVariant::WithCallback = call_variant {
if let Err(err) = callback(JsUnknown(crate::Value {
env: raw_env,
value: return_value,
value_type: crate::ValueType::Unknown,
})) {
// throw Error in JavaScript callback
let callback_arg = if status == sys::Status::napi_pending_exception {
let mut exception = ptr::null_mut();
status = unsafe { sys::napi_get_and_clear_last_exception(raw_env, &mut exception) };
Err(
JsUnknown(crate::Value {
env: raw_env,
value: exception,
value_type: crate::ValueType::Unknown,
})
.into(),
)
} else {
Ok(JsUnknown(crate::Value {
env: raw_env,
value: return_value,
value_type: crate::ValueType::Unknown,
}))
};
if let Err(err) = callback(callback_arg) {
let message = format!(
"Failed to convert return value in ThreadsafeFunction callback into Rust value: {}",
err
@ -717,7 +740,7 @@ unsafe extern "C" fn call_js_cb<T: 'static, V: ToNapiValue, R, ES>(
let message_length = message.len();
unsafe {
sys::napi_fatal_error(
"threadsafe_function.rs:642\0".as_ptr().cast(),
"threadsafe_function.rs:720\0".as_ptr().cast(),
26,
CString::new(message).unwrap().into_raw(),
message_length,
@ -769,7 +792,7 @@ unsafe extern "C" fn call_js_cb<T: 'static, V: ToNapiValue, R, ES>(
},
sys::Status::napi_ok,
);
let error_msg = "Call JavaScript callback failed in thread safe function";
let error_msg = "Call JavaScript callback failed in threadsafe function";
let mut error_msg_value = ptr::null_mut();
assert_eq!(
unsafe {

2
examples/napi/__tests__/__snapshots__/typegen.spec.ts.md
View file

@ -518,6 +518,8 @@ Generated by [AVA](https://avajs.dev).
␊
export function tsfnReturnPromiseTimeout(func: (err: Error | null, value: number) => any): Promise<number>␊
␊
export function tsfnThrowFromJs(tsfn: (err: Error | null, value: number) => any): Promise<number>␊
␊
export function tsRename(a: { foo: number }): string[]␊
␊
export interface TsTypeChanged {␊

BIN
examples/napi/__tests__/__snapshots__/typegen.spec.ts.snap
View file

Binary file not shown.

16
examples/napi/__tests__/values.spec.ts
View file

@ -55,6 +55,7 @@ import {
threadsafeFunctionClosureCapture,
tsfnCallWithCallback,
tsfnAsyncCall,
tsfnThrowFromJs,
asyncPlus100,
getGlobal,
getUndefined,
@ -843,6 +844,19 @@ Napi4Test('async call ThreadsafeFunction', async (t) => {
)
})
test('Throw from ThreadsafeFunction JavaScript callback', async (t) => {
const errMsg = 'ThrowFromJavaScriptRawCallback'
await t.throwsAsync(
() =>
tsfnThrowFromJs(() => {
throw new Error(errMsg)
}),
{
message: errMsg,
},
)
})
Napi4Test('accept ThreadsafeFunction', async (t) => {
await new Promise<void>((resolve, reject) => {
acceptThreadsafeFunction((err, value) => {
@ -923,7 +937,7 @@ Napi4Test('object only from js', (t) => {
})
})
Napi4Test('promise in either', async (t) => {
test('promise in either', async (t) => {
t.is(await promiseInEither(1), false)
t.is(await promiseInEither(20), true)
t.is(await promiseInEither(Promise.resolve(1)), false)

2
examples/napi/index.d.ts vendored
View file

@ -508,6 +508,8 @@ export function tsfnReturnPromise(func: (err: Error | null, value: number) => an
export function tsfnReturnPromiseTimeout(func: (err: Error | null, value: number) => any): Promise<number>
export function tsfnThrowFromJs(tsfn: (err: Error | null, value: number) => any): Promise<number>
export function tsRename(a: { foo: number }): string[]
export interface TsTypeChanged {

5
examples/napi/src/threadsafe_function.rs
View file

@ -160,3 +160,8 @@ pub async fn tsfn_return_promise_timeout(func: ThreadsafeFunction<u32>) -> Resul
}
}
}
#[napi]
pub async fn tsfn_throw_from_js(tsfn: ThreadsafeFunction<u32>) -> napi::Result<u32> {
tsfn.call_async::<Promise<u32>>(Ok(42)).await?.await
}