test: maybe helper

nodejs · Apr 15, 2021 · d75115a · d75115a
1 parent a2a8924
commit d75115a
Show file tree

Hide file tree

Showing 84 changed files with 390 additions and 364 deletions.
diff --git a/napi-inl.h b/napi-inl.h
@@ -403,7 +403,10 @@ void Maybe<T>::Check() const {
 
 template <class T>
 bool Maybe<T>::To(T* out) const {
-  if (IsJust()) *out = _value;
+  if (IsJust()) {
+    *out = _value;
+    return true;
+  };
   return false;
 }
 

diff --git a/test/addon.js b/test/addon.js
@@ -1,9 +1,8 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
+
 const assert = require('assert');
 
-test(require(`./build/${buildType}/binding.node`));
-test(require(`./build/${buildType}/binding_noexcept.node`));
+require('./common').runTest(test);
 
 function test(binding) {
   assert.strictEqual(binding.addon.increment(), 43);

diff --git a/test/addon_data.cc b/test/addon_data.cc
@@ -1,6 +1,7 @@
 #if (NAPI_VERSION > 5)
 #include <stdio.h>
 #include "napi.h"
+#include "test_helper.h"
 
 // An overly elaborate way to get/set a boolean stored in the instance data:
 // 0. A boolean named "verbose" is stored in the instance data. The constructor
@@ -42,7 +43,8 @@ class Addon {
   };
 
   static Napi::Value Getter(const Napi::CallbackInfo& info) {
-    return info.Env().GetInstanceData<Addon>()->VerboseIndicator.New({});
+    return MaybeToChecked(
+        info.Env().GetInstanceData<Addon>()->VerboseIndicator.New({}));
   }
 
   static void Setter(const Napi::CallbackInfo& info) {

diff --git a/test/addon_data.js b/test/addon_data.js
@@ -1,15 +1,10 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
+
 const assert = require('assert');
 const { spawn } = require('child_process');
 const readline = require('readline');
-const path = require('path');
 
-module.exports =
-  test(path.resolve(__dirname, `./build/${buildType}/binding.node`))
-  .then(() =>
-    test(path.resolve(__dirname,
-                      `./build/${buildType}/binding_noexcept.node`)));
+require('./common').runTestWithBindingPath(test);
 
 // Make sure the instance data finalizer is called at process exit. If the hint
 // is non-zero, it will be printed out by the child process.

diff --git a/test/arraybuffer.js b/test/arraybuffer.js
@@ -1,10 +1,9 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
+
 const assert = require('assert');
 const testUtil = require('./testUtil');
 
-module.exports = test(require(`./build/${buildType}/binding.node`))
-  .then(() => test(require(`./build/${buildType}/binding_noexcept.node`)));
+require('./common').runTest(test);
 
 function test(binding) {
   return testUtil.runGCTests([

diff --git a/test/asynccontext.js b/test/asynccontext.js
@@ -1,5 +1,5 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
+
 const assert = require('assert');
 const common = require('./common');
 
@@ -17,8 +17,7 @@ function checkAsyncHooks() {
   return false;
 }
 
-test(require(`./build/${buildType}/binding.node`));
-test(require(`./build/${buildType}/binding_noexcept.node`));
+common.runTest(test);
 
 function installAsyncHooksForTest() {
   return new Promise((resolve, reject) => {

diff --git a/test/asyncprogressqueueworker.js b/test/asyncprogressqueueworker.js
@@ -1,11 +1,9 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
+
 const common = require('./common')
 const assert = require('assert');
-const os = require('os');
 
-module.exports = test(require(`./build/${buildType}/binding.node`))
-  .then(() => test(require(`./build/${buildType}/binding_noexcept.node`)));
+common.runTest(test);
 
 async function test({ asyncprogressqueueworker }) {
   await success(asyncprogressqueueworker);

diff --git a/test/asyncprogressworker.js b/test/asyncprogressworker.js
@@ -1,10 +1,9 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
+
 const common = require('./common')
 const assert = require('assert');
 
-module.exports = test(require(`./build/${buildType}/binding.node`))
-  .then(() => test(require(`./build/${buildType}/binding_noexcept.node`)));
+common.runTest(test);
 
 async function test({ asyncprogressworker }) {
   await success(asyncprogressworker);

diff --git a/test/asyncworker-nocallback.js b/test/asyncworker-nocallback.js
@@ -1,9 +1,8 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
+
 const common = require('./common');
 
-module.exports = test(require(`./build/${buildType}/binding.node`))
-  .then(() => test(require(`./build/${buildType}/binding_noexcept.node`)));
+common.runTest(test);
 
 async function test(binding) {
   await binding.asyncworker.doWorkNoCallback(true, {})

diff --git a/test/asyncworker-persistent.js b/test/asyncworker-persistent.js
@@ -1,9 +1,6 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
+
 const assert = require('assert');
-const common = require('./common');
-const binding = require(`./build/${buildType}/binding.node`);
-const noexceptBinding = require(`./build/${buildType}/binding_noexcept.node`);
 
 function test(binding, succeed) {
   return new Promise((resolve) =>
@@ -21,7 +18,7 @@ function test(binding, succeed) {
     }));
 }
 
-module.exports = test(binding.persistentasyncworker, false)
-  .then(() => test(binding.persistentasyncworker, true))
-  .then(() => test(noexceptBinding.persistentasyncworker, false))
-  .then(() => test(noexceptBinding.persistentasyncworker, true));
+require('./common').runTest(async binding => {
+  await test(binding.persistentasyncworker, false);
+  await test(binding.persistentasyncworker, true);
+});
diff --git a/test/asyncworker.js b/test/asyncworker.js
@@ -1,5 +1,4 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
 const assert = require('assert');
 const common = require('./common');
 
@@ -17,8 +16,7 @@ function checkAsyncHooks() {
   return false;
 }
 
-module.exports = test(require(`./build/${buildType}/binding.node`))
-  .then(() => test(require(`./build/${buildType}/binding_noexcept.node`)));
+common.runTest(test);
 
 function installAsyncHooksForTest() {
   return new Promise((resolve, reject) => {

diff --git a/test/basic_types/array.js b/test/basic_types/array.js
@@ -1,9 +1,7 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
 const assert = require('assert');
 
-test(require(`../build/${buildType}/binding.node`));
-test(require(`../build/${buildType}/binding_noexcept.node`));
+require('../common').runTest(test);
 
 function test(binding) {
 

diff --git a/test/basic_types/boolean.js b/test/basic_types/boolean.js
@@ -1,9 +1,8 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
+
 const assert = require('assert');
 
-test(require(`../build/${buildType}/binding.node`));
-test(require(`../build/${buildType}/binding_noexcept.node`));
+require('../common').runTest(test);
 
 function test(binding) {
   const bool1 = binding.basic_types_boolean.createBoolean(true);

diff --git a/test/basic_types/number.js b/test/basic_types/number.js
@@ -1,10 +1,8 @@
 'use strict';
 
-const buildType = process.config.target_defaults.default_configuration;
 const assert = require('assert');
 
-test(require(`../build/${buildType}/binding.node`));
-test(require(`../build/${buildType}/binding_noexcept.node`));
+require('../common').runTest(test);
 
 function test(binding) {
   const MIN_INT32 = -2147483648;

diff --git a/test/basic_types/value.cc b/test/basic_types/value.cc
@@ -1,4 +1,5 @@
 #include "napi.h"
+#include "test_helper.h"
 
 using namespace Napi;
 
@@ -75,19 +76,19 @@ static Value IsExternal(const CallbackInfo& info) {
 }
 
 static Value ToBoolean(const CallbackInfo& info) {
-  return info[0].ToBoolean();
+  return FromMaybe(info[0].ToBoolean());
 }
 
 static Value ToNumber(const CallbackInfo& info) {
-  return info[0].ToNumber();
+  return FromMaybe(info[0].ToNumber());
 }
 
 static Value ToString(const CallbackInfo& info) {
-  return info[0].ToString();
+  return FromMaybe(info[0].ToString());
 }
 
 static Value ToObject(const CallbackInfo& info) {
-  return info[0].ToObject();
+  return FromMaybe(info[0].ToObject());
 }
 
 Object InitBasicTypesValue(Env env) {

diff --git a/test/basic_types/value.js b/test/basic_types/value.js
@@ -1,10 +1,8 @@
 'use strict';
 
-const buildType = process.config.target_defaults.default_configuration;
 const assert = require('assert');
 
-test(require(`../build/${buildType}/binding.node`));
-test(require(`../build/${buildType}/binding_noexcept.node`));
+require('../common').runTest(test);
 
 function test(binding) {
   const externalValue = binding.basic_types_value.createExternal();

diff --git a/test/bigint.cc b/test/bigint.cc
@@ -3,6 +3,8 @@
 #define NAPI_EXPERIMENTAL
 #include "napi.h"
 
+#include "test_helper.h"
+
 using namespace Napi;
 
 namespace {
@@ -11,7 +13,7 @@ Value IsLossless(const CallbackInfo& info) {
   Env env = info.Env();
 
   BigInt big = info[0].As<BigInt>();
-  bool is_signed = info[1].ToBoolean().Value();
+  bool is_signed = MaybeToChecked(info[1].ToBoolean()).Value();
 
   bool lossless;
   if (is_signed) {

diff --git a/test/bigint.js b/test/bigint.js
@@ -1,10 +1,8 @@
 'use strict';
 
-const buildType = process.config.target_defaults.default_configuration;
 const assert = require('assert');
 
-test(require(`./build/${buildType}/binding.node`));
-test(require(`./build/${buildType}/binding_noexcept.node`));
+require('./common').runTest(test);
 
 function test(binding) {
   const {

diff --git a/test/binding.gyp b/test/binding.gyp
@@ -1,6 +1,7 @@
 {
   'target_defaults': {
     'includes': ['../common.gypi'],
+    'include_dirs': ['./common'],
     'sources': [
         'addon.cc',
         'addon_data.cc',
@@ -84,10 +85,7 @@
     {
       'target_name': 'binding_noexcept_maybe',
       'includes': ['../noexcept.gypi'],
-      'defines': ['NODE_ADDON_API_ENABLE_MAYBE'],
-      'sources=': [
-        'maybe/function.cc',
-      ],
+      'defines': ['NODE_ADDON_API_ENABLE_MAYBE']
     },
   ],
 }
diff --git a/test/buffer.js b/test/buffer.js
@@ -1,11 +1,10 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
+
 const assert = require('assert');
 const testUtil = require('./testUtil');
 const safeBuffer = require('safe-buffer');
 
-module.exports = test(require(`./build/${buildType}/binding.node`))
-  .then(() => test(require(`./build/${buildType}/binding_noexcept.node`)));
+require('./common').runTest(test);
 
 function test(binding) {
   return testUtil.runGCTests([

diff --git a/test/callbackscope.js b/test/callbackscope.js
@@ -1,7 +1,5 @@
 'use strict';
-const buildType = process.config.target_defaults.default_configuration;
 const assert = require('assert');
-const common = require('./common');
 
 // we only check async hooks on 8.x an higher were
 // they are closer to working properly
@@ -17,8 +15,7 @@ function checkAsyncHooks() {
   return false;
 }
 
-test(require(`./build/${buildType}/binding.node`));
-test(require(`./build/${buildType}/binding_noexcept.node`));
+require('./common').runTest(test);
 
 function test(binding) {
   if (!checkAsyncHooks())

diff --git a/test/common/index.js b/test/common/index.js
@@ -74,3 +74,31 @@ exports.mustNotCall = function(msg) {
     assert.fail(msg || 'function should not have been called');
   };
 };
+
+exports.runTest = async function(test, buildType) {
+  buildType = buildType ?? process.config.target_defaults.default_configuration;
+
+  const bindings = [
+    `../build/${buildType}/binding.node`,
+    `../build/${buildType}/binding_noexcept.node`,
+    `../build/${buildType}/binding_noexcept_maybe.node`,
+  ].map(it => require.resolve(it));
+
+  for (const item of bindings) {
+    await test(require(item));
+  }
+}
+
+exports.runTestWithBindingPath = async function(test, buildType) {
+  buildType = buildType ?? process.config.target_defaults.default_configuration;
+
+  const bindings = [
+    `../build/${buildType}/binding.node`,
+    `../build/${buildType}/binding_noexcept.node`,
+    `../build/${buildType}/binding_noexcept_maybe.node`,
+  ].map(it => require.resolve(it));
+
+  for (const item of bindings) {
+    await test(item);
+  }
+}
diff --git a/test/common/test_helper.h b/test/common/test_helper.h
@@ -0,0 +1,38 @@
+#pragma once
+#include "napi.h"
+
+namespace Napi {
+
+/**
+ * A test helper that converts MaybeOrValue<T> to T by checking that
+ * MaybeOrValue is NOT an empty Maybe when NODE_ADDON_API_ENABLE_MAYBE is
+ * defined.
+ *
+ * Do nothing when NODE_ADDON_API_ENABLE_MAYBE is not defined.
+ */
+template <typename T>
+inline T MaybeToChecked(MaybeOrValue<T> maybe) {
+#if defined(NODE_ADDON_API_ENABLE_MAYBE)
+  return maybe.ToChecked();
+#else
+  return maybe;
+#endif
+}
+
+/**
+ * A test helper that converts MaybeOrValue<T> to T by getting the value that
+ * wrapped by the Maybe or return the default_value if the Maybe is empty when
+ * NODE_ADDON_API_ENABLE_MAYBE is defined.
+ *
+ * Do nothing when NODE_ADDON_API_ENABLE_MAYBE is not defined.
+ */
+template <typename T>
+inline T FromMaybe(MaybeOrValue<T> maybe, const T& default_value = T()) {
+#if defined(NODE_ADDON_API_ENABLE_MAYBE)
+  return maybe.FromMaybe(default_value);
+#else
+  return maybe;
+#endif
+}
+
+}  // namespace Napi