Skip to content

buffer: cleanup handling different types buffers #54439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+59 −49
Open

buffer: cleanup handling different types buffers #54439

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0af1f9
buffer: cleanup handling different types buffers
ronag Aug 18, 2024
4a17f1f
Update lib/buffer.js
ronag Aug 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 59 additions & 49 deletions lib/buffer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,7 @@ const {
SymbolSpecies,
SymbolToPrimitive,
TypedArrayPrototypeFill,
TypedArrayPrototypeGetBuffer,
TypedArrayPrototypeGetByteLength,
TypedArrayPrototypeGetByteOffset,
TypedArrayPrototypeGetLength,
Comment on lines -47 to -50
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these no longer needed (in regards to primordials)?

TypedArrayPrototypeSet,
TypedArrayPrototypeSlice,
Uint8Array,
Uint8ArrayPrototype,
} = primordials;
Expand Down Expand Up @@ -93,7 +88,6 @@ const {
isAnyArrayBuffer,
isArrayBufferView,
isUint8Array,
isTypedArray,
} = require('internal/util/types');
const {
inspect: utilInspect,
Expand Down Expand Up @@ -133,6 +127,15 @@ FastBuffer.prototype.constructor = Buffer;
Buffer.prototype = FastBuffer.prototype;
addBufferPrototypeMethods(Buffer.prototype);

const BUFFER_NAMES = [
'ArrayBuffer',
'Buffer',
'TypedArray',
'DataView',
'ArrayBuffer',
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

duplicated 'ArrayBuffer' element

'SharedArrayBuffer',
];

const constants = ObjectDefineProperties({}, {
MAX_LENGTH: {
__proto__: null,
Expand Down Expand Up @@ -203,10 +206,13 @@ function toInteger(n, defaultVal) {
}

function copyImpl(source, target, targetStart, sourceStart, sourceEnd) {
if (!ArrayBufferIsView(source))
throw new ERR_INVALID_ARG_TYPE('source', ['Buffer', 'Uint8Array'], source);
if (!ArrayBufferIsView(target))
throw new ERR_INVALID_ARG_TYPE('target', ['Buffer', 'Uint8Array'], target);
if (isArrayBufferView(target)) {
// Do nothing..
} else if (isAnyArrayBuffer(target)) {
target = new Uint8Array(target);
} else {
throw new ERR_INVALID_ARG_TYPE('target', BUFFER_NAMES, target);
}

if (targetStart === undefined) {
targetStart = 0;
Expand Down Expand Up @@ -321,25 +327,29 @@ Buffer.from = function from(value, encodingOrOffset, length) {

throw new ERR_INVALID_ARG_TYPE(
'first argument',
['string', 'Buffer', 'ArrayBuffer', 'Array', 'Array-like Object'],
['string', 'Array', 'Array-like Object', ...BUFFER_NAMES],
value,
);
};

/**
* Creates the Buffer as a copy of the underlying ArrayBuffer of the view
* rather than the contents of the view.
* @param {TypedArray} view
* @param {Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer} view
* @param {number} [offset]
* @param {number} [length]
* @returns {Buffer}
*/
Buffer.copyBytesFrom = function copyBytesFrom(view, offset, length) {
if (!isTypedArray(view)) {
throw new ERR_INVALID_ARG_TYPE('view', [ 'TypedArray' ], view);
if (isArrayBufferView(view)) {
// Do nothing..
} else if (isAnyArrayBuffer(view)) {
view = new Uint8Array(view);
} else {
throw new ERR_INVALID_ARG_TYPE('view', BUFFER_NAMES, view);
}

const viewLength = TypedArrayPrototypeGetLength(view);
const viewLength = view.byteLength;
if (viewLength === 0) {
return Buffer.alloc(0);
}
Expand All @@ -351,21 +361,17 @@ Buffer.copyBytesFrom = function copyBytesFrom(view, offset, length) {
} else {
offset = 0;
}
let end;
if (length !== undefined) {
validateInteger(length, 'length', 0);
end = offset + length;
} else {
end = viewLength;
length = viewLength - offset;
}

view = TypedArrayPrototypeSlice(view, offset, end);
}

return fromArrayLike(new Uint8Array(
TypedArrayPrototypeGetBuffer(view),
TypedArrayPrototypeGetByteOffset(view),
TypedArrayPrototypeGetByteLength(view)));
view.buffer,
view.byteOffset + offset,
length));
};

// Identical to the built-in %TypedArray%.of(), but avoids using the deprecated
Expand Down Expand Up @@ -583,8 +589,8 @@ Buffer.concat = function concat(list, length) {
if (length === undefined) {
length = 0;
for (let i = 0; i < list.length; i++) {
if (list[i].length) {
length += list[i].length;
if (list[i].byteLength) {
length += list[i].byteLength;
}
}
} else {
Expand All @@ -595,13 +601,13 @@ Buffer.concat = function concat(list, length) {
let pos = 0;
for (let i = 0; i < list.length; i++) {
const buf = list[i];
if (!isUint8Array(buf)) {
if (!isArrayBufferView(buf) && !isAnyArrayBuffer(buf)) {
// TODO(BridgeAR): This should not be of type ERR_INVALID_ARG_TYPE.
// Instead, find the proper error code for this.
throw new ERR_INVALID_ARG_TYPE(
`list[${i}]`, ['Buffer', 'Uint8Array'], list[i]);
`list[${i}]`, BUFFER_NAMES, list[i]);
}
pos += _copyActual(buf, buffer, pos, 0, buf.length);
pos += _copyActual(buf, buffer, pos, 0, buf.byteLength);
}

// Note: `length` is always equal to `buffer.length` at this point
Expand Down Expand Up @@ -772,10 +778,7 @@ function byteLength(string, encoding) {
if (isArrayBufferView(string) || isAnyArrayBuffer(string)) {
return string.byteLength;
}

throw new ERR_INVALID_ARG_TYPE(
'string', ['string', 'Buffer', 'ArrayBuffer'], string,
);
throw new ERR_INVALID_ARG_TYPE('string', ['string', ...BUFFER_NAMES], string);
}

const len = string.length;
Expand Down Expand Up @@ -864,15 +867,18 @@ Buffer.prototype.toString = function toString(encoding, start, end) {
};

Buffer.prototype.equals = function equals(otherBuffer) {
if (!isUint8Array(otherBuffer)) {
throw new ERR_INVALID_ARG_TYPE(
'otherBuffer', ['Buffer', 'Uint8Array'], otherBuffer);
if (isArrayBufferView(otherBuffer)) {
// Do nothing..
} else if (isAnyArrayBuffer(otherBuffer)) {
otherBuffer = new Uint8Array(otherBuffer);
} else {
throw new ERR_INVALID_ARG_TYPE('otherBuffer', BUFFER_NAMES, otherBuffer);
}

if (this === otherBuffer)
return true;
const len = TypedArrayPrototypeGetByteLength(this);
if (len !== TypedArrayPrototypeGetByteLength(otherBuffer))
const len = this.byteLength;
if (len !== otherBuffer.byteLength)
return false;

return len === 0 || _compare(this, otherBuffer) === 0;
Expand Down Expand Up @@ -919,9 +925,14 @@ Buffer.prototype.compare = function compare(target,
targetEnd,
sourceStart,
sourceEnd) {
if (!isUint8Array(target)) {
throw new ERR_INVALID_ARG_TYPE('target', ['Buffer', 'Uint8Array'], target);
if (isArrayBufferView(target)) {
// Do nothing..
} else if (isAnyArrayBuffer(target)) {
target = new Uint8Array(target);
} else {
throw new ERR_INVALID_ARG_TYPE('target', BUFFER_NAMES, target);
}

if (arguments.length === 1)
return _compare(this, target);

Expand Down Expand Up @@ -997,14 +1008,14 @@ function bidirectionalIndexOf(buffer, val, byteOffset, encoding, dir) {
return ops.indexOf(buffer, val, byteOffset, dir);
}

if (isUint8Array(val)) {
if (isArrayBufferView(val) || isAnyArrayBuffer(val)) {
const encodingVal =
(ops === undefined ? encodingsMap.utf8 : ops.encodingVal);
return indexOfBuffer(buffer, val, byteOffset, encodingVal, dir);
}

throw new ERR_INVALID_ARG_TYPE(
'value', ['number', 'string', 'Buffer', 'Uint8Array'], val,
'value', ['number', 'string', ...BUFFER_NAMES], val,
);
}

Expand Down Expand Up @@ -1081,7 +1092,7 @@ function _fill(buf, value, offset, end, encoding) {

if (typeof value === 'number') {
// OOB check
const byteLen = TypedArrayPrototypeGetByteLength(buf);
const byteLen = buf.byteLength;
const fillLength = end - offset;
if (offset > end || fillLength + offset > byteLen)
throw new ERR_BUFFER_OUT_OF_BOUNDS();
Expand Down Expand Up @@ -1247,9 +1258,8 @@ if (internalBinding('config').hasIntl) {
// Transcodes the Buffer from one encoding to another, returning a new
// Buffer instance.
transcode = function transcode(source, fromEncoding, toEncoding) {
if (!isUint8Array(source)) {
throw new ERR_INVALID_ARG_TYPE('source',
['Buffer', 'Uint8Array'], source);
if (!ArrayBufferIsView(source) && !isAnyArrayBuffer(source)) {
throw new ERR_INVALID_ARG_TYPE('source', BUFFER_NAMES, source);
}
if (source.length === 0) return Buffer.alloc(0);

Expand Down Expand Up @@ -1305,19 +1315,19 @@ function atob(input) {
}

function isUtf8(input) {
if (isTypedArray(input) || isAnyArrayBuffer(input)) {
if (isArrayBufferView(input) || isAnyArrayBuffer(input)) {
return bindingIsUtf8(input);
}

throw new ERR_INVALID_ARG_TYPE('input', ['ArrayBuffer', 'Buffer', 'TypedArray'], input);
throw new ERR_INVALID_ARG_TYPE('input', BUFFER_NAMES, input);
}

function isAscii(input) {
if (isTypedArray(input) || isAnyArrayBuffer(input)) {
if (isArrayBufferView(input) || isAnyArrayBuffer(input)) {
return bindingIsAscii(input);
}

throw new ERR_INVALID_ARG_TYPE('input', ['ArrayBuffer', 'Buffer', 'TypedArray'], input);
throw new ERR_INVALID_ARG_TYPE('input', BUFFER_NAMES, input);
}

module.exports = {
Expand Down
Loading