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.

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

src: add BaseObjectPtr nullptr operations #56585

Merged
merged 1 commit into from
Apr 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions src/base_object-inl.h
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,17 @@ BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
return *new (this) BaseObjectPtrImpl(std::move(other));
}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>::BaseObjectPtrImpl(std::nullptr_t)
: BaseObjectPtrImpl() {}

template <typename T, bool kIsWeak>
BaseObjectPtrImpl<T, kIsWeak>& BaseObjectPtrImpl<T, kIsWeak>::operator=(
std::nullptr_t) {
this->~BaseObjectPtrImpl();
return *new (this) BaseObjectPtrImpl();
}

template <typename T, bool kIsWeak>
void BaseObjectPtrImpl<T, kIsWeak>::reset(T* ptr) {
*this = BaseObjectPtrImpl(ptr);
Expand Down Expand Up @@ -289,6 +300,16 @@ bool BaseObjectPtrImpl<T, kIsWeak>::operator !=(
return get() != other.get();
}

template <typename T, bool kIsWeak>
bool operator==(const BaseObjectPtrImpl<T, kIsWeak> ptr, const std::nullptr_t) {
return ptr.get() == nullptr;
}

template <typename T, bool kIsWeak>
bool operator==(const std::nullptr_t, const BaseObjectPtrImpl<T, kIsWeak> ptr) {
return ptr.get() == nullptr;
}

template <typename T, typename... Args>
BaseObjectPtr<T> MakeBaseObject(Args&&... args) {
return BaseObjectPtr<T>(new T(std::forward<Args>(args)...));
Expand Down
10 changes: 10 additions & 0 deletions src/base_object.h
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,9 @@ class BaseObjectPtrImpl final {
inline BaseObjectPtrImpl(BaseObjectPtrImpl&& other);
inline BaseObjectPtrImpl& operator=(BaseObjectPtrImpl&& other);

inline BaseObjectPtrImpl(std::nullptr_t);
inline BaseObjectPtrImpl& operator=(std::nullptr_t);

inline void reset(T* ptr = nullptr);
inline T* get() const;
inline T& operator*() const;
Expand All @@ -309,6 +312,13 @@ class BaseObjectPtrImpl final {
inline BaseObject::PointerData* pointer_data() const;
};

template <typename T, bool kIsWeak>
inline static bool operator==(const BaseObjectPtrImpl<T, kIsWeak>,
const std::nullptr_t);
template <typename T, bool kIsWeak>
inline static bool operator==(const std::nullptr_t,
const BaseObjectPtrImpl<T, kIsWeak>);

template <typename T>
using BaseObjectPtr = BaseObjectPtrImpl<T, false>;
template <typename T>
Expand Down
6 changes: 3 additions & 3 deletions src/histogram.cc
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ BaseObjectPtr<HistogramBase> HistogramBase::Create(
->InstanceTemplate()
->NewInstance(env->context())
.ToLocal(&obj)) {
return BaseObjectPtr<HistogramBase>();
return nullptr;
}

return MakeBaseObject<HistogramBase>(env, obj, options);
Expand All @@ -240,7 +240,7 @@ BaseObjectPtr<HistogramBase> HistogramBase::Create(
->InstanceTemplate()
->NewInstance(env->context())
.ToLocal(&obj)) {
return BaseObjectPtr<HistogramBase>();
return nullptr;
}
return MakeBaseObject<HistogramBase>(env, obj, std::move(histogram));
}
Expand Down Expand Up @@ -394,7 +394,7 @@ BaseObjectPtr<IntervalHistogram> IntervalHistogram::Create(
if (!GetConstructorTemplate(env)
->InstanceTemplate()
->NewInstance(env->context()).ToLocal(&obj)) {
return BaseObjectPtr<IntervalHistogram>();
return nullptr;
}

return MakeBaseObject<IntervalHistogram>(
Expand Down
7 changes: 3 additions & 4 deletions src/node_blob.cc
Original file line number Diff line number Diff line change
Expand Up @@ -169,11 +169,10 @@ BaseObjectPtr<Blob> Blob::Create(Environment* env,

Local<Function> ctor;
if (!GetConstructorTemplate(env)->GetFunction(env->context()).ToLocal(&ctor))
return BaseObjectPtr<Blob>();
return nullptr;

Local<Object> obj;
if (!ctor->NewInstance(env->context()).ToLocal(&obj))
return BaseObjectPtr<Blob>();
if (!ctor->NewInstance(env->context()).ToLocal(&obj)) return nullptr;

return MakeBaseObject<Blob>(env, obj, data_queue);
}
Expand Down Expand Up @@ -319,7 +318,7 @@ BaseObjectPtr<Blob::Reader> Blob::Reader::Create(Environment* env,
->InstanceTemplate()
->NewInstance(env->context())
.ToLocal(&obj)) {
return BaseObjectPtr<Blob::Reader>();
return nullptr;
}

return MakeBaseObject<Blob::Reader>(env, obj, std::move(blob));
Expand Down
2 changes: 1 addition & 1 deletion src/node_http2.cc
Original file line number Diff line number Diff line change
Expand Up @@ -843,7 +843,7 @@ void Http2Session::Close(uint32_t code, bool socket_closed) {
// but this is faster and does not fail if the stream is not found.
BaseObjectPtr<Http2Stream> Http2Session::FindStream(int32_t id) {
auto s = streams_.find(id);
return s != streams_.end() ? s->second : BaseObjectPtr<Http2Stream>();
return s != streams_.end() ? s->second : nullptr;
}

bool Http2Session::CanAddStream() {
Expand Down
6 changes: 3 additions & 3 deletions src/node_sockaddr.cc
Original file line number Diff line number Diff line change
Expand Up @@ -553,7 +553,7 @@ BaseObjectPtr<SocketAddressBlockListWrap> SocketAddressBlockListWrap::New(
if (!env->blocklist_constructor_template()
->InstanceTemplate()
->NewInstance(env->context()).ToLocal(&obj)) {
return BaseObjectPtr<SocketAddressBlockListWrap>();
return nullptr;
}
BaseObjectPtr<SocketAddressBlockListWrap> wrap =
MakeBaseObject<SocketAddressBlockListWrap>(env, obj);
Expand All @@ -568,7 +568,7 @@ BaseObjectPtr<SocketAddressBlockListWrap> SocketAddressBlockListWrap::New(
if (!env->blocklist_constructor_template()
->InstanceTemplate()
->NewInstance(env->context()).ToLocal(&obj)) {
return BaseObjectPtr<SocketAddressBlockListWrap>();
return nullptr;
}
BaseObjectPtr<SocketAddressBlockListWrap> wrap =
MakeBaseObject<SocketAddressBlockListWrap>(
Expand Down Expand Up @@ -775,7 +775,7 @@ BaseObjectPtr<SocketAddressBase> SocketAddressBase::Create(
if (!GetConstructorTemplate(env)
->InstanceTemplate()
->NewInstance(env->context()).ToLocal(&obj)) {
return BaseObjectPtr<SocketAddressBase>();
return nullptr;
}

return MakeBaseObject<SocketAddressBase>(env, obj, std::move(address));
Expand Down
4 changes: 2 additions & 2 deletions src/node_sqlite.cc
Original file line number Diff line number Diff line change
Expand Up @@ -1588,7 +1588,7 @@ BaseObjectPtr<StatementSync> StatementSync::Create(Environment* env,
->InstanceTemplate()
->NewInstance(env->context())
.ToLocal(&obj)) {
return BaseObjectPtr<StatementSync>();
return nullptr;
}

return MakeBaseObject<StatementSync>(env, obj, db, stmt);
Expand Down Expand Up @@ -1616,7 +1616,7 @@ BaseObjectPtr<Session> Session::Create(Environment* env,
->InstanceTemplate()
->NewInstance(env->context())
.ToLocal(&obj)) {
return BaseObjectPtr<Session>();
return nullptr;
}

return MakeBaseObject<Session>(env, obj, std::move(database), session);
Expand Down
4 changes: 2 additions & 2 deletions src/quic/session.h
Original file line number Diff line number Diff line change
Expand Up @@ -135,11 +135,11 @@ class Session final : public AsyncWrap, private SessionTicket::AppData::Source {
const CID::Factory* cid_factory = &CID::Factory::random();
// If the CID::Factory is a base object, we keep a reference to it
// so that it cannot be garbage collected.
BaseObjectPtr<BaseObject> cid_factory_ref = {};
BaseObjectPtr<BaseObject> cid_factory_ref;

// If the application provider is specified, it will be used to create
// the underlying Application instance for the session.
BaseObjectPtr<ApplicationProvider> application_provider = {};
BaseObjectPtr<ApplicationProvider> application_provider;

// When true, QLog output will be enabled for the session.
bool qlog = false;
Expand Down
36 changes: 36 additions & 0 deletions test/cctest/test_base_object_ptr.cc
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,42 @@ TEST_F(BaseObjectPtrTest, Moveable) {
EXPECT_EQ(realm->base_object_created_after_bootstrap(), 0);
}

TEST_F(BaseObjectPtrTest, Nullptr) {
const HandleScope handle_scope(isolate_);
const Argv argv;
Env env_{handle_scope, argv};
Environment* env = *env_;
Realm* realm = env->principal_realm();

BaseObjectPtr<DummyBaseObject> ptr = nullptr;
EXPECT_EQ(nullptr, ptr);
EXPECT_EQ(ptr, nullptr);
EXPECT_EQ(nullptr, ptr.get());

// Implicit constructor.
BaseObjectPtr<DummyBaseObject> ptr2 = []() -> BaseObjectPtr<DummyBaseObject> {
return nullptr;
}();
EXPECT_EQ(nullptr, ptr2);
EXPECT_EQ(ptr2, nullptr);
EXPECT_EQ(nullptr, ptr2.get());

BaseObjectWeakPtr<DummyBaseObject> weak_ptr{ptr};
EXPECT_EQ(nullptr, weak_ptr);
EXPECT_EQ(weak_ptr, nullptr);
EXPECT_EQ(nullptr, weak_ptr.get());
ptr.reset();
EXPECT_EQ(weak_ptr.get(), nullptr);

// No object creation with nullptr.
EXPECT_EQ(realm->base_object_created_after_bootstrap(), 0);

BaseObjectPtr<DummyBaseObject> ptr4 = DummyBaseObject::NewDetached(env);
EXPECT_NE(nullptr, ptr4);
EXPECT_NE(ptr4, nullptr);
EXPECT_EQ(realm->base_object_created_after_bootstrap(), 1);
}

TEST_F(BaseObjectPtrTest, NestedClasses) {
class ObjectWithPtr : public BaseObject {
public:
Expand Down
Loading