lib: support returning Safe collections from C++

Author: ExE-Boss

src/env.cc

@@ -273,6 +273,29 @@ void Environment::CreateProperties() {
  CHECK(primordials->IsObject());
  set_primordials(primordials.As<Object>());
 
+ Local<String> prototype_string =
+ FIXED_ONE_BYTE_STRING(isolate(), "prototype");
+
+#define V(EnvPropertyName, PrimordialsPropertyName) \
+ { \
+ Local<Value> ctor = \
+ primordials \
+ ->Get(ctx, \
+ FIXED_ONE_BYTE_STRING(isolate(), PrimordialsPropertyName)) \
+ .ToLocalChecked(); \
+ CHECK(ctor->IsObject()); \
+ Local<Value> prototype = \
+ ctor.As<Object>()->Get(ctx, prototype_string).ToLocalChecked(); \
+ CHECK(prototype->IsObject()); \
+ set_##EnvPropertyName(prototype.As<Object>()); \
+ }
+
+ V(primordials_safe_map_prototype_object, "SafeMap");
+ V(primordials_safe_set_prototype_object, "SafeSet");
+ V(primordials_safe_weak_map_prototype_object, "SafeWeakMap");
+ V(primordials_safe_weak_set_prototype_object, "SafeWeakSet");
+#undef V
+
  Local<Object> process_object =
  node::CreateProcessObject(this).FromMaybe(Local<Object>());
  set_process_object(process_object);

src/env.h

@@ -550,6 +550,10 @@ constexpr size_t kFsStatsBufferLength =
  V(prepare_stack_trace_callback, v8::Function) \
  V(process_object, v8::Object) \
  V(primordials, v8::Object) \
+ V(primordials_safe_map_prototype_object, v8::Object) \
+ V(primordials_safe_set_prototype_object, v8::Object) \
+ V(primordials_safe_weak_map_prototype_object, v8::Object) \
+ V(primordials_safe_weak_set_prototype_object, v8::Object) \
  V(promise_hook_handler, v8::Function) \
  V(promise_reject_callback, v8::Function) \
  V(script_data_constructor_function, v8::Function) \

src/node_options.cc

@@ -917,6 +917,12 @@ void GetOptions(const FunctionCallbackInfo<Value>& args) {
  });
 
  Local<Map> options = Map::New(isolate);
+ if (options
+ ->SetPrototype(context, env->primordials_safe_map_prototype_object())
+ .IsNothing()) {
+ return;
+ }
+
  for (const auto& item : _ppop_instance.options_) {
  Local<Value> value;
  const auto& option_info = item.second;

src/uv.cc

@@ -81,6 +81,8 @@ void GetErrMap(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = env->isolate();
  Local<Context> context = env->context();
 
+ // This can't return a SafeMap, because the uv binding can be referenced
+ // by user code by using `process.binding('uv').getErrorMap()`:
  Local<Map> err_map = Map::New(isolate);
 
  size_t errors_len = arraysize(per_process::uv_errors_map);

test/parallel/test-options-binding.js

@@ -0,0 +1,16 @@
+// Flags: --expose-internals
+'use strict';
+
+require('../common');
+const { internalBinding, primordials } = require('internal/test/binding');
+const {
+ SafeMap,
+} = primordials;
+
+const options = internalBinding('options');
+const assert = require('assert');
+
+assert(
+ options.getOptions() instanceof SafeMap,
+ "internalBinding('options').getOptions() returns SafeMap",
+);