Promise API feedback

kfarnung · kfarnung · commit 836587865189 · 2018-05-11T11:56:55.000-07:00
diff --git a/bin/NativeTests/JsRTApiTest.cpp b/bin/NativeTests/JsRTApiTest.cpp
@@ -2676,12 +2676,12 @@ namespace JsRTApiTest
         // Create resolvable promise
         REQUIRE(JsCreatePromise(&promise, &resolve, &reject) == JsNoError);
 
-        JsPromiseState state = JsPromiseState_Pending;
+        JsPromiseState state = JsPromiseStatePending;
         REQUIRE(JsGetPromiseState(promise, &state) == JsNoError);
-        CHECK(state == JsPromiseState_Pending);
+        CHECK(state == JsPromiseStatePending);
 
         result = JS_INVALID_REFERENCE;
-        CHECK(JsGetPromiseResult(promise, &result) == JsErrorInvalidArgument);
+        CHECK(JsGetPromiseResult(promise, &result) == JsErrorPromisePending);
         CHECK(result == JS_INVALID_REFERENCE);
 
         JsValueRef num = JS_INVALID_REFERENCE;
@@ -2690,9 +2690,9 @@ namespace JsRTApiTest
         std::array<JsValueRef, 2> args{ GetUndefined(), num };
         REQUIRE(JsCallFunction(resolve, args.data(), static_cast<unsigned short>(args.size()), &result) == JsNoError);
 
-        state = JsPromiseState_Pending;
+        state = JsPromiseStatePending;
         REQUIRE(JsGetPromiseState(promise, &state) == JsNoError);
-        CHECK(state == JsPromiseState_Fulfilled);
+        CHECK(state == JsPromiseStateFulfilled);
 
         result = JS_INVALID_REFERENCE;
         REQUIRE(JsGetPromiseResult(promise, &result) == JsNoError);
@@ -2704,12 +2704,12 @@ namespace JsRTApiTest
         // Create rejectable promise
         REQUIRE(JsCreatePromise(&promise, &resolve, &reject) == JsNoError);
 
-        state = JsPromiseState_Pending;
+        state = JsPromiseStatePending;
         REQUIRE(JsGetPromiseState(promise, &state) == JsNoError);
-        CHECK(state == JsPromiseState_Pending);
+        CHECK(state == JsPromiseStatePending);
 
         result = JS_INVALID_REFERENCE;
-        CHECK(JsGetPromiseResult(promise, &result) == JsErrorInvalidArgument);
+        CHECK(JsGetPromiseResult(promise, &result) == JsErrorPromisePending);
         CHECK(result == JS_INVALID_REFERENCE);
 
         num = JS_INVALID_REFERENCE;
@@ -2718,9 +2718,9 @@ namespace JsRTApiTest
         args = { GetUndefined(), num };
         REQUIRE(JsCallFunction(reject, args.data(), static_cast<unsigned short>(args.size()), &result) == JsNoError);
 
-        state = JsPromiseState_Pending;
+        state = JsPromiseStatePending;
         REQUIRE(JsGetPromiseState(promise, &state) == JsNoError);
-        CHECK(state == JsPromiseState_Rejected);
+        CHECK(state == JsPromiseStateRejected);
 
         result = JS_INVALID_REFERENCE;
         REQUIRE(JsGetPromiseResult(promise, &result) == JsNoError);
diff --git a/lib/Jsrt/ChakraCommon.h b/lib/Jsrt/ChakraCommon.h
@@ -230,6 +230,10 @@ typedef unsigned short uint16_t;
         /// </summary>
         JsNoWeakRefRequired,
         /// <summary>
+        ///     The <c>Promise</c> object is still in the pending state.
+        /// </summary>
+        JsErrorPromisePending,
+        /// <summary>
         ///     Category of errors that relates to errors occurring within the engine itself.
         /// </summary>
         JsErrorCategoryEngine = 0x20000,
