Break apart plugin reconciler (#332)

* Start splitting apart reconciler, with tests * Reify children in reify * Baseline hydrate implementation * Remove debug print * Scaffold out diff implementation, just supporting name changes * invariant -> error in decodeValue * Flesh out diff and add getProperty * Clear out top-level reconciler interface, start updating code that touches it * Address review feedback * Add (experimental) Selene configuration * Add emptiness checks to PatchSet, remove unimplement invert method * Improve descendant destruction behavior in InstanceMap * Track instanceId on all reify errors * Base implementation of applyPatch, returning partial patches on failure * Change reify to accept InstanceMap and insert instances into it * Start testing applyPatch for removals * Add test for applyPatch adding instances successfully and not * Add , which is just error with formatting * Correctly use new diff and applyPatch APIs * Improve applyPatch logging and fix field name typo * Better debug output when reify fails * Print out unapplied patch in debug mode * Don't write properties if their values are not different. This was exposed trying to sync the Rojo plugin, which has a gigantic ModuleScript in it with the reflection database. This workaround was present in some form in many versions of Rojo, and I guess we still need it. This time, I actually documented why it's here so that I don't forget for the umpteenth time... * Add placeholder test that needs to happen still * Introduce easier plugin testing, write applyPatch properties test * Delete legacy get/setCanonicalProperty files * Fix trying to remove numbers instead of instances * Change applyPatch to return partial patches instead of binary success * Work towards being able to decode and apply refs * Add helpers for PatchSet assertions * Apply refs in reify, test all cases * Improve diagnostics when patches fail to apply * Stop logging when destroying untracked instances, it's ok * Remove read before setting property in applyPatch * Fix diff thinking all properties are changed
2026-04-21 13:15:50 +00:00 · 2020-11-11 16:30:23 -08:00
parent 50f0a2bd2e
commit f66860bdfe
26 changed files with 1818 additions and 466 deletions
--- a/plugin/src/Reconciler/hydrate.spec.lua
+++ b/plugin/src/Reconciler/hydrate.spec.lua
@@ -0,0 +1,129 @@
+return function()
+	local hydrate = require(script.Parent.hydrate)
+
+	local InstanceMap = require(script.Parent.Parent.InstanceMap)
+
+	it("should match the root instance no matter what", function()
+		local knownInstances = InstanceMap.new()
+		local virtualInstances = {
+			ROOT = {
+				ClassName = "Model",
+				Name = "Foo",
+				Properties = {},
+				Children = {},
+			},
+		}
+
+		local rootInstance = Instance.new("Folder")
+
+		hydrate(knownInstances, virtualInstances, "ROOT", rootInstance)
+
+		expect(knownInstances:size()).to.equal(1)
+		expect(knownInstances.fromIds["ROOT"]).to.equal(rootInstance)
+	end)
+
+	it("should not match children with mismatched ClassName", function()
+		local knownInstances = InstanceMap.new()
+		local virtualInstances = {
+			ROOT = {
+				ClassName = "Folder",
+				Name = "Root",
+				Properties = {},
+				Children = {},
+			},
+
+			CHILD = {
+				ClassName = "Folder",
+				Name = "Child",
+				Properties = {},
+				Children = {},
+			},
+		}
+
+		local rootInstance = Instance.new("Folder")
+
+		-- ClassName of this instance is intentionally different
+		local child = Instance.new("Model")
+		child.Name = "Child"
+		child.Parent = rootInstance
+
+		hydrate(knownInstances, virtualInstances, "ROOT", rootInstance)
+
+		expect(knownInstances:size()).to.equal(1)
+		expect(knownInstances.fromIds["ROOT"]).to.equal(rootInstance)
+	end)
+
+	it("should not match children with mismatched Name", function()
+		local knownInstances = InstanceMap.new()
+		local virtualInstances = {
+			ROOT = {
+				ClassName = "Folder",
+				Name = "Root",
+				Properties = {},
+				Children = {},
+			},
+
+			CHILD = {
+				ClassName = "Folder",
+				Name = "Child",
+				Properties = {},
+				Children = {},
+			},
+		}
+
+		local rootInstance = Instance.new("Folder")
+
+		-- Name of this instance is intentionally different
+		local child = Instance.new("Folder")
+		child.Name = "Not Child"
+		child.Parent = rootInstance
+
+		hydrate(knownInstances, virtualInstances, "ROOT", rootInstance)
+
+		expect(knownInstances:size()).to.equal(1)
+		expect(knownInstances.fromIds["ROOT"]).to.equal(rootInstance)
+	end)
+
+	it("should pair instances with matching Name and ClassName", function()
+		local knownInstances = InstanceMap.new()
+		local virtualInstances = {
+			ROOT = {
+				ClassName = "Folder",
+				Name = "Root",
+				Properties = {},
+				Children = {"CHILD1", "CHILD2"},
+			},
+
+			CHILD1 = {
+				ClassName = "Folder",
+				Name = "Child 1",
+				Properties = {},
+				Children = {},
+			},
+
+			CHILD2 = {
+				ClassName = "Model",
+				Name = "Child 2",
+				Properties = {},
+				Children = {},
+			},
+		}
+
+		local rootInstance = Instance.new("Folder")
+
+		local child1 = Instance.new("Folder")
+		child1.Name = "Child 1"
+		child1.Parent = rootInstance
+
+		local child2 = Instance.new("Model")
+		child2.Name = "Child 2"
+		child2.Parent = rootInstance
+
+		hydrate(knownInstances, virtualInstances, "ROOT", rootInstance)
+
+		expect(knownInstances:size()).to.equal(3)
+		expect(knownInstances.fromIds["ROOT"]).to.equal(rootInstance)
+		expect(knownInstances.fromIds["CHILD1"]).to.equal(child1)
+		expect(knownInstances.fromIds["CHILD2"]).to.equal(child2)
+	end)
+end