src: add error code helpers to src/node_errors.h

This commit adds node::ERR_*(isolate, message) helpers in
the C++ land to assign error codes to existing C++ errors.

The following errors are added:

- ERR_MEMORY_ALLOCATION_FAILED
- ERR_STRING_TOO_LARGE

PR-URL: #19739
Fixes: #3175
Fixes: #9489
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>

Author: joyeecheung

doc/api/errors.md

@@ -1242,6 +1242,12 @@ An attempt was made to open an IPC communication channel with a synchronously
 forked Node.js process. See the documentation for the [`child_process`][] module
 for more information.
 
+<a id="ERR_MEMORY_ALLOCATION_FAILED"></a>
+### ERR_MEMORY_ALLOCATION_FAILED
+
+An attempt was made to allocate memory (usually in the C++ layer) but it
+failed.
+
 <a id="ERR_METHOD_NOT_IMPLEMENTED"></a>
 ### ERR_METHOD_NOT_IMPLEMENTED
 
@@ -1468,6 +1474,12 @@ additional details.
 A stream method was called that cannot complete because the stream was
 destroyed using `stream.destroy()`.
 
+<a id="ERR_STRING_TOO_LARGE"></a>
+### ERR_STRING_TOO_LARGE
+
+An attempt has been made to create a string larger than the maximum allowed
+size.
+
 <a id="ERR_TLS_CERT_ALTNAME_INVALID"></a>
 ### ERR_TLS_CERT_ALTNAME_INVALID
 

node.gyp

@@ -316,6 +316,7 @@
         'src/node_contextify.cc',
         'src/node_debug_options.cc',
         'src/node_domain.cc',
+        'src/node_errors.h',
         'src/node_file.cc',
         'src/node_http2.cc',
         'src/node_http_parser.cc',

src/node_errors.h

@@ -0,0 +1,73 @@
+#ifndef SRC_NODE_ERRORS_H_
+#define SRC_NODE_ERRORS_H_
+
+#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
+
+#include "node.h"
+#include "util-inl.h"
+#include "env-inl.h"
+#include "v8.h"
+
+namespace node {
+
+// Helpers to construct errors similar to the ones provided by
+// lib/internal/errors.js.
+// Example: with `V(ERR_INVALID_ARG_TYPE, TypeError)`, there will be
+// `node::ERR_INVALID_ARG_TYPE(isolate, "message")` returning
+// a `Local<Value>` containing the TypeError with proper code and message
+
+#define ERRORS_WITH_CODE(V)                                                  \
+  V(ERR_MEMORY_ALLOCATION_FAILED, Error)                                     \
+  V(ERR_STRING_TOO_LARGE, Error)                                             \
+  V(ERR_BUFFER_TOO_LARGE, Error)
+
+#define V(code, type)                                                         \
+  inline v8::Local<v8::Value> code(v8::Isolate* isolate,                      \
+                                   const char* message)       {               \
+    v8::Local<v8::String> js_code = OneByteString(isolate, #code);            \
+    v8::Local<v8::String> js_msg = OneByteString(isolate, message);           \
+    v8::Local<v8::Object> e =                                                 \
+        v8::Exception::type(js_msg)->ToObject(                                \
+            isolate->GetCurrentContext()).ToLocalChecked();                   \
+    e->Set(isolate->GetCurrentContext(), OneByteString(isolate, "code"),      \
+           js_code).FromJust();                                               \
+    return e;                                                                 \
+  }
+  ERRORS_WITH_CODE(V)
+#undef V
+
+// Errors with predefined static messages
+
+#define PREDEFINED_ERROR_MESSAGES(V)                                         \
+  V(ERR_MEMORY_ALLOCATION_FAILED, "Failed to allocate memory")
+
+#define V(code, message)                                                     \
+  inline v8::Local<v8::Value> code(v8::Isolate* isolate) {                   \
+    return code(isolate, message);                                           \
+  }
+  PREDEFINED_ERROR_MESSAGES(V)
+#undef V
+
+// Errors with predefined non-static messages
+
+inline v8::Local<v8::Value> ERR_BUFFER_TOO_LARGE(v8::Isolate *isolate) {
+  char message[128];
+  snprintf(message, sizeof(message),
+      "Cannot create a Buffer larger than 0x%lx bytes",
+      v8::TypedArray::kMaxLength);
+  return ERR_BUFFER_TOO_LARGE(isolate, message);
+}
+
+inline v8::Local<v8::Value> ERR_STRING_TOO_LARGE(v8::Isolate *isolate) {
+  char message[128];
+  snprintf(message, sizeof(message),
+      "Cannot create a string larger than 0x%x bytes",
+      v8::String::kMaxLength);
+  return ERR_STRING_TOO_LARGE(isolate, message);
+}
+
+}  // namespace node
+
+#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
+
+#endif  // SRC_NODE_ERRORS_H_