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

worker: do not add removed methods to MessagePort #26109

Closed
wants to merge 1 commit into from
Closed

worker: do not add removed methods to MessagePort #26109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 7 additions & 13 deletions lib/internal/worker/io.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ const {
} = internalBinding('symbols');
const {
MessagePort,
MessageChannel
MessageChannel,
drainMessagePort,
stopMessagePort
} = internalBinding('messaging');
const { threadId } = internalBinding('worker');

Expand All @@ -33,13 +35,6 @@ const messageTypes = {
LOAD_SCRIPT: 'loadScript'
};

// Original drain from C++
const originalDrain = MessagePort.prototype.drain;

function drainMessagePort(port) {
return originalDrain.call(port);
}

// We have to mess with the MessagePort prototype a bit, so that a) we can make
// it inherit from EventEmitter, even though it is a C++ class, and b) we do
// not provide methods that are not present in the Browser and not documented
Expand All @@ -51,9 +46,8 @@ const MessagePortPrototype = Object.create(
// Set up the new inheritance chain.
Object.setPrototypeOf(MessagePort, EventEmitter);
Object.setPrototypeOf(MessagePort.prototype, EventEmitter.prototype);
// Finally, purge methods we don't want to be public.
delete MessagePort.prototype.stop;
delete MessagePort.prototype.drain;
// Copy methods that are inherited from HandleWrap, because
// changing the prototype of MessagePort.prototype implicitly removed them.
MessagePort.prototype.ref = MessagePortPrototype.ref;
MessagePort.prototype.unref = MessagePortPrototype.unref;

Expand Down Expand Up @@ -84,7 +78,7 @@ Object.defineProperty(MessagePort.prototype, 'onmessage', {
MessagePortPrototype.start.call(this);
} else {
this.unref();
MessagePortPrototype.stop.call(this);
stopMessagePort(this);
}
}
});
Expand Down Expand Up @@ -152,7 +146,7 @@ function setupPortReferencing(port, eventEmitter, eventName) {
});
eventEmitter.on('removeListener', (name) => {
if (name === eventName && eventEmitter.listenerCount(eventName) === 0) {
MessagePortPrototype.stop.call(port);
stopMessagePort(port);
port.unref();
}
});
Expand Down
13 changes: 9 additions & 4 deletions src/node_messaging.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -733,7 +733,8 @@ void MessagePort::Start(const FunctionCallbackInfo<Value>& args) {
void MessagePort::Stop(const FunctionCallbackInfo<Value>& args) {
Environment* env = Environment::GetCurrent(args);
MessagePort* port;
ASSIGN_OR_RETURN_UNWRAP(&port, args.This());
CHECK(args[0]->IsObject());
ASSIGN_OR_RETURN_UNWRAP(&port, args[0].As<Object>());
if (!port->data_) {
THROW_ERR_CLOSED_MESSAGE_PORT(env);
return;
Expand All @@ -743,7 +744,8 @@ void MessagePort::Stop(const FunctionCallbackInfo<Value>& args) {

void MessagePort::Drain(const FunctionCallbackInfo<Value>& args) {
MessagePort* port;
ASSIGN_OR_RETURN_UNWRAP(&port, args.This());
CHECK(args[0]->IsObject());
ASSIGN_OR_RETURN_UNWRAP(&port, args[0].As<Object>());
port->OnMessage();
}

Expand Down Expand Up @@ -771,8 +773,6 @@ MaybeLocal<Function> GetMessagePortConstructor(

env->SetProtoMethod(m, "postMessage", MessagePort::PostMessage);
env->SetProtoMethod(m, "start", MessagePort::Start);
env->SetProtoMethod(m, "stop", MessagePort::Stop);
env->SetProtoMethod(m, "drain", MessagePort::Drain);

env->set_message_port_constructor_template(m);
}
Expand Down Expand Up @@ -831,6 +831,11 @@ static void InitMessaging(Local<Object> target,
.FromJust();

env->SetMethod(target, "registerDOMException", RegisterDOMException);

// These are not methods on the MessagePort prototype, because
// the browser equivalents do not provide them.
env->SetMethod(target, "stopMessagePort", MessagePort::Stop);
env->SetMethod(target, "drainMessagePort", MessagePort::Drain);
}

} // anonymous namespace
Expand Down