All files / lib/internal blob.js

98.78% Statements 406/411
82.61% Branches 57/69
94.74% Functions 18/19
98.78% Lines 406/411

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 41222x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 7x 7x 7x 7x 22x 5x 5x 5x 5x 5x 22x 22x 22x 22x 1x 1x 1x 1x 22x 212x 212x 212x 22x 62x 62x 62x 61x 62x 1x 62x 36x 36x 36x 36x 36x 61x 61x 61x 61x 61x 61x 61x 62x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 58x 58x 58x 58x 3x 3x 55x 55x 55x 55x 55x 55x 55x 58x 58x 52x 52x 52x 62x 62x 62x 52x 52x 52x 58x 52x 52x 52x 52x 52x 58x 58x 58x 58x 58x 58x 22x 22x 2x 2x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 22x 22x 1x 1x 1x 1x 1x 1x 1x 1x 22x 22x 1x 1x 1x 1x 22x 22x 22x 22x 22x 22x 14x 14x 14x 14x 22x 22x 22x 22x 22x 22x 32x 32x 32x 32x 22x 22x 22x 22x 22x 22x 22x 22x 13x 13x 13x 2x 13x 11x 11x 13x 13x 13x 6x 13x 7x 7x 13x 13x 13x 13x   13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 22x 22x 22x 22x 22x 49x 49x 49x 49x 49x 49x 49x 49x 49x 47x 47x 47x 47x 47x 47x 47x 47x 47x 49x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 49x 22x 22x 22x 22x 22x 25x 25x 25x 25x 25x 25x 22x 22x 22x 22x 22x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x         5x 5x 5x 22x 22x 1x 1x 1x 22x 22x 14x 14x 14x 14x 14x 14x 14x 22x 22x 22x 22x 22x 22x 7x 7x 7x 7x 7x 7x 7x 7x 7x 2x 2x 2x 2x 2x 2x 2x 7x 2x 2x 2x 2x 7x 1x 1x 1x 1x 1x 1x 1x 1x 1x 7x 4x 4x 7x 22x 22x 22x 22x 22x 22x 22x 22x 22x  
'use strict';
 
const {
  ArrayFrom,
  MathMax,
  MathMin,
  ObjectDefineProperty,
  PromiseResolve,
  PromiseReject,
  SafePromisePrototypeFinally,
  ReflectConstruct,
  RegExpPrototypeSymbolReplace,
  RegExpPrototypeTest,
  StringPrototypeToLowerCase,
  StringPrototypeSplit,
  Symbol,
  SymbolIterator,
  SymbolToStringTag,
  Uint8Array,
} = primordials;
 
const {
  createBlob: _createBlob,
  FixedSizeBlobCopyJob,
  getDataObject,
} = internalBinding('blob');
 
const {
  TextDecoder,
  TextEncoder,
} = require('internal/encoding');
 
const {
  makeTransferable,
  kClone,
  kDeserialize,
} = require('internal/worker/js_transferable');
 
const {
  isAnyArrayBuffer,
  isArrayBufferView,
} = require('internal/util/types');
 
const {
  createDeferredPromise,
  customInspectSymbol: kInspect,
  emitExperimentalWarning,
} = require('internal/util');
const { inspect } = require('internal/util/inspect');
 
const {
  AbortError,
  codes: {
    ERR_INVALID_ARG_TYPE,
    ERR_INVALID_ARG_VALUE,
    ERR_INVALID_THIS,
    ERR_BUFFER_TOO_LARGE,
  }
} = require('internal/errors');
 
const {
  validateObject,
  isUint32,
} = require('internal/validators');
 
const kHandle = Symbol('kHandle');
const kState = Symbol('kState');
const kType = Symbol('kType');
const kLength = Symbol('kLength');
const kArrayBufferPromise = Symbol('kArrayBufferPromise');
 
const kMaxChunkSize = 65536;
 
const disallowedTypeCharacters = /[^\u{0020}-\u{007E}]/u;
 
let ReadableStream;
let URL;
let EOL;
 
const enc = new TextEncoder();
 
// Yes, lazy loading is annoying but because of circular
// references between the url, internal/blob, and buffer
// modules, lazy loading here makes sure that things work.
 
