web.structured-clone.js 17 KB

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