diff --git a/lib/Jsrt/ChakraCore.h b/lib/Jsrt/ChakraCore.h
@@ -63,9 +63,9 @@ typedef enum JsModuleHostInfoKind
 /// </summary>
 typedef enum _JsPromiseState
 {
-    JsPromiseState_Pending = 0x0,
-    JsPromiseState_Fulfilled = 0x1,
-    JsPromiseState_Rejected = 0x2
+    JsPromiseStatePending = 0x0,
+    JsPromiseStateFulfilled = 0x1,
+    JsPromiseStateRejected = 0x2
 } JsPromiseState;
 
 /// <summary>
diff --git a/lib/Jsrt/Jsrt.cpp b/lib/Jsrt/Jsrt.cpp
@@ -5120,7 +5120,7 @@ CHAKRA_API JsGetPromiseState(_In_ JsValueRef promise, _Out_ JsPromiseState *stat
         VALIDATE_INCOMING_REFERENCE(promise, scriptContext);
         PARAM_NOT_NULL(state);
 
-        *state = JsPromiseState_Pending;
+        *state = JsPromiseStatePending;
 
         if (!Js::JavascriptPromise::Is(promise))
         {
@@ -5133,11 +5133,11 @@ CHAKRA_API JsGetPromiseState(_In_ JsValueRef promise, _Out_ JsPromiseState *stat
         switch (status)
         {
         case Js::JavascriptPromise::PromiseStatus::PromiseStatusCode_HasRejection:
-            *state = JsPromiseState_Rejected;
+            *state = JsPromiseStateRejected;
             break;
 
         case Js::JavascriptPromise::PromiseStatus::PromiseStatusCode_HasResolution:
-            *state = JsPromiseState_Fulfilled;
+            *state = JsPromiseStateFulfilled;
             break;
         }
 
@@ -5165,7 +5165,7 @@ CHAKRA_API JsGetPromiseResult(_In_ JsValueRef promise, _Out_ JsValueRef *result)
 
         if (jsResult == nullptr)
         {
-            return JsErrorInvalidArgument;
+            return JsErrorPromisePending;
         }
 
         *result = (JsValueRef)jsResult;

Original file line number	Diff line number	Diff line change
`@@ -5120,7 +5120,7 @@ CHAKRA_API JsGetPromiseState(_In_ JsValueRef promise, _Out_ JsPromiseState *stat`
`5120`	`5120`	`VALIDATE_INCOMING_REFERENCE(promise, scriptContext);`
`5121`	`5121`	`PARAM_NOT_NULL(state);`
`5122`	`5122`
`5123`		`- *state = JsPromiseState_Pending;`
	`5123`	`+ *state = JsPromiseStatePending;`
`5124`	`5124`
`5125`	`5125`	`if (!Js::JavascriptPromise::Is(promise))`
`5126`	`5126`	`{`
`@@ -5133,11 +5133,11 @@ CHAKRA_API JsGetPromiseState(_In_ JsValueRef promise, _Out_ JsPromiseState *stat`
`5133`	`5133`	`switch (status)`
`5134`	`5134`	`{`
`5135`	`5135`	`case Js::JavascriptPromise::PromiseStatus::PromiseStatusCode_HasRejection:`
`5136`		`- *state = JsPromiseState_Rejected;`
	`5136`	`+ *state = JsPromiseStateRejected;`
`5137`	`5137`	`break;`
`5138`	`5138`
`5139`	`5139`	`case Js::JavascriptPromise::PromiseStatus::PromiseStatusCode_HasResolution:`
`5140`		`- *state = JsPromiseState_Fulfilled;`
	`5140`	`+ *state = JsPromiseStateFulfilled;`
`5141`	`5141`	`break;`
`5142`	`5142`	`}`
`5143`	`5143`
`@@ -5165,7 +5165,7 @@ CHAKRA_API JsGetPromiseResult(_In_ JsValueRef promise, _Out_ JsValueRef *result)`
`5165`	`5165`
`5166`	`5166`	`if (jsResult == nullptr)`
`5167`	`5167`	`{`
`5168`		`- return JsErrorInvalidArgument;`
	`5168`	`+ return JsErrorPromisePending;`
`5169`	`5169`	`}`
`5170`	`5170`
`5171`	`5171`	`*result = (JsValueRef)jsResult;`