Introduce jerry_port_report_unhandled_promise_rejection

This patch resolves #2931.

JerryScript-DCO-1.0-Signed-off-by: Robert Fancsik frobert@inf.u-szeged.hu

Author: rerobika

docs/05.PORT-API.md

@@ -151,6 +151,24 @@ jerry_port_get_native_module (jerry_value_t name) /**< module specifier */
 }
 ```
 
+## Promise
+
+Allow user to get notified whenever an unhandled promise rejection happens.
+
+```c
+/**
+ * Report the reason of the unhandled promise rejections.
+ *
+ * Note:
+ *      This port function is called by jerry-core when JERRY_BUILTIN_PROMISE
+ *      is enabled.
+ *
+ * @param promise rejected promise.
+ * @param reason reason of the rejection.
+ */
+void jerry_port_report_unhandled_promise_rejection (jerry_value_t promise, jerry_value_t reason);
+```
+
 ## Date
 
 ```c

jerry-core/ecma/operations/ecma-promise-object.c

@@ -181,6 +181,23 @@ ecma_is_resolver_already_called (ecma_object_t *promise_obj_p) /**< promise */
   return (ecma_promise_get_flags (promise_obj_p) & ECMA_PROMISE_ALREADY_RESOLVED) != 0;
 } /* ecma_is_resolver_already_called */
 
+/**
+ * HostPromiseRejectionTracker
+ *
+ * See also: ES11 25.6.1.9
+ */
+static void
+ecma_promise_track_rejection (ecma_object_t *obj_p, /**< promise */
+                              ecma_value_t reason) /**< reason for reject */
+{
+  JERRY_ASSERT (ecma_is_promise (obj_p));
+
+  if (!(ecma_promise_get_flags (obj_p) & ECMA_PROMISE_HANDLED))
+  {
+    jerry_port_report_unhandled_promise_rejection (ecma_make_object_value (obj_p), reason);
+  }
+} /* ecma_promise_track_rejection */
+
 /**
  * Reject a Promise with a reason.
  *
@@ -208,6 +225,7 @@ ecma_reject_promise (ecma_value_t promise, /**< promise */
   promise_p->reactions = ecma_new_collection ();
 
   ecma_collection_destroy (reactions);
+  ecma_promise_track_rejection (obj_p, reason);
 } /* ecma_reject_promise */
 
 /**
@@ -818,10 +836,14 @@ ecma_promise_do_then (ecma_value_t promise, /**< the promise which call 'then' *
   {
     /* 9. */
     ecma_value_t reason = ecma_promise_get_result (promise_obj_p);
+    ecma_promise_track_rejection (promise_obj_p, reason);
     ecma_enqueue_promise_reaction_job (ecma_make_object_value (result_capability_obj_p), on_rejected, reason);
     ecma_free_value (reason);
   }
 
+  /* ES11: 11. */
+  promise_p->header.u.class_prop.extra_info |= ECMA_PROMISE_HANDLED;
+
   /* 10. */
   return ecma_copy_value (capability_p->header.u.class_prop.u.promise);
 } /* ecma_promise_do_then */

jerry-core/ecma/operations/ecma-promise-object.h

@@ -34,6 +34,7 @@ typedef enum
   ECMA_PROMISE_IS_PENDING = (1 << 0), /**< pending state */
   ECMA_PROMISE_IS_FULFILLED = (1 << 1), /**< fulfilled state */
   ECMA_PROMISE_ALREADY_RESOLVED = (1 << 2), /**< already resolved */
+  ECMA_PROMISE_HANDLED = (1 << 3), /**< ES11: 25.6.6 [[PromiseIsHandled]] internal slot */
 } ecma_promise_flags_t;
 
 /**

jerry-core/include/jerryscript-port.h

@@ -252,6 +252,18 @@ size_t jerry_port_normalize_path (const char *in_path_p,
  */
 jerry_value_t jerry_port_get_native_module (jerry_value_t name);
 
