hakowork/charm
3
0
Fork 0
mirror of https://github.com/littensy/charm.git synced 2026-10-22 04:14:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: correct inner effect cleanup order

Browse source
This commit is contained in:
Yuancheng Li 2026-07-20 11:55:55 -04:00
parent b05f3a9de6
commit 6f52537e62
3 changed files with 197 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

97
packages/charm/test/effect.test.luau
View file

@ -521,15 +521,59 @@ test("should effects dispose in order", function()
assert(#order == 0, "should not cleanup immediately")
setSrc(true)
assert(table.concat(order) == "123", `bad rerun order: {table.concat(order)}`)
assert(table.concat(order) == "321", `bad rerun order: {table.concat(order)}`)
table.clear(order)
stopEffect()
assert(table.concat(order) == "123", `bad dispose order: {table.concat(order)}`)
assert(table.concat(order) == "321", `bad dispose order: {table.concat(order)}`)
table.clear(order)
setSrc(false)
assert(#order == 0, "should not cleanup after dispose")
end)
test("should cleanup nested effects deepest first", function()
local order: { string } = {}
local stopEffect = effect(function()
effect(function()
effect(function()
return function()
table.insert(order, "grandchild")
end
end)
return function()
table.insert(order, "child")
end
end)
return function()
table.insert(order, "outer")
end
end)
stopEffect()
assert(table.concat(order, ", ") == "grandchild, child, outer", `bad dispose order: {table.concat(order, ", ")}`)
end)
test("should cleanup computed child effects in reverse when unwatched", function()
local order: { number } = {}
local c = computed(function()
for i = 1, 3 do
effect(function()
return function()
table.insert(order, i)
end
end)
end
return 0
end)
local stopEffect = effect(function()
c()
end)
stopEffect()
assert(table.concat(order) == "321", `bad dispose order: {table.concat(order)}`)
end)
test("should handle inner effect clearing outer effect's deps on rerun", function()
local src, setSrc = signal(false)
local stopEffect: () -> ()
@ -545,7 +589,7 @@ test("should handle inner effect clearing outer effect's deps on rerun", functio
setSrc(true)
end)
test.skip("should handle inner effect cleanup disposing outer effect", function()
test("should handle inner effect cleanup disposing outer effect", function()
local order: { number } = {}
local src, setSrc = signal(false)
@ -566,28 +610,65 @@ test.skip("should handle inner effect cleanup disposing outer effect", function(
table.clear(order)
setSrc(true)
assert(table.concat(order) == "1234", `bad rerun order: {table.concat(order)}`)
assert(table.concat(order) == "4321", `bad rerun order: {table.concat(order)}`)
table.clear(order)
setSrc(false)
assert(#order == 0, "should not cleanup after dispose")
end)
test.skip("should old inner effect dispose before outer effect re-runs", function()
test("should cleanup child before parent on rerun", function()
local order: { string } = {}
local src, setSrc = signal(false)
effect(function()
src()
table.insert(order, "outer")
table.insert(order, "outer run")
effect(function()
table.insert(order, "inner run")
return function()
table.insert(order, "inner")
table.insert(order, "inner cleanup")
end
end)
return function()
table.insert(order, "outer cleanup")
end
end)
table.clear(order)
setSrc(true)
assert(table.concat(order) == "innerouter", `bad rerun order: {table.concat(order)}`)
assert(
table.concat(order, ", ") == "inner cleanup, outer cleanup, outer run, inner run",
`bad rerun order: {table.concat(order, ", ")}`
)
end)
test("should preserve child tracking after an inner-only rerun", function()
local order: { string } = {}
local outerSrc, setOuterSrc = signal(false)
local innerSrc, setInnerSrc = signal(false)
effect(function()
outerSrc()
table.insert(order, "outer run")
effect(function()
innerSrc()
table.insert(order, "inner run")
return function()
table.insert(order, "inner cleanup")
end
end)
return function()
table.insert(order, "outer cleanup")
end
end)
setInnerSrc(true)
table.clear(order)
setOuterSrc(true)
assert(
table.concat(order, ", ") == "inner cleanup, outer cleanup, outer run, inner run",
`bad rerun order: {table.concat(order, ", ")}`
)
end)
return {}

63
packages/charm/test/effectScope.test.luau
View file

@ -92,4 +92,67 @@ test("should dispose inner effects if created in an effect", function()
assert(triggers == 2, "ran after dispose")
end)
test("should dispose child effects in reverse order", function()
local order: { number } = {}
local stopScope = effectScope(function()
for i = 1, 3 do
effect(function()
return function()
table.insert(order, i)
end
end)
end
end)
stopScope()
assert(table.concat(order) == "321", `bad dispose order: {table.concat(order)}`)
end)
test("should dispose nested effects deepest first", function()
local order: { string } = {}
local stopScope = effectScope(function()
effect(function()
effect(function()
return function()
table.insert(order, "grandchild")
end
end)
return function()
table.insert(order, "child")
end
end)
end)
stopScope()
assert(table.concat(order, ", ") == "grandchild, child", `bad dispose order: {table.concat(order, ", ")}`)
end)
test("should cleanup an intermediate scope before its parent effect", function()
local order: { string } = {}
local src, setSrc = signal(false)
effect(function()
src()
table.insert(order, "outer run")
effectScope(function()
effect(function()
table.insert(order, "inner run")
return function()
table.insert(order, "inner cleanup")
end
end)
end)
return function()
table.insert(order, "outer cleanup")
end
end)
table.clear(order)
setSrc(true)
assert(
table.concat(order, ", ") == "inner cleanup, outer cleanup, outer run, inner run",
`bad rerun order: {table.concat(order, ", ")}`
)
end)
return {}