web.structured-clone.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489
  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 isObject = require('../internals/is-object');
  11. var isSymbol = require('../internals/is-symbol');
  12. var iterate = require('../internals/iterate');
  13. var anObject = require('../internals/an-object');
  14. var classof = require('../internals/classof');
  15. var hasOwn = require('../internals/has-own-property');
  16. var createProperty = require('../internals/create-property');
  17. var createNonEnumerableProperty = require('../internals/create-non-enumerable-property');
  18. var lengthOfArrayLike = require('../internals/length-of-array-like');
  19. var validateArgumentsLength = require('../internals/validate-arguments-length');
  20. var getRegExpFlags = require('../internals/regexp-get-flags');
  21. var ERROR_STACK_INSTALLABLE = require('../internals/error-stack-installable');
  22. var V8 = require('../internals/engine-v8-version');
  23. var IS_BROWSER = require('../internals/engine-is-browser');
  24. var IS_DENO = require('../internals/engine-is-deno');
  25. var IS_NODE = require('../internals/engine-is-node');
  26. var Object = global.Object;
  27. var Date = global.Date;
  28. var Error = global.Error;
  29. var EvalError = global.EvalError;
  30. var RangeError = global.RangeError;
  31. var ReferenceError = global.ReferenceError;
  32. var SyntaxError = global.SyntaxError;
  33. var TypeError = global.TypeError;
  34. var URIError = global.URIError;
  35. var PerformanceMark = global.PerformanceMark;
  36. var WebAssembly = global.WebAssembly;
  37. var CompileError = WebAssembly && WebAssembly.CompileError || Error;
  38. var LinkError = WebAssembly && WebAssembly.LinkError || Error;
  39. var RuntimeError = WebAssembly && WebAssembly.RuntimeError || Error;
  40. var DOMException = getBuiltin('DOMException');
  41. var Set = getBuiltin('Set');
  42. var Map = getBuiltin('Map');
  43. var MapPrototype = Map.prototype;
  44. var mapHas = uncurryThis(MapPrototype.has);
  45. var mapGet = uncurryThis(MapPrototype.get);
  46. var mapSet = uncurryThis(MapPrototype.set);
  47. var setAdd = uncurryThis(Set.prototype.add);
  48. var objectKeys = getBuiltin('Object', 'keys');
  49. var push = uncurryThis([].push);
  50. var booleanValueOf = uncurryThis(true.valueOf);
  51. var numberValueOf = uncurryThis(1.0.valueOf);
  52. var stringValueOf = uncurryThis(''.valueOf);
  53. var getTime = 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, kind) {
  115. throw new DOMException((kind || 'Cloning') + ' of ' + type + ' cannot be properly polyfilled in this engine', DATA_CLONE_ERROR);
  116. };
  117. var structuredCloneInternal = function (value, map) {
  118. if (isSymbol(value)) throwUncloneable('Symbol');
  119. if (!isObject(value)) return value;
  120. // effectively preserves circular references
  121. if (map) {
  122. if (mapHas(map, value)) return mapGet(map, value);
  123. } else map = new Map();
  124. var type = classof(value);
  125. var deep = false;
  126. var C, name, cloned, dataTransfer, i, length, keys, key, source, target;
  127. switch (type) {
  128. case 'Array':
  129. cloned = [];
  130. deep = true;
  131. break;
  132. case 'Object':
  133. cloned = {};
  134. deep = true;
  135. break;
  136. case 'Map':
  137. cloned = new Map();
  138. deep = true;
  139. break;
  140. case 'Set':
  141. cloned = new Set();
  142. deep = true;
  143. break;
  144. case 'RegExp':
  145. // in this block because of a Safari 14.1 bug
  146. // old FF does not clone regexes passed to the constructor, so get the source and flags directly
  147. cloned = new RegExp(value.source, getRegExpFlags(value));
  148. break;
  149. case 'Error':
  150. name = value.name;
  151. switch (name) {
  152. case 'AggregateError':
  153. cloned = getBuiltin('AggregateError')([]);
  154. break;
  155. case 'EvalError':
  156. cloned = EvalError();
  157. break;
  158. case 'RangeError':
  159. cloned = RangeError();
  160. break;
  161. case 'ReferenceError':
  162. cloned = ReferenceError();
  163. break;
  164. case 'SyntaxError':
  165. cloned = SyntaxError();
  166. break;
  167. case 'TypeError':
  168. cloned = TypeError();
  169. break;
  170. case 'URIError':
  171. cloned = URIError();
  172. break;
  173. case 'CompileError':
  174. cloned = CompileError();
  175. break;
  176. case 'LinkError':
  177. cloned = LinkError();
  178. break;
  179. case 'RuntimeError':
  180. cloned = RuntimeError();
  181. break;
  182. default:
  183. cloned = Error();
  184. }
  185. deep = true;
  186. break;
  187. case 'DOMException':
  188. cloned = new DOMException(value.message, value.name);
  189. deep = true;
  190. break;
  191. case 'DataView':
  192. case 'Int8Array':
  193. case 'Uint8Array':
  194. case 'Uint8ClampedArray':
  195. case 'Int16Array':
  196. case 'Uint16Array':
  197. case 'Int32Array':
  198. case 'Uint32Array':
  199. case 'Float32Array':
  200. case 'Float64Array':
  201. case 'BigInt64Array':
  202. case 'BigUint64Array':
  203. C = global[type];
  204. // in some old engines like Safari 9, typeof C is 'object'
  205. // on Uint8ClampedArray or some other constructors
  206. if (!isObject(C)) throwUnpolyfillable(type);
  207. cloned = new C(
  208. // this is safe, since arraybuffer cannot have circular references
  209. structuredCloneInternal(value.buffer, map),
  210. value.byteOffset,
  211. type === 'DataView' ? value.byteLength : value.length
  212. );
  213. break;
  214. case 'DOMQuad':
  215. try {
  216. cloned = new DOMQuad(
  217. structuredCloneInternal(value.p1, map),
  218. structuredCloneInternal(value.p2, map),
  219. structuredCloneInternal(value.p3, map),
  220. structuredCloneInternal(value.p4, map)
  221. );
  222. } catch (error) {
  223. if (nativeRestrictedStructuredClone) {
  224. cloned = nativeRestrictedStructuredClone(value);
  225. } else throwUnpolyfillable(type);
  226. }
  227. break;
  228. case 'FileList':
  229. C = global.DataTransfer;
  230. if (isConstructor(C)) {
  231. dataTransfer = new C();
  232. for (i = 0, length = lengthOfArrayLike(value); i < length; i++) {
  233. dataTransfer.items.add(structuredCloneInternal(value[i], map));
  234. }
  235. cloned = dataTransfer.files;
  236. } else if (nativeRestrictedStructuredClone) {
  237. cloned = nativeRestrictedStructuredClone(value);
  238. } else throwUnpolyfillable(type);
  239. break;
  240. case 'ImageData':
  241. // Safari 9 ImageData is a constructor, but typeof ImageData is 'object'
  242. try {
  243. cloned = new ImageData(
  244. structuredCloneInternal(value.data, map),
  245. value.width,
  246. value.height,
  247. { colorSpace: value.colorSpace }
  248. );
  249. } catch (error) {
  250. if (nativeRestrictedStructuredClone) {
  251. cloned = nativeRestrictedStructuredClone(value);
  252. } else throwUnpolyfillable(type);
  253. } break;
  254. default:
  255. if (nativeRestrictedStructuredClone) {
  256. cloned = nativeRestrictedStructuredClone(value);
  257. } else switch (type) {
  258. case 'BigInt':
  259. // can be a 3rd party polyfill
  260. cloned = Object(value.valueOf());
  261. break;
  262. case 'Boolean':
  263. cloned = Object(booleanValueOf(value));
  264. break;
  265. case 'Number':
  266. cloned = Object(numberValueOf(value));
  267. break;
  268. case 'String':
  269. cloned = Object(stringValueOf(value));
  270. break;
  271. case 'Date':
  272. cloned = new Date(getTime(value));
  273. break;
  274. case 'ArrayBuffer':
  275. C = global.DataView;
  276. // `ArrayBuffer#slice` is not available in IE10
  277. // `ArrayBuffer#slice` and `DataView` are not available in old FF
  278. if (!C && typeof value.slice != 'function') throwUnpolyfillable(type);
  279. // detached buffers throws in `DataView` and `.slice`
  280. try {
  281. if (typeof value.slice == 'function') {
  282. cloned = value.slice(0);
  283. } else {
  284. length = value.byteLength;
  285. cloned = new ArrayBuffer(length);
  286. source = new C(value);
  287. target = new C(cloned);
  288. for (i = 0; i < length; i++) {
  289. target.setUint8(i, source.getUint8(i));
  290. }
  291. }
  292. } catch (error) {
  293. throw new DOMException('ArrayBuffer is detached', DATA_CLONE_ERROR);
  294. } break;
  295. case 'SharedArrayBuffer':
  296. // SharedArrayBuffer should use shared memory, we can't polyfill it, so return the original
  297. cloned = value;
  298. break;
  299. case 'Blob':
  300. try {
  301. cloned = value.slice(0, value.size, value.type);
  302. } catch (error) {
  303. throwUnpolyfillable(type);
  304. } break;
  305. case 'DOMPoint':
  306. case 'DOMPointReadOnly':
  307. C = global[type];
  308. try {
  309. cloned = C.fromPoint
  310. ? C.fromPoint(value)
  311. : new C(value.x, value.y, value.z, value.w);
  312. } catch (error) {
  313. throwUnpolyfillable(type);
  314. } break;
  315. case 'DOMRect':
  316. case 'DOMRectReadOnly':
  317. C = global[type];
  318. try {
  319. cloned = C.fromRect
  320. ? C.fromRect(value)
  321. : new C(value.x, value.y, value.width, value.height);
  322. } catch (error) {
  323. throwUnpolyfillable(type);
  324. } break;
  325. case 'DOMMatrix':
  326. case 'DOMMatrixReadOnly':
  327. C = global[type];
  328. try {
  329. cloned = C.fromMatrix
  330. ? C.fromMatrix(value)
  331. : new C(value);
  332. } catch (error) {
  333. throwUnpolyfillable(type);
  334. } break;
  335. case 'AudioData':
  336. case 'VideoFrame':
  337. if (!isCallable(value.clone)) throwUnpolyfillable(type);
  338. try {
  339. cloned = value.clone();
  340. } catch (error) {
  341. throwUncloneable(type);
  342. } break;
  343. case 'File':
  344. try {
  345. cloned = new File([value], value.name, value);
  346. } catch (error) {
  347. throwUnpolyfillable(type);
  348. } break;
  349. case 'CryptoKey':
  350. case 'GPUCompilationMessage':
  351. case 'GPUCompilationInfo':
  352. case 'ImageBitmap':
  353. case 'RTCCertificate':
  354. case 'WebAssembly.Module':
  355. throwUnpolyfillable(type);
  356. // break omitted
  357. default:
  358. throwUncloneable(type);
  359. }
  360. }
  361. mapSet(map, value, cloned);
  362. if (deep) switch (type) {
  363. case 'Array':
  364. case 'Object':
  365. keys = objectKeys(value);
  366. for (i = 0, length = lengthOfArrayLike(keys); i < length; i++) {
  367. key = keys[i];
  368. createProperty(cloned, key, structuredCloneInternal(value[key], map));
  369. } break;
  370. case 'Map':
  371. value.forEach(function (v, k) {
  372. mapSet(cloned, structuredCloneInternal(k, map), structuredCloneInternal(v, map));
  373. });
  374. break;
  375. case 'Set':
  376. value.forEach(function (v) {
  377. setAdd(cloned, structuredCloneInternal(v, map));
  378. });
  379. break;
  380. case 'Error':
  381. createNonEnumerableProperty(cloned, 'message', structuredCloneInternal(value.message, map));
  382. if (hasOwn(value, 'cause')) {
  383. createNonEnumerableProperty(cloned, 'cause', structuredCloneInternal(value.cause, map));
  384. }
  385. if (name == 'AggregateError') {
  386. cloned.errors = structuredCloneInternal(value.errors, map);
  387. } // break omitted
  388. case 'DOMException':
  389. if (ERROR_STACK_INSTALLABLE) {
  390. createNonEnumerableProperty(cloned, 'stack', structuredCloneInternal(value.stack, map));
  391. }
  392. }
  393. return cloned;
  394. };
  395. var PROPER_TRANSFER = nativeStructuredClone && !fails(function () {
  396. // prevent V8 ArrayBufferDetaching protector cell invalidation and performance degradation
  397. // https://github.com/zloirock/core-js/issues/679
  398. if ((IS_DENO && V8 > 92) || (IS_NODE && V8 > 94) || (IS_BROWSER && V8 > 97)) return false;
  399. var buffer = new ArrayBuffer(8);
  400. var clone = nativeStructuredClone(buffer, { transfer: [buffer] });
  401. return buffer.byteLength != 0 || clone.byteLength != 8;
  402. });
  403. var tryToTransfer = function (rawTransfer, map) {
  404. if (!isObject(rawTransfer)) throw TypeError('Transfer option cannot be converted to a sequence');
  405. var transfer = [];
  406. iterate(rawTransfer, function (value) {
  407. push(transfer, anObject(value));
  408. });
  409. var i = 0;
  410. var length = lengthOfArrayLike(transfer);
  411. var value, type, C, transferredArray, transferred, canvas, context;
  412. if (PROPER_TRANSFER) {
  413. transferredArray = nativeStructuredClone(transfer, { transfer: transfer });
  414. while (i < length) mapSet(map, transfer[i], transferredArray[i++]);
  415. } else while (i < length) {
  416. value = transfer[i++];
  417. if (mapHas(map, value)) throw new DOMException('Duplicate transferable', DATA_CLONE_ERROR);
  418. type = classof(value);
  419. switch (type) {
  420. case 'ImageBitmap':
  421. C = global.OffscreenCanvas;
  422. if (!isConstructor(C)) throwUnpolyfillable(type, TRANSFERRING);
  423. try {
  424. canvas = new C(value.width, value.height);
  425. context = canvas.getContext('bitmaprenderer');
  426. context.transferFromImageBitmap(value);
  427. transferred = canvas.transferToImageBitmap();
  428. } catch (error) { /* empty */ }
  429. break;
  430. case 'AudioData':
  431. case 'VideoFrame':
  432. if (!isCallable(value.clone) || !isCallable(value.close)) throwUnpolyfillable(type, TRANSFERRING);
  433. try {
  434. transferred = value.clone();
  435. value.close();
  436. } catch (error) { /* empty */ }
  437. break;
  438. case 'ArrayBuffer':
  439. case 'MessagePort':
  440. case 'OffscreenCanvas':
  441. case 'ReadableStream':
  442. case 'TransformStream':
  443. case 'WritableStream':
  444. throwUnpolyfillable(type, TRANSFERRING);
  445. }
  446. if (transferred === undefined) throw new DOMException('This object cannot be transferred: ' + type, DATA_CLONE_ERROR);
  447. mapSet(map, value, transferred);
  448. }
  449. };
  450. $({ global: true, enumerable: true, sham: !PROPER_TRANSFER, forced: FORCED_REPLACEMENT }, {
  451. structuredClone: function structuredClone(value /* , { transfer } */) {
  452. var options = validateArgumentsLength(arguments.length, 1) > 1 && arguments[1] != null ? anObject(arguments[1]) : undefined;
  453. var transfer = options ? options.transfer : undefined;
  454. var map;
  455. if (transfer !== undefined) {
  456. map = new Map();
  457. tryToTransfer(transfer, map);
  458. }
  459. return structuredCloneInternal(value, map);
  460. }
  461. });