web.structured-clone.js 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502
  1. var IS_PURE = require('../internals/is-pure');
  2. var $ = require('../internals/export');
  3. var global = require('../internals/global');
  4. var getBuiltin = require('../internals/get-built-in');
  5. var uncurryThis = require('../internals/function-uncurry-this');
  6. var fails = require('../internals/fails');
  7. var uid = require('../internals/uid');
  8. var isCallable = require('../internals/is-callable');
  9. var isConstructor = require('../internals/is-constructor');
  10. var isNullOrUndefined = require('../internals/is-null-or-undefined');
  11. var isObject = require('../internals/is-object');
  12. var isSymbol = require('../internals/is-symbol');
  13. var iterate = require('../internals/iterate');
  14. var anObject = require('../internals/an-object');
  15. var classof = require('../internals/classof');
  16. var hasOwn = require('../internals/has-own-property');
  17. var createProperty = require('../internals/create-property');
  18. var createNonEnumerableProperty = require('../internals/create-non-enumerable-property');
  19. var lengthOfArrayLike = require('../internals/length-of-array-like');
  20. var validateArgumentsLength = require('../internals/validate-arguments-length');
  21. var getRegExpFlags = require('../internals/regexp-get-flags');
  22. var MapHelpers = require('../internals/map-helpers');
  23. var SetHelpers = require('../internals/set-helpers');
  24. var ERROR_STACK_INSTALLABLE = require('../internals/error-stack-installable');
  25. var PROPER_TRANSFER = require('../internals/structured-clone-proper-transfer');
  26. var Object = global.Object;
  27. var Array = global.Array;
  28. var Date = global.Date;
  29. var Error = global.Error;
  30. var EvalError = global.EvalError;
  31. var RangeError = global.RangeError;
  32. var ReferenceError = global.ReferenceError;
  33. var SyntaxError = global.SyntaxError;
  34. var TypeError = global.TypeError;
  35. var URIError = global.URIError;
  36. var PerformanceMark = global.PerformanceMark;
  37. var WebAssembly = global.WebAssembly;
  38. var CompileError = WebAssembly && WebAssembly.CompileError || Error;
  39. var LinkError = WebAssembly && WebAssembly.LinkError || Error;
  40. var RuntimeError = WebAssembly && WebAssembly.RuntimeError || Error;
  41. var DOMException = getBuiltin('DOMException');
  42. var Map = MapHelpers.Map;
  43. var mapHas = MapHelpers.has;
  44. var mapGet = MapHelpers.get;
  45. var mapSet = MapHelpers.set;
  46. var Set = SetHelpers.Set;
  47. var setAdd = SetHelpers.add;
  48. var objectKeys = getBuiltin('Object', 'keys');
  49. var push = uncurryThis([].push);
  50. var thisBooleanValue = uncurryThis(true.valueOf);
  51. var thisNumberValue = uncurryThis(1.0.valueOf);
  52. var thisStringValue = uncurryThis(''.valueOf);
  53. var thisTimeValue = uncurryThis(Date.prototype.getTime);
  54. var PERFORMANCE_MARK = uid('structuredClone');
  55. var DATA_CLONE_ERROR = 'DataCloneError';
  56. var TRANSFERRING = 'Transferring';
  57. var checkBasicSemantic = function (structuredCloneImplementation) {
  58. return !fails(function () {
  59. var set1 = new global.Set([7]);
  60. var set2 = structuredCloneImplementation(set1);
  61. var number = structuredCloneImplementation(Object(7));
  62. return set2 == set1 || !set2.has(7) || typeof number != 'object' || number != 7;
  63. }) && structuredCloneImplementation;
  64. };
  65. var checkErrorsCloning = function (structuredCloneImplementation, $Error) {
  66. return !fails(function () {
  67. var error = new $Error();
  68. var test = structuredCloneImplementation({ a: error, b: error });
  69. return !(test && test.a === test.b && test.a instanceof $Error && test.a.stack === error.stack);
  70. });
  71. };
  72. // https://github.com/whatwg/html/pull/5749
  73. var checkNewErrorsCloningSemantic = function (structuredCloneImplementation) {
  74. return !fails(function () {
  75. var test = structuredCloneImplementation(new global.AggregateError([1], PERFORMANCE_MARK, { cause: 3 }));
  76. return test.name != 'AggregateError' || test.errors[0] != 1 || test.message != PERFORMANCE_MARK || test.cause != 3;
  77. });
  78. };
  79. // FF94+, Safari 15.4+, Chrome 98+, NodeJS 17.0+, Deno 1.13+
  80. // FF<103 and Safari implementations can't clone errors
  81. // https://bugzilla.mozilla.org/show_bug.cgi?id=1556604
  82. // FF103 can clone errors, but `.stack` of clone is an empty string
  83. // https://bugzilla.mozilla.org/show_bug.cgi?id=1778762
  84. // FF104+ fixed it on usual errors, but not on DOMExceptions
  85. // https://bugzilla.mozilla.org/show_bug.cgi?id=1777321
  86. // Chrome <102 returns `null` if cloned object contains multiple references to one error
  87. // https://bugs.chromium.org/p/v8/issues/detail?id=12542
  88. // NodeJS implementation can't clone DOMExceptions
  89. // https://github.com/nodejs/node/issues/41038
  90. // only FF103+ supports new (html/5749) error cloning semantic
  91. var nativeStructuredClone = global.structuredClone;
  92. var FORCED_REPLACEMENT = IS_PURE
  93. || !checkErrorsCloning(nativeStructuredClone, Error)
  94. || !checkErrorsCloning(nativeStructuredClone, DOMException)
  95. || !checkNewErrorsCloningSemantic(nativeStructuredClone);
  96. // Chrome 82+, Safari 14.1+, Deno 1.11+
  97. // Chrome 78-81 implementation swaps `.name` and `.message` of cloned `DOMException`
  98. // Chrome returns `null` if cloned object contains multiple references to one error
  99. // Safari 14.1 implementation doesn't clone some `RegExp` flags, so requires a workaround
  100. // Safari implementation can't clone errors
  101. // Deno 1.2-1.10 implementations too naive
  102. // NodeJS 16.0+ does not have `PerformanceMark` constructor
  103. // NodeJS <17.2 structured cloning implementation from `performance.mark` is too naive
  104. // and can't clone, for example, `RegExp` or some boxed primitives
  105. // https://github.com/nodejs/node/issues/40840
  106. // no one of those implementations supports new (html/5749) error cloning semantic
  107. var structuredCloneFromMark = !nativeStructuredClone && checkBasicSemantic(function (value) {
  108. return new PerformanceMark(PERFORMANCE_MARK, { detail: value }).detail;
  109. });
  110. var nativeRestrictedStructuredClone = checkBasicSemantic(nativeStructuredClone) || structuredCloneFromMark;
  111. var throwUncloneable = function (type) {
  112. throw new DOMException('Uncloneable type: ' + type, DATA_CLONE_ERROR);
  113. };
  114. var throwUnpolyfillable = function (type, action) {
  115. throw new DOMException((action || 'Cloning') + ' of ' + type + ' cannot be properly polyfilled in this engine', DATA_CLONE_ERROR);
  116. };
  117. var createDataTransfer = function () {
  118. var dataTransfer;
  119. try {
  120. dataTransfer = new global.DataTransfer();
  121. } catch (error) {
  122. try {
  123. dataTransfer = new global.ClipboardEvent('').clipboardData;
  124. } catch (error2) { /* empty */ }
  125. }
  126. return dataTransfer && dataTransfer.items && dataTransfer.files ? dataTransfer : null;
  127. };
  128. var structuredCloneInternal = function (value, map) {
  129. if (isSymbol(value)) throwUncloneable('Symbol');
  130. if (!isObject(value)) return value;
  131. // effectively preserves circular references
  132. if (map) {
  133. if (mapHas(map, value)) return mapGet(map, value);
  134. } else map = new Map();
  135. var type = classof(value);
  136. var deep = false;
  137. var C, name, cloned, dataTransfer, i, length, keys, key, source, target, options;
  138. switch (type) {
  139. case 'Array':
  140. cloned = Array(lengthOfArrayLike(value));
  141. deep = true;
  142. break;
  143. case 'Object':
  144. cloned = {};
  145. deep = true;
  146. break;
  147. case 'Map':
  148. cloned = new Map();
  149. deep = true;
  150. break;
  151. case 'Set':
  152. cloned = new Set();
  153. deep = true;
  154. break;
  155. case 'RegExp':
  156. // in this block because of a Safari 14.1 bug
  157. // old FF does not clone regexes passed to the constructor, so get the source and flags directly
  158. cloned = new RegExp(value.source, getRegExpFlags(value));
  159. break;
  160. case 'Error':
  161. name = value.name;
  162. switch (name) {
  163. case 'AggregateError':
  164. cloned = getBuiltin('AggregateError')([]);
  165. break;
  166. case 'EvalError':
  167. cloned = EvalError();
  168. break;
  169. case 'RangeError':
  170. cloned = RangeError();
  171. break;
  172. case 'ReferenceError':
  173. cloned = ReferenceError();
  174. break;
  175. case 'SyntaxError':
  176. cloned = SyntaxError();
  177. break;
  178. case 'TypeError':
  179. cloned = TypeError();
  180. break;
  181. case 'URIError':
  182. cloned = URIError();
  183. break;
  184. case 'CompileError':
  185. cloned = CompileError();
  186. break;
  187. case 'LinkError':
  188. cloned = LinkError();
  189. break;
  190. case 'RuntimeError':
  191. cloned = RuntimeError();
  192. break;
  193. default:
  194. cloned = Error();
  195. }
  196. deep = true;
  197. break;
  198. case 'DOMException':
  199. cloned = new DOMException(value.message, value.name);
  200. deep = true;
  201. break;
  202. case 'DataView':
  203. case 'Int8Array':
  204. case 'Uint8Array':
  205. case 'Uint8ClampedArray':
  206. case 'Int16Array':
  207. case 'Uint16Array':
  208. case 'Int32Array':
  209. case 'Uint32Array':
  210. case 'Float32Array':
  211. case 'Float64Array':
  212. case 'BigInt64Array':
  213. case 'BigUint64Array':
  214. C = global[type];
  215. // in some old engines like Safari 9, typeof C is 'object'
  216. // on Uint8ClampedArray or some other constructors
  217. if (!isObject(C)) throwUnpolyfillable(type);
  218. cloned = new C(
  219. // this is safe, since arraybuffer cannot have circular references
  220. structuredCloneInternal(value.buffer, map),
  221. value.byteOffset,
  222. type === 'DataView' ? value.byteLength : value.length
  223. );
  224. break;
  225. case 'DOMQuad':
  226. try {
  227. cloned = new DOMQuad(
  228. structuredCloneInternal(value.p1, map),
  229. structuredCloneInternal(value.p2, map),
  230. structuredCloneInternal(value.p3, map),
  231. structuredCloneInternal(value.p4, map)
  232. );
  233. } catch (error) {
  234. if (nativeRestrictedStructuredClone) {
  235. cloned = nativeRestrictedStructuredClone(value);
  236. } else throwUnpolyfillable(type);
  237. }
  238. break;
  239. case 'FileList':
  240. dataTransfer = createDataTransfer();
  241. if (dataTransfer) {
  242. for (i = 0, length = lengthOfArrayLike(value); i < length; i++) {
  243. dataTransfer.items.add(structuredCloneInternal(value[i], map));
  244. }
  245. cloned = dataTransfer.files;
  246. } else if (nativeRestrictedStructuredClone) {
  247. cloned = nativeRestrictedStructuredClone(value);
  248. } else throwUnpolyfillable(type);
  249. break;
  250. case 'ImageData':
  251. // Safari 9 ImageData is a constructor, but typeof ImageData is 'object'
  252. try {
  253. cloned = new ImageData(
  254. structuredCloneInternal(value.data, map),
  255. value.width,
  256. value.height,
  257. { colorSpace: value.colorSpace }
  258. );
  259. } catch (error) {
  260. if (nativeRestrictedStructuredClone) {
  261. cloned = nativeRestrictedStructuredClone(value);
  262. } else throwUnpolyfillable(type);
  263. } break;
  264. default:
  265. if (nativeRestrictedStructuredClone) {
  266. cloned = nativeRestrictedStructuredClone(value);
  267. } else switch (type) {
  268. case 'BigInt':
  269. // can be a 3rd party polyfill
  270. cloned = Object(value.valueOf());
  271. break;
  272. case 'Boolean':
  273. cloned = Object(thisBooleanValue(value));
  274. break;
  275. case 'Number':
  276. cloned = Object(thisNumberValue(value));
  277. break;
  278. case 'String':
  279. cloned = Object(thisStringValue(value));
  280. break;
  281. case 'Date':
  282. cloned = new Date(thisTimeValue(value));
  283. break;
  284. case 'ArrayBuffer':
  285. C = global.DataView;
  286. // `ArrayBuffer#slice` is not available in IE10
  287. // `ArrayBuffer#slice` and `DataView` are not available in old FF
  288. if (!C && typeof value.slice != 'function') throwUnpolyfillable(type);
  289. // detached buffers throws in `DataView` and `.slice`
  290. try {
  291. if (typeof value.slice == 'function' && !value.resizable) {
  292. cloned = value.slice(0);
  293. } else {
  294. length = value.byteLength;
  295. options = 'maxByteLength' in value ? { maxByteLength: value.maxByteLength } : undefined;
  296. cloned = new ArrayBuffer(length, options);
  297. source = new C(value);
  298. target = new C(cloned);
  299. for (i = 0; i < length; i++) {
  300. target.setUint8(i, source.getUint8(i));
  301. }
  302. }
  303. } catch (error) {
  304. throw new DOMException('ArrayBuffer is detached', DATA_CLONE_ERROR);
  305. } break;
  306. case 'SharedArrayBuffer':
  307. // SharedArrayBuffer should use shared memory, we can't polyfill it, so return the original
  308. cloned = value;
  309. break;
  310. case 'Blob':
  311. try {
  312. cloned = value.slice(0, value.size, value.type);
  313. } catch (error) {
  314. throwUnpolyfillable(type);
  315. } break;
  316. case 'DOMPoint':
  317. case 'DOMPointReadOnly':
  318. C = global[type];
  319. try {
  320. cloned = C.fromPoint
  321. ? C.fromPoint(value)
  322. : new C(value.x, value.y, value.z, value.w);
  323. } catch (error) {
  324. throwUnpolyfillable(type);
  325. } break;
  326. case 'DOMRect':
  327. case 'DOMRectReadOnly':
  328. C = global[type];
  329. try {
  330. cloned = C.fromRect
  331. ? C.fromRect(value)
  332. : new C(value.x, value.y, value.width, value.height);
  333. } catch (error) {
  334. throwUnpolyfillable(type);
  335. } break;
  336. case 'DOMMatrix':
  337. case 'DOMMatrixReadOnly':
  338. C = global[type];
  339. try {
  340. cloned = C.fromMatrix
  341. ? C.fromMatrix(value)
  342. : new C(value);
  343. } catch (error) {
  344. throwUnpolyfillable(type);
  345. } break;
  346. case 'AudioData':
  347. case 'VideoFrame':
  348. if (!isCallable(value.clone)) throwUnpolyfillable(type);
  349. try {
  350. cloned = value.clone();
  351. } catch (error) {
  352. throwUncloneable(type);
  353. } break;
  354. case 'File':
  355. try {
  356. cloned = new File([value], value.name, value);
  357. } catch (error) {
  358. throwUnpolyfillable(type);
  359. } break;
  360. case 'CropTarget':
  361. case 'CryptoKey':
  362. case 'FileSystemDirectoryHandle':
  363. case 'FileSystemFileHandle':
  364. case 'FileSystemHandle':
  365. case 'GPUCompilationInfo':
  366. case 'GPUCompilationMessage':
  367. case 'ImageBitmap':
  368. case 'RTCCertificate':
  369. case 'WebAssembly.Module':
  370. throwUnpolyfillable(type);
  371. // break omitted
  372. default:
  373. throwUncloneable(type);
  374. }
  375. }
  376. mapSet(map, value, cloned);
  377. if (deep) switch (type) {
  378. case 'Array':
  379. case 'Object':
  380. keys = objectKeys(value);
  381. for (i = 0, length = lengthOfArrayLike(keys); i < length; i++) {
  382. key = keys[i];
  383. createProperty(cloned, key, structuredCloneInternal(value[key], map));
  384. } break;
  385. case 'Map':
  386. value.forEach(function (v, k) {
  387. mapSet(cloned, structuredCloneInternal(k, map), structuredCloneInternal(v, map));
  388. });
  389. break;
  390. case 'Set':
  391. value.forEach(function (v) {
  392. setAdd(cloned, structuredCloneInternal(v, map));
  393. });
  394. break;
  395. case 'Error':
  396. createNonEnumerableProperty(cloned, 'message', structuredCloneInternal(value.message, map));
  397. if (hasOwn(value, 'cause')) {
  398. createNonEnumerableProperty(cloned, 'cause', structuredCloneInternal(value.cause, map));
  399. }
  400. if (name == 'AggregateError') {
  401. cloned.errors = structuredCloneInternal(value.errors, map);
  402. } // break omitted
  403. case 'DOMException':
  404. if (ERROR_STACK_INSTALLABLE) {
  405. createNonEnumerableProperty(cloned, 'stack', structuredCloneInternal(value.stack, map));
  406. }
  407. }
  408. return cloned;
  409. };
  410. var tryToTransfer = function (rawTransfer, map) {
  411. if (!isObject(rawTransfer)) throw TypeError('Transfer option cannot be converted to a sequence');
  412. var transfer = [];
  413. iterate(rawTransfer, function (value) {
  414. push(transfer, anObject(value));
  415. });
  416. var i = 0;
  417. var length = lengthOfArrayLike(transfer);
  418. var value, type, C, transferredArray, transferred, canvas, context;
  419. if (PROPER_TRANSFER) {
  420. transferredArray = nativeStructuredClone(transfer, { transfer: transfer });
  421. while (i < length) mapSet(map, transfer[i], transferredArray[i++]);
  422. } else while (i < length) {
  423. value = transfer[i++];
  424. if (mapHas(map, value)) throw new DOMException('Duplicate transferable', DATA_CLONE_ERROR);
  425. type = classof(value);
  426. switch (type) {
  427. case 'ImageBitmap':
  428. C = global.OffscreenCanvas;
  429. if (!isConstructor(C)) throwUnpolyfillable(type, TRANSFERRING);
  430. try {
  431. canvas = new C(value.width, value.height);
  432. context = canvas.getContext('bitmaprenderer');
  433. context.transferFromImageBitmap(value);
  434. transferred = canvas.transferToImageBitmap();
  435. } catch (error) { /* empty */ }
  436. break;
  437. case 'AudioData':
  438. case 'VideoFrame':
  439. if (!isCallable(value.clone) || !isCallable(value.close)) throwUnpolyfillable(type, TRANSFERRING);
  440. try {
  441. transferred = value.clone();
  442. value.close();
  443. } catch (error) { /* empty */ }
  444. break;
  445. case 'ArrayBuffer':
  446. if (!isCallable(value.transfer)) throwUnpolyfillable(type, TRANSFERRING);
  447. transferred = value.transfer();
  448. break;
  449. case 'MediaSourceHandle':
  450. case 'MessagePort':
  451. case 'OffscreenCanvas':
  452. case 'ReadableStream':
  453. case 'TransformStream':
  454. case 'WritableStream':
  455. throwUnpolyfillable(type, TRANSFERRING);
  456. }
  457. if (transferred === undefined) throw new DOMException('This object cannot be transferred: ' + type, DATA_CLONE_ERROR);
  458. mapSet(map, value, transferred);
  459. }
  460. };
  461. // `structuredClone` method
  462. // https://html.spec.whatwg.org/multipage/structured-data.html#dom-structuredclone
  463. $({ global: true, enumerable: true, sham: !PROPER_TRANSFER, forced: FORCED_REPLACEMENT }, {
  464. structuredClone: function structuredClone(value /* , { transfer } */) {
  465. var options = validateArgumentsLength(arguments.length, 1) > 1 && !isNullOrUndefined(arguments[1]) ? anObject(arguments[1]) : undefined;
  466. var transfer = options ? options.transfer : undefined;
  467. var map;
  468. if (transfer !== undefined) {
  469. map = new Map();
  470. tryToTransfer(transfer, map);
  471. }
  472. return structuredCloneInternal(value, map);
  473. }
  474. });