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

src: use better return types in KVStore #54539

Closed
wants to merge 2 commits into from
Closed

src: use better return types in KVStore #54539

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d33af3
src: use better return types in KVStore
targos Aug 24, 2024
6fcc1a6
fixup
targos Aug 24, 2024
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
2 changes: 1 addition & 1 deletion src/inspector_profiler.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ void StartProfilers(Environment* env) {
}, env);

std::string coverage_str =
env->env_vars()->Get("NODE_V8_COVERAGE").FromMaybe(std::string());
env->env_vars()->Get("NODE_V8_COVERAGE").value_or(std::string());
if (!coverage_str.empty() || env->options()->test_runner_coverage) {
CHECK_NULL(env->coverage_connection());
env->set_coverage_connection(std::make_unique<V8CoverageConnection>(env));
Expand Down
5 changes: 4 additions & 1 deletion src/node_credentials.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,10 @@ bool SafeGetenv(const char* key,
env_vars = per_process::system_environment;
}

return env_vars->Get(key).To(text);
std::optional<std::string> value = env_vars->Get(key);
if (!value.has_value()) return false;
*text = value.value();
return true;
}

static void SafeGetenv(const FunctionCallbackInfo<Value>& args) {
Expand Down
2 changes: 1 addition & 1 deletion src/node_dotenv.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ void Dotenv::SetEnvironment(node::Environment* env) {

auto existing = env->env_vars()->Get(key.data());

if (existing.IsNothing()) {
if (!existing.has_value()) {
env->env_vars()->Set(
isolate,
v8::String::NewFromUtf8(
Expand Down
39 changes: 20 additions & 19 deletions src/node_env_var.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#include "node_process-inl.h"

#include <time.h> // tzset(), _tzset()
#include <optional>

namespace node {
using v8::Array;
Expand All @@ -19,6 +20,7 @@ using v8::Integer;
using v8::Intercepted;
using v8::Isolate;
using v8::Just;
using v8::JustVoid;
using v8::Local;
using v8::Maybe;
using v8::MaybeLocal;
Expand All @@ -38,7 +40,7 @@ using v8::Value;
class RealEnvStore final : public KVStore {
public:
MaybeLocal<String> Get(Isolate* isolate, Local<String> key) const override;
Maybe<std::string> Get(const char* key) const override;
std::optional<std::string> Get(const char* key) const override;
void Set(Isolate* isolate, Local<String> key, Local<String> value) override;
int32_t Query(Isolate* isolate, Local<String> key) const override;
int32_t Query(const char* key) const override;
Expand All @@ -49,7 +51,7 @@ class RealEnvStore final : public KVStore {
class MapKVStore final : public KVStore {
public:
MaybeLocal<String> Get(Isolate* isolate, Local<String> key) const override;
Maybe<std::string> Get(const char* key) const override;
std::optional<std::string> Get(const char* key) const override;
void Set(Isolate* isolate, Local<String> key, Local<String> value) override;
int32_t Query(Isolate* isolate, Local<String> key) const override;
int32_t Query(const char* key) const override;
Expand Down Expand Up @@ -101,7 +103,7 @@ void DateTimeConfigurationChangeNotification(
}
}

Maybe<std::string> RealEnvStore::Get(const char* key) const {
std::optional<std::string> RealEnvStore::Get(const char* key) const {
Mutex::ScopedLock lock(per_process::env_var_mutex);

size_t init_sz = 256;
Expand All @@ -116,19 +118,19 @@ Maybe<std::string> RealEnvStore::Get(const char* key) const {
}

if (ret >= 0) { // Env key value fetch success.
return Just(std::string(*val, init_sz));
return std::string(*val, init_sz);
}

return Nothing<std::string>();
return std::nullopt;
}

MaybeLocal<String> RealEnvStore::Get(Isolate* isolate,
Local<String> property) const {
node::Utf8Value key(isolate, property);
Maybe<std::string> value = Get(*key);
std::optional<std::string> value = Get(*key);

if (value.IsJust()) {
std::string val = value.FromJust();
if (value.has_value()) {
std::string val = value.value();
return String::NewFromUtf8(
isolate, val.data(), NewStringType::kNormal, val.size());
}
Expand Down Expand Up @@ -229,17 +231,17 @@ std::shared_ptr<KVStore> KVStore::Clone(Isolate* isolate) const {
return copy;
}

Maybe<std::string> MapKVStore::Get(const char* key) const {
std::optional<std::string> MapKVStore::Get(const char* key) const {
Mutex::ScopedLock lock(mutex_);
auto it = map_.find(key);
return it == map_.end() ? Nothing<std::string>() : Just(it->second);
return it == map_.end() ? std::nullopt : std::make_optional(it->second);
}

MaybeLocal<String> MapKVStore::Get(Isolate* isolate, Local<String> key) const {
Utf8Value str(isolate, key);
Maybe<std::string> value = Get(*str);
if (value.IsNothing()) return Local<String>();
std::string val = value.FromJust();
std::optional<std::string> value = Get(*str);
if (value.has_value()) return MaybeLocal<String>();
std::string val = value.value();
return String::NewFromUtf8(
isolate, val.data(), NewStringType::kNormal, val.size());
}
Expand Down Expand Up @@ -291,30 +293,29 @@ std::shared_ptr<KVStore> KVStore::CreateMapKVStore() {
return std::make_shared<MapKVStore>();
}

Maybe<bool> KVStore::AssignFromObject(Local<Context> context,
Maybe<void> KVStore::AssignFromObject(Local<Context> context,
Local<Object> entries) {
Isolate* isolate = context->GetIsolate();
HandleScope handle_scope(isolate);
Local<Array> keys;
if (!entries->GetOwnPropertyNames(context).ToLocal(&keys))
return Nothing<bool>();
return Nothing<void>();
uint32_t keys_length = keys->Length();
for (uint32_t i = 0; i < keys_length; i++) {
Local<Value> key;
if (!keys->Get(context, i).ToLocal(&key))
return Nothing<bool>();
if (!keys->Get(context, i).ToLocal(&key)) return Nothing<void>();
if (!key->IsString()) continue;

Local<Value> value;
Local<String> value_string;
if (!entries->Get(context, key).ToLocal(&value) ||
!value->ToString(context).ToLocal(&value_string)) {
return Nothing<bool>();
return Nothing<void>();
}

Set(isolate, key.As<String>(), value_string);
}
return Just(true);
return JustVoid();
}

// TODO(bnoordhuis) Not super efficient but called infrequently. Not worth
Expand Down
20 changes: 12 additions & 8 deletions src/node_worker.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,8 +531,12 @@ void Worker::New(const FunctionCallbackInfo<Value>& args) {
} else if (args[1]->IsObject()) {
// User provided env.
env_vars = KVStore::CreateMapKVStore();
env_vars->AssignFromObject(isolate->GetCurrentContext(),
args[1].As<Object>());
if (env_vars
->AssignFromObject(isolate->GetCurrentContext(),
args[1].As<Object>())
.IsNothing()) {
return;
}
} else {
// Env is shared.
env_vars = env->env_vars();
Expand All @@ -542,21 +546,21 @@ void Worker::New(const FunctionCallbackInfo<Value>& args) {
per_isolate_opts.reset(new PerIsolateOptions());

HandleEnvOptions(per_isolate_opts->per_env, [&env_vars](const char* name) {
return env_vars->Get(name).FromMaybe("");
return env_vars->Get(name).value_or("");
});

#ifndef NODE_WITHOUT_NODE_OPTIONS
std::string node_options;
if (env_vars->Get("NODE_OPTIONS").To(&node_options)) {
std::optional<std::string> node_options = env_vars->Get("NODE_OPTIONS");
if (node_options.has_value()) {
std::vector<std::string> errors{};
std::vector<std::string> env_argv =
ParseNodeOptionsEnvVar(node_options, &errors);
ParseNodeOptionsEnvVar(node_options.value(), &errors);
// [0] is expected to be the program name, add dummy string.
env_argv.insert(env_argv.begin(), "");
std::vector<std::string> invalid_args{};

std::string parent_node_options;
USE(env->env_vars()->Get("NODE_OPTIONS").To(&parent_node_options));
std::optional<std::string> parent_node_options =
env->env_vars()->Get("NODE_OPTIONS");

// If the worker code passes { env: { ...process.env, ... } } or
// the NODE_OPTIONS is otherwise character-for-character equal to the
Expand Down
5 changes: 3 additions & 2 deletions src/util.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
#include <bit>
#include <limits>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <string_view>
Expand Down Expand Up @@ -306,7 +307,7 @@ class KVStore {

virtual v8::MaybeLocal<v8::String> Get(v8::Isolate* isolate,
v8::Local<v8::String> key) const = 0;
virtual v8::Maybe<std::string> Get(const char* key) const = 0;
virtual std::optional<std::string> Get(const char* key) const = 0;
virtual void Set(v8::Isolate* isolate,
v8::Local<v8::String> key,
v8::Local<v8::String> value) = 0;
Expand All @@ -317,7 +318,7 @@ class KVStore {
virtual v8::Local<v8::Array> Enumerate(v8::Isolate* isolate) const = 0;

virtual std::shared_ptr<KVStore> Clone(v8::Isolate* isolate) const;
virtual v8::Maybe<bool> AssignFromObject(v8::Local<v8::Context> context,
virtual v8::Maybe<void> AssignFromObject(v8::Local<v8::Context> context,
v8::Local<v8::Object> entries);
v8::Maybe<bool> AssignToObject(v8::Isolate* isolate,
v8::Local<v8::Context> context,
Expand Down
Loading