src: add rudimentary Promise support

mmarchini · mmarchini · commit 991c731deb42 · 2020-03-25T15:16:26.000-07:00
This patch allows llnode to list Promise objects with findjsobjects, findjsinstances and findrefs. We can investigate more fancy Promise features in the future (such as listing handlers, Promise status, etc.). For Node.js v10.x, since we don't have the JS_PROMISE type as postmortem metadata, we assume JS_PROMISE is the next type after JS_MESSAGE_OBJECT_TYPE. This is a safe assumption for Node.js v10.x, v12.x has the JS_PROMISE type, and v8.x is not supported anymore. ```console $ git log v10.0.0..v10.17.0 -L :InstanceType:deps/v8/src/objects.h \ | grep -C2 "JS_PROMISE" JS_MAP_VALUE_ITERATOR_TYPE, JS_MESSAGE_OBJECT_TYPE, JS_PROMISE_TYPE, JS_REGEXP_TYPE, JS_REGEXP_STRING_ITERATOR_TYPE, -- JS_MAP_VALUE_ITERATOR_TYPE, JS_MESSAGE_OBJECT_TYPE, JS_PROMISE_TYPE, JS_REGEXP_TYPE, + JS_REGEXP_STRING_ITERATOR_TYPE, ``` PR-URL: #272
diff --git a/src/llv8-constants.cc b/src/llv8-constants.cc
@@ -580,6 +580,13 @@ void Types::Load() {
   kLastContextType = LoadConstant("LastContextType");
 
   kJSErrorType = LoadConstant("type_JSError__JS_ERROR_TYPE");
+  kJSPromiseType = LoadConstant("type_JSPromise__JS_PROMISE_TYPE");
+  if (kJSPromiseType == -1) {
+    // NOTE(mmarchini): On Node.js v10.x, JS_PROMISE always comes after
+    // JS_MESSAGE_OBJECT_TYPE in the InstanceType enum.
+    kJSPromiseType =
+        LoadConstant("type_JSMessageObject__JS_MESSAGE_OBJECT_TYPE") + 1;
+  }
   kHeapNumberType = LoadConstant("type_HeapNumber__HEAP_NUMBER_TYPE");
   kMapType = LoadConstant("type_Map__MAP_TYPE");
   kGlobalObjectType =
diff --git a/src/llv8-constants.h b/src/llv8-constants.h
@@ -527,6 +527,7 @@ class Types : public Module {
   int64_t kLastContextType;
 
   int64_t kJSErrorType;
+  int64_t kJSPromiseType;
   int64_t kHeapNumberType;
   int64_t kMapType;
   int64_t kGlobalObjectType;
diff --git a/src/llv8-inl.h b/src/llv8-inl.h
@@ -350,6 +350,7 @@ inline bool JSObject::IsObjectType(LLV8* v8, int64_t type) {
   return type == v8->types()->kJSObjectType ||
          type == v8->types()->kJSAPIObjectType ||
          type == v8->types()->kJSErrorType ||
+         type == v8->types()->kJSPromiseType ||
          type == v8->types()->kJSSpecialAPIObjectType;
 }
 
diff --git a/test/fixtures/inspect-scenario.js b/test/fixtures/inspect-scenario.js
@@ -67,6 +67,8 @@ function closure() {
   c.hashmap['stringifiedError'] = new Error('test');
   c.hashmap['stringifiedErrorStack'] = c.hashmap['stringifiedError'].stack;
 
+  c.hashmap['promise'] = new Promise(() => {});
+
   c.hashmap[0] = null;
   c.hashmap[4] = undefined;
   c.hashmap[23] = /regexp/;
diff --git a/test/plugin/inspect-test.js b/test/plugin/inspect-test.js
@@ -185,6 +185,10 @@ const hashMapTests = {
       });
     }
   },
+  'promise': {
+    re: /.promise=(0x[0-9a-f]+):<Object: Promise>/,
+    desc: '.promise Promise property'
+  },
   // .array=0x000003df9cbe7919:<Array: length=6>,
   'array': {
     re: /.array=(0x[0-9a-f]+):<Array: length=6>/,

Original file line number	Diff line number	Diff line change
`@@ -350,6 +350,7 @@ inline bool JSObject::IsObjectType(LLV8* v8, int64_t type) {`
`350`	`350`	`return type == v8->types()->kJSObjectType \|\|`
`351`	`351`	`type == v8->types()->kJSAPIObjectType \|\|`
`352`	`352`	`type == v8->types()->kJSErrorType \|\|`
	`353`	`+ type == v8->types()->kJSPromiseType \|\|`
`353`	`354`	`type == v8->types()->kJSSpecialAPIObjectType;`
`354`	`355`	`}`
`355`	`356`