web.structured-clone.js 16 KB

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