From 0d602fc9aa7be629fa3e0f751d4ff2df4072806d Mon Sep 17 00:00:00 2001
From: Darshan Sen <darshan.sen@postman.com>
Date: Sat, 1 Jan 2022 12:55:20 +0530
Subject: [PATCH] src: add napi_get_symbol_to_string_tag

Fixes: https://github.com/nodejs/node/issues/41358

Signed-off-by: Darshan Sen <darshan.sen@postman.com>
---
 doc/api/n-api.md                              | 24 ++++++++++++
 src/js_native_api.h                           |  4 ++
 src/js_native_api_v8.cc                       | 11 ++++++
 test/js-native-api/test_properties/test.js    | 10 ++---
 .../test_properties/test_properties.c         |  6 +++
 test/js-native-api/test_reference/test.js     |  7 ++++
 .../test_reference/test_reference.c           |  8 ++++
 test/js-native-api/test_symbol/test4.js       | 39 +++++++++++++++++++
 test/js-native-api/test_symbol/test_symbol.c  |  8 ++++
 9 files changed, 111 insertions(+), 6 deletions(-)
 create mode 100644 test/js-native-api/test_symbol/test4.js

diff --git a/doc/api/n-api.md b/doc/api/n-api.md
index c146a6d661dddb..1b7f51a3c8b7f1 100644
--- a/doc/api/n-api.md
+++ b/doc/api/n-api.md
@@ -2492,6 +2492,30 @@ This API creates a JavaScript `symbol` value from a UTF8-encoded C string.
 The JavaScript `symbol` type is described in [Section 19.4][]
 of the ECMAScript Language Specification.
 
+#### `napi_get_symbol_to_string_tag`
+
+<!-- YAML
+added: REPLACEME
+napiVersion: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+```c
+napi_status napi_get_symbol_to_string_tag(napi_env env,
+                                          napi_value* result)
+```
+
+* `[in] env`: The environment that the API is invoked under.
+* `[out] result`: A `napi_value` representing a JavaScript `symbol`.
+
+Returns `napi_ok` if the API succeeded.
+
+This API returns the JavaScript well-known symbol, `Symbol.toStringTag`.
+
+The JavaScript `symbol` type is described in [Section 19.4][]
+of the ECMAScript Language Specification.
+
 #### `napi_create_typedarray`
 
 <!-- YAML
