Skip to content

Commit

Permalink
src: use new V8 API to define stream accessor
Browse files Browse the repository at this point in the history
Define XxxStream.prototype.onread as an accessor in JavaScript sense.

Previously it was defined via soon-to-be-deprecated
`v8::ObjectTemplate::SetAccessor(..)` which used to call setter even
for property stores via stream object.

The replacement V8 API `v8::ObjectTemplate::SetNativeDataProperty(..)`
defines a properly behaving data property and thus a store to a stream
object will not trigger the "onread" setter callback.

In order to preserve the desired behavior of storing the value in the
receiver's internal field the "onread" property should be defined as
a proper JavaScript accessor.

PR-URL: nodejs#53084
Refs: v8/v8@46c241e
Refs: v8/v8@6ec8839
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
  • Loading branch information
isheludko authored and bmeck committed Jun 22, 2024
1 parent cec55f7 commit e032f48
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 18 deletions.
15 changes: 7 additions & 8 deletions src/base_object-inl.h
Original file line number Diff line number Diff line change
Expand Up @@ -132,19 +132,18 @@ v8::EmbedderGraph::Node::Detachedness BaseObject::GetDetachedness() const {

template <int Field>
void BaseObject::InternalFieldGet(
v8::Local<v8::Name> property,
const v8::PropertyCallbackInfo<v8::Value>& info) {
info.GetReturnValue().Set(
info.This()->GetInternalField(Field).As<v8::Value>());
const v8::FunctionCallbackInfo<v8::Value>& args) {
args.GetReturnValue().Set(
args.This()->GetInternalField(Field).As<v8::Value>());
}

template <int Field, bool (v8::Value::*typecheck)() const>
void BaseObject::InternalFieldSet(v8::Local<v8::Name> property,
v8::Local<v8::Value> value,
const v8::PropertyCallbackInfo<void>& info) {
void BaseObject::InternalFieldSet(
const v8::FunctionCallbackInfo<v8::Value>& args) {
v8::Local<v8::Value> value = args[0];
// This could be e.g. value->IsFunction().
CHECK(((*value)->*typecheck)());
info.This()->SetInternalField(Field, value);
args.This()->SetInternalField(Field, value);
}

bool BaseObject::has_pointer_data() const {
Expand Down
7 changes: 2 additions & 5 deletions src/base_object.h
Original file line number Diff line number Diff line change
Expand Up @@ -111,12 +111,9 @@ class BaseObject : public MemoryRetainer {

// Setter/Getter pair for internal fields that can be passed to SetAccessor.
template <int Field>
static void InternalFieldGet(v8::Local<v8::Name> property,
const v8::PropertyCallbackInfo<v8::Value>& info);
static void InternalFieldGet(const v8::FunctionCallbackInfo<v8::Value>& args);
template <int Field, bool (v8::Value::*typecheck)() const>
static void InternalFieldSet(v8::Local<v8::Name> property,
v8::Local<v8::Value> value,
const v8::PropertyCallbackInfo<void>& info);
static void InternalFieldSet(const v8::FunctionCallbackInfo<v8::Value>& args);

// This is a bit of a hack. See the override in async_wrap.cc for details.
virtual bool IsDoneInitializing() const;
Expand Down
36 changes: 31 additions & 5 deletions src/stream_base.cc
Original file line number Diff line number Diff line change
Expand Up @@ -492,6 +492,29 @@ Local<Object> StreamBase::GetObject() {
return GetAsyncWrap()->object();
}

void StreamBase::AddAccessor(v8::Isolate* isolate,
v8::Local<v8::Signature> signature,
enum v8::PropertyAttribute attributes,
v8::Local<v8::FunctionTemplate> t,
JSMethodFunction* getter,
JSMethodFunction* setter,
v8::Local<v8::String> string) {
Local<FunctionTemplate> getter_templ =
NewFunctionTemplate(isolate,
getter,
signature,
ConstructorBehavior::kThrow,
SideEffectType::kHasNoSideEffect);
Local<FunctionTemplate> setter_templ =
NewFunctionTemplate(isolate,
setter,
signature,
ConstructorBehavior::kThrow,
SideEffectType::kHasSideEffect);
t->PrototypeTemplate()->SetAccessorProperty(
string, getter_templ, setter_templ, attributes);
}

void StreamBase::AddMethod(Isolate* isolate,
Local<Signature> signature,
enum PropertyAttribute attributes,
Expand Down Expand Up @@ -561,11 +584,14 @@ void StreamBase::AddMethods(IsolateData* isolate_data,
JSMethod<&StreamBase::WriteString<LATIN1>>);
t->PrototypeTemplate()->Set(FIXED_ONE_BYTE_STRING(isolate, "isStreamBase"),
True(isolate));
t->PrototypeTemplate()->SetAccessor(
FIXED_ONE_BYTE_STRING(isolate, "onread"),
BaseObject::InternalFieldGet<StreamBase::kOnReadFunctionField>,
BaseObject::InternalFieldSet<StreamBase::kOnReadFunctionField,
&Value::IsFunction>);
AddAccessor(isolate,
sig,
static_cast<PropertyAttribute>(DontDelete | DontEnum),
t,
BaseObject::InternalFieldGet<StreamBase::kOnReadFunctionField>,
BaseObject::InternalFieldSet<StreamBase::kOnReadFunctionField,
&Value::IsFunction>,
FIXED_ONE_BYTE_STRING(isolate, "onread"));
}

void StreamBase::RegisterExternalReferences(
Expand Down
7 changes: 7 additions & 0 deletions src/stream_base.h
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,13 @@ class StreamBase : public StreamResource {
EmitToJSStreamListener default_listener_;

void SetWriteResult(const StreamWriteResult& res);
static void AddAccessor(v8::Isolate* isolate,
v8::Local<v8::Signature> sig,
enum v8::PropertyAttribute attributes,
v8::Local<v8::FunctionTemplate> t,
JSMethodFunction* getter,
JSMethodFunction* setter,
v8::Local<v8::String> str);
static void AddMethod(v8::Isolate* isolate,
v8::Local<v8::Signature> sig,
enum v8::PropertyAttribute attributes,
Expand Down

0 comments on commit e032f48

Please sign in to comment.