Skip to content

Commit

Permalink
fix: ensure internal cloning can work circular values (#14347)
Browse files Browse the repository at this point in the history
* fix: ensure internal cloning can work circular values

* better fixc

* 'original' feels slightly clearer than 'json_instance'

* use an optional parameter, so we can omit it in most cases

* Update packages/svelte/src/internal/shared/clone.js

Co-authored-by: Rich Harris <rich.harris@vercel.com>

---------

Co-authored-by: Rich Harris <rich.harris@vercel.com>
  • Loading branch information
trueadm and Rich-Harris authored Nov 19, 2024
1 parent f6117bb commit 7411068
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changeset/cool-trains-yawn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'svelte': patch
---

fix: ensure internal cloning can work circular values
15 changes: 13 additions & 2 deletions packages/svelte/src/internal/shared/clone.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,10 @@ export function snapshot(value, skip_warning = false) {
* @param {Map<T, Snapshot<T>>} cloned
* @param {string} path
* @param {string[]} paths
* @param {null | T} original The original value, if `value` was produced from a `toJSON` call
* @returns {Snapshot<T>}
*/
function clone(value, cloned, path, paths) {
function clone(value, cloned, path, paths, original = null) {
if (typeof value === 'object' && value !== null) {
const unwrapped = cloned.get(value);
if (unwrapped !== undefined) return unwrapped;
Expand All @@ -63,6 +64,10 @@ function clone(value, cloned, path, paths) {
const copy = /** @type {Snapshot<any>} */ ([]);
cloned.set(value, copy);

if (original !== null) {
cloned.set(original, copy);
}

for (let i = 0; i < value.length; i += 1) {
copy.push(clone(value[i], cloned, DEV ? `${path}[${i}]` : path, paths));
}
Expand All @@ -75,6 +80,10 @@ function clone(value, cloned, path, paths) {
const copy = {};
cloned.set(value, copy);

if (original !== null) {
cloned.set(original, copy);
}

for (var key in value) {
// @ts-expect-error
copy[key] = clone(value[key], cloned, DEV ? `${path}.${key}` : path, paths);
Expand All @@ -92,7 +101,9 @@ function clone(value, cloned, path, paths) {
/** @type {T & { toJSON(): any } } */ (value).toJSON(),
cloned,
DEV ? `${path}.toJSON()` : path,
paths
paths,
// Associate the instance with the toJSON clone
value
);
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { test } from '../../test';

export default test({
compileOptions: {
dev: true
},

async test({ assert, logs }) {
var a = {
a: {}
};
a.a = a;

var b = {
a: {
b: {}
}
};
b.a.b = b;

assert.deepEqual(logs, ['init', a, 'init', b]);
}
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<script>
class A {
toJSON(){
return {
a: this
}
}
}
const state = $state(new A());
$inspect(state);
class B {
toJSON(){
return {
a: {
b: this
}
}
}
}
const state2 = $state(new B());
$inspect(state2);
</script>

0 comments on commit 7411068

Please sign in to comment.