function lazyURL(id) {
  URL ??= require('internal/url').URL;
  return new URL(id);
}
 
function lazyReadableStream(options) {
  ReadableStream ??=
    require('internal/webstreams/readablestream').ReadableStream;
  return new ReadableStream(options);
}
 
// TODO(@jasnell): This is annoying but this has to be lazy because
// requiring the 'os' module too early causes building Node.js to
// fail with an unknown reference failure.
function lazyEOL() {
  EOL ??= require('os').EOL;
  return EOL;
}
 
function isBlob(object) {
  return object?.[kHandle] !== undefined;
}
 
function getSource(source, endings) {
  if (isBlob(source))
    return [source.size, source[kHandle]];
 
  if (isAnyArrayBuffer(source)) {
    source = new Uint8Array(source);
  } else if (!isArrayBufferView(source)) {
    source = `${source}`;
    if (endings === 'native')
      source = RegExpPrototypeSymbolReplace(/\n|\r\n/g, source, lazyEOL());
    source = enc.encode(source);
  }
 
  // We copy into a new Uint8Array because the underlying
  // BackingStores are going to be detached and owned by
  // the Blob. We also don't want to have to worry about
  // byte offsets.
  source = new Uint8Array(source);
  return [source.byteLength, source];
}
 
class Blob {
  /**
   * @typedef {string|ArrayBuffer|ArrayBufferView|Blob} SourcePart
   *
   * @param {SourcePart[]} [sources]
   * @param {{
   *   endings? : string,
   *   type? : string,
   * }} [options]
   * @returns
   */
  constructor(sources = [], options = {}) {
    emitExperimentalWarning('buffer.Blob');
    if (sources === null ||
        typeof sources[SymbolIterator] !== 'function' ||
        typeof sources === 'string') {
      throw new ERR_INVALID_ARG_TYPE('sources', 'Iterable', sources);
    }
    validateObject(options, 'options');
    let {
      type = '',
      endings = 'transparent',
    } = options;
 
    endings = `${endings}`;
    if (endings !== 'transparent' && endings !== 'native')
      throw new ERR_INVALID_ARG_VALUE('options.endings', endings);
 
    let length = 0;
    const sources_ = ArrayFrom(sources, (source) => {
      const { 0: len, 1: src } = getSource(source, endings);
      length += len;
      return src;
    });
 
    if (!isUint32(length))
      throw new ERR_BUFFER_TOO_LARGE(0xFFFFFFFF);
 
    this[kHandle] = _createBlob(sources_, length);
    this[kLength] = length;
 
    type = `${type}`;
    this[kType] = RegExpPrototypeTest(disallowedTypeCharacters, type) ?
      '' : StringPrototypeToLowerCase(type);
 
    // eslint-disable-next-line no-constructor-return
    return makeTransferable(this);
  }
 
  [kInspect](depth, options) {
    if (depth < 0)
      return this;
 
    const opts = {
      ...options,
      depth: options.depth == null ? null : options.depth - 1
    };
 
    return `Blob ${inspect({
      size: this.size,
      type: this.type,
    }, opts)}`;
  }
 
  [kClone]() {
    const handle = this[kHandle];
    const type = this[kType];
    const length = this[kLength];
    return {
      data: { handle, type, length },
      deserializeInfo: 'internal/blob:ClonedBlob'
    };
  }
 
  [kDeserialize]({ handle, type, length }) {
    this[kHandle] = handle;
    this[kType] = type;
    this[kLength] = length;
  }
 
  /**
   * @readonly
   * @type {string}
   */
  get type() {
    if (!isBlob(this))
      throw new ERR_INVALID_THIS('Blob');
    return this[kType];
  }
 
  /**
   * @readonly
   * @type {number}
   */
  get size() {
    if (!isBlob(this))
      throw new ERR_INVALID_THIS('Blob');
    return this[kLength];
  }
 
