0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-02-08 07:16:56 -05:00

refactor(ext/broadcastchannel): use concrete error type (#26105)

This commit is contained in:
Leo Kettmeir 2024-10-12 08:20:17 -07:00 committed by GitHub
parent 9117a9a43c
commit 3df8f16500
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 90 additions and 21 deletions

9
Cargo.lock generated
View file

@ -1340,6 +1340,7 @@ version = "0.165.0"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"deno_core", "deno_core",
"thiserror",
"tokio", "tokio",
"uuid", "uuid",
] ]
@ -7153,18 +7154,18 @@ dependencies = [
[[package]] [[package]]
name = "thiserror" name = "thiserror"
version = "1.0.61" version = "1.0.64"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c546c80d6be4bc6a00c0f01730c08df82eaa7a7a61f11d656526506112cc1709" checksum = "d50af8abc119fb8bb6dbabcfa89656f46f84aa0ac7688088608076ad2b459a84"
dependencies = [ dependencies = [
"thiserror-impl", "thiserror-impl",
] ]
[[package]] [[package]]
name = "thiserror-impl" name = "thiserror-impl"
version = "1.0.61" version = "1.0.64"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "46c3384250002a6d5af4d114f2845d37b57521033f30d5c3f46c4d70e1197533" checksum = "08904e7672f5eb876eaaf87e0ce17857500934f4981c4a0ab2b4aa98baac7fc3"
dependencies = [ dependencies = [
"proc-macro2", "proc-macro2",
"quote", "quote",

View file

@ -16,5 +16,6 @@ path = "lib.rs"
[dependencies] [dependencies]
async-trait.workspace = true async-trait.workspace = true
deno_core.workspace = true deno_core.workspace = true
thiserror.workspace = true
tokio.workspace = true tokio.workspace = true
uuid.workspace = true uuid.workspace = true

View file

@ -3,13 +3,13 @@
use std::sync::Arc; use std::sync::Arc;
use async_trait::async_trait; use async_trait::async_trait;
use deno_core::error::AnyError;
use deno_core::parking_lot::Mutex; use deno_core::parking_lot::Mutex;
use tokio::sync::broadcast; use tokio::sync::broadcast;
use tokio::sync::mpsc; use tokio::sync::mpsc;
use uuid::Uuid; use uuid::Uuid;
use crate::BroadcastChannel; use crate::BroadcastChannel;
use crate::BroadcastChannelError;
#[derive(Clone)] #[derive(Clone)]
pub struct InMemoryBroadcastChannel(Arc<Mutex<broadcast::Sender<Message>>>); pub struct InMemoryBroadcastChannel(Arc<Mutex<broadcast::Sender<Message>>>);
@ -41,7 +41,7 @@ impl Default for InMemoryBroadcastChannel {
impl BroadcastChannel for InMemoryBroadcastChannel { impl BroadcastChannel for InMemoryBroadcastChannel {
type Resource = InMemoryBroadcastChannelResource; type Resource = InMemoryBroadcastChannelResource;
fn subscribe(&self) -> Result<Self::Resource, AnyError> { fn subscribe(&self) -> Result<Self::Resource, BroadcastChannelError> {
let (cancel_tx, cancel_rx) = mpsc::unbounded_channel(); let (cancel_tx, cancel_rx) = mpsc::unbounded_channel();
let broadcast_rx = self.0.lock().subscribe(); let broadcast_rx = self.0.lock().subscribe();
let rx = tokio::sync::Mutex::new((broadcast_rx, cancel_rx)); let rx = tokio::sync::Mutex::new((broadcast_rx, cancel_rx));
@ -53,7 +53,10 @@ impl BroadcastChannel for InMemoryBroadcastChannel {
}) })
} }
fn unsubscribe(&self, resource: &Self::Resource) -> Result<(), AnyError> { fn unsubscribe(
&self,
resource: &Self::Resource,
) -> Result<(), BroadcastChannelError> {
Ok(resource.cancel_tx.send(())?) Ok(resource.cancel_tx.send(())?)
} }
@ -62,7 +65,7 @@ impl BroadcastChannel for InMemoryBroadcastChannel {
resource: &Self::Resource, resource: &Self::Resource,
name: String, name: String,
data: Vec<u8>, data: Vec<u8>,
) -> Result<(), AnyError> { ) -> Result<(), BroadcastChannelError> {
let name = Arc::new(name); let name = Arc::new(name);
let data = Arc::new(data); let data = Arc::new(data);
let uuid = resource.uuid; let uuid = resource.uuid;
@ -73,7 +76,7 @@ impl BroadcastChannel for InMemoryBroadcastChannel {
async fn recv( async fn recv(
&self, &self,
resource: &Self::Resource, resource: &Self::Resource,
) -> Result<Option<crate::Message>, AnyError> { ) -> Result<Option<crate::Message>, BroadcastChannelError> {
let mut g = resource.rx.lock().await; let mut g = resource.rx.lock().await;
let (broadcast_rx, cancel_rx) = &mut *g; let (broadcast_rx, cancel_rx) = &mut *g;
loop { loop {

View file

@ -10,34 +10,69 @@ use std::path::PathBuf;
use std::rc::Rc; use std::rc::Rc;
use async_trait::async_trait; use async_trait::async_trait;
use deno_core::error::AnyError;
use deno_core::op2; use deno_core::op2;
use deno_core::JsBuffer; use deno_core::JsBuffer;
use deno_core::OpState; use deno_core::OpState;
use deno_core::Resource; use deno_core::Resource;
use deno_core::ResourceId; use deno_core::ResourceId;
use tokio::sync::broadcast::error::SendError as BroadcastSendError;
use tokio::sync::mpsc::error::SendError as MpscSendError;
pub const UNSTABLE_FEATURE_NAME: &str = "broadcast-channel"; pub const UNSTABLE_FEATURE_NAME: &str = "broadcast-channel";
#[derive(Debug, thiserror::Error)]
pub enum BroadcastChannelError {
#[error(transparent)]
Resource(deno_core::error::AnyError),
#[error(transparent)]
MPSCSendError(MpscSendError<Box<dyn std::fmt::Debug + Send + Sync>>),
#[error(transparent)]
BroadcastSendError(
BroadcastSendError<Box<dyn std::fmt::Debug + Send + Sync>>,
),
#[error(transparent)]
Other(deno_core::error::AnyError),
}
impl<T: std::fmt::Debug + Send + Sync + 'static> From<MpscSendError<T>>
for BroadcastChannelError
{
fn from(value: MpscSendError<T>) -> Self {
BroadcastChannelError::MPSCSendError(MpscSendError(Box::new(value.0)))
}
}
impl<T: std::fmt::Debug + Send + Sync + 'static> From<BroadcastSendError<T>>
for BroadcastChannelError
{
fn from(value: BroadcastSendError<T>) -> Self {
BroadcastChannelError::BroadcastSendError(BroadcastSendError(Box::new(
value.0,
)))
}
}
#[async_trait] #[async_trait]
pub trait BroadcastChannel: Clone { pub trait BroadcastChannel: Clone {
type Resource: Resource; type Resource: Resource;
fn subscribe(&self) -> Result<Self::Resource, AnyError>; fn subscribe(&self) -> Result<Self::Resource, BroadcastChannelError>;
fn unsubscribe(&self, resource: &Self::Resource) -> Result<(), AnyError>; fn unsubscribe(
&self,
resource: &Self::Resource,
) -> Result<(), BroadcastChannelError>;
async fn send( async fn send(
&self, &self,
resource: &Self::Resource, resource: &Self::Resource,
name: String, name: String,
data: Vec<u8>, data: Vec<u8>,
) -> Result<(), AnyError>; ) -> Result<(), BroadcastChannelError>;
async fn recv( async fn recv(
&self, &self,
resource: &Self::Resource, resource: &Self::Resource,
) -> Result<Option<Message>, AnyError>; ) -> Result<Option<Message>, BroadcastChannelError>;
} }
pub type Message = (String, Vec<u8>); pub type Message = (String, Vec<u8>);
@ -46,7 +81,7 @@ pub type Message = (String, Vec<u8>);
#[smi] #[smi]
pub fn op_broadcast_subscribe<BC>( pub fn op_broadcast_subscribe<BC>(
state: &mut OpState, state: &mut OpState,
) -> Result<ResourceId, AnyError> ) -> Result<ResourceId, BroadcastChannelError>
where where
BC: BroadcastChannel + 'static, BC: BroadcastChannel + 'static,
{ {
@ -62,11 +97,14 @@ where
pub fn op_broadcast_unsubscribe<BC>( pub fn op_broadcast_unsubscribe<BC>(
state: &mut OpState, state: &mut OpState,
#[smi] rid: ResourceId, #[smi] rid: ResourceId,
) -> Result<(), AnyError> ) -> Result<(), BroadcastChannelError>
where where
BC: BroadcastChannel + 'static, BC: BroadcastChannel + 'static,
{ {
let resource = state.resource_table.get::<BC::Resource>(rid)?; let resource = state
.resource_table
.get::<BC::Resource>(rid)
.map_err(BroadcastChannelError::Resource)?;
let bc = state.borrow::<BC>(); let bc = state.borrow::<BC>();
bc.unsubscribe(&resource) bc.unsubscribe(&resource)
} }
@ -77,11 +115,15 @@ pub async fn op_broadcast_send<BC>(
#[smi] rid: ResourceId, #[smi] rid: ResourceId,
#[string] name: String, #[string] name: String,
#[buffer] buf: JsBuffer, #[buffer] buf: JsBuffer,
) -> Result<(), AnyError> ) -> Result<(), BroadcastChannelError>
where where
BC: BroadcastChannel + 'static, BC: BroadcastChannel + 'static,
{ {
let resource = state.borrow().resource_table.get::<BC::Resource>(rid)?; let resource = state
.borrow()
.resource_table
.get::<BC::Resource>(rid)
.map_err(BroadcastChannelError::Resource)?;
let bc = state.borrow().borrow::<BC>().clone(); let bc = state.borrow().borrow::<BC>().clone();
bc.send(&resource, name, buf.to_vec()).await bc.send(&resource, name, buf.to_vec()).await
} }
@ -91,11 +133,15 @@ where
pub async fn op_broadcast_recv<BC>( pub async fn op_broadcast_recv<BC>(
state: Rc<RefCell<OpState>>, state: Rc<RefCell<OpState>>,
#[smi] rid: ResourceId, #[smi] rid: ResourceId,
) -> Result<Option<Message>, AnyError> ) -> Result<Option<Message>, BroadcastChannelError>
where where
BC: BroadcastChannel + 'static, BC: BroadcastChannel + 'static,
{ {
let resource = state.borrow().resource_table.get::<BC::Resource>(rid)?; let resource = state
.borrow()
.resource_table
.get::<BC::Resource>(rid)
.map_err(BroadcastChannelError::Resource)?;
let bc = state.borrow().borrow::<BC>().clone(); let bc = state.borrow().borrow::<BC>().clone();
bc.recv(&resource).await bc.recv(&resource).await
} }

View file

@ -9,6 +9,7 @@
//! Diagnostics are compile-time type errors, whereas JsErrors are runtime //! Diagnostics are compile-time type errors, whereas JsErrors are runtime
//! exceptions. //! exceptions.
use deno_broadcast_channel::BroadcastChannelError;
use deno_core::error::AnyError; use deno_core::error::AnyError;
use deno_core::serde_json; use deno_core::serde_json;
use deno_core::url; use deno_core::url;
@ -153,12 +154,29 @@ pub fn get_nix_error_class(error: &nix::Error) -> &'static str {
} }
} }
fn get_broadcast_channel_error(error: &BroadcastChannelError) -> &'static str {
match error {
BroadcastChannelError::Resource(err) => {
deno_core::error::get_custom_error_class(err).unwrap()
}
BroadcastChannelError::MPSCSendError(_) => "Error",
BroadcastChannelError::BroadcastSendError(_) => "Error",
BroadcastChannelError::Other(err) => {
get_error_class_name(err).unwrap_or("Error")
}
}
}
pub fn get_error_class_name(e: &AnyError) -> Option<&'static str> { pub fn get_error_class_name(e: &AnyError) -> Option<&'static str> {
deno_core::error::get_custom_error_class(e) deno_core::error::get_custom_error_class(e)
.or_else(|| deno_webgpu::error::get_error_class_name(e)) .or_else(|| deno_webgpu::error::get_error_class_name(e))
.or_else(|| deno_web::get_error_class_name(e)) .or_else(|| deno_web::get_error_class_name(e))
.or_else(|| deno_webstorage::get_not_supported_error_class_name(e)) .or_else(|| deno_webstorage::get_not_supported_error_class_name(e))
.or_else(|| deno_websocket::get_network_error_class_name(e)) .or_else(|| deno_websocket::get_network_error_class_name(e))
.or_else(|| {
e.downcast_ref::<BroadcastChannelError>()
.map(get_broadcast_channel_error)
})
.or_else(|| { .or_else(|| {
e.downcast_ref::<dlopen2::Error>() e.downcast_ref::<dlopen2::Error>()
.map(get_dlopen_error_class) .map(get_dlopen_error_class)