util: expose toUSVString

ronag · targos · commit 8eb11356dd6a · 2021-09-04T10:03:29.000+02:00
Expose toUSVString so it can be used by user libraries. PR-URL: #39814 Refs: nodejs/undici#986 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
diff --git a/doc/api/util.md b/doc/api/util.md
@@ -2468,6 +2468,18 @@ const util = require('util');
 util.log('Timestamped message.');
 ```
 
+
+### `util.toUSVString(string)`
+<!-- YAML
+added: REPLACEME
+-->
+
+* `string` {string}
+
+Returns the `string` after replacing any surrogate code points
+(or equivalently, any unpaired surrogate code units) with the
+Unicode "replacement character" U+FFFD.
+
 [Common System Errors]: errors.md#errors_common_system_errors
 [Custom inspection functions on objects]: #util_custom_inspection_functions_on_objects
 [Custom promisified functions]: #util_custom_promisified_functions
diff --git a/lib/internal/url.js b/lib/internal/url.js
@@ -19,7 +19,6 @@ const {
   ReflectApply,
   ReflectGetOwnPropertyDescriptor,
   ReflectOwnKeys,
-  RegExpPrototypeExec,
   String,
   StringPrototypeCharCodeAt,
   StringPrototypeIncludes,
@@ -40,7 +39,12 @@ const {
   isHexTable
 } = require('internal/querystring');
 
-const { getConstructorOf, removeColors } = require('internal/util');
+const {
+  getConstructorOf,
+  removeColors,
+  toUSVString,
+} = require('internal/util');
+
 const {
   ERR_ARG_NOT_ITERABLE,
   ERR_INVALID_ARG_TYPE,
@@ -76,7 +80,6 @@ const {
   domainToASCII: _domainToASCII,
   domainToUnicode: _domainToUnicode,
   encodeAuth,
-  toUSVString: _toUSVString,
   parse,
   setURLConstructor,
   URL_FLAGS_CANNOT_BE_BASE,
@@ -110,18 +113,6 @@ const IteratorPrototype = ObjectGetPrototypeOf(
   ObjectGetPrototypeOf([][SymbolIterator]())
 );
 
-const unpairedSurrogateRe =
-    /(?:[^\uD800-\uDBFF]|^)[\uDC00-\uDFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])/;
-function toUSVString(val) {
-  const str = `${val}`;
-  // As of V8 5.5, `str.search()` (and `unpairedSurrogateRe[@@search]()`) are
-  // slower than `unpairedSurrogateRe.exec()`.
-  const match = RegExpPrototypeExec(unpairedSurrogateRe, str);
-  if (!match)
-    return str;
-  return _toUSVString(str, match.index);
-}
-
 // Refs: https://html.spec.whatwg.org/multipage/browsers.html#concept-origin-opaque
 const kOpaqueOrigin = 'null';
 
diff --git a/lib/internal/util.js b/lib/internal/util.js
@@ -14,11 +14,16 @@ const {
   ObjectSetPrototypeOf,
   Promise,
   ReflectConstruct,
+  RegExpPrototypeExec,
   Set,
   Symbol,
   SymbolFor,
 } = primordials;
 
+const {
+  toUSVString: _toUSVString,
+} = internalBinding('url');
+
 const {
   codes: {
     ERR_INVALID_ARG_TYPE,
@@ -44,6 +49,18 @@ const experimentalWarnings = new Set();
 
 const colorRegExp = /\u001b\[\d\d?m/g; // eslint-disable-line no-control-regex
 
+const unpairedSurrogateRe =
+  /(?:[^\uD800-\uDBFF]|^)[\uDC00-\uDFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])/;
+function toUSVString(val) {
+  const str = `${val}`;
+  // As of V8 5.5, `str.search()` (and `unpairedSurrogateRe[@@search]()`) are
+  // slower than `unpairedSurrogateRe.exec()`.
+  const match = RegExpPrototypeExec(unpairedSurrogateRe, str);
+  if (!match)
+    return str;
+  return _toUSVString(str, match.index);
+}
+
 let uvBinding;
 
 function lazyUv() {
@@ -452,6 +469,7 @@ module.exports = {
   promisify,
   sleep,
   spliceOne,
+  toUSVString,
   removeColors,
 
   // Symbol used to customize promisify conversion
diff --git a/lib/util.js b/lib/util.js
@@ -60,7 +60,8 @@ const {
   deprecate,
   getSystemErrorMap,
   getSystemErrorName: internalErrorName,
-  promisify
+  promisify,
+  toUSVString,
 } = require('internal/util');
 
 let internalDeepEqual;
@@ -358,6 +359,7 @@ module.exports = {
   isPrimitive,
   log,
   promisify,
+  toUSVString,
   TextDecoder,
   TextEncoder,
   types
diff --git a/test/parallel/test-util.js b/test/parallel/test-util.js
@@ -148,6 +148,8 @@ assert.strictEqual(util.isFunction(function() {}), true);
 assert.strictEqual(util.isFunction(), false);
 assert.strictEqual(util.isFunction('string'), false);
 
+assert.strictEqual(util.toUSVString('string\ud801'), 'string\ufffd');
+
 {
   assert.strictEqual(util.types.isNativeError(new Error()), true);
   assert.strictEqual(util.types.isNativeError(new TypeError()), true);

Original file line number	Diff line number	Diff line change
`@@ -148,6 +148,8 @@ assert.strictEqual(util.isFunction(function() {}), true);`
`148`	`148`	`assert.strictEqual(util.isFunction(), false);`
`149`	`149`	`assert.strictEqual(util.isFunction('string'), false);`
`150`	`150`
	`151`	`+assert.strictEqual(util.toUSVString('string\ud801'), 'string\ufffd');`
	`152`	`+`
`151`	`153`	`{`
`152`	`154`	`assert.strictEqual(util.types.isNativeError(new Error()), true);`
`153`	`155`	`assert.strictEqual(util.types.isNativeError(new TypeError()), true);`