lib: runtime deprecate SlowBuffer

PR-URL: #55175 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
nodejs · Oct 15, 2024 · 019efe1 · 019efe1
1 parent 2545b9e
commit 019efe1
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
@@ -695,6 +695,9 @@ Type: End-of-Life
 
 <!-- YAML
 changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/55175
+ description: Runtime deprecation.
  - version: v6.12.0
  pr-url: https://github.com/nodejs/node/pull/10116
  description: A deprecation code has been assigned.
@@ -703,7 +706,7 @@ changes:
  description: Documentation-only deprecation.
 -->
 
-Type: Documentation-only
+Type: Runtime
 
 The [`SlowBuffer`][] class is deprecated. Please use
 [`Buffer.allocUnsafeSlow(size)`][] instead.

diff --git a/lib/buffer.js b/lib/buffer.js
@@ -88,6 +88,7 @@ const {
  kIsEncodingSymbol,
  defineLazyProperties,
  encodingsMap,
+ deprecate,
 } = require('internal/util');
 const {
  isAnyArrayBuffer,
@@ -1322,7 +1323,10 @@ function isAscii(input) {
 
 module.exports = {
  Buffer,
- SlowBuffer,
+ SlowBuffer: deprecate(
+ SlowBuffer,
+ 'SlowBuffer() is deprecated. Please use Buffer.allocUnsafeSlow()',
+ 'DEP0030'),
  transcode,
  isUtf8,
  isAscii,

diff --git a/test/parallel/test-buffer-slow.js b/test/parallel/test-buffer-slow.js
@@ -1,12 +1,18 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 const buffer = require('buffer');
 const SlowBuffer = buffer.SlowBuffer;
 
 const ones = [1, 1, 1, 1];
 
+common.expectWarning(
+ 'DeprecationWarning',
+ 'SlowBuffer() is deprecated. Please use Buffer.allocUnsafeSlow()',
+ 'DEP0030'
+);
+
 // Should create a Buffer
 let sb = SlowBuffer(4);
 assert(sb instanceof Buffer);