diff --git a/src/js_native_api.h b/src/js_native_api.h
index d72e7f4e997270..fa12692b1bf4b8 100644
--- a/src/js_native_api.h
+++ b/src/js_native_api.h
@@ -93,6 +93,10 @@ NAPI_EXTERN napi_status napi_create_string_utf16(napi_env env,
 NAPI_EXTERN napi_status napi_create_symbol(napi_env env,
                                            napi_value description,
                                            napi_value* result);
+#ifdef NAPI_EXPERIMENTAL
+NAPI_EXTERN napi_status napi_get_symbol_to_string_tag(napi_env env,
+                                                      napi_value* result);
+#endif  // NAPI_EXPERIMENTAL
 NAPI_EXTERN napi_status napi_create_function(napi_env env,
                                              const char* utf8name,
                                              size_t length,
diff --git a/src/js_native_api_v8.cc b/src/js_native_api_v8.cc
index 72f911cab6c203..81ec3ae80500c2 100644
--- a/src/js_native_api_v8.cc
+++ b/src/js_native_api_v8.cc
@@ -1662,6 +1662,17 @@ napi_status napi_create_symbol(napi_env env,
   return napi_clear_last_error(env);
 }
 
+napi_status napi_get_symbol_to_string_tag(napi_env env,
+                                          napi_value* result) {
+  CHECK_ENV(env);
+  CHECK_ARG(env, result);
+
+  *result = v8impl::JsValueFromV8LocalValue(
+      v8::Symbol::GetToStringTag(env->isolate));
+
+  return napi_clear_last_error(env);
+}
+
 static inline napi_status set_error_code(napi_env env,
                                          v8::Local<v8::Value> error,
                                          napi_value code,
diff --git a/test/js-native-api/test_properties/test.js b/test/js-native-api/test_properties/test.js
index 704002dfc74f3a..edd73c3f8a7f81 100644
--- a/test/js-native-api/test_properties/test.js
+++ b/test/js-native-api/test_properties/test.js
@@ -35,12 +35,10 @@ assert.ok(!propertyNames.includes('readwriteAccessor2'));
 assert.ok(!propertyNames.includes('readonlyAccessor1'));
 assert.ok(!propertyNames.includes('readonlyAccessor2'));
 
-// Validate property created with symbol
-const start = 'Symbol('.length;
-const end = start + 'NameKeySymbol'.length;
-const symbolDescription =
-    String(Object.getOwnPropertySymbols(test_object)[0]).slice(start, end);
-assert.strictEqual(symbolDescription, 'NameKeySymbol');
+// Validate properties created with symbol
+const propertySymbols = Object.getOwnPropertySymbols(test_object);
+assert.strictEqual(String(propertySymbols[0]), 'Symbol(NameKeySymbol)');
+assert.strictEqual(String(propertySymbols[1]), 'Symbol(Symbol.toStringTag)');
 
 // The napi_writable attribute should be ignored for accessors.
 const readwriteAccessor1Descriptor =
diff --git a/test/js-native-api/test_properties/test_properties.c b/test/js-native-api/test_properties/test_properties.c
index c778601aa7489b..894fdb3438bc58 100644
--- a/test/js-native-api/test_properties/test_properties.c
+++ b/test/js-native-api/test_properties/test_properties.c
@@ -1,3 +1,4 @@
+#define NAPI_EXPERIMENTAL
 #include <js_native_api.h>
 #include "../common.h"
 
@@ -77,6 +78,10 @@ napi_value Init(napi_env env, napi_value exports) {
   NODE_API_CALL(env,
       napi_create_symbol(env, symbol_description, &name_symbol));
 
+  napi_value to_string_tag_symbol;
+  NODE_API_CALL(env,
+      napi_get_symbol_to_string_tag(env, &to_string_tag_symbol));
+
   napi_property_descriptor properties[] = {
     { "echo", 0, Echo, 0, 0, 0, napi_enumerable, 0 },
     { "readwriteValue", 0, 0, 0, 0, number, napi_enumerable | napi_writable, 0 },
@@ -84,6 +89,7 @@ napi_value Init(napi_env env, napi_value exports) {
     { "hiddenValue", 0, 0, 0, 0, number, napi_default, 0},
     { NULL, name_value, 0, 0, 0, number, napi_enumerable, 0},
     { NULL, name_symbol, 0, 0, 0, number, napi_enumerable, 0},
+    { NULL, to_string_tag_symbol, 0, 0, 0, number, napi_enumerable, 0},
     { "readwriteAccessor1", 0, 0, GetValue, SetValue, 0, napi_default, 0},
     { "readwriteAccessor2", 0, 0, GetValue, SetValue, 0, napi_writable, 0},
     { "readonlyAccessor1", 0, 0, GetValue, NULL, 0, napi_default, 0},
diff --git a/test/js-native-api/test_reference/test.js b/test/js-native-api/test_reference/test.js
index 0dc9e553300060..60457c438f7109 100644
--- a/test/js-native-api/test_reference/test.js
+++ b/test/js-native-api/test_reference/test.js
@@ -21,6 +21,13 @@ async function runTests() {
   })();
   test_reference.deleteReference();
 
+  (() => {
+    const symbol = test_reference.createToStringTagSymbol();
+    test_reference.createReference(symbol, 0);
+    assert.strictEqual(test_reference.referenceValue, symbol);
+  })();
+  test_reference.deleteReference();
+
   (() => {
     const value = test_reference.createExternal();
     assert.strictEqual(test_reference.finalizeCount, 0);
diff --git a/test/js-native-api/test_reference/test_reference.c b/test/js-native-api/test_reference/test_reference.c
index 7b770cb8766775..c4ef1e029b2bf5 100644
--- a/test/js-native-api/test_reference/test_reference.c
+++ b/test/js-native-api/test_reference/test_reference.c
@@ -1,3 +1,4 @@
+#define NAPI_EXPERIMENTAL
 #include <stdlib.h>
 #include <assert.h>
 #include <js_native_api.h>
@@ -49,6 +50,12 @@ static napi_value CreateSymbol(napi_env env, napi_callback_info info) {
     return result_symbol;
 }
 
+static napi_value CreateToStringTagSymbol(napi_env env, napi_callback_info info) {
+    napi_value result_symbol;
+    NODE_API_CALL(env, napi_get_symbol_to_string_tag(env, &result_symbol));
+    return result_symbol;
+}
+
 static napi_value
 CreateExternalWithFinalize(napi_env env, napi_callback_info info) {
   napi_value result;
@@ -190,6 +197,7 @@ napi_value Init(napi_env env, napi_value exports) {
     DECLARE_NODE_API_PROPERTY("checkExternal", CheckExternal),
     DECLARE_NODE_API_PROPERTY("createReference", CreateReference),
     DECLARE_NODE_API_PROPERTY("createSymbol", CreateSymbol),
+    DECLARE_NODE_API_PROPERTY("createToStringTagSymbol", CreateToStringTagSymbol),
     DECLARE_NODE_API_PROPERTY("deleteReference", DeleteReference),
     DECLARE_NODE_API_PROPERTY("incrementRefcount", IncrementRefcount),
     DECLARE_NODE_API_PROPERTY("decrementRefcount", DecrementRefcount),
diff --git a/test/js-native-api/test_symbol/test4.js b/test/js-native-api/test_symbol/test4.js
new file mode 100644
index 00000000000000..a41c0927500075
--- /dev/null
+++ b/test/js-native-api/test_symbol/test4.js
@@ -0,0 +1,39 @@
+'use strict';
+const common = require('../../common');
+const {
+  deepStrictEqual,
+  strictEqual,
+} = require('assert');
+
+// Testing api calls for test_symbol.ToStringTag
+const { ToStringTag } = require(`./build/${common.buildType}/test_symbol`);
+
+const toStringTagSymbol = ToStringTag();
+strictEqual(typeof toStringTagSymbol, 'symbol');
+strictEqual(toStringTagSymbol, ToStringTag());
+strictEqual(toStringTagSymbol, Symbol.toStringTag);
+strictEqual(toStringTagSymbol.toString(), 'Symbol(Symbol.toStringTag)');
+
+{
+  const tag = 'MyTag';
+  const object = { [toStringTagSymbol]: tag };
+
+  deepStrictEqual(Object.keys(object), []);
+  deepStrictEqual(Object.getOwnPropertyNames(object), []);
+  deepStrictEqual(Object.getOwnPropertySymbols(object), [ Symbol.toStringTag ]);
+
+  strictEqual(object[toStringTagSymbol], tag);
+  strictEqual(object.toString(), `[object ${tag}]`);
+}
+
+{
+  const tag = 5;
+  const object = { [toStringTagSymbol]: tag };
+
+  deepStrictEqual(Object.keys(object), []);
+  deepStrictEqual(Object.getOwnPropertyNames(object), []);
+  deepStrictEqual(Object.getOwnPropertySymbols(object), [ Symbol.toStringTag ]);
+
+  strictEqual(object[toStringTagSymbol], tag);
+  strictEqual(object.toString(), '[object Object]');
+}
diff --git a/test/js-native-api/test_symbol/test_symbol.c b/test/js-native-api/test_symbol/test_symbol.c
index a87b275c938fbf..9b0c195b963a7f 100644
--- a/test/js-native-api/test_symbol/test_symbol.c
+++ b/test/js-native-api/test_symbol/test_symbol.c
@@ -1,3 +1,4 @@
+#define NAPI_EXPERIMENTAL
 #include <js_native_api.h>
 #include "../common.h"
 
@@ -23,10 +24,17 @@ static napi_value New(napi_env env, napi_callback_info info) {
   return symbol;
 }
 
+static napi_value ToStringTag(napi_env env, napi_callback_info info) {
+  napi_value symbol;
+  NODE_API_CALL(env, napi_get_symbol_to_string_tag(env, &symbol));
+  return symbol;
+}
+
 EXTERN_C_START
 napi_value Init(napi_env env, napi_value exports) {
   napi_property_descriptor properties[] = {
     DECLARE_NODE_API_PROPERTY("New", New),
+    DECLARE_NODE_API_PROPERTY("ToStringTag", ToStringTag),
   };
 
   NODE_API_CALL(env, napi_define_properties(