Shim String.includes

Author: lukechilds

internal/errors.js

@@ -106,7 +106,7 @@ createErrorType('ERR_INVALID_ARG_TYPE',
       // For cases like 'first argument'
       msg = `The ${name} ${determiner} ${oneOf(expected, 'type')}`;
     } else {
-      const type = name.includes('.') ? 'property' : 'argument';
+      const type = includes(name, '.') ? 'property' : 'argument';
       msg = `The "${name}" ${type} ${determiner} ${oneOf(expected, 'type')}`;
     }
 

test/common/index.js

@@ -42,6 +42,19 @@ function repeat(str, count) {
   return str;
 }
 
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/includes
+function includes(str, search, start) {
+  if (typeof start !== 'number') {
+    start = 0;
+  }
+
+  if (start + search.length > str.length) {
+    return false;
+  } else {
+    return str.indexOf(search, start) !== -1;
+  }
+}
+
 const isBrowser = typeof window !== 'undefined';
 
 const bigIntSupported = typeof BigInt !== 'undefined';
@@ -273,6 +286,7 @@ process.on('unhandledRejection', crashOnUnhandledRejection);
 module.exports = {
   getOwnPropertyDescriptors,
   repeat,
+  includes,
   isBrowser,
   bigIntSupported,
   symbolToStringTagSupported,

test/parallel/test-assert-async.js

@@ -79,7 +79,7 @@ const invalidThenableFunc = () => {
     assert.strictEqual(err.message,
                        'Missing expected rejection (mustNotCall).');
     assert.strictEqual(err.operator, 'rejects');
-    assert.ok(!err.stack.includes('at Function.rejects'));
+    assert.ok(!common.includes(err.stack, 'at Function.rejects'));
     return true;
   };
 
@@ -170,7 +170,7 @@ promises.push(assert.rejects(
                        'Got unwanted rejection.\nActual message: "Failed"');
     assert.strictEqual(err.operator, 'doesNotReject');
     assert.ok(err.stack);
-    assert.ok(!err.stack.includes('at Function.doesNotReject'));
+    assert.ok(!common.includes(err.stack, 'at Function.doesNotReject'));
     return true;
   };
 

test/parallel/test-assert.js

@@ -137,7 +137,7 @@ assert.throws(() => thrower(TypeError));
   } catch (e) {
     threw = true;
     assert.ok(e instanceof a.AssertionError);
-    assert.ok(!e.stack.includes('at Function.doesNotThrow'));
+    assert.ok(!common.includes(e.stack, 'at Function.doesNotThrow'));
   }
   assert.ok(threw, 'a.doesNotThrow is not catching type matching errors');
 }
@@ -251,7 +251,7 @@ a.throws(() => thrower(TypeError), (err) => {
   } catch (e) {
     threw = true;
     assert.ok(e instanceof a.AssertionError);
-    assert.ok(!e.stack.includes('at Function.throws'));
+    assert.ok(!common.includes(e.stack, 'at Function.throws'));
   }
   assert.ok(threw);
 }
@@ -341,13 +341,13 @@ try {
     }, TypeError, rangeError);
   } catch (e) {
     threw = true;
-    assert.ok(e.message.includes(rangeError.message));
+    assert.ok(common.includes(e.message, rangeError.message));
     assert.ok(e instanceof assert.AssertionError);
     // [browserify]
     // This fails because `doesNotThrow` appears in the stack trace.
     // I'm not quite sure why that's an issue if the error message is set
     // and the above tests pass so commenting out for now.
-    // assert.ok(!e.stack.includes('doesNotThrow'), e.stack);
+    // assert.ok(!common.includes(e.stack, 'doesNotThrow'), e.stack);
   }
   assert.ok(threw);
 }

test/pseudo-tty/test-assert-position-indicator.js

@@ -2,7 +2,7 @@
 // https://github.com/nodejs/node/commit/40a8a7391664e7a5d8a264a1d85d059f9c05063b
 
 'use strict';
-require('../common');
+const common = require('../common');
 const assert = require('../../assert');
 
 process.env.NODE_DISABLE_COLORS = true;
@@ -15,11 +15,11 @@ process.stderr.columns = 20;
 // Confirm that there is no position indicator.
 assert.throws(
   () => { assert.deepStrictEqual('a'.repeat(30), 'a'.repeat(31)); },
-  (err) => !err.message.includes('^')
+  (err) => !common.includes(err.message, '^')
 );
 
 // Confirm that there is a position indicator.
 assert.throws(
   () => { assert.deepStrictEqual('aaa', 'aaaa'); },
-  (err) => err.message.includes('^')
+  (err) => common.includes(err.message, '^')
 );