Fix string_decoder import (#548)

* Fix `string_decoder` import Resolves #547 * add replacement to replacement.mjs, add node version to package.json and rebuild * chore: put node version in package.json script * chore: use node version 18.19.0 * run npm run format
nodejs · Dec 31, 2024 · 4281bc0 · 4281bc0
1 parent fdfbf82
commit 4281bc0
Show file tree

Hide file tree

Showing 23 changed files with 359 additions and 324 deletions.
diff --git a/build/replacements.mjs b/build/replacements.mjs
@@ -146,6 +146,8 @@ const streamsRequireInternal = ["require\\('internal/(.+)'\\)", "require('../int
 
 const streamsRequirePrimordials = ['= primordials', "= require('../ours/primordials')"]
 
+const stringDecoderRequirePackage = ["require\\('string_decoder'\\)", "require('string_decoder/')"]
+
 const testCommonKnownGlobals = [
   'let knownGlobals = \\[(\\n\\s+)',
   `
@@ -312,7 +314,8 @@ export const replacements = {
   ],
   'lib/internal/streams/readable.js': [
     removefromWebReadableMethod,
-    removetoWebReadableMethod
+    removetoWebReadableMethod,
+    stringDecoderRequirePackage
   ],
   'lib/internal/streams/.+': [
     internalStreamsRequireErrors,

diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -21,7 +21,7 @@ export default [
       'space-before-function-paren': 0,
       curly: [2, 'all'],
       'local/no-big-int': 'error',
+      'no-undef': 'warn',
     },
   },
 ]
-
diff --git a/lib/internal/streams/readable.js b/lib/internal/streams/readable.js
@@ -65,7 +65,7 @@ const {
 } = require('../../ours/errors')
 const { validateObject } = require('../validators')
 const kPaused = Symbol('kPaused')
-const { StringDecoder } = require('string_decoder')
+const { StringDecoder } = require('string_decoder/')
 const from = require('./from')
 ObjectSetPrototypeOf(Readable.prototype, Stream.prototype)
 ObjectSetPrototypeOf(Readable, Stream)

diff --git a/lib/internal/streams/utils.js b/lib/internal/streams/utils.js
@@ -30,7 +30,6 @@ function isReadableNodeStream(obj, strict = false) {
     ) // Writable has .pipe.
   )
 }
-
 function isWritableNodeStream(obj) {
   var _obj$_writableState
   return !!(
@@ -45,7 +44,6 @@ function isWritableNodeStream(obj) {
     ) // Duplex
   )
 }
-
 function isDuplexNodeStream(obj) {
   return !!(
     obj &&

diff --git a/lib/ours/errors.js b/lib/ours/errors.js
@@ -311,7 +311,8 @@ E(
       received = addNumericalSeparator(String(input))
     } else if (typeof input === 'bigint') {
       received = String(input)
-      if (input > 2n ** 32n || input < -(2n ** 32n)) {
+      const limit = BigInt(2) ** BigInt(32)
+      if (input > limit || input < -limit) {
         received = addNumericalSeparator(received)
       }
       received += 'n'

diff --git a/lib/ours/primordials.js b/lib/ours/primordials.js
@@ -102,6 +102,6 @@ module.exports = {
   TypedArrayPrototypeSet(self, buf, len) {
     return self.set(buf, len)
   },
-  Boolean: Boolean,
+  Boolean,
   Uint8Array
 }
diff --git a/lib/ours/util.js b/lib/ours/util.js
@@ -24,7 +24,9 @@ const validateAbortSignal = (signal, name) => {
   }
 }
 const validateFunction = (value, name) => {
-  if (typeof value !== 'function') throw new ERR_INVALID_ARG_TYPE(name, 'Function', value)
+  if (typeof value !== 'function') {
+    throw new ERR_INVALID_ARG_TYPE(name, 'Function', value)
+  }
 }
 
 // This is a simplified version of AggregateError

diff --git a/package.json b/package.json
@@ -33,7 +33,7 @@
     "./lib/ours/index.js": "./lib/ours/browser.js"
   },
   "scripts": {
-    "build": "node build/build.mjs",
+    "build": "node build/build.mjs 18.19.0",
     "postbuild": "prettier -w lib test",
     "test": "tap --rcfile=./tap.yml test/parallel/test-*.js test/ours/test-*.js",
     "test:prepare": "node test/browser/runner-prepare.mjs",

diff --git a/src/primordials.js b/src/primordials.js
@@ -103,6 +103,6 @@ module.exports = {
   TypedArrayPrototypeSet(self, buf, len) {
     return self.set(buf, len)
   },
-  Boolean: Boolean,
+  Boolean,
   Uint8Array
 }
diff --git a/src/util.js b/src/util.js
@@ -20,17 +20,15 @@ const isBlob =
 /* eslint-enable indent */
 
 const validateAbortSignal = (signal, name) => {
-  if (signal !== undefined &&
-      (signal === null ||
-       typeof signal !== 'object' ||
-       !('aborted' in signal))) {
-    throw new ERR_INVALID_ARG_TYPE(name, 'AbortSignal', signal);
+  if (signal !== undefined && (signal === null || typeof signal !== 'object' || !('aborted' in signal))) {
+    throw new ERR_INVALID_ARG_TYPE(name, 'AbortSignal', signal)
   }
-};
+}
 const validateFunction = (value, name) => {
-  if (typeof value !== 'function')
-    throw new ERR_INVALID_ARG_TYPE(name, 'Function', value);
-};
+  if (typeof value !== 'function') {
+    throw new ERR_INVALID_ARG_TYPE(name, 'Function', value)
+  }
+}
 
 // This is a simplified version of AggregateError
 class AggregateError extends Error {
@@ -153,45 +151,53 @@ module.exports = {
   deprecate(fn, message) {
     return fn
   },
-  addAbortListener: require('events').addAbortListener || function addAbortListener(signal, listener) {
-    if (signal === undefined) {
-      throw new ERR_INVALID_ARG_TYPE('signal', 'AbortSignal', signal);
-    }
-    validateAbortSignal(signal, 'signal');
-    validateFunction(listener, 'listener');
-
-    let removeEventListener;
-    if (signal.aborted) {
-      queueMicrotask(() => listener());
-    } else {
-      signal.addEventListener('abort', listener, { __proto__: null, once: true, [kResistStopPropagation]: true });
-      removeEventListener = () => {
-        signal.removeEventListener('abort', listener);
-      };
-    }
-    return {
-      __proto__: null,
-      [SymbolDispose]() {
-        removeEventListener?.();
-      },
-    };
-  },
-  AbortSignalAny: AbortSignal.any || function AbortSignalAny(signals) {
-    // Fast path if there is only one signal.
-    if (signals.length === 1) {
-      return signals[0]
+  addAbortListener:
+    require('events').addAbortListener ||
+    function addAbortListener(signal, listener) {
+      if (signal === undefined) {
+        throw new ERR_INVALID_ARG_TYPE('signal', 'AbortSignal', signal)
+      }
+      validateAbortSignal(signal, 'signal')
+      validateFunction(listener, 'listener')
+
+      let removeEventListener
+      if (signal.aborted) {
+        queueMicrotask(() => listener())
+      } else {
+        signal.addEventListener('abort', listener, { __proto__: null, once: true, [kResistStopPropagation]: true })
+        removeEventListener = () => {
+          signal.removeEventListener('abort', listener)
+        }
+      }
+      return {
+        __proto__: null,
+        [SymbolDispose]() {
+          removeEventListener?.()
+        }
+      }
+    },
+  AbortSignalAny:
+    AbortSignal.any ||
+    function AbortSignalAny(signals) {
+      // Fast path if there is only one signal.
+      if (signals.length === 1) {
+        return signals[0]
+      }
+      const ac = new AbortController()
+      const abort = () => ac.abort()
+      signals.forEach((signal) => {
+        validateAbortSignal(signal, 'signals')
+        signal.addEventListener('abort', abort, { once: true })
+      })
+      ac.signal.addEventListener(
+        'abort',
+        () => {
+          signals.forEach((signal) => signal.removeEventListener('abort', abort))
+        },
+        { once: true }
+      )
+      return ac.signal
     }
-    const ac = new AbortController()
-    const abort = () => ac.abort()
-    signals.forEach(signal => {
-      validateAbortSignal(signal, 'signals')
-      signal.addEventListener('abort', abort, { once: true })
-    })
-    ac.signal.addEventListener('abort', () => {
-      signals.forEach(signal => signal.removeEventListener('abort', abort))
-    }, { once: true })
-    return ac.signal
-  }
 }
 
 module.exports.promisify.custom = Symbol.for('nodejs.util.promisify.custom')
diff --git a/test/browser/test-stream2-readable-wrap.js b/test/browser/test-stream2-readable-wrap.js
@@ -47,7 +47,6 @@ module.exports = function (test) {
           old.emit('data', item)
           // console.log('after emit', chunks, flowing);
         }
-
         if (chunks <= 0) {
           oldEnded = true
           // console.log('old end', chunks, flowing);

diff --git a/test/common/fixtures.mjs b/test/common/fixtures.mjs
@@ -1,17 +1,5 @@
-import fixtures from './fixtures.js';
+import fixtures from './fixtures.js'
 
-const {
-  fixturesDir,
-  path,
-  fileURL,
-  readSync,
-  readKey,
-} = fixtures;
+const { fixturesDir, path, fileURL, readSync, readKey } = fixtures
 
-export {
-  fixturesDir,
-  path,
-  fileURL,
-  readSync,
-  readKey,
-};
+export { fixturesDir, path, fileURL, readSync, readKey }
diff --git a/test/common/index.js b/test/common/index.js
@@ -866,7 +866,6 @@ const common = {
   get enoughTestMem() {
     return require('os').totalmem() > 0x70000000 /* 1.75 Gb */
   },
-
   get hasFipsCrypto() {
     return hasCrypto && require('crypto').getFips()
   },

diff --git a/test/common/index.mjs b/test/common/index.mjs
@@ -1,7 +1,7 @@
-import { createRequire } from 'module';
+import { createRequire } from 'module'
 
-const require = createRequire(import.meta.url);
-const common = require('./index.js');
+const require = createRequire(import.meta.url)
+const common = require('./index.js')
 
 const {
   allowGlobals,
@@ -50,10 +50,10 @@ const {
   skipIfDumbTerminal,
   skipIfEslintMissing,
   skipIfInspectorDisabled,
-  spawnPromisified,
-} = common;
+  spawnPromisified
+} = common
 
-const getPort = () => common.PORT;
+const getPort = () => common.PORT
 
 export {
   allowGlobals,
@@ -104,5 +104,5 @@ export {
   skipIfDumbTerminal,
   skipIfEslintMissing,
   skipIfInspectorDisabled,
-  spawnPromisified,
-};
+  spawnPromisified
+}