1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-24 08:09:08 -05:00

feat(extensions): BroadcastChannel WPT conformance

Replaces the file-backed provider by an in-memory one because proper
file locking is a hard problem that detracts from the proof of concept.

Teach the WPT runner how to extract tests from .html files because all
the relevant tests in test_util/wpt/webmessaging/broadcastchannel are
inside basics.html and interface.html.
This commit is contained in:
Ben Noordhuis 2021-05-22 18:08:24 +02:00
parent 8cf7f966f2
commit af1546391c
18 changed files with 343 additions and 111 deletions

2
Cargo.lock generated
View file

@ -595,8 +595,10 @@ dependencies = [
name = "deno_broadcast_channel"
version = "0.1.0"
dependencies = [
"async-trait",
"deno_core",
"tokio",
"uuid",
]
[[package]]

View file

@ -12,6 +12,7 @@
/// <reference lib="deno.fetch" />
/// <reference lib="deno.websocket" />
/// <reference lib="deno.crypto" />
/// <reference lib="deno.broadcast_channel" />
declare namespace WebAssembly {
/**

View file

@ -124,6 +124,7 @@ fn create_web_worker_callback(
no_color: !colors::use_color(),
get_error_class_fn: Some(&crate::errors::get_error_class_name),
blob_url_store: program_state.blob_url_store.clone(),
broadcast_channel: program_state.broadcast_channel.clone(),
};
let mut worker = WebWorker::from_options(
@ -212,6 +213,7 @@ pub fn create_main_worker(
.join(checksum::gen(&[loc.to_string().as_bytes()]))
}),
blob_url_store: program_state.blob_url_store.clone(),
broadcast_channel: program_state.broadcast_channel.clone(),
};
let mut worker = MainWorker::from_options(main_module, permissions, &options);

View file

@ -15,6 +15,7 @@ use crate::module_graph::TypeLib;
use crate::source_maps::SourceMapGetter;
use crate::specifier_handler::FetchHandler;
use crate::version;
use deno_runtime::deno_broadcast_channel::InMemoryBroadcastChannel;
use deno_runtime::deno_file::BlobUrlStore;
use deno_runtime::inspector::InspectorServer;
use deno_runtime::permissions::Permissions;
@ -52,6 +53,7 @@ pub struct ProgramState {
pub maybe_inspector_server: Option<Arc<InspectorServer>>,
pub ca_data: Option<Vec<u8>>,
pub blob_url_store: BlobUrlStore,
pub broadcast_channel: InMemoryBroadcastChannel,
}
impl ProgramState {
@ -77,6 +79,7 @@ impl ProgramState {
};
let blob_url_store = BlobUrlStore::default();
let broadcast_channel = InMemoryBroadcastChannel::default();
let file_fetcher = FileFetcher::new(
http_cache,
@ -143,6 +146,7 @@ impl ProgramState {
maybe_inspector_server,
ca_data,
blob_url_store,
broadcast_channel,
};
Ok(Arc::new(program_state))
}

View file

@ -15,6 +15,7 @@ use deno_core::v8_set_flags;
use deno_core::ModuleLoader;
use deno_core::ModuleSpecifier;
use deno_core::OpState;
use deno_runtime::deno_broadcast_channel::InMemoryBroadcastChannel;
use deno_runtime::deno_file::BlobUrlStore;
use deno_runtime::permissions::Permissions;
use deno_runtime::permissions::PermissionsOptions;
@ -160,6 +161,7 @@ pub async fn run(
let main_module = resolve_url(SPECIFIER)?;
let permissions = Permissions::from_options(&metadata.permissions);
let blob_url_store = BlobUrlStore::default();
let broadcast_channel = InMemoryBroadcastChannel::default();
let module_loader = Rc::new(EmbeddedModuleLoader(source_code));
let create_web_worker_cb = Arc::new(|_| {
todo!("Worker are currently not supported in standalone binaries");
@ -193,6 +195,7 @@ pub async fn run(
location: metadata.location,
location_data_dir: None,
blob_url_store,
broadcast_channel,
};
let mut worker =
MainWorker::from_options(main_module.clone(), permissions, &options);

View file

@ -0,0 +1,27 @@
// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
import { assertEquals } from "../../../test_util/std/testing/asserts.ts";
import { deferred } from "../../../test_util/std/async/deferred.ts";
Deno.test("broadcastchannel worker", async () => {
const intercom = new BroadcastChannel("intercom");
let count = 0;
const url = new URL("../workers/broadcast_channel.ts", import.meta.url);
const worker = new Worker(url.href, { type: "module", name: "worker" });
worker.onmessage = () => intercom.postMessage(++count);
const promise = deferred();
intercom.onmessage = function (e) {
assertEquals(count, e.data);
if (count < 42) {
intercom.postMessage(++count);
} else {
worker.terminate();
intercom.close();
promise.resolve();
}
};
await promise;
});

View file

@ -0,0 +1,5 @@
new BroadcastChannel("intercom").onmessage = function (e) {
this.postMessage(e.data);
};
self.postMessage("go");

View file

@ -4,6 +4,7 @@
((window) => {
const core = window.Deno.core;
const webidl = window.__bootstrap.webidl;
const { setTarget } = window.__bootstrap.event;
const handlerSymbol = Symbol("eventHandlers");
function makeWrappedHandler(handler) {
@ -21,7 +22,10 @@
// HTML specification section 8.1.5.1
Object.defineProperty(emitter, `on${name}`, {
get() {
return this[handlerSymbol]?.get(name)?.handler;
// TODO(bnoordhuis) The "BroadcastChannel should have an onmessage
// event" WPT test expects that .onmessage !== undefined. Returning
// null makes it pass but is perhaps not exactly in the spirit.
return this[handlerSymbol]?.get(name)?.handler ?? null;
},
set(value) {
if (!this[handlerSymbol]) {
@ -43,12 +47,56 @@
const _name = Symbol("[[name]]");
const _closed = Symbol("[[closed]]");
const _rid = Symbol("[[rid]]");
const channels = [];
let rid = null;
async function recv() {
while (channels.length > 0) {
const message = await core.opAsync("op_broadcast_recv", rid);
if (message === null) {
break;
}
const [name, data] = message;
dispatch(null, name, new Uint8Array(data));
}
core.close(rid);
rid = null;
}
function dispatch(source, name, data) {
for (const channel of channels) {
if (channel === source) continue; // Don't self-send.
if (channel[_name] !== name) continue;
if (channel[_closed]) continue;
const go = () => {
if (channel[_closed]) return;
const event = new MessageEvent("message", {
data: core.deserialize(data), // TODO(bnoordhuis) Cache immutables.
origin: "http://127.0.0.1",
});
setTarget(event, channel);
channel.dispatchEvent(event);
};
defer(go);
}
}
// Defer to avoid starving the event loop. Not using queueMicrotask()
// for that reason: it lets promises make forward progress but can
// still starve other parts of the event loop.
function defer(go) {
setTimeout(go, 1);
}
class BroadcastChannel extends EventTarget {
[_name];
[_closed] = false;
[_rid];
get name() {
return this[_name];
@ -57,8 +105,6 @@
constructor(name) {
super();
window.location;
const prefix = "Failed to construct 'broadcastChannel'";
webidl.requiredArguments(arguments.length, 1, { prefix });
@ -67,46 +113,50 @@
context: "Argument 1",
});
this[_rid] = core.opSync("op_broadcast_open", this[_name]);
this[webidl.brand] = webidl.brand;
this.#eventLoop();
channels.push(this);
if (rid === null) {
// Create the rid immediately, otherwise there is a time window (and a
// race condition) where messages can get lost, because recv() is async.
rid = core.opSync("op_broadcast_subscribe");
recv();
}
}
postMessage(message) {
webidl.assertBranded(this, BroadcastChannel);
const prefix = "Failed to execute 'postMessage' on 'BroadcastChannel'";
webidl.requiredArguments(arguments.length, 1, { prefix });
if (this[_closed]) {
throw new DOMException("Already closed", "InvalidStateError");
}
core.opAsync("op_broadcast_send", this[_rid], core.serialize(message));
if (typeof message === "function" || typeof message === "symbol") {
throw new DOMException("Uncloneable value", "DataCloneError");
}
const data = core.serialize(message);
// Send to other listeners in this VM.
dispatch(this, this[_name], new Uint8Array(data));
// Send to listeners in other VMs.
defer(() => core.opAsync("op_broadcast_send", [rid, this[_name]], data));
}
close() {
webidl.assertBranded(this, BroadcastChannel);
this[_closed] = true;
core.close(this[_rid]);
}
async #eventLoop() {
while (!this[_closed]) {
const message = await core.opAsync(
"op_broadcast_next_event",
this[_rid],
);
const index = channels.indexOf(this);
if (index === -1) return;
if (message.length !== 0) {
const event = new MessageEvent("message", {
data: core.deserialize(message),
origin: window.location,
});
event.target = this;
this.dispatchEvent(event);
}
}
channels.splice(index, 1);
if (channels.length === 0) core.opSync("op_broadcast_unsubscribe", rid);
}
}

View file

@ -14,5 +14,7 @@ repository = "https://github.com/denoland/deno"
path = "lib.rs"
[dependencies]
async-trait = "0.1"
deno_core = { version = "0.88.0", path = "../../core" }
tokio = { version = "1.4.0", features = ["full"] }
uuid = { version = "0.8.2", features = ["v4"] }

View file

@ -0,0 +1,97 @@
// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
use crate::BroadcastChannel;
use async_trait::async_trait;
use deno_core::error::AnyError;
use std::sync::Arc;
use std::sync::Mutex;
use tokio::sync::broadcast;
use tokio::sync::mpsc;
use uuid::Uuid;
#[derive(Clone)]
pub struct InMemoryBroadcastChannel(Arc<Mutex<broadcast::Sender<Message>>>);
pub struct InMemoryBroadcastChannelResource {
rx: tokio::sync::Mutex<(
broadcast::Receiver<Message>,
mpsc::UnboundedReceiver<()>,
)>,
cancel_tx: mpsc::UnboundedSender<()>,
uuid: Uuid,
}
#[derive(Clone, Debug)]
struct Message {
name: Arc<String>,
data: Arc<Vec<u8>>,
uuid: Uuid,
}
impl Default for InMemoryBroadcastChannel {
fn default() -> Self {
let (tx, _) = broadcast::channel(256);
Self(Arc::new(Mutex::new(tx)))
}
}
#[async_trait]
impl BroadcastChannel for InMemoryBroadcastChannel {
type Resource = InMemoryBroadcastChannelResource;
fn subscribe(&self) -> Result<Self::Resource, AnyError> {
let (cancel_tx, cancel_rx) = mpsc::unbounded_channel();
let broadcast_rx = self.0.lock().unwrap().subscribe();
let rx = tokio::sync::Mutex::new((broadcast_rx, cancel_rx));
let uuid = Uuid::new_v4();
Ok(Self::Resource {
rx,
cancel_tx,
uuid,
})
}
fn unsubscribe(&self, resource: &Self::Resource) -> Result<(), AnyError> {
Ok(resource.cancel_tx.send(())?)
}
async fn send(
&self,
resource: &Self::Resource,
name: String,
data: Vec<u8>,
) -> Result<(), AnyError> {
let name = Arc::new(name);
let data = Arc::new(data);
let uuid = resource.uuid;
self.0.lock().unwrap().send(Message { name, data, uuid })?;
Ok(())
}
async fn recv(
&self,
resource: &Self::Resource,
) -> Result<Option<crate::Message>, AnyError> {
let mut g = resource.rx.lock().await;
let (broadcast_rx, cancel_rx) = &mut *g;
loop {
let result = tokio::select! {
r = broadcast_rx.recv() => r,
_ = cancel_rx.recv() => return Ok(None),
};
use tokio::sync::broadcast::error::RecvError::*;
match result {
Err(Closed) => return Ok(None),
Err(Lagged(_)) => (), // Backlogged, messages dropped.
Ok(message) if message.uuid == resource.uuid => (), // Self-send.
Ok(message) => {
let name = String::clone(&message.name);
let data = Vec::clone(&message.data);
return Ok(Some((name, data)));
}
}
}
}
}
impl deno_core::Resource for InMemoryBroadcastChannelResource {}

View file

@ -1,127 +1,135 @@
// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
mod in_memory_broadcast_channel;
pub use in_memory_broadcast_channel::InMemoryBroadcastChannel;
use async_trait::async_trait;
use deno_core::error::bad_resource_id;
use deno_core::error::AnyError;
use deno_core::include_js_files;
use deno_core::op_async;
use deno_core::op_sync;
use deno_core::AsyncRefCell;
use deno_core::Extension;
use deno_core::OpState;
use deno_core::RcRef;
use deno_core::Resource;
use deno_core::ResourceId;
use deno_core::ZeroCopyBuf;
use std::borrow::Cow;
use std::cell::RefCell;
use std::path::PathBuf;
use std::rc::Rc;
use tokio::io::AsyncReadExt;
use tokio::io::AsyncWriteExt;
struct BroadcastChannelResource(AsyncRefCell<tokio::fs::File>);
#[async_trait]
pub trait BroadcastChannel: Clone {
type Resource: Resource;
impl Resource for BroadcastChannelResource {
fn name(&self) -> Cow<str> {
"broadcastChannel".into()
}
fn subscribe(&self) -> Result<Self::Resource, AnyError>;
fn unsubscribe(&self, resource: &Self::Resource) -> Result<(), AnyError>;
async fn send(
&self,
resource: &Self::Resource,
name: String,
data: Vec<u8>,
) -> Result<(), AnyError>;
async fn recv(
&self,
resource: &Self::Resource,
) -> Result<Option<Message>, AnyError>;
}
pub fn op_broadcast_open(
pub type Message = (String, Vec<u8>);
struct Unstable(bool); // --unstable
pub fn op_broadcast_subscribe<BC: BroadcastChannel + 'static>(
state: &mut OpState,
name: String,
_bufs: Option<ZeroCopyBuf>,
_args: (),
_buf: (),
) -> Result<ResourceId, AnyError> {
let path = PathBuf::from("./");
std::fs::create_dir_all(&path)?;
let file = std::fs::OpenOptions::new()
.create(true)
.append(true)
.read(true)
.open(path.join(format!("broadcast_{}", name)))?;
let unstable = state.borrow::<Unstable>().0;
let rid =
state
.resource_table
.add(BroadcastChannelResource(AsyncRefCell::new(
tokio::fs::File::from_std(file),
)));
if !unstable {
eprintln!(
"Unstable API 'BroadcastChannel'. The --unstable flag must be provided.",
);
std::process::exit(70);
}
Ok(rid)
let bc = state.borrow::<BC>();
let resource = bc.subscribe()?;
Ok(state.resource_table.add(resource))
}
pub async fn op_broadcast_send(
state: Rc<RefCell<OpState>>,
pub fn op_broadcast_unsubscribe<BC: BroadcastChannel + 'static>(
state: &mut OpState,
rid: ResourceId,
buf: Option<ZeroCopyBuf>,
_buf: (),
) -> Result<(), AnyError> {
let state = state.borrow_mut();
let resource = state
.resource_table
.get::<BroadcastChannelResource>(rid)
.get::<BC::Resource>(rid)
.ok_or_else(bad_resource_id)?;
let mut file = RcRef::map(&resource, |r| &r.0).borrow_mut().await;
let buffer_data = buf.unwrap();
let mut data = vec![];
data.extend_from_slice(&(buffer_data.len() as u64).to_ne_bytes());
data.extend_from_slice(&buffer_data);
file.write_all(&data).await?;
Ok(())
let bc = state.borrow::<BC>();
bc.unsubscribe(&resource)
}
pub async fn op_broadcast_next_event(
pub async fn op_broadcast_send<BC: BroadcastChannel + 'static>(
state: Rc<RefCell<OpState>>,
(rid, name): (ResourceId, String),
buf: ZeroCopyBuf,
) -> Result<(), AnyError> {
let resource = state
.borrow()
.resource_table
.get::<BC::Resource>(rid)
.ok_or_else(bad_resource_id)?;
let bc = state.borrow().borrow::<BC>().clone();
bc.send(&resource, name, buf.to_vec()).await
}
pub async fn op_broadcast_recv<BC: BroadcastChannel + 'static>(
state: Rc<RefCell<OpState>>,
rid: ResourceId,
_bufs: Option<ZeroCopyBuf>,
) -> Result<Vec<u8>, AnyError> {
let resource = {
let state = state.borrow_mut();
state
.resource_table
.get::<BroadcastChannelResource>(rid)
.ok_or_else(bad_resource_id)?
};
let mut file = RcRef::map(&resource, |r| &r.0).borrow_mut().await;
let size = match file.read_u64().await {
Ok(s) => s,
Err(e) => {
return match e.kind() {
deno_core::futures::io::ErrorKind::UnexpectedEof => Ok(vec![]),
_ => Err(e.into()),
}
}
};
let mut data = vec![0u8; size as usize];
match file.read_exact(&mut data).await {
Ok(s) => s,
Err(e) => {
return match e.kind() {
deno_core::futures::io::ErrorKind::UnexpectedEof => Ok(vec![]),
_ => Err(e.into()),
}
}
};
Ok(data)
_buf: (),
) -> Result<Option<Message>, AnyError> {
let resource = state
.borrow()
.resource_table
.get::<BC::Resource>(rid)
.ok_or_else(bad_resource_id)?;
let bc = state.borrow().borrow::<BC>().clone();
bc.recv(&resource).await
}
pub fn init() -> Extension {
pub fn init<BC: BroadcastChannel + 'static>(
bc: BC,
unstable: bool,
) -> Extension {
Extension::builder()
.js(include_js_files!(
prefix "deno:extensions/broadcast_channel",
"01_broadcast_channel.js",
))
.ops(vec![
("op_broadcast_open", op_sync(op_broadcast_open)),
("op_broadcast_send", op_async(op_broadcast_send)),
("op_broadcast_next_event", op_async(op_broadcast_next_event)),
(
"op_broadcast_subscribe",
op_sync(op_broadcast_subscribe::<BC>),
),
(
"op_broadcast_unsubscribe",
op_sync(op_broadcast_unsubscribe::<BC>),
),
("op_broadcast_send", op_async(op_broadcast_send::<BC>)),
("op_broadcast_recv", op_async(op_broadcast_recv::<BC>)),
])
.state(move |state| {
state.put(bc.clone());
state.put(Unstable(unstable));
Ok(())
})
.build()
}

View file

@ -1117,6 +1117,10 @@
}
class MessageEvent extends Event {
get source() {
return null;
}
constructor(type, eventInitDict) {
super(type, {
bubbles: eventInitDict?.bubbles ?? false,
@ -1208,5 +1212,6 @@
};
window.__bootstrap.event = {
setIsTrusted,
setTarget,
};
})(this);

View file

@ -52,7 +52,10 @@ fn create_runtime_snapshot(snapshot_path: &Path, files: Vec<PathBuf>) {
deno_crypto::init(None),
deno_webgpu::init(false),
deno_timers::init::<deno_timers::NoTimersPermission>(),
deno_broadcast_channel::init(),
deno_broadcast_channel::init(
deno_broadcast_channel::InMemoryBroadcastChannel::default(),
false, // No --unstable.
),
];
let js_runtime = JsRuntime::new(RuntimeOptions {

View file

@ -2,6 +2,7 @@
use deno_core::error::AnyError;
use deno_core::FsModuleLoader;
use deno_runtime::deno_broadcast_channel::InMemoryBroadcastChannel;
use deno_runtime::deno_file::BlobUrlStore;
use deno_runtime::permissions::Permissions;
use deno_runtime::worker::MainWorker;
@ -42,6 +43,7 @@ async fn main() -> Result<(), AnyError> {
location: None,
location_data_dir: None,
blob_url_store: BlobUrlStore::default(),
broadcast_channel: InMemoryBroadcastChannel::default(),
};
let js_path =

View file

@ -7,6 +7,7 @@ use crate::metrics;
use crate::ops;
use crate::permissions::Permissions;
use crate::tokio_util::create_basic_runtime;
use deno_broadcast_channel::InMemoryBroadcastChannel;
use deno_core::error::AnyError;
use deno_core::error::Context as ErrorContext;
use deno_core::futures::channel::mpsc;
@ -230,6 +231,7 @@ pub struct WebWorkerOptions {
pub no_color: bool,
pub get_error_class_fn: Option<GetErrorClassFn>,
pub blob_url_store: BlobUrlStore,
pub broadcast_channel: InMemoryBroadcastChannel,
}
impl WebWorker {
@ -268,7 +270,10 @@ impl WebWorker {
options.user_agent.clone(),
options.ca_data.clone(),
),
deno_broadcast_channel::init(),
deno_broadcast_channel::init(
options.broadcast_channel.clone(),
options.unstable,
),
deno_crypto::init(options.seed),
deno_webgpu::init(options.unstable),
deno_timers::init::<Permissions>(),
@ -567,6 +572,7 @@ mod tests {
no_color: true,
get_error_class_fn: None,
blob_url_store: BlobUrlStore::default(),
broadcast_channel: InMemoryBroadcastChannel::default(),
};
let mut worker = WebWorker::from_options(

View file

@ -7,6 +7,7 @@ use crate::js;
use crate::metrics;
use crate::ops;
use crate::permissions::Permissions;
use deno_broadcast_channel::InMemoryBroadcastChannel;
use deno_core::error::AnyError;
use deno_core::error::Context as ErrorContext;
use deno_core::futures::future::poll_fn;
@ -71,6 +72,7 @@ pub struct WorkerOptions {
pub location: Option<Url>,
pub location_data_dir: Option<std::path::PathBuf>,
pub blob_url_store: BlobUrlStore,
pub broadcast_channel: InMemoryBroadcastChannel,
}
impl MainWorker {
@ -107,7 +109,10 @@ impl MainWorker {
),
deno_webstorage::init(options.location_data_dir.clone()),
deno_crypto::init(options.seed),
deno_broadcast_channel::init(),
deno_broadcast_channel::init(
options.broadcast_channel.clone(),
options.unstable,
),
deno_webgpu::init(options.unstable),
deno_timers::init::<Permissions>(),
// Metrics
@ -296,6 +301,7 @@ mod tests {
location: None,
location_data_dir: None,
blob_url_store: BlobUrlStore::default(),
broadcast_channel: InMemoryBroadcastChannel::default(),
};
MainWorker::from_options(main_module, permissions, &options)

View file

@ -1098,6 +1098,14 @@
"sessionStorage: defineProperty not configurable"
]
},
"webmessaging": {
"broadcastchannel": {
"basics.any.html": [
"postMessage results in correct event"
],
"interface.any.html": true
}
},
"xhr": {
"formdata": {
"append.any.html": true,

View file

@ -76,6 +76,7 @@ export async function runSingleTest(
join(ROOT_PATH, `./target/${release ? "release" : "debug"}/deno`),
"run",
"-A",
"--unstable",
"--location",
url.toString(),
"--cert",