Release Rojo 7.0.0-rc.3

* Add ambiguous value resolution StringArray -> Tags

* Remove funny autocompleted reference

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        rust_version: [stable, "1.43.1"]
+        rust_version: [stable, "1.46.0"]
 
     steps:
     - uses: actions/checkout@v1

CHANGELOG.md

@@ -2,21 +2,119 @@
 
 ## Unreleased Changes
 
-## [6.2.0][6.2.0] (June 10, 2021)
+## [7.0.0-rc.3] - October 19, 2021
+This is the last release candidate for Rojo 7. In an effort to get Rojo 7 out the door, we'll be freezing features from here on out, something we should've done a couple months ago.
+
+Expect to see Rojo 7 stable soon!
+
+* Added support for writing `Tags` in project files, model files, and meta files. ([#484])
+* Adjusted Studio plugin colors to match Roblox Studio palette. ([#482])
+* Improved experimental two-way sync feature by batching changes. ([#478])
+
+[#482]: https://github.com/rojo-rbx/rojo/pull/482
+[#484]: https://github.com/rojo-rbx/rojo/pull/484
+[#478]: https://github.com/rojo-rbx/rojo/pull/478
+[7.0.0-rc.3]: https://github.com/rojo-rbx/rojo/releases/tag/v7.0.0-rc.3
+
+## 7.0.0-rc.2 - October 19, 2021
+(Botched release due to Git mishap, oops!)
+
+## [7.0.0-rc.1] - August 23, 2021
+In Rojo 6 and previous Rojo 7 alphas, an explicit Vector3 property would be written like this:
+
+```json
+{
+    "className": "Part",
+    "properties": {
+        "Position": {
+            "Type": "Vector3",
+            "Value": [1, 2, 3]
+        }
+    }
+}
+```
+
+For Rojo 7, this will need to be changed to:
+
+```json
+{
+    "className": "Part",
+    "properties": {
+        "Position": {
+            "Vector3": [1, 2, 3]
+        }
+    }
+}
+```
+
+The shorthand property format that most users use is not impacted. For reference, it looks like this:
+
+```json
+{
+    "className": "Part",
+    "properties": {
+        "Position": [1, 2, 3]
+    }
+}
+```
+
+* Major breaking change: changed property syntax for project files; shorthand syntax is unchanged.
+* Added the `fmt-project` subcommand for formatting Rojo project files.
+* Improved error output for many subcommands.
+* Updated to stable versions of rbx-dom libraries.
+* Updated async infrastructure, which should fix a handful of bugs. ([#459])
+* Fixed syncing refs in the Roblox Studio plugin ([#462], [#466])
+* Added support for long paths on Windows. ([#464])
+
+[#459]: https://github.com/rojo-rbx/rojo/pull/459
+[#462]: https://github.com/rojo-rbx/rojo/pull/462
+[#464]: https://github.com/rojo-rbx/rojo/pull/464
+[#466]: https://github.com/rojo-rbx/rojo/pull/466
+[7.0.0-rc.1]: https://github.com/rojo-rbx/rojo/releases/tag/v7.0.0-rc.1
+
+## [7.0.0-alpha.4][7.0.0-alpha.4] (May 5, 2021)
+* Added the `gameId` and `placeId` optional properties to project files.
+    * When connecting from the Rojo Roblox Studio plugin, Rojo will set the game and place ID of the current place to these values, if set.
+    * This is equivalent to running `game:SetUniverseId(...)` and `game:SetPlaceId(...)` from the command bar in Studio. 
 * Added "EXPERIMENTAL!" label to two-way sync toggle in Rojo's Roblox Studio plugin.
-* Fixed "Open Scripts Externally" feature crashing Studio ([#369][issue-369])
-* Updated dependencies, fixing `HumanoidDescription` ID issues.
+* Fixed `Name` and `Parent` properties being allowed in Rojo projects. ([#413][pr-413])
+* Fixed "Open Scripts Externally" feature crashing Studio. ([#369][issue-369])
+* Empty `.model.json` files will no longer cause errors. ([#420][pr-420])
+* When specifying `$path` on a service, Rojo now keeps the correct class name. ([#331][issue-331])
+* Improved error messages for misconfigured projects.
 
+[issue-331]: https://github.com/rojo-rbx/rojo/issues/331
 [issue-369]: https://github.com/rojo-rbx/rojo/issues/369
-[6.2.0]: https://github.com/rojo-rbx/rojo/releases/tag/v6.2.0
-
-## [6.1.0][6.1.0] (April 12, 2021)
-* Updated dependencies, fixing OptionalCoordinateFrame-related issues.
+[pr-420]: https://github.com/rojo-rbx/rojo/pull/420
+[pr-413]: https://github.com/rojo-rbx/rojo/pull/413
+[7.0.0-alpha.4]: https://github.com/rojo-rbx/rojo/releases/tag/v7.0.0-alpha.4
 
+## [7.0.0-alpha.3][7.0.0-alpha.3] (February 19, 2021)
+* Updated dependencies, fixing `OptionalCoordinateFrame`-related issues.
 * Added `--address` flag to `rojo serve` to allow for external connections. ([#403][pr-403])
 
 [pr-403]: https://github.com/rojo-rbx/rojo/pull/403
-[6.1.0]: https://github.com/rojo-rbx/rojo/releases/tag/v6.1.0
+[7.0.0-alpha.3]: https://github.com/rojo-rbx/rojo/releases/tag/v7.0.0-alpha.3
+
+## [7.0.0-alpha.2][7.0.0-alpha.2] (February 19, 2021)
+* Fixed incorrect protocol version between the client and server.
+
+[7.0.0-alpha.2]: https://github.com/rojo-rbx/rojo/releases/tag/v7.0.0-alpha.2
+
+## [7.0.0-alpha.1][7.0.0-alpha.1] (February 18, 2021)
+This release includes a brand new implementation of the Roblox DOM. It brings performance improvements, much better support for `rbxl` and `rbxm` files, and a better internal API.
+
+* Added support for all remaining property types.
+* Added support for the entire Roblox binary model format.
+* Changed `rojo upload` to upload binary places and models instead of XML.
+    * This should make using `rojo upload` much more feasible for large places.
+* **Breaking**: Changed format of some types of values in `project.json`, `model.json`, and `meta.json` files.
+    * This should impact few projects. See [this file][allValues.json] for new examples of each property type.
+
+Formatting of types will change more before the stable release of Rojo 7. We're hoping to use this opportunity to normalize some of the case inconsistency introduced in Rojo 0.5.
+
+[7.0.0-alpha.1]: https://github.com/rojo-rbx/rojo/releases/tag/v7.0.0-alpha.1
+[allValues.json]: https://github.com/rojo-rbx/rojo/blob/f4a790eb50b74e482000bad1dcfe22533992fb20/plugin/rbx_dom_lua/src/allValues.json
 
 ## [6.0.2](https://github.com/rojo-rbx/rojo/releases/tag/v6.0.2) (February 9, 2021)
 * Fixed `rojo upload` to handle CSRF challenges.

CONTRIBUTING.md

@@ -34,16 +34,17 @@ The Rojo release process is pretty manual right now. If you need to do it, here'
 
 1. Bump server version in [`Cargo.toml`](Cargo.toml)
 2. Bump plugin version in [`plugin/src/Config.lua`](plugin/src/Config.lua)
-3. Run `cargo test` to update `Cargo.lock` and double-check tests
+3. Run `cargo test` to update `Cargo.lock` and run tests
 4. Update [`CHANGELOG.md`](CHANGELOG.md)
 5. Commit!
     * `git add . && git commit -m "Release vX.Y.Z"`
-6. Tag the commit with the version from `Cargo.toml` prepended with a v, like `v0.4.13`
+6. Tag the commit
+    * `git tag vX.Y.Z`
 7. Publish the CLI
     * `cargo publish`
-8. Build and upload the plugin
-    * `rojo build plugin -o Rojo.rbxm`
-    * Upload `Rojo.rbxm` to Roblox.com, keep it for later
+8. Publish the Plugin
+    * `cargo run -- upload plugin --asset_id 6415005344`
+    * `cargo run -- build plugin --output Rojo.rbxm`
 9. Push commits and tags
     * `git push && git push --tags`
 10. Copy GitHub release content from previous release

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rojo"
-version = "6.2.0"
+version = "7.0.0-rc.3"
 authors = ["Lucien Greathouse <me@lpghatguy.com>"]
 description = "Enables professional-grade development tools for Roblox developers"
 license = "MPL-2.0"
@@ -9,6 +9,7 @@ documentation = "https://rojo.space/docs"
 repository = "https://github.com/rojo-rbx/rojo"
 readme = "README.md"
 edition = "2018"
+build = "build.rs"
 
 exclude = [
     "/test-projects/**",
@@ -36,70 +37,76 @@ members = [
 name = "librojo"
 path = "src/lib.rs"
 
-[[bin]]
-name = "rojo"
-path = "src/bin.rs"
-
 [[bench]]
 name = "build"
 harness = false
 
 [dependencies]
-memofs = { version = "0.1.2", path = "memofs" }
+memofs = { version = "0.2.0", path = "memofs" }
 
-anyhow = "1.0.27"
-backtrace = "0.3"
-bincode = "1.2.1"
-crossbeam-channel = "0.4.0"
-csv = "1.1.1"
-env_logger = "0.7.1"
-fs-err = "2.2.0"
-futures = "0.1.29"
-globset = "0.4.4"
-humantime = "1.3.0"
-hyper = "0.12.35"
-jod-thread = "0.1.0"
+# These dependencies can be uncommented when working on rbx-dom simultaneously
+# rbx_binary = { path = "../rbx-dom/rbx_binary" }
+# rbx_dom_weak = { path = "../rbx-dom/rbx_dom_weak" }
+# rbx_reflection = { path = "../rbx-dom/rbx_reflection" }
+# rbx_reflection_database = { path = "../rbx-dom/rbx_reflection_database" }
+# rbx_xml = { path = "../rbx-dom/rbx_xml" }
+
+rbx_binary = "0.6.4"
+rbx_dom_weak = "2.3.0"
+rbx_reflection = "4.2.0"
+rbx_reflection_database = "0.2.2"
+rbx_xml = "0.12.3"
+
+anyhow = "1.0.44"
+backtrace = "0.3.61"
+bincode = "1.3.3"
+crossbeam-channel = "0.5.1"
+csv = "1.1.6"
+env_logger = "0.9.0"
+fs-err = "2.6.0"
+futures = "0.3.17"
+globset = "0.4.8"
+humantime = "2.1.0"
+hyper = { version = "0.14.13", features = ["server", "tcp", "http1"] }
+jod-thread = "0.1.2"
 lazy_static = "1.4.0"
-log = "0.4.8"
-maplit = "1.0.1"
-notify = "4.0.14"
-opener = "0.4.1"
-rbx_binary = "0.5.0"
-rbx_dom_weak = "1.10.1"
-rbx_reflection = "3.3.408"
-rbx_xml = "0.11.3"
-regex = "1.3.1"
-reqwest = "0.9.20"
+log = "0.4.14"
+maplit = "1.0.2"
+notify = "4.0.17"
+opener = "0.5.0"
+regex = "1.5.4"
+reqwest = "0.9.24"
 ritz = "0.1.0"
-rlua = "0.17.0"
-roblox_install = "0.2.2"
-serde = { version = "1.0", features = ["derive", "rc"] }
-serde_json = "1.0"
-structopt = "0.3.5"
-termcolor = "1.0.5"
-thiserror = "1.0.11"
-tokio = "0.1.22"
-uuid = { version = "0.8.1", features = ["v4", "serde"] }
+rlua = "0.17.1"
+roblox_install = "1.0.0"
+serde = { version = "1.0.130", features = ["derive", "rc"] }
+serde_json = "1.0.68"
+structopt = "0.3.23"
+termcolor = "1.1.2"
+thiserror = "1.0.30"
+tokio = { version = "1.12.0", features = ["rt", "rt-multi-thread"] }
+uuid = { version = "0.8.2", features = ["v4", "serde"] }
 
 [target.'cfg(windows)'.dependencies]
-winreg = "0.6.2"
+winreg = "0.9.0"
 
 [build-dependencies]
-memofs = { version = "0.1.3", path = "memofs" }
+memofs = { version = "0.2.0", path = "memofs" }
 
-anyhow = "1.0.27"
-bincode = "1.2.1"
-fs-err = "2.3.0"
-maplit = "1.0.1"
+embed-resource = "1.6.4"
+anyhow = "1.0.44"
+bincode = "1.3.3"
+fs-err = "2.6.0"
+maplit = "1.0.2"
 
 [dev-dependencies]
 rojo-insta-ext = { path = "rojo-insta-ext" }
 
-criterion = "0.3"
-insta = { version = "1.3.0", features = ["redactions"] }
-lazy_static = "1.2"
-paste = "0.1"
-pretty_assertions = "0.6.1"
-serde_yaml = "0.8.9"
-tempfile = "3.0"
-walkdir = "2.1"
+criterion = "0.3.5"
+insta = { version = "1.8.0", features = ["redactions"] }
+lazy_static = "1.4.0"
+paste = "1.0.5"
+pretty_assertions = "0.7.2"
+serde_yaml = "0.8.21"
+tempfile = "3.2.0"
+walkdir = "2.3.2"

README.md

@@ -1,21 +1,13 @@
 <div align="center">
-    <a href="https://rojo.space">
-        <img src="assets/logo-512.png" alt="Rojo" height="217" />
-    </a>
+    <a href="https://rojo.space"><img src="assets/logo-512.png" alt="Rojo" height="217" /></a>
 </div>
 
 <div>&nbsp;</div>
 
 <div align="center">
-    <a href="https://github.com/rojo-rbx/rojo/actions">
-        <img src="https://github.com/rojo-rbx/rojo/workflows/CI/badge.svg" alt="Actions status" />
-    </a>
-    <a href="https://crates.io/crates/rojo">
-        <img src="https://img.shields.io/crates/v/rojo.svg?label=latest%20release" alt="Latest server version" />
-    </a>
-    <a href="https://rojo.space/docs">
-        <img src="https://img.shields.io/badge/docs-website-brightgreen.svg" alt="Rojo Documentation" />
-    </a>
+    <a href="https://github.com/rojo-rbx/rojo/actions"><img src="https://github.com/rojo-rbx/rojo/workflows/CI/badge.svg" alt="Actions status" /></a>
+    <a href="https://crates.io/crates/rojo"><img src="https://img.shields.io/crates/v/rojo.svg?label=latest%20release" alt="Latest server version" /></a>
+    <a href="https://rojo.space/docs"><img src="https://img.shields.io/badge/docs-website-brightgreen.svg" alt="Rojo Documentation" /></a>
 </div>
 
 <hr />
@@ -48,7 +40,7 @@ Check out our [contribution guide](CONTRIBUTING.md) for detailed instructions fo
 
 Pull requests are welcome!
 
-Rojo supports Rust 1.43.1 and newer. The minimum supported version of Rust is based on the latest versions of the dependencies that Rojo has.
+Rojo supports Rust 1.46.0 and newer. The minimum supported version of Rust is based on the latest versions of the dependencies that Rojo has.
 
 ## License
 Rojo is available under the terms of the Mozilla Public License, Version 2.0. See [LICENSE.txt](LICENSE.txt) for details.

build.rs

@@ -73,5 +73,9 @@ fn main() -> Result<(), anyhow::Error> {
 
     bincode::serialize_into(out_file, &snapshot)?;
 
+    println!("cargo:rerun-if-changed=build/windows/rojo-manifest.rc");
+    println!("cargo:rerun-if-changed=build/windows/rojo.manifest");
+    embed_resource::compile("build/windows/rojo-manifest.rc");
+
     Ok(())
 }

build/windows/rojo-manifest.rc

@@ -0,0 +1,2 @@
+#define RT_MANIFEST 24
+1 RT_MANIFEST "rojo.manifest"

build/windows/rojo.manifest

@@ -0,0 +1,8 @@
+<?xml version='1.0' encoding='utf-8' standalone='yes'?>
+<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
+  <application xmlns="urn:schemas-microsoft-com:asm.v3">
+    <windowsSettings xmlns:ws2="http://schemas.microsoft.com/SMI/2016/WindowsSettings">
+      <ws2:longPathAware>true</ws2:longPathAware>
+    </windowsSettings>
+  </application>
+</assembly>

foreman.toml

@@ -1,3 +1,3 @@
 [tools]
-rojo = { source = "rojo-rbx/rojo", version = "6.0.0-rc.3" }
+rojo = { source = "rojo-rbx/rojo", version = "6.1.0" }
 run-in-roblox = { source = "rojo-rbx/run-in-roblox", version = "0.3.0" }

memofs/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased Changes
 
+## 0.2.0 (2021-08-23)
+* Updated to `crossbeam-channel` 0.5.1.
+
 ## 0.1.3 (2020-11-19)
 * Added `set_watch_enabled` to `Vfs` and `VfsLock` to allow turning off file watching.
 

memofs/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "memofs"
 description = "Virtual filesystem with configurable backends."
-version = "0.1.3"
+version = "0.2.0"
 authors = ["Lucien Greathouse <me@lpghatguy.com>"]
 edition = "2018"
 readme = "README.md"
@@ -11,7 +11,7 @@ homepage = "https://github.com/rojo-rbx/rojo/tree/master/memofs"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-crossbeam-channel = "0.4.0"
+crossbeam-channel = "0.5.1"
 fs-err = "2.3.0"
 notify = "4.0.15"
 serde = { version = "1.0", features = ["derive"] }

plugin/rbx_dom_lua/.luacheckrc

@@ -1,44 +0,0 @@
-stds.roblox = {
-	read_globals = {
-		game = {
-			other_fields = true,
-		},
-
-		-- Roblox globals
-		"script",
-
-		-- Extra functions
-		"tick", "warn",
-		"wait", "typeof",
-
-		-- Types
-		"CFrame",
-		"Color3",
-		"Enum",
-		"Instance",
-		"NumberRange",
-		"Rect",
-		"UDim", "UDim2",
-		"Vector2", "Vector3",
-		"Vector2int16", "Vector3int16",
-	}
-}
-
-stds.testez = {
-	read_globals = {
-		"describe",
-		"it", "itFOCUS", "itSKIP",
-		"FOCUS", "SKIP", "HACK_NO_XPCALL",
-		"expect",
-	}
-}
-
-ignore = {
-	"212", -- unused arguments
-}
-
-std = "lua51+roblox"
-
-files["**/*.spec.lua"] = {
-	std = "+testez",
-}

plugin/rbx_dom_lua/EncodedValue.lua

@@ -0,0 +1,462 @@
+local base64 = require(script.Parent.base64)
+
+local function identity(...)
+	return ...
+end
+
+local function unpackDecoder(f)
+	return function(value)
+		return f(unpack(value))
+	end
+end
+
+local function serializeFloat(value)
+	-- TODO: Figure out a better way to serialize infinity and NaN, neither of
+	-- which fit into JSON.
+	if value == math.huge or value == -math.huge then
+		return 999999999 * math.sign(value)
+	end
+
+	return value
+end
+
+local ALL_AXES = {"X", "Y", "Z"}
+local ALL_FACES = {"Right", "Top", "Back", "Left", "Bottom", "Front"}
+
+local types
+types = {
+	Axes = {
+		fromPod = function(pod)
+			local axes = {}
+
+			for index, axisName in ipairs(pod) do
+				axes[index] = Enum.Axis[axisName]
+			end
+
+			return Axes.new(unpack(axes))
+		end,
+
+		toPod = function(roblox)
+			local json = {}
+
+			for _, axis in ipairs(ALL_AXES) do
+				if roblox[axis] then
+					table.insert(json, axis)
+				end
+			end
+
+			return json
+		end,
+	},
+
+	BinaryString = {
+		fromPod = base64.decode,
+		toPod = base64.encode,
+	},
+
+	Bool = {
+		fromPod = identity,
+		toPod = identity,
+	},
+
+	BrickColor = {
+		fromPod = function(pod)
+			return BrickColor.new(pod)
+		end,
+
+		toPod = function(roblox)
+			return roblox.Number
+		end,
+	},
+
+	CFrame = {
+		fromPod = function(pod)
+			local pos = pod.position
+			local orient = pod.orientation
+
+			return CFrame.new(
+				pos[1], pos[2], pos[3],
+				orient[1][1], orient[1][2], orient[1][3],
+				orient[2][1], orient[2][2], orient[2][3],
+				orient[3][1], orient[3][2], orient[3][3]
+			)
+		end,
+
+		toPod = function(roblox)
+			local x, y, z,
+				r00, r01, r02,
+				r10, r11, r12,
+				r20, r21, r22 = roblox:GetComponents()
+
+			return {
+				position = {x, y, z},
+				orientation = {
+					{r00, r01, r02},
+					{r10, r11, r12},
+					{r20, r21, r22},
+				},
+			}
+		end,
+	},
+
+	Color3 = {
+		fromPod = unpackDecoder(Color3.new),
+
+		toPod = function(roblox)
+			return {roblox.r, roblox.g, roblox.b}
+		end,
+	},
+
+	Color3uint8 = {
+		fromPod = unpackDecoder(Color3.fromRGB),
+
+		toPod = function(roblox)
+			return {
+				math.round(roblox.R * 255),
+				math.round(roblox.G * 255),
+				math.round(roblox.B * 255),
+			}
+		end,
+	},
+
+	ColorSequence = {
+		fromPod = function(pod)
+			local keypoints = {}
+
+			for index, keypoint in ipairs(pod.keypoints) do
+				keypoints[index] = ColorSequenceKeypoint.new(
+					keypoint.time,
+					types.Color3.fromPod(keypoint.color)
+				)
+			end
+
+			return ColorSequence.new(keypoints)
+		end,
+
+		toPod = function(roblox)
+			local keypoints = {}
+
+			for index, keypoint in ipairs(roblox.Keypoints) do
+				keypoints[index] = {
+					time = keypoint.Time,
+					color = types.Color3.toPod(keypoint.Value),
+				}
+			end
+
+			return {
+				keypoints = keypoints,
+			}
+		end,
+	},
+
+	Content = {
+		fromPod = identity,
+		toPod = identity,
+	},
+
+	Enum = {
+		fromPod = identity,
+
+		toPod = function(roblox)
+			-- FIXME: More robust handling of enums
+			if typeof(roblox) == "number" then
+				return roblox
+			else
+				return roblox.Value
+			end
+		end,
+	},
+
+	Faces = {
+		fromPod = function(pod)
+			local faces = {}
+
+			for index, faceName in ipairs(pod) do
+				faces[index] = Enum.NormalId[faceName]
+			end
+
+			return Faces.new(unpack(faces))
+		end,
+
+		toPod = function(roblox)
+			local pod = {}
+
+			for _, face in ipairs(ALL_FACES) do
+				if roblox[face] then
+					table.insert(pod, face)
+				end
+			end
+
+			return pod
+		end,
+	},
+
+	Float32 = {
+		fromPod = identity,
+		toPod = serializeFloat,
+	},
+
+	Float64 = {
+		fromPod = identity,
+		toPod = serializeFloat,
+	},
+
+	Int32 = {
+		fromPod = identity,
+		toPod = identity,
+	},
+
+	Int64 = {
+		fromPod = identity,
+		toPod = identity,
+	},
+
+	NumberRange = {
+		fromPod = unpackDecoder(NumberRange.new),
+
+		toPod = function(roblox)
+			return {roblox.Min, roblox.Max}
+		end,
+	},
+
+	NumberSequence = {
+		fromPod = function(pod)
+			local keypoints = {}
+
+			for index, keypoint in ipairs(pod.keypoints) do
+				keypoints[index] = NumberSequenceKeypoint.new(
+					keypoint.time,
+					keypoint.value,
+					keypoint.envelope
+				)
+			end
+
+			return NumberSequence.new(keypoints)
+		end,
+
+		toPod = function(roblox)
+			local keypoints = {}
+
+			for index, keypoint in ipairs(roblox.Keypoints) do
+				keypoints[index] = {
+					time = keypoint.Time,
+					value = keypoint.Value,
+					envelope = keypoint.Envelope,
+				}
+			end
+
+			return {
+				keypoints = keypoints,
+			}
+		end,
+	},
+
+	PhysicalProperties = {
+		fromPod = function(pod)
+			if pod == "Default" then
+				return nil
+			else
+				return PhysicalProperties.new(
+					pod.density,
+					pod.friction,
+					pod.elasticity,
+					pod.frictionWeight,
+					pod.elasticityWeight
+				)
+			end
+		end,
+
+		toPod = function(roblox)
+			if roblox == nil then
+				return "Default"
+			else
+				return {
+					density = roblox.Density,
+					friction = roblox.Friction,
+					elasticity = roblox.Elasticity,
+					frictionWeight = roblox.FrictionWeight,
+					elasticityWeight = roblox.ElasticityWeight,
+				}
+			end
+		end,
+	},
+
+	Ray = {
+		fromPod = function(pod)
+			return Ray.new(
+				types.Vector3.fromPod(pod.origin),
+				types.Vector3.fromPod(pod.direction)
+			)
+		end,
+
+		toPod = function(roblox)
+			return {
+				origin = types.Vector3.toPod(roblox.Origin),
+				direction = types.Vector3.toPod(roblox.Direction),
+			}
+		end,
+	},
+
+	Rect = {
+		fromPod = function(pod)
+			return Rect.new(
+				types.Vector2.fromPod(pod[1]),
+				types.Vector2.fromPod(pod[2])
+			)
+		end,
+
+		toPod = function(roblox)
+			return {
+				types.Vector2.toPod(roblox.Min),
+				types.Vector2.toPod(roblox.Max),
+			}
+		end,
+	},
+
+	Ref = {
+		fromPod = function(_pod)
+			error("Ref cannot be decoded on its own")
+		end,
+
+		toPod = function(_roblox)
+			error("Ref can not be encoded on its own")
+		end,
+	},
+
+	Region3 = {
+		fromPod = function(pod)
+			error("Region3 is not implemented")
+		end,
+
+		toPod = function(roblox)
+			error("Region3 is not implemented")
+		end,
+	},
+
+	Region3int16 = {
+		fromPod = function(pod)
+			return Region3int16.new(
+				types.Vector3int16.fromPod(pod[1]),
+				types.Vector3int16.fromPod(pod[2])
+			)
+		end,
+
+		toPod = function(roblox)
+			return {
+				types.Vector3int16.toPod(roblox.Min),
+				types.Vector3int16.toPod(roblox.Max),
+			}
+		end,
+	},
+
+	SharedString = {
+		fromPod = function(pod)
+			error("SharedString is not supported")
+		end,
+
+		toPod = function(roblox)
+			error("SharedString is not supported")
+		end,
+	},
+
+	String = {
+		fromPod = identity,
+		toPod = identity,
+	},
+
+	UDim = {
+		fromPod = unpackDecoder(UDim.new),
+
+		toPod = function(roblox)
+			return {roblox.Scale, roblox.Offset}
+		end,
+	},
+
+	UDim2 = {
+		fromPod = function(pod)
+			return UDim2.new(
+				types.UDim.fromPod(pod[1]),
+				types.UDim.fromPod(pod[2])
+			)
+		end,
+
+		toPod = function(roblox)
+			return {
+				types.UDim.toPod(roblox.X),
+				types.UDim.toPod(roblox.Y),
+			}
+		end,
+	},
+
+	Tags = {
+		fromPod = identity,
+		toPod = identity,
+	},
+
+	Vector2 = {
+		fromPod = unpackDecoder(Vector2.new),
+
+		toPod = function(roblox)
+			return {
+				serializeFloat(roblox.X),
+				serializeFloat(roblox.Y),
+			}
+		end,
+	},
+
+	Vector2int16 = {
+		fromPod = unpackDecoder(Vector2int16.new),
+
+		toPod = function(roblox)
+			return {roblox.X, roblox.Y}
+		end,
+	},
+
+	Vector3 = {
+		fromPod = unpackDecoder(Vector3.new),
+
+		toPod = function(roblox)
+			return {
+				serializeFloat(roblox.X),
+				serializeFloat(roblox.Y),
+				serializeFloat(roblox.Z),
+			}
+		end,
+	},
+
+	Vector3int16 = {
+		fromPod = unpackDecoder(Vector3int16.new),
+
+		toPod = function(roblox)
+			return {roblox.X, roblox.Y, roblox.Z}
+		end,
+	},
+}
+
+local EncodedValue = {}
+
+function EncodedValue.decode(encodedValue)
+	local ty, value = next(encodedValue)
+
+	local typeImpl = types[ty]
+	if typeImpl == nil then
+		return false, "Couldn't decode value " .. tostring(ty)
+	end
+
+	return true, typeImpl.fromPod(value)
+end
+
+function EncodedValue.encode(rbxValue, propertyType)
+	assert(propertyType ~= nil, "Property type descriptor is required")
+
+	local typeImpl = types[propertyType]
+	if typeImpl == nil then
+		return false, ("Missing encoder for property type %q"):format(propertyType)
+	end
+
+	return true, {
+		[propertyType] = typeImpl.toPod(rbxValue),
+	}
+end
+
+return EncodedValue

plugin/rbx_dom_lua/EncodedValue.spec.lua

@@ -0,0 +1,72 @@
+return function()
+	local HttpService = game:GetService("HttpService")
+	
+	local EncodedValue = require(script.Parent.EncodedValue)
+	local allValues = require(script.Parent.allValues)
+
+	local function deepEq(a, b)
+		if typeof(a) ~= typeof(b) then
+			return false
+		end
+
+		local ty = typeof(a)
+
+		if ty == "table" then
+			local visited = {}
+			
+			for key, valueA in pairs(a) do
+				visited[key] = true
+				
+				if not deepEq(valueA, b[key]) then
+					return false
+				end
+			end
+
+			for key, valueB in pairs(b) do
+				if visited[key] then
+					continue
+				end
+
+				if not deepEq(valueB, a[key]) then
+					return false
+				end
+			end
+
+			return true
+		else
+			return a == b
+		end
+	end
+
+	local extraAssertions = {
+		CFrame = function(value)
+			expect(value).to.equal(CFrame.new(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12))
+		end,
+	}
+
+	for testName, testEntry in pairs(allValues) do
+		it("round trip " .. testName, function()
+			local ok, decoded = EncodedValue.decode(testEntry.value)
+			assert(ok, decoded)
+
+			if extraAssertions[testName] ~= nil then
+				extraAssertions[testName](decoded)
+			end
+
+			local ok, encoded = EncodedValue.encode(decoded, testEntry.ty)
+			assert(ok, encoded)
+
+			if not deepEq(encoded, testEntry.value) then
+				local expected = HttpService:JSONEncode(testEntry.value)
+				local actual = HttpService:JSONEncode(encoded)
+
+				local message = string.format(
+					"Round-trip results did not match.\nExpected:\n%s\nActual:\n%s",
+					expected, actual
+				)
+
+				error(message)
+			end
+		end)
+	end
+end

plugin/rbx_dom_lua/PropertyDescriptor.lua

@@ -20,8 +20,22 @@ local function set(container, key, value)
 end
 
 function PropertyDescriptor.fromRaw(data, className, propertyName)
+	local key, value = next(data.DataType)
+
 	return setmetatable({
-		scriptability = data.scriptability,
+		-- The meanings of the key and value in DataType differ when the type of
+		-- the property is Enum. When the property is of type Enum, the key is
+		-- the name of the type:
+		--
+		-- { Enum = "<name of enum>" }
+		--
+		-- When the property is not of type Enum, the value is the name of the
+		-- type:
+		--
+		-- { Value = "<data type>" }
+		dataType = key == "Enum" and key or value,
+
+		scriptability = data.Scriptability,
 		className = className,
 		name = propertyName,
 	}, PropertyDescriptor)
@@ -77,4 +91,4 @@ function PropertyDescriptor:write(instance, value)
 	end
 end
 
-return PropertyDescriptor
+return PropertyDescriptor

plugin/rbx_dom_lua/README.md

@@ -1,2 +0,0 @@
-# rbx_dom_lua
-Roblox Lua implementation of rbx-dom mechanisms, intended to work with rbx_dom_weak and friends.

plugin/rbx_dom_lua/allValues.json

@@ -0,0 +1,326 @@
+{
+  "Axes": {
+    "value": {
+      "Axes": [
+        "X",
+        "Y",
+        "Z"
+      ]
+    },
+    "ty": "Axes"
+  },
+  "BinaryString": {
+    "value": {
+      "BinaryString": "SGVsbG8h"
+    },
+    "ty": "BinaryString"
+  },
+  "Bool": {
+    "value": {
+      "Bool": true
+    },
+    "ty": "Bool"
+  },
+  "BrickColor": {
+    "value": {
+      "BrickColor": 1004
+    },
+    "ty": "BrickColor"
+  },
+  "CFrame": {
+    "value": {
+      "CFrame": {
+        "position": [
+          1.0,
+          2.0,
+          3.0
+        ],
+        "orientation": [
+          [
+            4.0,
+            5.0,
+            6.0
+          ],
+          [
+            7.0,
+            8.0,
+            9.0
+          ],
+          [
+            10.0,
+            11.0,
+            12.0
+          ]
+        ]
+      }
+    },
+    "ty": "CFrame"
+  },
+  "Color3": {
+    "value": {
+      "Color3": [
+        1.0,
+        2.0,
+        3.0
+      ]
+    },
+    "ty": "Color3"
+  },
+  "Color3uint8": {
+    "value": {
+      "Color3uint8": [
+        0,
+        128,
+        255
+      ]
+    },
+    "ty": "Color3uint8"
+  },
+  "ColorSequence": {
+    "value": {
+      "ColorSequence": {
+        "keypoints": [
+          {
+            "time": 0.0,
+            "color": [
+              1.0,
+              1.0,
+              0.5
+            ]
+          },
+          {
+            "time": 1.0,
+            "color": [
+              0.0,
+              0.0,
+              0.0
+            ]
+          }
+        ]
+      }
+    },
+    "ty": "ColorSequence"
+  },
+  "Content": {
+    "value": {
+      "Content": "rbxassetid://12345"
+    },
+    "ty": "Content"
+  },
+  "Enum": {
+    "value": {
+      "Enum": 1234
+    },
+    "ty": "Enum"
+  },
+  "Faces": {
+    "value": {
+      "Faces": [
+        "Right",
+        "Top",
+        "Back",
+        "Left",
+        "Bottom",
+        "Front"
+      ]
+    },
+    "ty": "Faces"
+  },
+  "Float32": {
+    "value": {
+      "Float32": 15.0
+    },
+    "ty": "Float32"
+  },
+  "Float64": {
+    "value": {
+      "Float64": 15123.0
+    },
+    "ty": "Float64"
+  },
+  "Int32": {
+    "value": {
+      "Int32": 6014
+    },
+    "ty": "Int32"
+  },
+  "Int64": {
+    "value": {
+      "Int64": 23491023
+    },
+    "ty": "Int64"
+  },
+  "NumberRange": {
+    "value": {
+      "NumberRange": [
+        -36.0,
+        94.0
+      ]
+    },
+    "ty": "NumberRange"
+  },
+  "NumberSequence": {
+    "value": {
+      "NumberSequence": {
+        "keypoints": [
+          {
+            "time": 0.0,
+            "value": 5.0,
+            "envelope": 2.0
+          },
+          {
+            "time": 1.0,
+            "value": 22.0,
+            "envelope": 0.0
+          }
+        ]
+      }
+    },
+    "ty": "NumberSequence"
+  },
+  "PhysicalProperties-Custom": {
+    "value": {
+      "PhysicalProperties": {
+        "density": 0.5,
+        "friction": 1.0,
+        "elasticity": 0.0,
+        "frictionWeight": 50.0,
+        "elasticityWeight": 25.0
+      }
+    },
+    "ty": "PhysicalProperties"
+  },
+  "PhysicalProperties-Default": {
+    "value": {
+      "PhysicalProperties": "Default"
+    },
+    "ty": "PhysicalProperties"
+  },
+  "Ray": {
+    "value": {
+      "Ray": {
+        "origin": [
+          1.0,
+          2.0,
+          3.0
+        ],
+        "direction": [
+          4.0,
+          5.0,
+          6.0
+        ]
+      }
+    },
+    "ty": "Ray"
+  },
+  "Rect": {
+    "value": {
+      "Rect": [
+        [
+          0.0,
+          5.0
+        ],
+        [
+          10.0,
+          15.0
+        ]
+      ]
+    },
+    "ty": "Rect"
+  },
+  "Region3int16": {
+    "value": {
+      "Region3int16": [
+        [
+          -10,
+          -5,
+          0
+        ],
+        [
+          5,
+          10,
+          15
+        ]
+      ]
+    },
+    "ty": "Region3int16"
+  },
+  "String": {
+    "value": {
+      "String": "Hello, world!"
+    },
+    "ty": "String"
+  },
+  "Tags": {
+    "value": {
+      "Tags": [
+        "foo",
+        "con'fusion?!",
+        "bar"
+      ]
+    },
+    "ty": "Tags"
+  },
+  "UDim": {
+    "value": {
+      "UDim": [
+        1.0,
+        32
+      ]
+    },
+    "ty": "UDim"
+  },
+  "UDim2": {
+    "value": {
+      "UDim2": [
+        [
+          -1.0,
+          100
+        ],
+        [
+          1.0,
+          -100
+        ]
+      ]
+    },
+    "ty": "UDim2"
+  },
+  "Vector2": {
+    "value": {
+      "Vector2": [
+        -50.0,
+        50.0
+      ]
+    },
+    "ty": "Vector2"
+  },
+  "Vector2int16": {
+    "value": {
+      "Vector2int16": [
+        -300,
+        300
+      ]
+    },
+    "ty": "Vector2int16"
+  },
+  "Vector3": {
+    "value": {
+      "Vector3": [
+        -300.0,
+        0.0,
+        1500.0
+      ]
+    },
+    "ty": "Vector3"
+  },
+  "Vector3int16": {
+    "value": {
+      "Vector3int16": [
+        60,
+        37,
+        -450
+      ]
+    },
+    "ty": "Vector3int16"
+  }
+}

plugin/rbx_dom_lua/customProperties.lua

@@ -6,12 +6,10 @@ local CollectionService = game:GetService("CollectionService")
 return {
 	Instance = {
 		Tags = {
-			read = function(instance, key)
-				local tagList = CollectionService:GetTags(instance)
-
-				return true, table.concat(tagList, "\0")
+			read = function(instance)
+				return true, CollectionService:GetTags(instance)
 			end,
-			write = function(instance, key, value)
+			write = function(instance, _, value)
 				local existingTags = CollectionService:GetTags(instance)
 
 				local unseenTags = {}
@@ -19,8 +17,7 @@ return {
 					unseenTags[tag] = true
 				end
 
-				local tagList = string.split(value, "\0")
-				for _, tag in ipairs(tagList) do
+				for _, tag in ipairs(value) do
 					unseenTags[tag] = nil
 					CollectionService:AddTag(instance, tag)
 				end
@@ -44,4 +41,4 @@ return {
 			end,
 		},
 	},
-}
+}

plugin/rbx_dom_lua/init.lua

@@ -1,4 +1,4 @@
-local ReflectionDatabase = require(script.ReflectionDatabase)
+local database = require(script.database)
 local Error = require(script.Error)
 local PropertyDescriptor = require(script.PropertyDescriptor)
 
@@ -6,29 +6,31 @@ local function findCanonicalPropertyDescriptor(className, propertyName)
 	local currentClassName = className
 
 	repeat
-		local currentClass = ReflectionDatabase.classes[currentClassName]
+		local currentClass = database.Classes[currentClassName]
 
 		if currentClass == nil then
 			return currentClass
 		end
 
-		local propertyData = currentClass.properties[propertyName]
+		local propertyData = currentClass.Properties[propertyName]
 		if propertyData ~= nil then
-			if propertyData.isCanonical then
+			local canonicalData = propertyData.Kind.Canonical
+			if canonicalData ~= nil then
 				return PropertyDescriptor.fromRaw(propertyData, currentClassName, propertyName)
 			end
 
-			if propertyData.canonicalName ~= nil then
+			local aliasData = propertyData.Kind.Alias
+			if aliasData ~= nil then
 				return PropertyDescriptor.fromRaw(
-					currentClass.properties[propertyData.canonicalName],
+					currentClass.Properties[aliasData.AliasFor],
 					currentClassName,
-					propertyData.canonicalName)
+					aliasData.AliasFor)
 			end
 
 			return nil
 		end
 
-		currentClassName = currentClass.superclass
+		currentClassName = currentClass.Superclass
 	until currentClassName == nil
 
 	return nil
@@ -64,4 +66,4 @@ return {
 	findCanonicalPropertyDescriptor = findCanonicalPropertyDescriptor,
 	Error = Error,
 	EncodedValue = require(script.EncodedValue),
-}
+}

plugin/rbx_dom_lua/src/EncodedValue.lua

@@ -1,242 +0,0 @@
-local base64 = require(script.Parent.base64)
-
-local function identity(...)
-	return ...
-end
-
-local function unpackDecoder(f)
-	return function(value)
-		return f(unpack(value))
-	end
-end
-
-local function serializeFloat(value)
-	-- TODO: Figure out a better way to serialize infinity and NaN, neither of
-	-- which fit into JSON.
-	if value == math.huge or value == -math.huge then
-		return 999999999 * math.sign(value)
-	end
-
-	return value
-end
-
-local encoders
-encoders = {
-	Bool = identity,
-	Content = identity,
-	Float32 = serializeFloat,
-	Float64 = serializeFloat,
-	Int32 = identity,
-	Int64 = identity,
-	String = identity,
-
-	BinaryString = base64.encode,
-	SharedString = base64.encode,
-
-	BrickColor = function(value)
-		return value.Number
-	end,
-
-	CFrame = function(value)
-		return {value:GetComponents()}
-	end,
-	Color3 = function(value)
-		return {value.r, value.g, value.b}
-	end,
-	NumberRange = function(value)
-		return {value.Min, value.Max}
-	end,
-	NumberSequence = function(value)
-		local keypoints = {}
-
-		for index, keypoint in ipairs(value.Keypoints) do
-			keypoints[index] = {
-				Time = keypoint.Time,
-				Value = keypoint.Value,
-				Envelope = keypoint.Envelope,
-			}
-		end
-
-		return {
-			Keypoints = keypoints,
-		}
-	end,
-	ColorSequence = function(value)
-		local keypoints = {}
-
-		for index, keypoint in ipairs(value.Keypoints) do
-			keypoints[index] = {
-				Time = keypoint.Time,
-				Color = encoders.Color3(keypoint.Value),
-			}
-		end
-
-		return {
-			Keypoints = keypoints,
-		}
-	end,
-	Rect = function(value)
-		return {
-			Min = {value.Min.X, value.Min.Y},
-			Max = {value.Max.X, value.Max.Y},
-		}
-	end,
-	UDim = function(value)
-		return {value.Scale, value.Offset}
-	end,
-	UDim2 = function(value)
-		return {value.X.Scale, value.X.Offset, value.Y.Scale, value.Y.Offset}
-	end,
-	Vector2 = function(value)
-		return {
-			serializeFloat(value.X),
-			serializeFloat(value.Y),
-		}
-	end,
-	Vector2int16 = function(value)
-		return {value.X, value.Y}
-	end,
-	Vector3 = function(value)
-		return {
-			serializeFloat(value.X),
-			serializeFloat(value.Y),
-			serializeFloat(value.Z),
-		}
-	end,
-	Vector3int16 = function(value)
-		return {value.X, value.Y, value.Z}
-	end,
-
-	PhysicalProperties = function(value)
-		if value == nil then
-			return nil
-		else
-			return {
-				Density = value.Density,
-				Friction = value.Friction,
-				Elasticity = value.Elasticity,
-				FrictionWeight = value.FrictionWeight,
-				ElasticityWeight = value.ElasticityWeight,
-			}
-		end
-	end,
-
-	Ref = function(value)
-		return nil
-	end,
-}
-
-local decoders = {
-	Bool = identity,
-	Content = identity,
-	Enum = identity,
-	Float32 = identity,
-	Float64 = identity,
-	Int32 = identity,
-	Int64 = identity,
-	String = identity,
-
-	BinaryString = base64.decode,
-	SharedString = base64.decode,
-
-	BrickColor = BrickColor.new,
-
-	CFrame = unpackDecoder(CFrame.new),
-	Color3 = unpackDecoder(Color3.new),
-	Color3uint8 = unpackDecoder(Color3.fromRGB),
-	NumberRange = unpackDecoder(NumberRange.new),
-	UDim = unpackDecoder(UDim.new),
-	UDim2 = unpackDecoder(UDim2.new),
-	Vector2 = unpackDecoder(Vector2.new),
-	Vector2int16 = unpackDecoder(Vector2int16.new),
-	Vector3 = unpackDecoder(Vector3.new),
-	Vector3int16 = unpackDecoder(Vector3int16.new),
-
-	Rect = function(value)
-		return Rect.new(value.Min[1], value.Min[2], value.Max[1], value.Max[2])
-	end,
-
-	NumberSequence = function(value)
-		local keypoints = {}
-
-		for index, keypoint in ipairs(value.Keypoints) do
-			keypoints[index] = NumberSequenceKeypoint.new(
-				keypoint.Time,
-				keypoint.Value,
-				keypoint.Envelope
-			)
-		end
-
-		return NumberSequence.new(keypoints)
-	end,
-
-	ColorSequence = function(value)
-		local keypoints = {}
-
-		for index, keypoint in ipairs(value.Keypoints) do
-			keypoints[index] = ColorSequenceKeypoint.new(
-				keypoint.Time,
-				Color3.new(unpack(keypoint.Color))
-			)
-		end
-
-		return ColorSequence.new(keypoints)
-	end,
-
-	PhysicalProperties = function(properties)
-		if properties == nil then
-			return nil
-		else
-			return PhysicalProperties.new(
-				properties.Density,
-				properties.Friction,
-				properties.Elasticity,
-				properties.FrictionWeight,
-				properties.ElasticityWeight
-			)
-		end
-	end,
-
-	Ref = function()
-		return nil
-	end,
-}
-
-local EncodedValue = {}
-
-function EncodedValue.decode(encodedValue)
-	local decoder = decoders[encodedValue.Type]
-	if decoder ~= nil then
-		return true, decoder(encodedValue.Value)
-	end
-
-	return false, "Couldn't decode value " .. tostring(encodedValue.Type)
-end
-
-function EncodedValue.encode(rbxValue, propertyType)
-	assert(propertyType ~= nil, "Property type descriptor is required")
-
-	if propertyType.type == "Data" then
-		local encoder = encoders[propertyType.name]
-
-		if encoder == nil then
-			return false, ("Missing encoder for property type %q"):format(propertyType.name)
-		end
-
-		if encoder ~= nil then
-			return true, {
-				Type = propertyType.name,
-				Value = encoder(rbxValue),
-			}
-		end
-	elseif propertyType.type == "Enum" then
-		return true, {
-			Type = "Enum",
-			Value = rbxValue.Value,
-		}
-	end
-
-	return false, ("Unknown property descriptor type %q"):format(tostring(propertyType.type))
-end
-
-return EncodedValue

plugin/rbx_dom_lua/src/EncodedValue.spec.lua

@@ -1,127 +0,0 @@
-return function()
-	local RbxDom = require(script.Parent)
-	local EncodedValue = require(script.Parent.EncodedValue)
-
-	it("should decode Rect values", function()
-		local input = {
-			Type = "Rect",
-			Value = {
-				Min = {1, 2},
-				Max = {3, 4},
-			},
-		}
-
-		local output = Rect.new(1, 2, 3, 4)
-
-		local ok, decoded = EncodedValue.decode(input)
-
-		assert(ok, decoded)
-		expect(decoded).to.equal(output)
-	end)
-
-	it("should decode ColorSequence values", function()
-		local input = {
-			Type = "ColorSequence",
-			Value = {
-				Keypoints = {
-					{
-						Time = 0,
-						Color = { 0.12, 0.34, 0.56 },
-					},
-
-					{
-						Time = 1,
-						Color = { 0.13, 0.33, 0.37 },
-					},
-				}
-			},
-		}
-
-		local output = ColorSequence.new({
-			ColorSequenceKeypoint.new(0, Color3.new(0.12, 0.34, 0.56)),
-			ColorSequenceKeypoint.new(1, Color3.new(0.13, 0.33, 0.37)),
-		})
-
-		local ok, decoded = EncodedValue.decode(input)
-		assert(ok, decoded)
-		expect(decoded).to.equal(output)
-	end)
-
-	it("should decode NumberSequence values", function()
-		local input = {
-			Type = "NumberSequence",
-			Value = {
-				Keypoints = {
-					{
-						Time = 0,
-						Value = 0.5,
-						Envelope = 0,
-					},
-
-					{
-						Time = 1,
-						Value = 0.5,
-						Envelope = 0,
-					},
-				}
-			},
-		}
-
-		local output = NumberSequence.new({
-			NumberSequenceKeypoint.new(0, 0.5, 0),
-			NumberSequenceKeypoint.new(1, 0.5, 0),
-		})
-
-		local ok, decoded = EncodedValue.decode(input)
-		assert(ok, decoded)
-		expect(decoded).to.equal(output)
-	end)
-
-	it("should decode PhysicalProperties values", function()
-		local input = {
-			Type = "PhysicalProperties",
-			Value = {
-				Density = 0.1,
-				Friction = 0.2,
-				Elasticity = 0.3,
-				FrictionWeight = 0.4,
-				ElasticityWeight = 0.5,
-			},
-		}
-
-		local output = PhysicalProperties.new(
-			0.1,
-			0.2,
-			0.3,
-			0.4,
-			0.5
-		)
-
-		local ok, decoded = EncodedValue.decode(input)
-		assert(ok, decoded)
-		expect(decoded).to.equal(output)
-	end)
-
-	-- This part of rbx_dom_lua needs some work still.
-	itSKIP("should encode Rect values", function()
-		local input = Rect.new(10, 20, 30, 40)
-
-		local output = {
-			Type = "Rect",
-			Value = {
-				Min = {10, 20},
-				Max = {30, 40},
-			},
-		}
-
-		local descriptor = RbxDom.findCanonicalPropertyDescriptor("ImageLabel", "SliceCenter")
-		local ok, encoded = EncodedValue.encode(input, descriptor)
-
-		assert(ok, encoded)
-		expect(encoded.Type).to.equal(output.Type)
-		expect(encoded.Value.Min[1]).to.equal(output.Value.Min[1])
-		expect(encoded.Value.Min[2]).to.equal(output.Value.Min[2])
-		expect(encoded.Value.Max[1]).to.equal(output.Value.Max[1])
-		expect(encoded.Value.Max[2]).to.equal(output.Value.Max[2])
-	end)
-end

plugin/rbx_dom_lua/src/ReflectionDatabase/init.lua

@@ -1,3 +0,0 @@
-return {
-	classes = require(script.classes)
-}

plugin/rbx_dom_lua/test-place.project.json

@@ -1,35 +0,0 @@
-{
-  "name": "rbx_dom_lua test place",
-  "tree": {
-    "$className": "DataModel",
-    "ReplicatedStorage": {
-      "$className": "ReplicatedStorage",
-
-      "RbxDom": {
-        "$path": "src"
-      },
-      "TestEZ": {
-        "$path": "modules/testez/lib"
-      }
-    },
-    "ServerScriptService": {
-      "$className": "ServerScriptService",
-
-      "Run Tests": {
-        "$path": "test.server.lua"
-      }
-    },
-    "Players": {
-      "$className": "Players",
-      "$properties": {
-        "CharacterAutoLoads": false
-      }
-    },
-    "HttpService": {
-      "$className": "HttpService",
-      "$properties": {
-        "HttpEnabled": true
-      }
-    }
-  }
-}

plugin/rbx_dom_lua/test.server.lua

@@ -1,7 +0,0 @@
-local ReplicatedStorage = game:GetService("ReplicatedStorage")
-
-local LIB_ROOT = ReplicatedStorage.RbxDom
-
-local TestEZ = require(ReplicatedStorage.TestEZ)
-
-TestEZ.TestBootstrap:run({LIB_ROOT})

plugin/src/App/Theme.lua

@@ -34,7 +34,7 @@ end
 local BRAND_COLOR = hexColor(0xE13835)
 
 local lightTheme = strict("LightTheme", {
-	BackgroundColor = hexColor(0xF0F0F0),
+	BackgroundColor = hexColor(0xFFFFFF),
 	Button = {
 		Solid = {
 			ActionFillColor = hexColor(0xFFFFFF),
@@ -67,7 +67,7 @@ local lightTheme = strict("LightTheme", {
 			BackgroundColor = BRAND_COLOR,
 		},
 		Inactive = {
-			IconColor = hexColor(0xCACACA),
+			IconColor = hexColor(0xEEEEEE),
 			BorderColor = hexColor(0xAFAFAF),
 		},
 	},
@@ -77,11 +77,11 @@ local lightTheme = strict("LightTheme", {
 	},
 	BorderedContainer = {
 		BorderColor = hexColor(0xCBCBCB),
-		BackgroundColor = hexColor(0xE0E0E0),
+		BackgroundColor = hexColor(0xEEEEEE),
 	},
 	Spinner = {
 		ForegroundColor = BRAND_COLOR,
-		BackgroundColor = hexColor(0xE0E0E0),
+		BackgroundColor = hexColor(0xEEEEEE),
 	},
 	ConnectionDetails = {
 		ProjectNameColor = hexColor(0x00000),
@@ -108,7 +108,7 @@ local lightTheme = strict("LightTheme", {
 })
 
 local darkTheme = strict("DarkTheme", {
-	BackgroundColor = hexColor(0x272727),
+	BackgroundColor = hexColor(0x2E2E2E),
 	Button = {
 		Solid = {
 			ActionFillColor = hexColor(0xFFFFFF),
@@ -147,15 +147,15 @@ local darkTheme = strict("DarkTheme", {
 	},
 	AddressEntry = {
 		TextColor = hexColor(0xFFFFFF),
-		PlaceholderColor = hexColor(0x717171)
+		PlaceholderColor = hexColor(0x8B8B8B)
 	},
 	BorderedContainer = {
 		BorderColor = hexColor(0x535353),
-		BackgroundColor = hexColor(0x323232),
+		BackgroundColor = hexColor(0x2B2B2B),
 	},
 	Spinner = {
 		ForegroundColor = BRAND_COLOR,
-		BackgroundColor = hexColor(0x323232),
+		BackgroundColor = hexColor(0x2B2B2B),
 	},
 	ConnectionDetails = {
 		ProjectNameColor = hexColor(0xFFFFFF),
@@ -236,4 +236,4 @@ return {
 	StudioProvider = StudioProvider,
 	Consumer = Context.Consumer,
 	with = with,
-}
+}

plugin/src/ChangeBatcher/createPatchSet.lua

@@ -0,0 +1,40 @@
+--[[
+	Take an InstanceMap and a dictionary mapping instances to sets of property
+	names. Populate a patch with the encoded values of all the given properties
+	on all the given instances (or, if any changes set Parent to nil, removals
+	of instances) and return the patch.
+]]
+
+local Log = require(script.Parent.Parent.Parent.Log)
+
+local PatchSet = require(script.Parent.Parent.PatchSet)
+
+local encodePatchUpdate = require(script.Parent.encodePatchUpdate)
+
+return function(instanceMap, propertyChanges)
+	local patch = PatchSet.newEmpty()
+
+	for instance, properties in pairs(propertyChanges) do
+		local instanceId = instanceMap.fromInstances[instance]
+
+		if instanceId == nil then
+			Log.warn("Ignoring change for instance {:?} as it is unknown to Rojo", instance)
+			continue
+		end
+
+		if properties.Parent then
+			if instance.Parent == nil then
+				table.insert(patch.removed, instanceId)
+			else
+				Log.warn("Cannot sync non-nil Parent property changes yet")
+			end
+		else
+			local update = encodePatchUpdate(instance, instanceId, properties)
+			table.insert(patch.updated, update)
+		end
+
+		propertyChanges[instance] = nil
+	end
+
+	return patch
+end

plugin/src/ChangeBatcher/createPatchSet.spec.lua

@@ -0,0 +1,74 @@
+return function()
+	local PatchSet = require(script.Parent.Parent.PatchSet)
+	local InstanceMap = require(script.Parent.Parent.InstanceMap)
+
+	local createPatchSet = require(script.Parent.createPatchSet)
+
+	it("should return a patch", function()
+		local patch = createPatchSet(InstanceMap.new(), {})
+
+		assert(PatchSet.validate(patch))
+	end)
+
+	it("should contain updates for every instance with property changes", function()
+		local instanceMap = InstanceMap.new()
+
+		local part1 = Instance.new("Part")
+		instanceMap:insert("PART_1", part1)
+
+		local part2 = Instance.new("Part")
+		instanceMap:insert("PART_2", part2)
+
+		local changes = {
+			[part1] = {
+				Position = true,
+				Size = true,
+				Color = true,
+			},
+			[part2] = {
+				CFrame = true,
+				Velocity = true,
+				Transparency = true,
+			},
+		}
+
+		local patch = createPatchSet(instanceMap, changes)
+
+		expect(#patch.updated).to.equal(2)
+	end)
+
+	it("should not contain any updates for removed instances", function()
+		local instanceMap = InstanceMap.new()
+
+		local part1 = Instance.new("Part")
+		instanceMap:insert("PART_1", part1)
+
+		local changes = {
+			[part1] = {
+				Parent = true,
+				Position = true,
+				Size = true,
+			},
+		}
+
+		local patch = createPatchSet(instanceMap, changes)
+
+		expect(#patch.removed).to.equal(1)
+		expect(#patch.updated).to.equal(0)
+	end)
+
+	it("should remove instances from the property change table", function()
+		local instanceMap = InstanceMap.new()
+
+		local part1 = Instance.new("Part")
+		instanceMap:insert("PART_1", part1)
+
+		local changes = {
+			[part1] = {},
+		}
+
+		createPatchSet(instanceMap, changes)
+
+		expect(next(changes)).to.equal(nil)
+	end)
+end

plugin/src/ChangeBatcher/encodePatchUpdate.lua

@@ -0,0 +1,39 @@
+local Log = require(script.Parent.Parent.Parent.Log)
+local RbxDom = require(script.Parent.Parent.Parent.RbxDom)
+
+local encodeProperty = require(script.Parent.encodeProperty)
+
+return function(instance, instanceId, properties)
+	local update = {
+		id = instanceId,
+		changedProperties = {},
+	}
+
+	for propertyName in pairs(properties) do
+		if propertyName == "Name" then
+			update.changedName = instance.Name
+		else
+			local descriptor = RbxDom.findCanonicalPropertyDescriptor(instance.ClassName, propertyName)
+
+			if not descriptor then
+				Log.debug("Could not sync back property {:?}.{}", instance, propertyName)
+				continue
+			end
+
+			local encodeSuccess, encodeResult = encodeProperty(instance, propertyName, descriptor)
+
+			if not encodeSuccess then
+				Log.debug("Could not sync back property {:?}.{}: {}", instance, propertyName, encodeResult)
+				continue
+			end
+
+			update.changedProperties[propertyName] = encodeResult
+		end
+	end
+
+	if next(update.changedProperties) == nil and update.changedName == nil then
+		return nil
+	end
+
+	return update
+end

plugin/src/ChangeBatcher/encodePatchUpdate.spec.lua

@@ -0,0 +1,62 @@
+return function()
+	local encodePatchUpdate = require(script.Parent.encodePatchUpdate)
+
+	it("should return an update when there are property changes", function()
+		local part = Instance.new("Part")
+		local properties = {
+			CFrame = true,
+			Color = true,
+		}
+		local update = encodePatchUpdate(part, "PART", properties)
+
+		expect(update.id).to.equal("PART")
+		expect(update.changedProperties.CFrame).to.be.ok()
+		expect(update.changedProperties.Color).to.be.ok()
+	end)
+
+	it("should return nil when there are no property changes", function()
+		local part = Instance.new("Part")
+		local properties = {
+			NonExistentProperty = true,
+		}
+		local update = encodePatchUpdate(part, "PART", properties)
+
+		expect(update).to.equal(nil)
+	end)
+
+	it("should set changedName in the update when the instance's Name changes", function()
+		local part = Instance.new("Part")
+		local properties = {
+			Name = true,
+		}
+
+		part.Name = "We'reGettingToTheCoolPart"
+
+		local update = encodePatchUpdate(part, "PART", properties)
+
+		expect(update.changedName).to.equal("We'reGettingToTheCoolPart")
+	end)
+
+	it("should correctly encode property values", function()
+		local part = Instance.new("Part")
+		local properties = {
+			Position = true,
+			Color = true,
+		}
+
+		part.Position = Vector3.new(0, 100, 0)
+		part.Color = Color3.new(0.8, 0.2, 0.9)
+
+		local update = encodePatchUpdate(part, "PART", properties)
+		local position = update.changedProperties.Position
+		local color = update.changedProperties.Color
+
+		expect(position.Vector3[1]).to.equal(0)
+		expect(position.Vector3[2]).to.equal(100)
+		expect(position.Vector3[3]).to.equal(0)
+
+		expect(color.Color3[1]).to.be.near(0.8, 0.01)
+		expect(color.Color3[2]).to.be.near(0.2, 0.01)
+		expect(color.Color3[3]).to.be.near(0.9, 0.01)
+	end)
+end

plugin/src/ChangeBatcher/encodeProperty.lua

@@ -0,0 +1,21 @@
+local Log = require(script.Parent.Parent.Parent.Log)
+local RbxDom = require(script.Parent.Parent.Parent.RbxDom)
+
+return function(instance, propertyName, propertyDescriptor)
+	local readSuccess, readResult = propertyDescriptor:read(instance)
+
+	if not readSuccess then
+		Log.warn("Could not sync back property {:?}.{}: {}", instance, propertyName, readResult)
+		return false, nil
+	end
+
+	local dataType = propertyDescriptor.dataType
+	local encodeSuccess, encodeResult = RbxDom.EncodedValue.encode(readResult, dataType)
+
+	if not encodeSuccess then
+		Log.warn("Could not sync back property {:?}.{}: {}", instance, propertyName, encodeResult)
+		return false, nil
+	end
+
+	return true, encodeResult
+end

plugin/src/ChangeBatcher/init.lua

@@ -0,0 +1,81 @@
+--[[
+	The ChangeBatcher is responsible for collecting and dispatching changes made
+	to tracked instances during two-way sync.
+]]
+
+local RunService = game:GetService("RunService")
+
+local PatchSet = require(script.Parent.PatchSet)
+
+local createPatchSet = require(script.createPatchSet)
+
+local ChangeBatcher = {}
+ChangeBatcher.__index = ChangeBatcher
+
+local BATCH_INTERVAL = 0.2
+
+function ChangeBatcher.new(instanceMap, onChangesFlushed)
+	local self
+
+	local renderSteppedConnection = RunService.RenderStepped:Connect(function(dt)
+		self:__cycle(dt)
+	end)
+
+	self = setmetatable({
+		__accumulator = 0,
+		__renderSteppedConnection = renderSteppedConnection,
+		__instanceMap = instanceMap,
+		__onChangesFlushed = onChangesFlushed,
+		__pendingPropertyChanges = {},
+	}, ChangeBatcher)
+
+	return self
+end
+
+function ChangeBatcher:stop()
+	self.__renderSteppedConnection:Disconnect()
+	self.__pendingPropertyChanges = {}
+end
+
+function ChangeBatcher:add(instance, propertyName)
+	local properties = self.__pendingPropertyChanges[instance]
+
+	if not properties then
+		properties = {}
+		self.__pendingPropertyChanges[instance] = properties
+	end
+
+	properties[propertyName] = true
+end
+
+function ChangeBatcher:__cycle(dt)
+	self.__accumulator += dt
+
+	if self.__accumulator >= BATCH_INTERVAL then
+		self.__accumulator -= BATCH_INTERVAL
+
+		local patch = self:__flush()
+
+		if patch then
+			self.__onChangesFlushed(patch)
+		end
+	end
+
+	self.__instanceMap:unpauseAllInstances()
+end
+
+function ChangeBatcher:__flush()
+	if next(self.__pendingPropertyChanges) == nil then
+		return nil
+	end
+
+	local patch = createPatchSet(self.__instanceMap, self.__pendingPropertyChanges)
+
+	if PatchSet.isEmpty(patch) then
+		return nil
+	end
+
+	return patch
+end
+
+return ChangeBatcher

plugin/src/ChangeBatcher/init.spec.lua

@@ -0,0 +1,101 @@
+return function()
+	local ChangeBatcher = require(script.Parent)
+	local InstanceMap = require(script.Parent.Parent.InstanceMap)
+	local PatchSet = require(script.Parent.Parent.PatchSet)
+
+	local noop = function() end
+
+	describe("new", function()
+		it("should create a new ChangeBatcher", function()
+			local instanceMap = InstanceMap.new()
+			local changeBatcher = ChangeBatcher.new(instanceMap, noop)
+
+			expect(changeBatcher.__pendingPropertyChanges).to.be.a("table")
+			expect(next(changeBatcher.__pendingPropertyChanges)).to.equal(nil)
+			expect(changeBatcher.__onChangesFlushed).to.equal(noop)
+			expect(changeBatcher.__instanceMap).to.equal(instanceMap)
+			expect(typeof(changeBatcher.__renderSteppedConnection)).to.equal("RBXScriptConnection")
+		end)
+	end)
+
+	describe("stop", function()
+		it("should disconnect the RenderStepped connection", function()
+			local changeBatcher = ChangeBatcher.new(InstanceMap.new(), noop)
+
+			changeBatcher:stop()
+
+			expect(changeBatcher.__renderSteppedConnection.Connected).to.equal(false)
+		end)
+	end)
+
+	describe("add", function()
+		it("should add property changes to be considered for the current batch", function()
+			local instanceMap = InstanceMap.new()
+			local changeBatcher = ChangeBatcher.new(instanceMap, noop)
+			local part = Instance.new("Part")
+
+			instanceMap:insert("PART", part)
+			changeBatcher:add(part, "Name")
+
+			local properties = changeBatcher.__pendingPropertyChanges[part]
+
+			expect(properties).to.be.a("table")
+			expect(properties.Name).to.be.ok()
+
+			changeBatcher:add(part, "Position")
+			expect(properties.Position).to.be.ok()
+		end)
+	end)
+
+	describe("__cycle", function()
+		it("should immediately unpause any paused instances after each cycle", function()
+			local instanceMap = InstanceMap.new()
+			local changeBatcher = ChangeBatcher.new(instanceMap, noop)
+			local part = Instance.new("Part")
+
+			instanceMap.pausedUpdateInstances[part] = true
+
+			changeBatcher:__cycle(0)
+
+			expect(instanceMap.pausedUpdateInstances[part]).to.equal(nil)
+		end)
+	end)
+
+	describe("__flush", function()
+		it("should return nil when there are no changes to process", function()
+			local changeBatcher = ChangeBatcher.new(InstanceMap.new(), noop)
+			expect(changeBatcher:__flush()).to.equal(nil)
+		end)
+
+		it("should return a patch when there are changes to process and the resulting patch is non-empty", function()
+			local instanceMap = InstanceMap.new()
+			local changeBatcher = ChangeBatcher.new(instanceMap, noop)
+			local part = Instance.new("Part")
+
+			instanceMap:insert("PART", part)
+
+			changeBatcher.__pendingPropertyChanges[part] = {
+				Position = true,
+				Name = true,
+			}
+
+			local patch = changeBatcher:__flush()
+
+			assert(PatchSet.validate(patch))
+		end)
+
+		it("should return nil when there are changes to process and the resulting patch is empty", function()
+			local instanceMap = InstanceMap.new()
+			local changeBatcher = ChangeBatcher.new(instanceMap, noop)
+			local part = Instance.new("Part")
+
+			instanceMap:insert("PART", part)
+
+			changeBatcher.__pendingPropertyChanges[part] = {
+				NonExistentProperty = true,
+			}
+
+			expect(changeBatcher:__flush()).to.equal(nil)
+		end)
+	end)
+end

plugin/src/Config.lua

@@ -5,9 +5,9 @@ local isDevBuild = script.Parent.Parent:FindFirstChild("ROJO_DEV_BUILD") ~= nil
 return strict("Config", {
 	isDevBuild = isDevBuild,
 	codename = "Epiphany",
-	version = {6, 2, 0},
-	expectedServerVersionString = "6.0 or newer",
-	protocolVersion = 3,
+	version = {7, 0, 0, "-rc.3"},
+	expectedServerVersionString = "7.0 or newer",
+	protocolVersion = 4,
 	defaultHost = "localhost",
 	defaultPort = 34872,
 })

plugin/src/InstanceMap.lua

@@ -1,3 +1,5 @@
+local RunService = game:GetService("RunService")
+
 local Log = require(script.Parent.Parent.Log)
 
 --[[
@@ -135,29 +137,31 @@ function InstanceMap:destroyId(id)
 end
 
 --[[
-	Pause updates for an instance momentarily and invoke a callback.
-
-	If the callback throws an error, InstanceMap will still be kept in a
-	consistent state.
+	Pause updates for an instance.
 ]]
-function InstanceMap:pauseInstance(instance, callback)
+function InstanceMap:pauseInstance(instance)
 	local id = self.fromInstances[instance]
 
-	-- If we don't know about this instance, ignore it and do not invoke the
-	-- callback.
+	-- If we don't know about this instance, ignore it.
 	if id == nil then
 		return
 	end
 
 	self.pausedUpdateInstances[instance] = true
-	local success, result = xpcall(callback, debug.traceback)
-	self.pausedUpdateInstances[instance] = false
+end
 
-	if success then
-		return result
-	else
-		error(result, 2)
-	end
+--[[
+	Unpause updates for an instance.
+]]
+function InstanceMap:unpauseInstance(instance)
+	self.pausedUpdateInstances[instance] = nil
+end
+
+--[[
+	Unpause updates for all instances.
+]]
+function InstanceMap:unpauseAllInstances()
+	table.clear(self.pausedUpdateInstances)
 end
 
 function InstanceMap:__connectSignals(instance)
@@ -200,6 +204,12 @@ function InstanceMap:__maybeFireInstanceChanged(instance, propertyName)
 		return
 	end
 
+	if RunService:IsRunning() then
+		-- We probably don't want to pick up property changes to save to the
+		-- filesystem in a running game.
+		return
+	end
+
 	self.onInstanceChanged(instance, propertyName)
 end
 
@@ -222,4 +232,4 @@ function InstanceMap:__disconnectSignals(instance)
 	end
 end
 
-return InstanceMap
+return InstanceMap

plugin/src/Reconciler/applyPatch.lua

@@ -77,6 +77,10 @@ local function applyPatch(instanceMap, patch)
 			continue
 		end
 
+		-- Pause updates on this instance to avoid picking up our changes when
+		-- two-way sync is enabled.
+		instanceMap:pauseInstance(instance)
+
 		-- Track any part of this update that could not be applied.
 		local unappliedUpdate = {
 			id = update.id,
@@ -197,4 +201,4 @@ local function applyPatch(instanceMap, patch)
 	return unappliedPatch
 end
 
-return applyPatch
+return applyPatch

plugin/src/Reconciler/applyPatch.spec.lua

@@ -146,8 +146,7 @@ return function()
 			id = "VALUE",
 			changedProperties = {
 				Value = {
-					Type = "String",
-					Value = "WORLD",
+					String = "WORLD",
 				},
 			},
 		})
@@ -176,8 +175,7 @@ return function()
 			changedClassName = "StringValue",
 			changedProperties = {
 				Value = {
-					Type = "String",
-					Value = "I am Root",
+					String = "I am Root",
 				},
 			},
 		})

plugin/src/Reconciler/decodeValue.lua

@@ -6,29 +6,31 @@
 local RbxDom = require(script.Parent.Parent.Parent.RbxDom)
 local Error = require(script.Parent.Error)
 
-local function decodeValue(virtualValue, instanceMap)
+local function decodeValue(encodedValue, instanceMap)
+	local ty, value = next(encodedValue)
+
 	-- Refs are represented as IDs in the same space that Rojo's protocol uses.
-	if virtualValue.Type == "Ref" then
-		if virtualValue.Value == nil then
+	if ty == "Ref" then
+		if value == "00000000000000000000000000000000" then
 			return true, nil
 		end
 
-		local instance = instanceMap.fromIds[virtualValue.Value]
+		local instance = instanceMap.fromIds[value]
 
 		if instance ~= nil then
 			return true, instance
 		else
 			return false, Error.new(Error.RefDidNotExist, {
-				virtualValue = virtualValue,
+				encodedValue = encodedValue,
 			})
 		end
 	end
 
-	local ok, decodedValue = RbxDom.EncodedValue.decode(virtualValue)
+	local ok, decodedValue = RbxDom.EncodedValue.decode(encodedValue)
 
 	if not ok then
 		return false, Error.new(Error.CannotDecodeValue, {
-			virtualValue = virtualValue,
+			encodedValue = encodedValue,
 			innerError = decodedValue,
 		})
 	end

plugin/src/Reconciler/diff.lua

@@ -75,7 +75,9 @@ local function diff(instanceMap, virtualInstances, rootId)
 						changedProperties[propertyName] = virtualValue
 					end
 				else
-					Log.warn("Failed to decode property of type {}", virtualValue.Type)
+					-- virtualValue can be empty in certain cases, and this may print out nil to the user.
+					local propertyType = next(virtualValue)
+					Log.warn("Failed to decode property of type {}", propertyType)
 				end
 			else
 				local err = existingValueOrErr

plugin/src/Reconciler/diff.spec.lua

@@ -80,8 +80,7 @@ return function()
 				Name = "Value",
 				Properties = {
 					Value = {
-						Type = "String",
-						Value = "Hello, world!",
+						String = "Hello, world!",
 					},
 				},
 				Children = {},
@@ -107,8 +106,9 @@ return function()
 
 		local patchProperty = update.changedProperties["Value"]
 		expect(patchProperty).to.be.a("table")
-		expect(patchProperty.Type).to.equal("String")
-		expect(patchProperty.Value).to.equal("Hello, world!")
+		local ty, value = next(patchProperty)
+		expect(ty).to.equal("String")
+		expect(value).to.equal("Hello, world!")
 	end)
 
 	it("should generate an empty patch if no properties changed", function()
@@ -119,8 +119,7 @@ return function()
 				Name = "Value",
 				Properties = {
 					Value = {
-						Type = "String",
-						Value = "Hello, world!",
+						String = "Hello, world!",
 					},
 				},
 				Children = {},
@@ -145,8 +144,7 @@ return function()
 				Name = "Folder",
 				Properties = {
 					FAKE_PROPERTY = {
-						Type = "String",
-						Value = "Hello, world!",
+						String = "Hello, world!",
 					},
 				},
 				Children = {},
@@ -183,8 +181,7 @@ return function()
 					-- heat_xml is a serialization-only property that is not
 					-- exposed to Lua.
 					heat_xml = {
-						Type = "Float32",
-						Value = 5,
+						Float32 = 5,
 					},
 				},
 				Children = {},

plugin/src/Reconciler/reify.lua

@@ -70,7 +70,7 @@ function reifyInner(instanceMap, virtualInstances, id, parentInstance, unapplied
 	for propertyName, virtualValue in pairs(virtualInstance.Properties) do
 		-- Because refs may refer to instances that we haven't constructed yet,
 		-- we defer applying any ref properties until all instances are created.
-		if virtualValue.Type == "Ref" then
+		if next(virtualValue) == "Ref" then
 			table.insert(deferredRefs, {
 				id = id,
 				instance = instance,
@@ -136,23 +136,23 @@ function applyDeferredRefs(instanceMap, deferredRefs, unappliedPatch)
 	end
 
 	for _, entry in ipairs(deferredRefs) do
-		local virtualValue = entry.virtualValue
+		local _, refId = next(entry.virtualValue)
 
-		if virtualValue.Value == nil then
+		if refId == nil then
 			continue
 		end
 
-		local targetInstance = instanceMap.fromIds[virtualValue.Value]
+		local targetInstance = instanceMap.fromIds[refId]
 		if targetInstance == nil then
-			markFailed(entry.id, entry.propertyName, virtualValue)
+			markFailed(entry.id, entry.propertyName, entry.virtualValue)
 			continue
 		end
 
 		local ok = setProperty(entry.instance, entry.propertyName, targetInstance)
 		if not ok then
-			markFailed(entry.id, entry.propertyName, virtualValue)
+			markFailed(entry.id, entry.propertyName, entry.virtualValue)
 		end
 	end
 end
 
-return reify
+return reify

plugin/src/Reconciler/reify.spec.lua

@@ -54,8 +54,7 @@ return function()
 				Name = "Spaghetti",
 				Properties = {
 					Value = {
-						Type = "String",
-						Value = "Hello, world!",
+						String = "Hello, world!",
 					},
 				},
 				Children = {},
@@ -191,8 +190,7 @@ return function()
 				Name = "Child",
 				Properties = {
 					Value = {
-						Type = "Ref",
-						Value = "ROOT",
+						Ref = "ROOT",
 					},
 				},
 				Children = {},
@@ -219,8 +217,7 @@ return function()
 				Name = "Root",
 				Properties = {
 					Value = {
-						Type = "Ref",
-						Value = "EXISTING",
+						Ref = "EXISTING",
 					},
 				},
 				Children = {},
@@ -258,8 +255,7 @@ return function()
 				Name = "Child A",
 				Properties = {
 					Value = {
-						Type = "Ref",
-						Value = "Child B",
+						Ref = "CHILD_B",
 					},
 				},
 				Children = {},
@@ -291,15 +287,14 @@ return function()
 	-- constructed as part of a recursive call before the parent has totally
 	-- finished. Given deferred refs, this should not fail, but it is a good
 	-- case to test.
-	it("should apply properties containing refs to later siblings correctly", function()
+	it("should apply properties containing refs to later children correctly", function()
 		local virtualInstances = {
 			ROOT = {
 				ClassName = "ObjectValue",
 				Name = "Root",
 				Properties = {
 					Value = {
-						Type = "Ref",
-						Value = "CHILD",
+						Ref = "CHILD",
 					},
 				},
 				Children = {"CHILD"},
@@ -349,4 +344,4 @@ return function()
 		expect(update.id).to.equal("ROOT")
 		expect(update.changedProperties.Value).to.equal(virtualInstances["ROOT"].Properties.Value)
 	end)
-end
+end

plugin/src/ServeSession.lua

@@ -5,6 +5,7 @@ local Log = require(script.Parent.Parent.Log)
 local Fmt = require(script.Parent.Parent.Fmt)
 local t = require(script.Parent.Parent.t)
 
+local ChangeBatcher = require(script.Parent.ChangeBatcher)
 local InstanceMap = require(script.Parent.InstanceMap)
 local PatchSet = require(script.Parent.PatchSet)
 local Reconciler = require(script.Parent.Reconciler)
@@ -56,10 +57,19 @@ function ServeSession.new(options)
 	-- Declare self ahead of time to capture it in a closure
 	local self
 	local function onInstanceChanged(instance, propertyName)
-		self:__onInstanceChanged(instance, propertyName)
+		if not self.__twoWaySync then
+			return
+		end
+
+		self.__changeBatcher:add(instance, propertyName)
+	end
+
+	local function onChangesFlushed(patch)
+		self.__apiContext:write(patch)
 	end
 
 	local instanceMap = InstanceMap.new(onInstanceChanged)
+	local changeBatcher = ChangeBatcher.new(instanceMap, onChangesFlushed)
 	local reconciler = Reconciler.new(instanceMap)
 
 	local connections = {}
@@ -82,6 +92,7 @@ function ServeSession.new(options)
 		__twoWaySync = options.twoWaySync,
 		__reconciler = reconciler,
 		__instanceMap = instanceMap,
+		__changeBatcher = changeBatcher,
 		__statusChangedCallback = nil,
 		__connections = connections,
 	}
@@ -112,6 +123,7 @@ function ServeSession:start()
 	self.__apiContext:connect()
 		:andThen(function(serverInfo)
 			self:__setStatus(Status.Connected, serverInfo.projectName)
+			self:__applyGameAndPlaceId(serverInfo)
 
 			local rootInstanceId = serverInfo.rootInstanceId
 
@@ -129,6 +141,16 @@ function ServeSession:stop()
 	self:__stopInternal()
 end
 
+function ServeSession:__applyGameAndPlaceId(serverInfo)
+	if serverInfo.gameId ~= nil then
+		game:SetUniverseId(serverInfo.gameId)
+	end
+
+	if serverInfo.placeId ~= nil then
+		game:SetPlaceId(serverInfo.placeId)
+	end
+end
+
 function ServeSession:__onActiveScriptChanged(activeScript)
 	if not self.__openScriptsExternally then
 		Log.trace("Not opening script {} because feature not enabled.", activeScript)
@@ -168,55 +190,6 @@ function ServeSession:__onActiveScriptChanged(activeScript)
 	self.__apiContext:open(scriptId)
 end
 
-function ServeSession:__onInstanceChanged(instance, propertyName)
-	if not self.__twoWaySync then
-		return
-	end
-
-	local instanceId = self.__instanceMap.fromInstances[instance]
-
-	if instanceId == nil then
-		Log.warn("Ignoring change for instance {:?} as it is unknown to Rojo", instance)
-		return
-	end
-
-	local remove = nil
-
-	local update = {
-		id = instanceId,
-		changedProperties = {},
-	}
-
-	if propertyName == "Name" then
-		update.changedName = instance.Name
-	elseif propertyName == "Parent" then
-		if instance.Parent == nil then
-			update = nil
-			remove = instanceId
-		else
-			Log.warn("Cannot sync non-nil Parent property changes yet")
-			return
-		end
-	else
-		local success, encoded = self.__reconciler:encodeApiValue(instance[propertyName])
-
-		if not success then
-			Log.warn("Could not sync back property {:?}.{}", instance, propertyName)
-			return
-		end
-
-		update.changedProperties[propertyName] = encoded
-	end
-
-	local patch = {
-		removed = {remove},
-		added = {},
-		updated = {update},
-	}
-
-	self.__apiContext:write(patch)
-end
-
 function ServeSession:__initialSync(rootInstanceId)
 	return self.__apiContext:read({ rootInstanceId })
 		:andThen(function(readResponseBody)
@@ -279,6 +252,7 @@ function ServeSession:__stopInternal(err)
 	self:__setStatus(Status.Disconnected, err)
 	self.__apiContext:disconnect()
 	self.__instanceMap:stop()
+	self.__changeBatcher:stop()
 
 	for _, connection in ipairs(self.__connections) do
 		connection:Disconnect()
@@ -294,4 +268,4 @@ function ServeSession:__setStatus(status, detail)
 	end
 end
 
-return ServeSession
+return ServeSession

plugin/src/Types.lua

@@ -5,10 +5,7 @@ local strict = require(script.Parent.strict)
 
 local RbxId = t.string
 
-local ApiValue = t.interface({
-	Type = t.string,
-	Value = t.optional(t.any),
-})
+local ApiValue = t.keys(t.string)
 
 local ApiInstanceMetadata = t.interface({
 	ignoreUnknownInstances = t.optional(t.boolean),
@@ -96,4 +93,4 @@ return strict("Types", {
 	VirtualInstance = ApiInstance,
 	VirtualMetadata = ApiInstanceMetadata,
 	VirtualValue = ApiValue,
-})
+})

plugin/test-place.project.json

@@ -9,7 +9,7 @@
       },
 
       "TestEZ": {
-        "$path": "modules/testez/lib"
+        "$path": "modules/testez"
       }
     },
 
@@ -25,4 +25,4 @@
       }
     }
   }
-}
+}

rojo-test/build-test-snapshots/end_to_end__tests__build__json_model_in_folder.snap

@@ -1,7 +1,6 @@
 ---
 source: tests/tests/build.rs
 expression: contents
-
 ---
 <roblox version="4">
   <Item class="Folder" referent="0">

rojo-test/build-test-snapshots/end_to_end__tests__build__rbxmx_in_folder.snap

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/build.rs
 expression: contents
+
 ---
 <roblox version="4">
   <Item class="Folder" referent="0">
@@ -25,14 +26,12 @@ expression: contents
           <R22>1</R22>
         </CoordinateFrame>
         <Ref name="PrimaryPart">null</Ref>
-        <BinaryString name="Tags">
-        </BinaryString>
+        <BinaryString name="Tags"></BinaryString>
       </Properties>
       <Item class="StringValue" referent="2">
         <Properties>
           <string name="Name">Cool StringValue</string>
-          <BinaryString name="Tags">
-          </BinaryString>
+          <BinaryString name="Tags"></BinaryString>
           <string name="Value">Did you know that BaseValue.Changed is different than Instance.Changed?</string>
         </Properties>
       </Item>

rojo-test/build-test-snapshots/end_to_end__tests__build__rbxmx_ref.snap

@@ -1,27 +1,25 @@
 ---
 source: tests/tests/build.rs
 expression: contents
+
 ---
 <roblox version="4">
   <Item class="Folder" referent="0">
     <Properties>
       <string name="Name">rbxmx_ref</string>
-      <BinaryString name="Tags">
-      </BinaryString>
+      <BinaryString name="Tags"></BinaryString>
     </Properties>
     <Item class="StringValue" referent="1">
       <Properties>
         <string name="Name">Target</string>
-        <BinaryString name="Tags">
-        </BinaryString>
+        <BinaryString name="Tags"></BinaryString>
         <string name="Value">Pointed to by ObjectValue</string>
       </Properties>
     </Item>
     <Item class="ObjectValue" referent="2">
       <Properties>
         <string name="Name">Pointer</string>
-        <BinaryString name="Tags">
-        </BinaryString>
+        <BinaryString name="Tags"></BinaryString>
         <Ref name="Value">1</Ref>
       </Properties>
     </Item>

rojo-test/build-test-snapshots/end_to_end__tests__build__unresolved_values.snap

@@ -0,0 +1,52 @@
+---
+source: tests/tests/build.rs
+expression: contents
+
+---
+<roblox version="4">
+  <Item class="DataModel" referent="0">
+    <Properties>
+      <string name="Name">unresolved-values</string>
+    </Properties>
+    <Item class="Lighting" referent="1">
+      <Properties>
+        <string name="Name">Lighting</string>
+        <Color3 name="Ambient">
+          <R>1</R>
+          <G>0</G>
+          <B>0</B>
+        </Color3>
+        <token name="Technology">1</token>
+      </Properties>
+    </Item>
+    <Item class="Workspace" referent="2">
+      <Properties>
+        <string name="Name">Workspace</string>
+      </Properties>
+      <Item class="BoolValue" referent="3">
+        <Properties>
+          <string name="Name">Bool</string>
+          <bool name="Value">true</bool>
+        </Properties>
+      </Item>
+      <Item class="Part" referent="4">
+        <Properties>
+          <string name="Name">Color</string>
+          <Color3uint8 name="Color3uint8">8404992</Color3uint8>
+        </Properties>
+      </Item>
+      <Item class="NumberValue" referent="5">
+        <Properties>
+          <string name="Name">Float</string>
+          <double name="Value">123.5</double>
+        </Properties>
+      </Item>
+      <Item class="IntValue" referent="6">
+        <Properties>
+          <string name="Name">Int</string>
+          <int64 name="Value">65</int64>
+        </Properties>
+      </Item>
+    </Item>
+  </Item>
+</roblox>

rojo-test/build-tests/unresolved_values/default.project.json

@@ -0,0 +1,43 @@
+{
+  "name": "unresolved-values",
+  "tree": {
+    "$className": "DataModel",
+
+    "Lighting": {
+      "$properties": {
+        "Technology": "Voxel",
+        "Ambient": [1, 0, 0]
+      }
+    },
+
+    "Workspace": {
+      "Color": {
+        "$className": "Part",
+        "$properties": {
+          "Color": [0.5, 0.25, 0]
+        }
+      },
+
+      "Bool": {
+        "$className": "BoolValue",
+        "$properties": {
+          "Value": true
+        }
+      },
+
+      "Int": {
+        "$className": "IntValue",
+        "$properties": {
+          "Value": 65
+        }
+      },
+
+      "Float": {
+        "$className": "NumberValue",
+        "$properties": {
+          "Value": 123.5
+        }
+      }
+    }
+  }
+}

rojo-test/serve-test-snapshots/end_to_end__tests__serve__add_folder_all-2.snap

@@ -11,7 +11,7 @@ instances:
     Metadata:
       ignoreUnknownInstances: false
     Name: add_folder
-    Parent: ~
+    Parent: "00000000000000000000000000000000"
     Properties: {}
   id-3:
     Children: []

rojo-test/serve-test-snapshots/end_to_end__tests__serve__add_folder_all.snap

@@ -10,7 +10,7 @@ instances:
     Metadata:
       ignoreUnknownInstances: false
     Name: add_folder
-    Parent: ~
+    Parent: "00000000000000000000000000000000"
     Properties: {}
 messageCursor: 0
 sessionId: id-1

rojo-test/serve-test-snapshots/end_to_end__tests__serve__add_folder_info.snap

@@ -1,10 +1,14 @@
 ---
 source: tests/tests/serve.rs
 expression: redactions.redacted_yaml(info)
+
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: add_folder
-protocolVersion: 3
+protocolVersion: 4
 rootInstanceId: id-2
 serverVersion: "[server-version]"
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__edit_init_all-2.snap

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-2:
@@ -10,10 +11,10 @@ instances:
     Metadata:
       ignoreUnknownInstances: false
     Name: edit_init
-    Parent: ~
+    Parent: "00000000000000000000000000000000"
     Properties:
       Source:
-        Type: String
-        Value: "-- Edited contents"
+        String: "-- Edited contents"
 messageCursor: 1
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__edit_init_all.snap

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-2:
@@ -10,10 +11,10 @@ instances:
     Metadata:
       ignoreUnknownInstances: false
     Name: edit_init
-    Parent: ~
+    Parent: "00000000000000000000000000000000"
     Properties:
       Source:
-        Type: String
-        Value: "-- Original contents"
+        String: "-- Original contents"
 messageCursor: 0
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__edit_init_info.snap

@@ -1,10 +1,14 @@
 ---
 source: tests/tests/serve.rs
 expression: redactions.redacted_yaml(info)
+
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: edit_init
-protocolVersion: 3
+protocolVersion: 4
 rootInstanceId: id-2
 serverVersion: "[server-version]"
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__edit_init_subscribe.snap

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "subscribe_response.intern_and_redact(&mut redactions, ())"
+
 ---
 messageCursor: 1
 messages:
@@ -12,7 +13,7 @@ messages:
         changedName: ~
         changedProperties:
           Source:
-            Type: String
-            Value: "-- Edited contents"
+            String: "-- Edited contents"
         id: id-2
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__empty_all.snap

@@ -10,7 +10,7 @@ instances:
     Metadata:
       ignoreUnknownInstances: true
     Name: empty
-    Parent: ~
+    Parent: "00000000000000000000000000000000"
     Properties: {}
 messageCursor: 0
 sessionId: id-1

rojo-test/serve-test-snapshots/end_to_end__tests__serve__empty_info.snap

@@ -1,10 +1,14 @@
 ---
 source: tests/tests/serve.rs
 expression: redactions.redacted_yaml(info)
+
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: empty
-protocolVersion: 3
+protocolVersion: 4
 rootInstanceId: id-2
 serverVersion: "[server-version]"
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__empty_json_model_all-2.snap

@@ -0,0 +1,28 @@
+---
+source: tests/tests/serve.rs
+expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
+---
+instances:
+  id-2:
+    Children:
+      - id-3
+    ClassName: Folder
+    Id: id-2
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: empty_folder
+    Parent: "00000000000000000000000000000000"
+    Properties: {}
+  id-3:
+    Children: []
+    ClassName: Model
+    Id: id-3
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: test
+    Parent: id-2
+    Properties: {}
+messageCursor: 1
+sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__empty_json_model_all.snap

@@ -0,0 +1,18 @@
+---
+source: tests/tests/serve.rs
+expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
+---
+instances:
+  id-2:
+    Children: []
+    ClassName: Folder
+    Id: id-2
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: empty_folder
+    Parent: "00000000000000000000000000000000"
+    Properties: {}
+messageCursor: 0
+sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__empty_json_model_info.snap

@@ -0,0 +1,14 @@
+---
+source: tests/tests/serve.rs
+expression: redactions.redacted_yaml(info)
+
+---
+expectedPlaceIds: ~
+gameId: ~
+placeId: ~
+projectName: empty_folder
+protocolVersion: 4
+rootInstanceId: id-2
+serverVersion: "[server-version]"
+sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__empty_json_model_subscribe.snap

@@ -0,0 +1,21 @@
+---
+source: tests/tests/serve.rs
+expression: "subscribe_response.intern_and_redact(&mut redactions, ())"
+
+---
+messageCursor: 1
+messages:
+  - added:
+      id-3:
+        Children: []
+        ClassName: Model
+        Id: id-3
+        Metadata:
+          ignoreUnknownInstances: false
+        Name: test
+        Parent: id-2
+        Properties: {}
+    removed: []
+    updated: []
+sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__move_folder_of_stuff_all-2.snap

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-10:
@@ -13,8 +14,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
-        Value: "File #6"
+        String: "File #6"
   id-11:
     Children: []
     ClassName: StringValue
@@ -25,8 +25,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
-        Value: "File #7"
+        String: "File #7"
   id-12:
     Children: []
     ClassName: StringValue
@@ -37,8 +36,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
-        Value: "File #8"
+        String: "File #8"
   id-13:
     Children: []
     ClassName: StringValue
@@ -49,8 +47,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
-        Value: "File #9"
+        String: "File #9"
   id-2:
     Children:
       - id-3
@@ -59,7 +56,7 @@ instances:
     Metadata:
       ignoreUnknownInstances: false
     Name: move_folder_of_stuff
-    Parent: ~
+    Parent: "00000000000000000000000000000000"
     Properties: {}
   id-3:
     Children:
@@ -90,8 +87,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
-        Value: "File #0"
+        String: "File #0"
   id-5:
     Children: []
     ClassName: StringValue
@@ -102,8 +98,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
-        Value: "File #1"
+        String: "File #1"
   id-6:
     Children: []
     ClassName: StringValue
@@ -114,8 +109,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
-        Value: "File #2"
+        String: "File #2"
   id-7:
     Children: []
     ClassName: StringValue
@@ -126,8 +120,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
-        Value: "File #3"
+        String: "File #3"
   id-8:
     Children: []
     ClassName: StringValue
@@ -138,8 +131,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
-        Value: "File #4"
+        String: "File #4"
   id-9:
     Children: []
     ClassName: StringValue
@@ -150,7 +142,7 @@ instances:
     Parent: id-3
     Properties:
       Value:
-        Type: String
-        Value: "File #5"
+        String: "File #5"
 messageCursor: 1
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__move_folder_of_stuff_all.snap

@@ -10,7 +10,7 @@ instances:
     Metadata:
       ignoreUnknownInstances: false
     Name: move_folder_of_stuff
-    Parent: ~
+    Parent: "00000000000000000000000000000000"
     Properties: {}
 messageCursor: 0
 sessionId: id-1

rojo-test/serve-test-snapshots/end_to_end__tests__serve__move_folder_of_stuff_info.snap

@@ -1,10 +1,14 @@
 ---
 source: tests/tests/serve.rs
 expression: redactions.redacted_yaml(info)
+
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: move_folder_of_stuff
-protocolVersion: 3
+protocolVersion: 4
 rootInstanceId: id-2
 serverVersion: "[server-version]"
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__move_folder_of_stuff_subscribe.snap

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "subscribe_response.intern_and_redact(&mut redactions, ())"
+
 ---
 messageCursor: 1
 messages:
@@ -15,8 +16,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
-            Value: "File #6"
+            String: "File #6"
       id-11:
         Children: []
         ClassName: StringValue
@@ -27,8 +27,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
-            Value: "File #7"
+            String: "File #7"
       id-12:
         Children: []
         ClassName: StringValue
@@ -39,8 +38,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
-            Value: "File #8"
+            String: "File #8"
       id-13:
         Children: []
         ClassName: StringValue
@@ -51,8 +49,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
-            Value: "File #9"
+            String: "File #9"
       id-3:
         Children:
           - id-4
@@ -82,8 +79,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
-            Value: "File #0"
+            String: "File #0"
       id-5:
         Children: []
         ClassName: StringValue
@@ -94,8 +90,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
-            Value: "File #1"
+            String: "File #1"
       id-6:
         Children: []
         ClassName: StringValue
@@ -106,8 +101,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
-            Value: "File #2"
+            String: "File #2"
       id-7:
         Children: []
         ClassName: StringValue
@@ -118,8 +112,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
-            Value: "File #3"
+            String: "File #3"
       id-8:
         Children: []
         ClassName: StringValue
@@ -130,8 +123,7 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
-            Value: "File #4"
+            String: "File #4"
       id-9:
         Children: []
         ClassName: StringValue
@@ -142,8 +134,8 @@ messages:
         Parent: id-3
         Properties:
           Value:
-            Type: String
-            Value: "File #5"
+            String: "File #5"
     removed: []
     updated: []
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__remove_file_all-2.snap

@@ -10,7 +10,7 @@ instances:
     Metadata:
       ignoreUnknownInstances: false
     Name: remove_file
-    Parent: ~
+    Parent: "00000000000000000000000000000000"
     Properties: {}
 messageCursor: 1
 sessionId: id-1

rojo-test/serve-test-snapshots/end_to_end__tests__serve__remove_file_all.snap

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-2:
@@ -11,7 +12,7 @@ instances:
     Metadata:
       ignoreUnknownInstances: false
     Name: remove_file
-    Parent: ~
+    Parent: "00000000000000000000000000000000"
     Properties: {}
   id-3:
     Children: []
@@ -23,7 +24,7 @@ instances:
     Parent: id-2
     Properties:
       Value:
-        Type: String
-        Value: This file will be removed!
+        String: This file will be removed!
 messageCursor: 0
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__remove_file_info.snap

@@ -1,10 +1,14 @@
 ---
 source: tests/tests/serve.rs
 expression: redactions.redacted_yaml(info)
+
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: remove_file
-protocolVersion: 3
+protocolVersion: 4
 rootInstanceId: id-2
 serverVersion: "[server-version]"
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__scripts_all-2.snap

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-2:
@@ -12,7 +13,7 @@ instances:
     Metadata:
       ignoreUnknownInstances: false
     Name: scripts
-    Parent: ~
+    Parent: "00000000000000000000000000000000"
     Properties: {}
   id-3:
     Children: []
@@ -24,8 +25,7 @@ instances:
     Parent: id-2
     Properties:
       Source:
-        Type: String
-        Value: "-- Hello, from bar!"
+        String: "-- Hello, from bar!"
   id-4:
     Children: []
     ClassName: ModuleScript
@@ -36,7 +36,7 @@ instances:
     Parent: id-2
     Properties:
       Source:
-        Type: String
-        Value: Updated foo!
+        String: Updated foo!
 messageCursor: 1
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__scripts_all.snap

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+
 ---
 instances:
   id-2:
@@ -12,7 +13,7 @@ instances:
     Metadata:
       ignoreUnknownInstances: false
     Name: scripts
-    Parent: ~
+    Parent: "00000000000000000000000000000000"
     Properties: {}
   id-3:
     Children: []
@@ -24,8 +25,7 @@ instances:
     Parent: id-2
     Properties:
       Source:
-        Type: String
-        Value: "-- Hello, from bar!"
+        String: "-- Hello, from bar!"
   id-4:
     Children: []
     ClassName: ModuleScript
@@ -36,7 +36,7 @@ instances:
     Parent: id-2
     Properties:
       Source:
-        Type: String
-        Value: "-- Hello, from foo!"
+        String: "-- Hello, from foo!"
 messageCursor: 0
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__scripts_info.snap

@@ -1,10 +1,14 @@
 ---
 source: tests/tests/serve.rs
 expression: redactions.redacted_yaml(info)
+
 ---
 expectedPlaceIds: ~
+gameId: ~
+placeId: ~
 projectName: scripts
-protocolVersion: 3
+protocolVersion: 4
 rootInstanceId: id-2
 serverVersion: "[server-version]"
 sessionId: id-1
+

rojo-test/serve-test-snapshots/end_to_end__tests__serve__scripts_subscribe.snap

@@ -1,6 +1,7 @@
 ---
 source: tests/tests/serve.rs
 expression: "subscribe_response.intern_and_redact(&mut redactions, ())"
+
 ---
 messageCursor: 1
 messages:
@@ -12,7 +13,7 @@ messages:
         changedName: ~
         changedProperties:
           Source:
-            Type: String
-            Value: Updated foo!
+            String: Updated foo!
         id: id-4
 sessionId: id-1
+

rojo-test/serve-tests/empty_json_model/default.project.json

@@ -1,5 +1,5 @@
 {
-  "name": "rbx_dom_lua",
+  "name": "empty_folder",
   "tree": {
     "$path": "src"
   }

src/change_processor.rs

@@ -6,7 +6,7 @@ use std::{
 use crossbeam_channel::{select, Receiver, RecvError, Sender};
 use jod_thread::JoinHandle;
 use memofs::{IoResultExt, Vfs, VfsEvent};
-use rbx_dom_weak::{RbxId, RbxValue};
+use rbx_dom_weak::types::{Ref, Variant};
 
 use crate::{
     message_queue::MessageQueue,
@@ -16,6 +16,9 @@ use crate::{
     snapshot_middleware::{snapshot_from_vfs, snapshot_project_node},
 };
 
+/// Processes file change events, updates the DOM, and sends those updates
+/// through a channel for other stuff to consume.
+///
 /// Owns the connection between Rojo's VFS and its DOM by holding onto another
 /// thread that processes messages.
 ///
@@ -179,7 +182,7 @@ impl JobThreadContext {
                             InstigatingSource::Path(path) => fs::remove_file(path).unwrap(),
                             InstigatingSource::ProjectNode(_, _, _, _) => {
                                 log::warn!(
-                                    "Cannot remove instance {}, it's from a project file",
+                                    "Cannot remove instance {:?}, it's from a project file",
                                     id
                                 );
                             }
@@ -187,12 +190,12 @@ impl JobThreadContext {
                     } else {
                         // TODO
                         log::warn!(
-                            "Cannot remove instance {}, it is not an instigating source.",
+                            "Cannot remove instance {:?}, it is not an instigating source.",
                             id
                         );
                     }
                 } else {
-                    log::warn!("Cannot remove instance {}, it does not exist.", id);
+                    log::warn!("Cannot remove instance {:?}, it does not exist.", id);
                 }
             }
 
@@ -219,7 +222,7 @@ impl JobThreadContext {
                             {
                                 match instigating_source {
                                     InstigatingSource::Path(path) => {
-                                        if let Some(RbxValue::String { value }) = changed_value {
+                                        if let Some(Variant::String(value)) = changed_value {
                                             fs::write(path, value).unwrap();
                                         } else {
                                             log::warn!("Cannot change Source to non-string value.");
@@ -227,14 +230,14 @@ impl JobThreadContext {
                                     }
                                     InstigatingSource::ProjectNode(_, _, _, _) => {
                                         log::warn!(
-                                            "Cannot remove instance {}, it's from a project file",
+                                            "Cannot remove instance {:?}, it's from a project file",
                                             id
                                         );
                                     }
                                 }
                             } else {
                                 log::warn!(
-                                    "Cannot update instance {}, it is not an instigating source.",
+                                    "Cannot update instance {:?}, it is not an instigating source.",
                                     id
                                 );
                             }
@@ -243,7 +246,7 @@ impl JobThreadContext {
                         }
                     }
                 } else {
-                    log::warn!("Cannot update instance {}, it does not exist.", id);
+                    log::warn!("Cannot update instance {:?}, it does not exist.", id);
                 }
             }
 
@@ -254,7 +257,7 @@ impl JobThreadContext {
     }
 }
 
-fn compute_and_apply_changes(tree: &mut RojoTree, vfs: &Vfs, id: RbxId) -> Option<AppliedPatchSet> {
+fn compute_and_apply_changes(tree: &mut RojoTree, vfs: &Vfs, id: Ref) -> Option<AppliedPatchSet> {
     let metadata = tree
         .get_metadata(id)
         .expect("metadata missing for instance present in tree");
@@ -263,7 +266,7 @@ fn compute_and_apply_changes(tree: &mut RojoTree, vfs: &Vfs, id: RbxId) -> Optio
         Some(path) => path,
         None => {
             log::error!(
-                "Instance {} did not have an instigating source, but was considered for an update.",
+                "Instance {:?} did not have an instigating source, but was considered for an update.",
                 id
             );
             log::error!("This is a bug. Please file an issue!");

src/cli/build.rs

@@ -1,24 +1,88 @@
 use std::{
-    fs::File,
     io::{BufWriter, Write},
+    path::{Path, PathBuf},
 };
 
+use anyhow::Context;
+use fs_err::File;
 use memofs::Vfs;
-use thiserror::Error;
+use structopt::StructOpt;
 use tokio::runtime::Runtime;
 
-use crate::{cli::BuildCommand, serve_session::ServeSession, snapshot::RojoTree};
+use crate::serve_session::ServeSession;
 
+use super::resolve_path;
+
+const UNKNOWN_OUTPUT_KIND_ERR: &str = "Could not detect what kind of file to build. \
+                                       Expected output file to end in .rbxl, .rbxlx, .rbxm, or .rbxmx.";
+
+/// Generates a model or place file from the Rojo project.
+#[derive(Debug, StructOpt)]
+pub struct BuildCommand {
+    /// Path to the project to serve. Defaults to the current directory.
+    #[structopt(default_value = "")]
+    pub project: PathBuf,
+
+    /// Where to output the result.
+    ///
+    /// Should end in .rbxm, .rbxl, .rbxmx, or .rbxlx.
+    #[structopt(long, short)]
+    pub output: PathBuf,
+
+    /// Whether to automatically rebuild when any input files change.
+    #[structopt(long)]
+    pub watch: bool,
+}
+
+impl BuildCommand {
+    pub fn run(self) -> anyhow::Result<()> {
+        let project_path = resolve_path(&self.project);
+
+        let output_kind = detect_output_kind(&self.output).context(UNKNOWN_OUTPUT_KIND_ERR)?;
+
+        log::trace!("Constructing in-memory filesystem");
+        let vfs = Vfs::new_default();
+        vfs.set_watch_enabled(self.watch);
+
+        let session = ServeSession::new(vfs, &project_path)?;
+        let mut cursor = session.message_queue().cursor();
+
+        write_model(&session, &self.output, output_kind)?;
+
+        if self.watch {
+            let rt = Runtime::new().unwrap();
+
+            loop {
+                let receiver = session.message_queue().subscribe(cursor);
+                let (new_cursor, _patch_set) = rt.block_on(receiver).unwrap();
+                cursor = new_cursor;
+
+                write_model(&session, &self.output, output_kind)?;
+            }
+        }
+
+        Ok(())
+    }
+}
+
+/// The different kinds of output that Rojo can build to.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 enum OutputKind {
+    /// An XML model file.
     Rbxmx,
+
+    /// An XML place file.
     Rbxlx,
+
+    /// A binary model file.
     Rbxm,
+
+    /// A binary place file.
     Rbxl,
 }
 
-fn detect_output_kind(options: &BuildCommand) -> Option<OutputKind> {
-    let extension = options.output.extension()?.to_str()?;
+fn detect_output_kind(output: &Path) -> Option<OutputKind> {
+    let extension = output.extension()?.to_str()?;
 
     match extension {
         "rbxlx" => Some(OutputKind::Rbxlx),
@@ -29,57 +93,33 @@ fn detect_output_kind(options: &BuildCommand) -> Option<OutputKind> {
     }
 }
 
-#[derive(Debug, Error)]
-enum Error {
-    #[error("Could not detect what kind of file to build. Expected output file to end in .rbxl, .rbxlx, .rbxm, or .rbxmx.")]
-    UnknownOutputKind,
-}
-
 fn xml_encode_config() -> rbx_xml::EncodeOptions {
     rbx_xml::EncodeOptions::new().property_behavior(rbx_xml::EncodePropertyBehavior::WriteUnknown)
 }
 
-pub fn build(options: BuildCommand) -> Result<(), anyhow::Error> {
-    log::trace!("Constructing in-memory filesystem");
-
-    let vfs = Vfs::new_default();
-    vfs.set_watch_enabled(options.watch);
-
-    let session = ServeSession::new(vfs, &options.absolute_project())?;
-    let mut cursor = session.message_queue().cursor();
-
-    {
-        let tree = session.tree();
-        write_model(&tree, &options)?;
-    }
-
-    if options.watch {
-        let mut rt = Runtime::new().unwrap();
-
-        loop {
-            let receiver = session.message_queue().subscribe(cursor);
-            let (new_cursor, _patch_set) = rt.block_on(receiver).unwrap();
-            cursor = new_cursor;
-
-            let tree = session.tree();
-            write_model(&tree, &options)?;
-        }
-    }
-
-    Ok(())
-}
-
-fn write_model(tree: &RojoTree, options: &BuildCommand) -> Result<(), anyhow::Error> {
-    let output_kind = detect_output_kind(&options).ok_or(Error::UnknownOutputKind)?;
-    log::debug!("Hoping to generate file of type {:?}", output_kind);
+fn write_model(
+    session: &ServeSession,
+    output: &Path,
+    output_kind: OutputKind,
+) -> anyhow::Result<()> {
+    println!("Building project '{}'", session.project_name());
 
+    let tree = session.tree();
     let root_id = tree.get_root_id();
 
     log::trace!("Opening output file for write");
-    let file = File::create(&options.output)?;
-    let mut file = BufWriter::new(file);
+    let mut file = BufWriter::new(File::create(output)?);
 
     match output_kind {
+        OutputKind::Rbxm => {
+            rbx_binary::to_writer(&mut file, tree.inner(), &[root_id])?;
+        }
+        OutputKind::Rbxl => {
+            let root_instance = tree.get_instance(root_id).unwrap();
+            let top_level_ids = root_instance.children();
+
+            rbx_binary::to_writer(&mut file, tree.inner(), top_level_ids)?;
+        }
         OutputKind::Rbxmx => {
             // Model files include the root instance of the tree and all its
             // descendants.
@@ -88,36 +128,22 @@ fn write_model(tree: &RojoTree, options: &BuildCommand) -> Result<(), anyhow::Er
         }
         OutputKind::Rbxlx => {
             // Place files don't contain an entry for the DataModel, but our
-            // RbxTree representation does.
+            // WeakDom representation does.
 
             let root_instance = tree.get_instance(root_id).unwrap();
             let top_level_ids = root_instance.children();
 
             rbx_xml::to_writer(&mut file, tree.inner(), top_level_ids, xml_encode_config())?;
         }
-        OutputKind::Rbxm => {
-            rbx_binary::encode(tree.inner(), &[root_id], &mut file)?;
-        }
-        OutputKind::Rbxl => {
-            log::warn!("Support for building binary places (rbxl) is still experimental.");
-            log::warn!("Using the XML place format (rbxlx) is recommended instead.");
-            log::warn!("For more info, see https://github.com/rojo-rbx/rojo/issues/180");
-
-            let root_instance = tree.get_instance(root_id).unwrap();
-            let top_level_ids = root_instance.children();
-
-            rbx_binary::encode(tree.inner(), top_level_ids, &mut file)?;
-        }
     }
 
     file.flush()?;
 
-    let filename = options
-        .output
+    let filename = output
         .file_name()
         .and_then(|name| name.to_str())
         .unwrap_or("<invalid utf-8>");
-    log::info!("Built project to {}", filename);
+    println!("Built project to {}", filename);
 
     Ok(())
 }

src/cli/doc.rs

@@ -1,4 +1,12 @@
-pub fn doc() -> Result<(), anyhow::Error> {
-    opener::open("https://rojo.space/docs")?;
-    Ok(())
+use structopt::StructOpt;
+
+/// Open Rojo's documentation in your browser.
+#[derive(Debug, StructOpt)]
+pub struct DocCommand {}
+
+impl DocCommand {
+    pub fn run(self) -> anyhow::Result<()> {
+        opener::open("https://rojo.space/docs")?;
+        Ok(())
+    }
 }

src/cli/fmt_project.rs

@@ -0,0 +1,29 @@
+use std::path::PathBuf;
+
+use anyhow::Context;
+use structopt::StructOpt;
+
+use crate::project::Project;
+
+/// Reformat a Rojo project using the standard JSON formatting rules.
+#[derive(Debug, StructOpt)]
+pub struct FmtProjectCommand {
+    /// Path to the project to format. Defaults to the current directory.
+    #[structopt(default_value = "")]
+    pub project: PathBuf,
+}
+
+impl FmtProjectCommand {
+    pub fn run(self) -> anyhow::Result<()> {
+        let project = Project::load_fuzzy(&self.project)?
+            .context("A project file is required to run 'rojo fmt-project'")?;
+
+        let serialized = serde_json::to_string_pretty(&project)
+            .context("could not re-encode project file as JSON")?;
+
+        fs_err::write(&project.file_location, &serialized)
+            .context("could not write back to project file")?;
+
+        Ok(())
+    }
+}

src/cli/init.rs

@@ -1,13 +1,14 @@
-use std::{
-    fs::{self, OpenOptions},
-    io::{self, Write},
-    path::Path,
-    process::{Command, Stdio},
-};
+use std::io::{self, Write};
+use std::path::{Path, PathBuf};
+use std::process::{Command, Stdio};
+use std::str::FromStr;
 
-use thiserror::Error;
+use anyhow::{bail, format_err};
+use fs_err as fs;
+use fs_err::OpenOptions;
+use structopt::StructOpt;
 
-use crate::cli::{InitCommand, InitKind};
+use super::resolve_path;
 
 static MODEL_PROJECT: &str =
     include_str!("../../assets/default-model-project/default.project.json");
@@ -20,37 +21,71 @@ static PLACE_PROJECT: &str =
 static PLACE_README: &str = include_str!("../../assets/default-place-project/README.md");
 static PLACE_GIT_IGNORE: &str = include_str!("../../assets/default-place-project/gitignore.txt");
 
-#[derive(Debug, Error)]
-enum Error {
-    #[error("A project file named default.project.json already exists in this folder")]
-    AlreadyExists,
+/// Initializes a new Rojo project.
+#[derive(Debug, StructOpt)]
+pub struct InitCommand {
+    /// Path to the place to create the project. Defaults to the current directory.
+    #[structopt(default_value = "")]
+    pub path: PathBuf,
 
-    #[error("git init failed")]
-    GitInit,
+    /// The kind of project to create, 'place' or 'model'. Defaults to place.
+    #[structopt(long, default_value = "place")]
+    pub kind: InitKind,
 }
 
-pub fn init(options: InitCommand) -> Result<(), anyhow::Error> {
-    let base_path = options.absolute_path();
-    fs::create_dir_all(&base_path)?;
+impl InitCommand {
+    pub fn run(self) -> anyhow::Result<()> {
+        let base_path = resolve_path(&self.path);
+        fs::create_dir_all(&base_path)?;
 
-    let canonical = fs::canonicalize(&base_path)?;
-    let project_name = canonical
-        .file_name()
-        .and_then(|name| name.to_str())
-        .unwrap_or("new-project");
+        let canonical = fs::canonicalize(&base_path)?;
+        let project_name = canonical
+            .file_name()
+            .and_then(|name| name.to_str())
+            .unwrap_or("new-project");
 
-    let project_params = ProjectParams {
-        name: project_name.to_owned(),
-    };
+        let project_params = ProjectParams {
+            name: project_name.to_owned(),
+        };
 
-    match options.kind {
-        InitKind::Place => init_place(&base_path, project_params),
-        InitKind::Model => init_model(&base_path, project_params),
+        match self.kind {
+            InitKind::Place => init_place(&base_path, project_params)?,
+            InitKind::Model => init_model(&base_path, project_params)?,
+        }
+
+        println!("Created project successfully.");
+
+        Ok(())
     }
 }
 
-fn init_place(base_path: &Path, project_params: ProjectParams) -> Result<(), anyhow::Error> {
-    eprintln!("Creating new place project '{}'", project_params.name);
+/// The templates we support for initializing a Rojo project.
+#[derive(Debug, Clone, Copy)]
+pub enum InitKind {
+    /// A place that contains a baseplate.
+    Place,
+
+    /// An empty model, suitable for a library or plugin.
+    Model,
+}
+
+impl FromStr for InitKind {
+    type Err = anyhow::Error;
+
+    fn from_str(source: &str) -> Result<Self, Self::Err> {
+        match source {
+            "place" => Ok(InitKind::Place),
+            "model" => Ok(InitKind::Model),
+            _ => Err(format_err!(
+                "Invalid init kind '{}'. Valid kinds are: place, model",
+                source
+            )),
+        }
+    }
+}
+
+fn init_place(base_path: &Path, project_params: ProjectParams) -> anyhow::Result<()> {
+    println!("Creating new place project '{}'", project_params.name);
 
     let project_file = project_params.render_template(PLACE_PROJECT);
     try_create_project(base_path, &project_file)?;
@@ -88,13 +123,11 @@ fn init_place(base_path: &Path, project_params: ProjectParams) -> Result<(), any
     let git_ignore = project_params.render_template(PLACE_GIT_IGNORE);
     try_git_init(base_path, &git_ignore)?;
 
-    eprintln!("Created project successfully.");
-
     Ok(())
 }
 
-fn init_model(base_path: &Path, project_params: ProjectParams) -> Result<(), anyhow::Error> {
-    eprintln!("Creating new model project '{}'", project_params.name);
+fn init_model(base_path: &Path, project_params: ProjectParams) -> anyhow::Result<()> {
+    println!("Creating new model project '{}'", project_params.name);
 
     let project_file = project_params.render_template(MODEL_PROJECT);
     try_create_project(base_path, &project_file)?;
@@ -111,8 +144,6 @@ fn init_model(base_path: &Path, project_params: ProjectParams) -> Result<(), any
     let git_ignore = project_params.render_template(MODEL_GIT_IGNORE);
     try_git_init(base_path, &git_ignore)?;
 
-    eprintln!("Created project successfully.");
-
     Ok(())
 }
 
@@ -138,7 +169,7 @@ fn try_git_init(path: &Path, git_ignore: &str) -> Result<(), anyhow::Error> {
         let status = Command::new("git").arg("init").current_dir(path).status()?;
 
         if !status.success() {
-            return Err(Error::GitInit.into());
+            bail!("git init failed: status code {:?}", status.code());
         }
     }
 
@@ -195,13 +226,15 @@ fn try_create_project(base_path: &Path, contents: &str) -> Result<(), anyhow::Er
     let file_res = OpenOptions::new()
         .write(true)
         .create_new(true)
-        .open(project_path);
+        .open(&project_path);
 
     let mut file = match file_res {
         Ok(file) => file,
         Err(err) => {
             return match err.kind() {
-                io::ErrorKind::AlreadyExists => Err(Error::AlreadyExists.into()),
+                io::ErrorKind::AlreadyExists => {
+                    bail!("Project file already exists: {}", project_path.display())
+                }
                 _ => Err(err.into()),
             }
         }

src/cli/mod.rs

@@ -2,30 +2,24 @@
 
 mod build;
 mod doc;
+mod fmt_project;
 mod init;
 mod plugin;
 mod serve;
 mod upload;
 
-use std::{
-    borrow::Cow,
-    env,
-    error::Error,
-    fmt,
-    net::IpAddr,
-    path::{Path, PathBuf},
-    str::FromStr,
-};
+use std::{borrow::Cow, env, path::Path, str::FromStr};
 
 use structopt::StructOpt;
 use thiserror::Error;
 
-pub use self::build::*;
-pub use self::doc::*;
-pub use self::init::*;
-pub use self::plugin::*;
-pub use self::serve::*;
-pub use self::upload::*;
+pub use self::build::BuildCommand;
+pub use self::doc::DocCommand;
+pub use self::fmt_project::FmtProjectCommand;
+pub use self::init::{InitCommand, InitKind};
+pub use self::plugin::{PluginCommand, PluginSubcommand};
+pub use self::serve::ServeCommand;
+pub use self::upload::UploadCommand;
 
 /// Command line options that Rojo accepts, defined using the structopt crate.
 #[derive(Debug, StructOpt)]
@@ -39,6 +33,20 @@ pub struct Options {
     pub subcommand: Subcommand,
 }
 
+impl Options {
+    pub fn run(self) -> anyhow::Result<()> {
+        match self.subcommand {
+            Subcommand::Init(subcommand) => subcommand.run(),
+            Subcommand::Serve(subcommand) => subcommand.run(self.global),
+            Subcommand::Build(subcommand) => subcommand.run(),
+            Subcommand::Upload(subcommand) => subcommand.run(),
+            Subcommand::FmtProject(subcommand) => subcommand.run(),
+            Subcommand::Doc(subcommand) => subcommand.run(),
+            Subcommand::Plugin(subcommand) => subcommand.run(),
+        }
+    }
+}
+
 #[derive(Debug, StructOpt)]
 pub struct GlobalOptions {
     /// Sets verbosity level. Can be specified multiple times.
@@ -100,218 +108,19 @@ pub struct ColorChoiceParseError {
 
 #[derive(Debug, StructOpt)]
 pub enum Subcommand {
-    /// Creates a new Rojo project.
     Init(InitCommand),
-
-    /// Serves the project's files for use with the Rojo Studio plugin.
     Serve(ServeCommand),
-
-    /// Generates a model or place file from the project.
     Build(BuildCommand),
-
-    /// Generates a place or model file out of the project and uploads it to Roblox.
     Upload(UploadCommand),
-
-    /// Open Rojo's documentation in your browser.
-    Doc,
-
-    /// Manages Rojo's Roblox Studio plugin.
+    FmtProject(FmtProjectCommand),
+    Doc(DocCommand),
     Plugin(PluginCommand),
 }
 
-/// Initializes a new Rojo project.
-#[derive(Debug, StructOpt)]
-pub struct InitCommand {
-    /// Path to the place to create the project. Defaults to the current directory.
-    #[structopt(default_value = "")]
-    pub path: PathBuf,
-
-    /// The kind of project to create, 'place' or 'model'. Defaults to place.
-    #[structopt(long, default_value = "place")]
-    pub kind: InitKind,
-}
-
-impl InitCommand {
-    pub fn absolute_path(&self) -> Cow<'_, Path> {
-        resolve_path(&self.path)
-    }
-}
-
-/// The templates we support for initializing a Rojo project.
-#[derive(Debug, Clone, Copy)]
-pub enum InitKind {
-    /// A place that matches what File -> New does in Roblox Studio.
-    Place,
-
-    /// An empty model, suitable for a library or plugin.
-    Model,
-}
-
-impl FromStr for InitKind {
-    type Err = InitKindParseError;
-
-    fn from_str(source: &str) -> Result<Self, Self::Err> {
-        match source {
-            "place" => Ok(InitKind::Place),
-            "model" => Ok(InitKind::Model),
-            _ => Err(InitKindParseError {
-                attempted: source.to_owned(),
-            }),
-        }
-    }
-}
-
-/// Error type for failing to parse an `InitKind`.
-#[derive(Debug)]
-pub struct InitKindParseError {
-    attempted: String,
-}
-
-impl Error for InitKindParseError {}
-
-impl fmt::Display for InitKindParseError {
-    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
-        write!(
-            formatter,
-            "Invalid init kind '{}'. Valid kinds are: place, model",
-            self.attempted
-        )
-    }
-}
-
-/// Expose a Rojo project through a web server that can communicate with the
-/// Rojo Roblox Studio plugin, or be visited by the user in the browser.
-#[derive(Debug, StructOpt)]
-pub struct ServeCommand {
-    /// Path to the project to serve. Defaults to the current directory.
-    #[structopt(default_value = "")]
-    pub project: PathBuf,
-
-    /// The IP address to listen on. Defaults to `127.0.0.1`.
-    #[structopt(long)]
-    pub address: Option<IpAddr>,
-
-    /// The port to listen on. Defaults to the project's preference, or `34872` if
-    /// it has none.
-    #[structopt(long)]
-    pub port: Option<u16>,
-}
-
-impl ServeCommand {
-    pub fn absolute_project(&self) -> Cow<'_, Path> {
-        resolve_path(&self.project)
-    }
-}
-
-/// Build a Rojo project into a file.
-#[derive(Debug, StructOpt)]
-pub struct BuildCommand {
-    /// Path to the project to serve. Defaults to the current directory.
-    #[structopt(default_value = "")]
-    pub project: PathBuf,
-
-    /// Where to output the result.
-    #[structopt(long, short)]
-    pub output: PathBuf,
-
-    /// Whether to automatically rebuild when any input files change.
-    #[structopt(long)]
-    pub watch: bool,
-}
-
-impl BuildCommand {
-    pub fn absolute_project(&self) -> Cow<'_, Path> {
-        resolve_path(&self.project)
-    }
-}
-
-/// Build and upload a Rojo project to Roblox.com.
-#[derive(Debug, StructOpt)]
-pub struct UploadCommand {
-    /// Path to the project to upload. Defaults to the current directory.
-    #[structopt(default_value = "")]
-    pub project: PathBuf,
-
-    /// Authenication cookie to use. If not specified, Rojo will attempt to find one from the system automatically.
-    #[structopt(long)]
-    pub cookie: Option<String>,
-
-    /// Asset ID to upload to.
-    #[structopt(long = "asset_id")]
-    pub asset_id: u64,
-}
-
-impl UploadCommand {
-    pub fn absolute_project(&self) -> Cow<'_, Path> {
-        resolve_path(&self.project)
-    }
-}
-
-/// The kind of asset to upload to the website. Affects what endpoints Rojo uses
-/// and changes how the asset is built.
-#[derive(Debug, Clone, Copy)]
-pub enum UploadKind {
-    /// Upload to a place.
-    Place,
-
-    /// Upload to a model-like asset, like a Model, Plugin, or Package.
-    Model,
-}
-
-impl FromStr for UploadKind {
-    type Err = UploadKindParseError;
-
-    fn from_str(source: &str) -> Result<Self, Self::Err> {
-        match source {
-            "place" => Ok(UploadKind::Place),
-            "model" => Ok(UploadKind::Model),
-            _ => Err(UploadKindParseError {
-                attempted: source.to_owned(),
-            }),
-        }
-    }
-}
-
-/// Error type for failing to parse an `UploadKind`.
-#[derive(Debug)]
-pub struct UploadKindParseError {
-    attempted: String,
-}
-
-impl Error for UploadKindParseError {}
-
-impl fmt::Display for UploadKindParseError {
-    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
-        write!(
-            formatter,
-            "Invalid upload kind '{}'. Valid kinds are: place, model",
-            self.attempted
-        )
-    }
-}
-
-fn resolve_path(path: &Path) -> Cow<'_, Path> {
+pub(super) fn resolve_path(path: &Path) -> Cow<'_, Path> {
     if path.is_absolute() {
         Cow::Borrowed(path)
     } else {
         Cow::Owned(env::current_dir().unwrap().join(path))
     }
 }
-
-#[derive(Debug, StructOpt)]
-pub enum PluginSubcommand {
-    /// Install the plugin in Roblox Studio's plugins folder. If the plugin is
-    /// already installed, installing it again will overwrite the current plugin
-    /// file.
-    Install,
-
-    /// Removes the plugin if it is installed.
-    Uninstall,
-}
-
-/// Install Rojo's plugin.
-#[derive(Debug, StructOpt)]
-pub struct PluginCommand {
-    #[structopt(subcommand)]
-    subcommand: PluginSubcommand,
-}

src/cli/plugin.rs

@@ -3,26 +3,50 @@ use std::{
     io::BufWriter,
 };
 
-use anyhow::Result;
 use memofs::{InMemoryFs, Vfs, VfsSnapshot};
 use roblox_install::RobloxStudio;
+use structopt::StructOpt;
 
-use crate::{
-    cli::{PluginCommand, PluginSubcommand},
-    serve_session::ServeSession,
-};
+use crate::serve_session::ServeSession;
 
 static PLUGIN_BINCODE: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/plugin.bincode"));
 static PLUGIN_FILE_NAME: &str = "RojoManagedPlugin.rbxm";
 
-pub fn plugin(options: PluginCommand) -> Result<()> {
-    match options.subcommand {
-        PluginSubcommand::Install => install_plugin(),
-        PluginSubcommand::Uninstall => uninstall_plugin(),
+/// Install Rojo's plugin.
+#[derive(Debug, StructOpt)]
+pub struct PluginCommand {
+    #[structopt(subcommand)]
+    subcommand: PluginSubcommand,
+}
+
+/// Manages Rojo's Roblox Studio plugin.
+#[derive(Debug, StructOpt)]
+pub enum PluginSubcommand {
+    /// Install the plugin in Roblox Studio's plugins folder. If the plugin is
+    /// already installed, installing it again will overwrite the current plugin
+    /// file.
+    Install,
+
+    /// Removes the plugin if it is installed.
+    Uninstall,
+}
+
+impl PluginCommand {
+    pub fn run(self) -> anyhow::Result<()> {
+        self.subcommand.run()
     }
 }
 
-pub fn install_plugin() -> Result<()> {
+impl PluginSubcommand {
+    pub fn run(self) -> anyhow::Result<()> {
+        match self {
+            PluginSubcommand::Install => install_plugin(),
+            PluginSubcommand::Uninstall => uninstall_plugin(),
+        }
+    }
+}
+
+fn install_plugin() -> anyhow::Result<()> {
     let plugin_snapshot: VfsSnapshot = bincode::deserialize(PLUGIN_BINCODE)
         .expect("Rojo's plugin was not properly packed into Rojo's binary");
 
@@ -49,12 +73,12 @@ pub fn install_plugin() -> Result<()> {
     let tree = session.tree();
     let root_id = tree.get_root_id();
 
-    rbx_binary::encode(tree.inner(), &[root_id], &mut file)?;
+    rbx_binary::to_writer(&mut file, tree.inner(), &[root_id])?;
 
     Ok(())
 }
 
-fn uninstall_plugin() -> Result<()> {
+fn uninstall_plugin() -> anyhow::Result<()> {
     let studio = RobloxStudio::locate()?;
 
     let plugin_path = studio.plugins_path().join(PLUGIN_FILE_NAME);

src/cli/serve.rs

@@ -1,52 +1,73 @@
 use std::{
     io::{self, Write},
-    net::IpAddr,
-    net::Ipv4Addr,
+    net::{IpAddr, Ipv4Addr},
+    path::PathBuf,
     sync::Arc,
 };
 
-use anyhow::Result;
 use memofs::Vfs;
+use structopt::StructOpt;
 use termcolor::{BufferWriter, Color, ColorChoice, ColorSpec, WriteColor};
 
-use crate::{
-    cli::{GlobalOptions, ServeCommand},
-    serve_session::ServeSession,
-    web::LiveServer,
-};
+use crate::{serve_session::ServeSession, web::LiveServer};
+
+use super::{resolve_path, GlobalOptions};
 
 const DEFAULT_BIND_ADDRESS: Ipv4Addr = Ipv4Addr::new(127, 0, 0, 1);
 const DEFAULT_PORT: u16 = 34872;
 
-pub fn serve(global: GlobalOptions, options: ServeCommand) -> Result<()> {
-    let vfs = Vfs::new_default();
+/// Expose a Rojo project to the Rojo Studio plugin.
+#[derive(Debug, StructOpt)]
+pub struct ServeCommand {
+    /// Path to the project to serve. Defaults to the current directory.
+    #[structopt(default_value = "")]
+    pub project: PathBuf,
 
-    let session = Arc::new(ServeSession::new(vfs, &options.absolute_project())?);
+    /// The IP address to listen on. Defaults to `127.0.0.1`.
+    #[structopt(long)]
+    pub address: Option<IpAddr>,
 
-    let ip = options.address.unwrap_or(DEFAULT_BIND_ADDRESS.into());
+    /// The port to listen on. Defaults to the project's preference, or `34872` if
+    /// it has none.
+    #[structopt(long)]
+    pub port: Option<u16>,
+}
 
-    let port = options
-        .port
-        .or_else(|| session.project_port())
-        .unwrap_or(DEFAULT_PORT);
+impl ServeCommand {
+    pub fn run(self, global: GlobalOptions) -> anyhow::Result<()> {
+        let project_path = resolve_path(&self.project);
 
-    let server = LiveServer::new(session);
+        let vfs = Vfs::new_default();
 
-    let _ = show_start_message(ip, port, global.color.into());
-    server.start((ip, port).into());
+        let session = Arc::new(ServeSession::new(vfs, &project_path)?);
 
-    Ok(())
+        let ip = self.address.unwrap_or(DEFAULT_BIND_ADDRESS.into());
+
+        let port = self
+            .port
+            .or_else(|| session.project_port())
+            .unwrap_or(DEFAULT_PORT);
+
+        let server = LiveServer::new(session);
+
+        let _ = show_start_message(ip, port, global.color.into());
+        server.start((ip, port).into());
+
+        Ok(())
+    }
 }
 
 fn show_start_message(bind_address: IpAddr, port: u16, color: ColorChoice) -> io::Result<()> {
+    let mut green = ColorSpec::new();
+    green.set_fg(Some(Color::Green)).set_bold(true);
+
     let writer = BufferWriter::stdout(color);
     let mut buffer = writer.buffer();
 
     writeln!(&mut buffer, "Rojo server listening:")?;
 
     write!(&mut buffer, "  Address: ")?;
-    buffer.set_color(ColorSpec::new().set_fg(Some(Color::Green)).set_bold(true))?;
-
+    buffer.set_color(&green)?;
     if bind_address.is_loopback() {
         writeln!(&mut buffer, "localhost")?;
     } else {
@@ -55,7 +76,7 @@ fn show_start_message(bind_address: IpAddr, port: u16, color: ColorChoice) -> io
 
     buffer.set_color(&ColorSpec::new())?;
     write!(&mut buffer, "  Port:    ")?;
-    buffer.set_color(ColorSpec::new().set_fg(Some(Color::Green)).set_bold(true))?;
+    buffer.set_color(&green)?;
     writeln!(&mut buffer, "{}", port)?;
 
     writeln!(&mut buffer)?;
@@ -63,7 +84,7 @@ fn show_start_message(bind_address: IpAddr, port: u16, color: ColorChoice) -> io
     buffer.set_color(&ColorSpec::new())?;
     write!(&mut buffer, "Visit ")?;
 
-    buffer.set_color(ColorSpec::new().set_fg(Some(Color::Green)).set_bold(true))?;
+    buffer.set_color(&green)?;
     write!(&mut buffer, "http://localhost:{}/", port)?;
 
     buffer.set_color(&ColorSpec::new())?;

src/cli/upload.rs

@@ -1,50 +1,87 @@
+use std::path::PathBuf;
+use std::str::FromStr;
+
+use anyhow::{bail, format_err, Context};
 use memofs::Vfs;
 use reqwest::{
     header::{ACCEPT, CONTENT_TYPE, COOKIE, USER_AGENT},
     StatusCode,
 };
-use thiserror::Error;
+use structopt::StructOpt;
 
-use crate::{auth_cookie::get_auth_cookie, cli::UploadCommand, serve_session::ServeSession};
+use crate::{auth_cookie::get_auth_cookie, serve_session::ServeSession};
 
-#[derive(Debug, Error)]
-enum Error {
-    #[error("Rojo could not find your Roblox auth cookie. Please pass one via --cookie.")]
-    NeedAuthCookie,
+use super::resolve_path;
 
-    #[error("The Roblox API returned an unexpected error: {body}")]
-    RobloxApi { body: String },
+/// Builds the project and uploads it to Roblox.
+#[derive(Debug, StructOpt)]
+pub struct UploadCommand {
+    /// Path to the project to upload. Defaults to the current directory.
+    #[structopt(default_value = "")]
+    pub project: PathBuf,
+
+    /// Authenication cookie to use. If not specified, Rojo will attempt to find one from the system automatically.
+    #[structopt(long)]
+    pub cookie: Option<String>,
+
+    /// Asset ID to upload to.
+    #[structopt(long = "asset_id")]
+    pub asset_id: u64,
 }
 
-pub fn upload(options: UploadCommand) -> Result<(), anyhow::Error> {
-    let cookie = options
-        .cookie
-        .clone()
-        .or_else(get_auth_cookie)
-        .ok_or(Error::NeedAuthCookie)?;
+impl UploadCommand {
+    pub fn run(self) -> Result<(), anyhow::Error> {
+        let project_path = resolve_path(&self.project);
 
-    let vfs = Vfs::new_default();
+        let cookie = self.cookie.or_else(get_auth_cookie).context(
+            "Rojo could not find your Roblox auth cookie. Please pass one via --cookie.",
+        )?;
 
-    let session = ServeSession::new(vfs, &options.absolute_project())?;
+        let vfs = Vfs::new_default();
 
-    let tree = session.tree();
-    let inner_tree = tree.inner();
-    let root_id = inner_tree.get_root_id();
-    let root_instance = inner_tree.get_instance(root_id).unwrap();
+        let session = ServeSession::new(vfs, project_path)?;
 
-    let encode_ids = match root_instance.class_name.as_str() {
-        "DataModel" => root_instance.get_children_ids().to_vec(),
-        _ => vec![root_id],
-    };
+        let tree = session.tree();
+        let inner_tree = tree.inner();
+        let root = inner_tree.root();
 
-    let mut buffer = Vec::new();
+        let encode_ids = match root.class.as_str() {
+            "DataModel" => root.children().to_vec(),
+            _ => vec![root.referent()],
+        };
 
-    log::trace!("Encoding XML model");
-    let config = rbx_xml::EncodeOptions::new()
-        .property_behavior(rbx_xml::EncodePropertyBehavior::WriteUnknown);
+        let mut buffer = Vec::new();
 
-    rbx_xml::to_writer(&mut buffer, tree.inner(), &encode_ids, config)?;
-    do_upload(buffer, options.asset_id, &cookie)
+        log::trace!("Encoding binary model");
+        rbx_binary::to_writer(&mut buffer, tree.inner(), &encode_ids)?;
+        do_upload(buffer, self.asset_id, &cookie)
+    }
+}
+
+/// The kind of asset to upload to the website. Affects what endpoints Rojo uses
+/// and changes how the asset is built.
+#[derive(Debug, Clone, Copy)]
+enum UploadKind {
+    /// Upload to a place.
+    Place,
+
+    /// Upload to a model-like asset, like a Model, Plugin, or Package.
+    Model,
+}
+
+impl FromStr for UploadKind {
+    type Err = anyhow::Error;
+
+    fn from_str(source: &str) -> Result<Self, Self::Err> {
+        match source {
+            "place" => Ok(UploadKind::Place),
+            "model" => Ok(UploadKind::Model),
+            attempted => Err(format_err!(
+                "Invalid upload kind '{}'. Valid kinds are: place, model",
+                attempted
+            )),
+        }
+    }
 }
 
 fn do_upload(buffer: Vec<u8>, asset_id: u64, cookie: &str) -> anyhow::Result<()> {
@@ -80,10 +117,10 @@ fn do_upload(buffer: Vec<u8>, asset_id: u64, cookie: &str) -> anyhow::Result<()>
 
     let status = response.status();
     if !status.is_success() {
-        return Err(Error::RobloxApi {
-            body: response.text()?,
-        }
-        .into());
+        bail!(
+            "The Roblox API returned an unexpected error: {}",
+            response.text()?
+        );
     }
 
     Ok(())

src/lib.rs

@@ -15,6 +15,7 @@ mod message_queue;
 mod multimap;
 mod path_serializer;
 mod project;
+mod resolution;
 mod serve_session;
 mod session_id;
 mod snapshot;

src/lua_ast.rs

@@ -1,4 +1,5 @@
-//! Defines module for defining a small Lua AST for simple codegen.
+//! Defines module for defining a small Lua AST for simple codegen. Rojo uses
+//! this module to convert JSON into generated Lua code.
 
 use std::{
     fmt::{self, Write},

src/main.rs

@@ -3,20 +3,7 @@ use std::{env, panic, process};
 use backtrace::Backtrace;
 use structopt::StructOpt;
 
-use librojo::cli::{self, GlobalOptions, Options, Subcommand};
-
-fn run(global: GlobalOptions, subcommand: Subcommand) -> anyhow::Result<()> {
-    match subcommand {
-        Subcommand::Init(init_options) => cli::init(init_options)?,
-        Subcommand::Serve(serve_options) => cli::serve(global, serve_options)?,
-        Subcommand::Build(build_options) => cli::build(build_options)?,
-        Subcommand::Upload(upload_options) => cli::upload(upload_options)?,
-        Subcommand::Doc => cli::doc()?,
-        Subcommand::Plugin(plugin_options) => cli::plugin(plugin_options)?,
-    }
-
-    Ok(())
-}
+use librojo::cli::Options;
 
 fn main() {
     panic::set_hook(Box::new(|panic_info| {
@@ -81,7 +68,7 @@ fn main() {
         .write_style(options.global.color.into())
         .init();
 
-    if let Err(err) = run(options.global, options.subcommand) {
+    if let Err(err) = options.run() {
         log::error!("{:?}", err);
         process::exit(1);
     }

src/message_queue.rs

@@ -1,26 +1,6 @@
 use std::sync::{Mutex, RwLock};
 
-use futures::sync::oneshot;
-
-struct Listener<T> {
-    sender: oneshot::Sender<(u32, Vec<T>)>,
-    cursor: u32,
-}
-
-fn fire_listener_if_ready<T: Clone>(
-    messages: &[T],
-    listener: Listener<T>,
-) -> Result<(), Listener<T>> {
-    let current_cursor = messages.len() as u32;
-
-    if listener.cursor < current_cursor {
-        let new_messages = messages[(listener.cursor as usize)..].to_vec();
-        let _ = listener.sender.send((current_cursor, new_messages));
-        Ok(())
-    } else {
-        Err(listener)
-    }
-}
+use futures::channel::oneshot;
 
 /// A message queue with persistent history that can be subscribed to.
 ///
@@ -97,3 +77,23 @@ impl<T: Clone> MessageQueue<T> {
         self.messages.read().unwrap().len() as u32
     }
 }
+
+struct Listener<T> {
+    sender: oneshot::Sender<(u32, Vec<T>)>,
+    cursor: u32,
+}
+
+fn fire_listener_if_ready<T: Clone>(
+    messages: &[T],
+    listener: Listener<T>,
+) -> Result<(), Listener<T>> {
+    let current_cursor = messages.len() as u32;
+
+    if listener.cursor < current_cursor {
+        let new_messages = messages[(listener.cursor as usize)..].to_vec();
+        let _ = listener.sender.send((current_cursor, new_messages));
+        Ok(())
+    } else {
+        Err(listener)
+    }
+}

src/project.rs

@@ -4,11 +4,10 @@ use std::{
     path::{Path, PathBuf},
 };
 
-use rbx_dom_weak::UnresolvedRbxValue;
 use serde::{Deserialize, Serialize};
 use thiserror::Error;
 
-use crate::glob::Glob;
+use crate::{glob::Glob, resolution::UnresolvedValue};
 
 static PROJECT_FILENAME: &str = "default.project.json";
 
@@ -58,6 +57,16 @@ pub struct Project {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub serve_place_ids: Option<HashSet<u64>>,
 
+    /// If specified, sets the current place's place ID when connecting to the
+    /// Rojo server from Roblox Studio.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub place_id: Option<u64>,
+
+    /// If specified, sets the current place's game ID when connecting to the
+    /// Rojo server from Roblox Studio.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub game_id: Option<u64>,
+
     /// A list of globs, relative to the folder the project file is in, that
     /// match files that should be excluded if Rojo encounters them.
     #[serde(default, skip_serializing_if = "Vec::is_empty")]
@@ -183,7 +192,7 @@ pub struct ProjectNode {
         default,
         skip_serializing_if = "HashMap::is_empty"
     )]
-    pub properties: HashMap<String, UnresolvedRbxValue>,
+    pub properties: HashMap<String, UnresolvedValue>,
 
     /// Defines the behavior when Rojo encounters unknown instances in Roblox
     /// Studio during live sync. `$ignoreUnknownInstances` should be considered

src/resolution.rs

@@ -0,0 +1,278 @@
+use std::borrow::Borrow;
+
+use anyhow::format_err;
+use rbx_dom_weak::types::{Color3, Content, Enum, Tags, Variant, VariantType, Vector2, Vector3};
+use rbx_reflection::{DataType, PropertyDescriptor};
+use serde::{Deserialize, Serialize};
+
+/// A user-friendly version of `Variant` that supports specifying ambiguous
+/// values. Ambiguous values need a reflection database to be resolved to a
+/// usable value.
+///
+/// This type is used in Rojo projects and JSON models to make specifying the
+/// most common types of properties, like strings or vectors, much easier.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(untagged)]
+pub enum UnresolvedValue {
+    FullyQualified(Variant),
+    Ambiguous(AmbiguousValue),
+}
+
+impl UnresolvedValue {
+    pub fn resolve(self, class_name: &str, prop_name: &str) -> anyhow::Result<Variant> {
+        match self {
+            UnresolvedValue::FullyQualified(full) => Ok(full),
+            UnresolvedValue::Ambiguous(partial) => partial.resolve(class_name, prop_name),
+        }
+    }
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(untagged)]
+pub enum AmbiguousValue {
+    Bool(bool),
+    String(String),
+    StringArray(Vec<String>),
+    Number(f64),
+    Array2([f64; 2]),
+    Array3([f64; 3]),
+    Array4([f64; 4]),
+}
+
+impl AmbiguousValue {
+    pub fn resolve(self, class_name: &str, prop_name: &str) -> anyhow::Result<Variant> {
+        let property = find_descriptor(class_name, prop_name)
+            .ok_or_else(|| format_err!("Unknown property {}.{}", class_name, prop_name))?;
+
+        match &property.data_type {
+            DataType::Enum(enum_name) => {
+                let database = rbx_reflection_database::get();
+
+                let enum_descriptor = database.enums.get(enum_name).ok_or_else(|| {
+                    format_err!("Unknown enum {}. This is a Rojo bug!", enum_name)
+                })?;
+
+                let error = |what: &str| {
+                    let mut all_values = enum_descriptor
+                        .items
+                        .keys()
+                        .map(|value| value.borrow())
+                        .collect::<Vec<_>>();
+                    all_values.sort();
+
+                    let examples = nonexhaustive_list(&all_values);
+
+                    format_err!(
+                        "Invalid value for property {}.{}. Got {} but \
+                         expected a member of the {} enum such as {}",
+                        class_name,
+                        prop_name,
+                        what,
+                        enum_name,
+                        examples,
+                    )
+                };
+
+                let value = match self {
+                    AmbiguousValue::String(value) => value,
+                    unresolved => return Err(error(unresolved.describe())),
+                };
+
+                let resolved = enum_descriptor
+                    .items
+                    .get(value.as_str())
+                    .ok_or_else(|| error(value.as_str()))?;
+
+                Ok(Enum::from_u32(*resolved).into())
+            }
+            DataType::Value(variant_ty) => match (variant_ty, self) {
+                (VariantType::Bool, AmbiguousValue::Bool(value)) => Ok(value.into()),
+
+                (VariantType::Float32, AmbiguousValue::Number(value)) => Ok((value as f32).into()),
+                (VariantType::Float64, AmbiguousValue::Number(value)) => Ok(value.into()),
+                (VariantType::Int32, AmbiguousValue::Number(value)) => Ok((value as i32).into()),
+                (VariantType::Int64, AmbiguousValue::Number(value)) => Ok((value as i64).into()),
+
+                (VariantType::String, AmbiguousValue::String(value)) => Ok(value.into()),
+                (VariantType::Tags, AmbiguousValue::StringArray(value)) => {
+                    Ok(Tags::from(value).into())
+                }
+                (VariantType::Content, AmbiguousValue::String(value)) => {
+                    Ok(Content::from(value).into())
+                }
+
+                (VariantType::Vector2, AmbiguousValue::Array2(value)) => {
+                    Ok(Vector2::new(value[0] as f32, value[1] as f32).into())
+                }
+
+                (VariantType::Vector3, AmbiguousValue::Array3(value)) => {
+                    Ok(Vector3::new(value[0] as f32, value[1] as f32, value[2] as f32).into())
+                }
+
+                (VariantType::Color3, AmbiguousValue::Array3(value)) => {
+                    Ok(Color3::new(value[0] as f32, value[1] as f32, value[2] as f32).into())
+                }
+
+                (_, unresolved) => Err(format_err!(
+                    "Wrong type of value for property {}.{}. Expected {:?}, got {}",
+                    class_name,
+                    prop_name,
+                    variant_ty,
+                    unresolved.describe(),
+                )),
+            },
+            _ => Err(format_err!(
+                "Unknown data type for property {}.{}",
+                class_name,
+                prop_name
+            )),
+        }
+    }
+
+    fn describe(&self) -> &'static str {
+        match self {
+            AmbiguousValue::Bool(_) => "a bool",
+            AmbiguousValue::String(_) => "a string",
+            AmbiguousValue::StringArray(_) => "an array of strings",
+            AmbiguousValue::Number(_) => "a number",
+            AmbiguousValue::Array2(_) => "an array of two numbers",
+            AmbiguousValue::Array3(_) => "an array of three numbers",
+            AmbiguousValue::Array4(_) => "an array of four numbers",
+        }
+    }
+}
+
+fn find_descriptor(
+    class_name: &str,
+    prop_name: &str,
+) -> Option<&'static PropertyDescriptor<'static>> {
+    let database = rbx_reflection_database::get();
+    let mut current_class_name = class_name;
+
+    loop {
+        let class = database.classes.get(current_class_name)?;
+        if let Some(descriptor) = class.properties.get(prop_name) {
+            return Some(descriptor);
+        }
+
+        current_class_name = class.superclass.as_deref()?;
+    }
+}
+
+/// Outputs a string containing up to MAX_ITEMS entries from the given list. If
+/// there are more than MAX_ITEMS items, the number of remaining items will be
+/// listed.
+fn nonexhaustive_list(values: &[&str]) -> String {
+    use std::fmt::Write;
+
+    const MAX_ITEMS: usize = 8;
+
+    let mut output = String::new();
+
+    let last_index = values.len() - 1;
+    let main_length = last_index.min(9);
+
+    let main_list = &values[..main_length];
+    for value in main_list {
+        output.push_str(value);
+        output.push_str(", ");
+    }
+
+    if values.len() > MAX_ITEMS {
+        write!(output, "or {} more", values.len() - main_length).unwrap();
+    } else {
+        output.push_str("or ");
+        output.push_str(values[values.len() - 1]);
+    }
+
+    output
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    fn resolve(class: &str, prop: &str, json_value: &str) -> Variant {
+        let unresolved: UnresolvedValue = serde_json::from_str(json_value).unwrap();
+        unresolved.resolve(class, prop).unwrap()
+    }
+
+    #[test]
+    fn bools() {
+        assert_eq!(resolve("BoolValue", "Value", "false"), Variant::Bool(false));
+
+        // Script.Disabled is inherited from BaseScript
+        assert_eq!(resolve("Script", "Disabled", "true"), Variant::Bool(true));
+    }
+
+    #[test]
+    fn strings() {
+        // String literals can stay as strings
+        assert_eq!(
+            resolve("StringValue", "Value", "\"Hello!\""),
+            Variant::String("Hello!".into()),
+        );
+
+        // String literals can also turn into Content
+        assert_eq!(
+            resolve("Sky", "MoonTextureId", "\"rbxassetid://12345\""),
+            Variant::Content("rbxassetid://12345".into()),
+        );
+
+        // What about BinaryString values? For forward-compatibility reasons, we
+        // don't support any shorthands for BinaryString.
+        //
+        // assert_eq!(
+        //     resolve("Folder", "Tags", "\"a\\u0000b\\u0000c\""),
+        //     Variant::BinaryString(b"a\0b\0c".to_vec().into()),
+        // );
+    }
+
+    #[test]
+    fn numbers() {
+        assert_eq!(
+            resolve("Part", "CollisionGroupId", "123"),
+            Variant::Int32(123),
+        );
+
+        assert_eq!(
+            resolve("Folder", "SourceAssetId", "532413"),
+            Variant::Int64(532413),
+        );
+
+        assert_eq!(resolve("Part", "Transparency", "1"), Variant::Float32(1.0));
+        assert_eq!(resolve("NumberValue", "Value", "1"), Variant::Float64(1.0));
+    }
+
+    #[test]
+    fn vectors() {
+        assert_eq!(
+            resolve("ParticleEmitter", "SpreadAngle", "[1, 2]"),
+            Variant::Vector2(Vector2::new(1.0, 2.0)),
+        );
+
+        assert_eq!(
+            resolve("Part", "Position", "[4, 5, 6]"),
+            Variant::Vector3(Vector3::new(4.0, 5.0, 6.0)),
+        );
+    }
+
+    #[test]
+    fn colors() {
+        assert_eq!(
+            resolve("Part", "Color", "[1, 1, 1]"),
+            Variant::Color3(Color3::new(1.0, 1.0, 1.0)),
+        );
+
+        // There aren't any user-facing Color3uint8 properties. If there are
+        // some, we should treat them the same in the future.
+    }
+
+    #[test]
+    fn enums() {
+        assert_eq!(
+            resolve("Lighting", "Technology", "\"Voxel\""),
+            Variant::Enum(Enum::from_u32(1)),
+        );
+    }
+}

src/serve_session.rs

@@ -10,7 +10,6 @@ use std::{
 use crossbeam_channel::Sender;
 use memofs::IoResultExt;
 use memofs::Vfs;
-use rbx_dom_weak::RbxInstanceProperties;
 use thiserror::Error;
 
 use crate::{
@@ -19,13 +18,15 @@ use crate::{
     project::{Project, ProjectError},
     session_id::SessionId,
     snapshot::{
-        apply_patch_set, compute_patch_set, AppliedPatchSet, InstanceContext,
-        InstancePropertiesWithMeta, PatchSet, RojoTree,
+        apply_patch_set, compute_patch_set, AppliedPatchSet, InstanceContext, InstanceSnapshot,
+        PatchSet, RojoTree,
     },
     snapshot_middleware::snapshot_from_vfs,
 };
 
-/// Contains all of the state for a Rojo serve session.
+/// Contains all of the state for a Rojo serve session. A serve session is used
+/// when we need to build a Rojo tree and possibly rebuild it when input files
+/// change.
 ///
 /// Nothing here is specific to any Rojo interface. Though the primary way to
 /// interact with a serve session is Rojo's HTTP right now, there's no reason
@@ -118,14 +119,7 @@ impl ServeSession {
             }
         };
 
-        let mut tree = RojoTree::new(InstancePropertiesWithMeta {
-            properties: RbxInstanceProperties {
-                name: "ROOT".to_owned(),
-                class_name: "Folder".to_owned(),
-                properties: Default::default(),
-            },
-            metadata: Default::default(),
-        });
+        let mut tree = RojoTree::new(InstanceSnapshot::new());
 
         let root_id = tree.get_root_id();
 
@@ -203,6 +197,14 @@ impl ServeSession {
         self.root_project.serve_port
     }
 
+    pub fn place_id(&self) -> Option<u64> {
+        self.root_project.place_id
+    }
+
+    pub fn game_id(&self) -> Option<u64> {
+        self.root_project.game_id
+    }
+
     pub fn start_time(&self) -> Instant {
         self.start_time
     }