+/**
+ * Report the reason of the unhandled promise rejections.
+ *
+ * Note:
+ *      This port function is called by jerry-core when JERRY_BUILTIN_PROMISE
+ *      is enabled.
+ *
+ * @param promise rejected promise.
+ * @param reason reason of the rejection.
+ */
+void jerry_port_report_unhandled_promise_rejection (jerry_value_t promise, jerry_value_t reason);
+
 /**
  * @}
  */

jerry-port/default/default-promise.c

@@ -0,0 +1,42 @@
+/* Copyright JS Foundation and other contributors, http://js.foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "jerryscript-port.h"
+#include "jerryscript-port-default.h"
+
+/**
+ * Default implementation of jerry_port_report_unhandled_promise_rejection.
+ * Prints the reason of the unhandled rejections.
+ *
+ * This function called when:
+ *  - A promise is rejected without any handlers
+ *  - A handler is added to a rejected promise for the first time
+ */
+void
+jerry_port_report_unhandled_promise_rejection (const jerry_value_t promise, /**< rejected promise */
+                                               const jerry_value_t reason) /**< reason of the rejection */
+{
+  (void) promise;
+
+  jerry_value_t reason_to_string = jerry_value_to_string (reason);
+  jerry_size_t req_sz = jerry_get_utf8_string_size (reason_to_string);
+  JERRY_VLA (jerry_char_t, str_buf_p, req_sz + 1);
+  jerry_string_to_utf8_char_buffer (reason_to_string, str_buf_p, req_sz);
+  str_buf_p[req_sz] = '\0';
+
+  jerry_release_value (reason_to_string);
+
+  jerry_port_log (jerry_port_default_get_log_level (), "Uncaught (in promise) %s\n", str_buf_p);
+} /* jerry_port_report_unhandled_promise_rejection */

targets/esp-idf/promise.c

@@ -0,0 +1,41 @@
+/* Copyright JS Foundation and other contributors, http://js.foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "jerryscript-port.h"
+
+/**
+ * Report the reason of the unhandled promise rejections.
+ *
+ * Note:
+ *      This port function is called by jerry-core when JERRY_BUILTIN_PROMISE
+ *      is enabled.
+ *
+ * @param promise rejected promise.
+ * @param reason reason of the rejection.
+ */
+void jerry_port_report_unhandled_promise_rejection (jerry_value_t promise, jerry_value_t reason)
+{
+  (void) promise;
+
+  jerry_value_t reason_to_string = jerry_value_to_string (reason);
+  jerry_size_t req_sz = jerry_get_utf8_string_size (reason_to_string);
+  jerry_char_t str_buf_p[req_sz + 1];
+  jerry_string_to_utf8_char_buffer (reason_to_string, str_buf_p, req_sz);
+  str_buf_p[req_sz] = '\0';
+
+  jerry_release_value (reason_to_string);
+
+  jerry_port_log (jerry_port_default_get_log_level (), "Uncaught (in promise) %s\n", str_buf_p);
+} /* jerry_port_report_unhandled_promise_rejection */

targets/nuttx-stm32f4/jerry_port.c

@@ -227,3 +227,29 @@ jerry_port_get_current_context (void)
 {
   return current_context_p;
 } /* jerry_port_get_current_context */
+
+/**
+ * Report the reason of the unhandled promise rejections.
+ *
+ * Note:
+ *      This port function is called by jerry-core when JERRY_BUILTIN_PROMISE
+ *      is enabled.
+ *
+ * @param promise rejected promise.
+ * @param reason reason of the rejection.
+ */
+void
+jerry_port_report_unhandled_promise_rejection (jerry_value_t promise, jerry_value_t reason)
+{
+  (void) promise;
+
+  jerry_value_t reason_to_string = jerry_value_to_string (reason);
+  jerry_size_t req_sz = jerry_get_utf8_string_size (reason_to_string);
+  jerry_char_t str_buf_p[req_sz + 1];
+  jerry_string_to_utf8_char_buffer (reason_to_string, str_buf_p, req_sz);
+  str_buf_p[req_sz] = '\0';
+
+  jerry_release_value (reason_to_string);
+
+  jerry_port_log (jerry_log_level, "Uncaught (in promise) %s\n", str_buf_p);
+} /* jerry_port_report_unhandled_promise_rejection */