buffer: expose btoa and atob as globals

Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: #37786 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Michaël Zasso <targos@protonmail.com>
nodejs · Mar 25, 2021 · d1e2184c8ea0362ad695d51fb6409fc1741a227b · d1e2184
1 parent abbd9d9
commit d1e2184c8ea0362ad695d51fb6409fc1741a227b
Unified Split

Showing with 67 additions and 6 deletions.

+2 −0 .eslintrc.js

+4 −0 doc/api/buffer.md

+20 −0 doc/api/globals.md

+25 −6 lib/internal/bootstrap/node.js

+7 −0 test/common/index.js

+9 −0 test/parallel/test-btoa-atob-global.js
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -329,5 +329,7 @@ module.exports = {
     TextDecoder: 'readable',
     queueMicrotask: 'readable',
     globalThis: 'readable',
+    btoa: 'readable',
+    atob: 'readable',
   },
 };
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
@@ -3282,6 +3282,8 @@ accessed using `require('buffer')`.
 added: REPLACEME
 -->
 
+> Stability: 3 - Legacy. Use `Buffer.from(data, 'base64')` instead.
+
 * `data` {any} The Base64-encoded input string.
 
 Decodes a string of Base64-encoded data into bytes, and encodes those bytes
@@ -3301,6 +3303,8 @@ and binary data should be performed using `Buffer.from(str, 'base64')` and
 added: REPLACEME
 -->
 
+> Stability: 3 - Legacy. Use `buf.toString('base64')` instead.
+
 * `data` {any} An ASCII (Latin1) string.
 
 Decodes a string into bytes using Latin-1 (ISO-8859), and encodes those bytes

diff --git a/doc/api/globals.md b/doc/api/globals.md
@@ -146,6 +146,24 @@ This variable may appear to be global but is not. See [`__dirname`][].
 
 This variable may appear to be global but is not. See [`__filename`][].
 
+## `atob(data)`
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 3 - Legacy. Use `Buffer.from(data, 'base64')` instead.
+
+Global alias for [`buffer.atob()`][].
+
+## `btoa(data)`
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 3 - Legacy. Use `buf.toString('base64')` instead.
+
+Global alias for [`buffer.btoa()`][].
+
 ## `clearImmediate(immediateObject)`
 <!-- YAML
 added: v0.9.1
@@ -402,6 +420,8 @@ The object that acts as the namespace for all W3C
 [`URL`]: url.md#url_class_url
 [`__dirname`]: modules.md#modules_dirname
 [`__filename`]: modules.md#modules_filename
+[`buffer.atob()`]: buffer.md#buffer_buffer_atob_data
+[`buffer.btoa()`]: buffer.md#buffer_buffer_btoa_data
 [`clearImmediate`]: timers.md#timers_clearimmediate_immediate
 [`clearInterval`]: timers.md#timers_clearinterval_timeout
 [`clearTimeout`]: timers.md#timers_cleartimeout_timeout

diff --git a/lib/internal/bootstrap/node.js b/lib/internal/bootstrap/node.js
@@ -42,6 +42,7 @@ const {
   FunctionPrototypeCall,
   JSONParse,
   ObjectDefineProperty,
+  ObjectDefineProperties,
   ObjectGetPrototypeOf,
   ObjectPreventExtensions,
   ObjectSetPrototypeOf,
@@ -400,19 +401,37 @@ function setupGlobalProxy() {
 }
 
 function setupBuffer() {
-  const { Buffer } = require('buffer');
+  const {
+    Buffer,
+    atob,
+    btoa,
+  } = require('buffer');
   const bufferBinding = internalBinding('buffer');
 
   // Only after this point can C++ use Buffer::New()
   bufferBinding.setBufferPrototype(Buffer.prototype);
   delete bufferBinding.setBufferPrototype;
   delete bufferBinding.zeroFill;
 
-  ObjectDefineProperty(global, 'Buffer', {
-    value: Buffer,
-    enumerable: false,
-    writable: true,
-    configurable: true
+  ObjectDefineProperties(global, {
+    'Buffer': {
+      value: Buffer,
+      enumerable: false,
+      writable: true,
+      configurable: true,
+    },
+    'atob': {
+      value: atob,
+      enumerable: false,
+      writable: true,
+      configurable: true,
+    },
+    'btoa': {
+      value: btoa,
+      enumerable: false,
+      writable: true,
+      configurable: true,
+    },
   });
 }
 

diff --git a/test/common/index.js b/test/common/index.js
@@ -38,6 +38,11 @@ const bits = ['arm64', 'mips', 'mipsel', 'ppc64', 's390x', 'x64']
   .includes(process.arch) ? 64 : 32;
 const hasIntl = !!process.config.variables.v8_enable_i18n_support;
 
+const {
+  atob,
+  btoa
+} = require('buffer');
+
 // Some tests assume a umask of 0o022 so set that up front. Tests that need a
 // different umask will set it themselves.
 //
@@ -257,6 +262,8 @@ function platformTimeout(ms) {
 }
 
 let knownGlobals = [
+  atob,
+  btoa,
   clearImmediate,
   clearInterval,
   clearTimeout,

diff --git a/test/parallel/test-btoa-atob-global.js b/test/parallel/test-btoa-atob-global.js
@@ -0,0 +1,9 @@
+'use strict';
+
+require('../common');
+
+const { strictEqual } = require('assert');
+const buffer = require('buffer');
+
+strictEqual(globalThis.atob, buffer.atob);
+strictEqual(globalThis.btoa, buffer.btoa);