  /**
   * @param {number} [start]
   * @param {number} [end]
   * @param {string} [contentType]
   * @returns {Blob}
   */
  slice(start = 0, end = this[kLength], contentType = '') {
    if (!isBlob(this))
      throw new ERR_INVALID_THIS('Blob');
    if (start < 0) {
      start = MathMax(this[kLength] + start, 0);
    } else {
      start = MathMin(start, this[kLength]);
    }
    start |= 0;
 
    if (end < 0) {
      end = MathMax(this[kLength] + end, 0);
    } else {
      end = MathMin(end, this[kLength]);
    }
    end |= 0;
 
    contentType = `${contentType}`;
    if (RegExpPrototypeTest(disallowedTypeCharacters, contentType)) {
      contentType = '';
    } else {
      contentType = StringPrototypeToLowerCase(contentType);
    }
 
    const span = MathMax(end - start, 0);
 
    return createBlob(
      this[kHandle].slice(start, start + span),
      span,
      contentType);
  }
 
  /**
   * @returns {Promise<ArrayBuffer>}
   */
  arrayBuffer() {
    if (!isBlob(this))
      return PromiseReject(new ERR_INVALID_THIS('Blob'));
 
    // If there's already a promise in flight for the content,
    // reuse it, but only while it's in flight. After the cached
    // promise resolves it will be cleared, allowing it to be
    // garbage collected as soon as possible.
    if (this[kArrayBufferPromise])
      return this[kArrayBufferPromise];
 
    const job = new FixedSizeBlobCopyJob(this[kHandle]);
 
    const ret = job.run();
 
    // If the job returns a value immediately, the ArrayBuffer
    // was generated synchronously and should just be returned
    // directly.
    if (ret !== undefined)
      return PromiseResolve(ret);
 
    const {
      promise,
      resolve,
      reject,
    } = createDeferredPromise();
 
    job.ondone = (err, ab) => {
      if (err !== undefined)
        return reject(new AbortError());
      resolve(ab);
    };
    this[kArrayBufferPromise] =
    SafePromisePrototypeFinally(
      promise,
      () => this[kArrayBufferPromise] = undefined);
 
    return this[kArrayBufferPromise];
  }
 
  /**
   * @returns {Promise<string>}
   */
  async text() {
    if (!isBlob(this))
      throw new ERR_INVALID_THIS('Blob');
 
    const dec = new TextDecoder();
    return dec.decode(await this.arrayBuffer());
  }
 
  /**
   * @returns {ReadableStream}
   */
  stream() {
    if (!isBlob(this))
      throw new ERR_INVALID_THIS('Blob');
 
    const self = this;
    return new lazyReadableStream({
      async start() {
        this[kState] = await self.arrayBuffer();
      },
 
      pull(controller) {
        if (this[kState].byteLength <= kMaxChunkSize) {
          controller.enqueue(new Uint8Array(this[kState]));
          controller.close();
          this[kState] = undefined;
        } else {
          const slice = this[kState].slice(0, kMaxChunkSize);
          this[kState] = this[kState].slice(kMaxChunkSize);
          controller.enqueue(new Uint8Array(slice));
        }
      }
    });
  }
}
 
function ClonedBlob() {
  return makeTransferable(ReflectConstruct(function() {}, [], Blob));
}
ClonedBlob.prototype[kDeserialize] = () => {};
 
function createBlob(handle, length, type = '') {
  return makeTransferable(ReflectConstruct(function() {
    this[kHandle] = handle;
    this[kType] = type;
    this[kLength] = length;
  }, [], Blob));
}
 
ObjectDefineProperty(Blob.prototype, SymbolToStringTag, {
  configurable: true,
  value: 'Blob',
});
 
function resolveObjectURL(url) {
  url = `${url}`;
  try {
    const parsed = new lazyURL(url);
 
    const split = StringPrototypeSplit(parsed.pathname, ':');
 
    if (split.length !== 2)
      return;
 
    const {
      0: base,
      1: id,
    } = split;
 
    if (base !== 'nodedata')
      return;
 
    const ret = getDataObject(id);
 
    if (ret === undefined)
      return;
 
    const {
      0: handle,
      1: length,
      2: type,
    } = ret;
 
    if (handle !== undefined)
      return createBlob(handle, length, type);
  } catch {
    // If there's an error, it's ignored and nothing is returned
  }
}
 
module.exports = {
  Blob,
  ClonedBlob,
  createBlob,
  isBlob,
  kHandle,
  resolveObjectURL,
};