Release 0.4.9

This functionality won't be present until the refactor in 0.5.0

CHANGES.md

@@ -1,7 +1,26 @@
 # Rojo Change Log
 
-## Current Master
-*No changes*
+## Current master
+* *No changes*
+
+## 0.4.9 (May 26, 2018)
+* Fixed warning when renaming or removing files that would sometimes corrupt the instance cache ([#72](https://github.com/LPGhatguy/rojo/pull/72))
+* JSON models are no longer as strict -- `Children` and `Properties` are now optional.
+
+## 0.4.8 (May 26, 2018)
+* Hotfix to prevent errors from being thrown when objects managed by Rojo are deleted
+
+## 0.4.7 (May 25, 2018)
+* Added icons to the Rojo plugin, made by [@Vorlias](https://github.com/Vorlias)! ([#70](https://github.com/LPGhatguy/rojo/pull/70))
+* Server will now issue a warning if no partitions are specified in `rojo serve` ([#40](https://github.com/LPGhatguy/rojo/issues/40))
+
+## 0.4.6 (May 21, 2018)
+* Rojo handles being restarted by Roblox Studio more gracefully ([#67](https://github.com/LPGhatguy/rojo/issues/67))
+* Folders should no longer get collapsed when syncing occurs.
+* **Significant** robustness improvements with regards to caching.
+    * **This should catch all existing script duplication bugs.**
+    * If there are any bugs with script duplication or caching in the future, restarting the Rojo server process will fix them for that session.
+* Fixed message in plugin not being prefixed with `Rojo: `.
 
 ## 0.4.5 (May 1, 2018)
 * Rojo messages are now prefixed with `Rojo: ` to make them stand out in the output more.
@@ -17,11 +36,11 @@
 ## 0.4.3 (April 7, 2018)
 * Plugin now automatically selects `HttpService` if it determines that HTTP isn't enabled ([#58](https://github.com/LPGhatguy/rojo/pull/58))
 * Plugin now has much more robust handling and will wipe all state when the server changes.
-	* This should fix issues that would otherwise be solved by restarting Roblox Studio.
+    * This should fix issues that would otherwise be solved by restarting Roblox Studio.
 
 ## 0.4.2 (April 4, 2018)
 * Fixed final case of duplicated instance insertion, caused by reconciled instances not being inserted into `RouteMap`.
-	* The reconciler is still not a perfect solution, especially if script instances get moved around without being destroyed. I don't think this can be fixed before a big refactor.
+    * The reconciler is still not a perfect solution, especially if script instances get moved around without being destroyed. I don't think this can be fixed before a big refactor.
 
 ## 0.4.1 (April 1, 2018)
 * Merged plugin repository into main Rojo repository for easier tracking.
@@ -29,9 +48,9 @@
 
 ## 0.4.0 (March 27, 2018)
 * Protocol version 1, which shifts more responsibility onto the server
-	* This is a **major breaking** change!
-	* The server now has a content of 'filter plugins', which transform data at various stages in the pipeline
-	* The server now exposes Roblox instance objects instead of file contents, which lines up with how `rojo pack` will work, and paves the way for more robust syncing.
+    * This is a **major breaking** change!
+    * The server now has a content of 'filter plugins', which transform data at various stages in the pipeline
+    * The server now exposes Roblox instance objects instead of file contents, which lines up with how `rojo pack` will work, and paves the way for more robust syncing.
 * Added `*.model.json` files, which let you embed small Roblox objects into your Rojo tree.
 * Improved error messages in some cases ([#46](https://github.com/LPGhatguy/rojo/issues/46))
 
@@ -41,18 +60,18 @@
 
 ## 0.3.1 (December 14, 2017)
 * Improved error reporting when invalid JSON is found in a `rojo.json` project
-	* These messages are passed on from Serde
+    * These messages are passed on from Serde
 
 ## 0.3.0 (December 12, 2017)
 * Factored out the plugin into a separate repository
 * Fixed server when using a file as a partition
-	* Previously, trailing slashes were put on the end of a partition even if the read request was an empty string. This broke file reading on Windows when a partition pointed to a file instead of a directory!
+    * Previously, trailing slashes were put on the end of a partition even if the read request was an empty string. This broke file reading on Windows when a partition pointed to a file instead of a directory!
 * Started running automatic tests on Travis CI (#9)
 
 ## 0.2.3 (December 4, 2017)
 * Plugin only release
 * Tightened `init` file rules to only match script files
-	* Previously, Rojo would sometimes pick up the wrong file when syncing
+    * Previously, Rojo would sometimes pick up the wrong file when syncing
 
 ## 0.2.2 (December 1, 2017)
 * Plugin only release

README.md

@@ -8,7 +8,7 @@
     <a href="https://travis-ci.org/LPGhatguy/rojo">
         <img src="https://api.travis-ci.org/LPGhatguy/rojo.svg?branch=master" alt="Travis-CI Build Status" />
     </a>
-    <img src="https://img.shields.io/badge/latest_version-0.4.5-brightgreen.svg" alt="Current server version" />
+    <img src="https://img.shields.io/badge/latest_version-0.4.9-brightgreen.svg" alt="Current server version" />
     <a href="https://lpghatguy.github.io/rojo">
         <img src="https://img.shields.io/badge/documentation-website-brightgreen.svg" alt="Rojo Documentation" />
     </a>

docs/sync-details.md

@@ -26,13 +26,16 @@ Will turn into these instances in Roblox:
 ![Example of Roblox instances](/images/sync-example.png)
 
 ## Models
-Rojo supports a JSON model format for representing simple models. It's designed for instance types like `BindableEvent` or `*Value` objects, and is not suitable for larger models.
+Rojo supports a JSON model format for representing simple models. It's designed for instance types like `BindableEvent` or `Value` objects, and is not suitable for larger models.
+
+Rojo JSON models are stored in `.model.json` files.
 
 !!! info
     In the future, Rojo will support `.rbxmx` models. See [issue #7](https://github.com/LPGhatguy/rojo/issues/7) for more details and updates on this feature.
 
-JSON model files are strict, with every property being required. They look like this:
+JSON model files are fairly strict; any syntax errors will cause the model to fail to sync! They look like this:
 
+`hello.model.json`
 ```json
 {
     "Name": "hello",
@@ -40,14 +43,11 @@ JSON model files are strict, with every property being required. They look like
     "Children": [
         {
             "Name": "Some Part",
-            "ClassName": "Part",
-            "Children": [],
-            "Properties": {}
+            "ClassName": "Part"
         },
         {
             "Name": "Some StringValue",
             "ClassName": "StringValue",
-            "Children": [],
             "Properties": {
                 "Value": {
                     "Type": "String",
@@ -55,7 +55,6 @@ JSON model files are strict, with every property being required. They look like
                 }
             }
         }
-    ],
-    "Properties": {}
+    ]
 }
 ```

plugin/src/Config.lua

@@ -1,7 +1,12 @@
 return {
 	pollingRate = 0.2,
-	version = {0, 4, 5},
+	version = {0, 4, 9},
 	expectedServerVersionString = "0.4.x",
 	protocolVersion = 1,
+	icons = {
+		syncIn = "rbxassetid://1820320573",
+		togglePolling = "rbxassetid://1820320064",
+		testConnection = "rbxassetid://1820320989",
+	},
 	dev = false,
 }

plugin/src/Main.server.lua

@@ -45,7 +45,7 @@ local function main()
 
 	local toolbar = plugin:CreateToolbar("Rojo Plugin " .. displayedVersion)
 
-	toolbar:CreateButton("Test Connection", "Connect to Rojo Server", "")
+	toolbar:CreateButton("Test Connection", "Connect to Rojo Server", Config.icons.testConnection)
 		.Click:Connect(function()
 			checkUpgrade()
 
@@ -55,7 +55,7 @@ local function main()
 				end)
 		end)
 
-	toolbar:CreateButton("Sync In", "Sync into Roblox Studio", "")
+	toolbar:CreateButton("Sync In", "Sync into Roblox Studio", Config.icons.syncIn)
 		.Click:Connect(function()
 			checkUpgrade()
 
@@ -65,7 +65,7 @@ local function main()
 				end)
 		end)
 
-	toolbar:CreateButton("Toggle Polling", "Poll server for changes", "")
+	toolbar:CreateButton("Toggle Polling", "Poll server for changes", Config.icons.togglePolling)
 		.Click:Connect(function()
 			checkUpgrade()
 

plugin/src/Plugin.lua

@@ -1,9 +1,12 @@
+local CoreGui = game:GetService("CoreGui")
+
 local Promise = require(script.Parent.Parent.modules.Promise)
 
 local Config = require(script.Parent.Config)
 local Http = require(script.Parent.Http)
 local Api = require(script.Parent.Api)
 local Reconciler = require(script.Parent.Reconciler)
+local Version = require(script.Parent.Version)
 
 local function collectMatch(source, pattern)
 	local result = {}
@@ -35,9 +38,23 @@ function Plugin.new()
 	setmetatable(self, Plugin)
 
 	do
+		local uiName = ("Rojo %s UI"):format(Version.display(Config.version))
+
+		if Config.dev then
+			uiName = "Rojo Dev UI"
+		end
+
+		-- If there's an existing Rojo UI, like from a Roblox plugin upgrade
+		-- that wasn't Rojo, make sure we clean it up.
+		local existingUi = CoreGui:FindFirstChild(uiName)
+
+		if existingUi ~= nil then
+			existingUi:Destroy()
+		end
+
 		local screenGui = Instance.new("ScreenGui")
-		screenGui.Name = "Rojo UI"
-		screenGui.Parent = game.CoreGui
+		screenGui.Name = uiName
+		screenGui.Parent = CoreGui
 		screenGui.DisplayOrder = -1
 		screenGui.Enabled = false
 
@@ -54,6 +71,18 @@ function Plugin.new()
 		label.Parent = screenGui
 
 		self._label = screenGui
+
+		-- If our UI was destroyed, we assume it was from another instance of
+		-- the Rojo plugin coming online.
+		--
+		-- Roblox doesn't notify plugins when they get unloaded, so this is the
+		-- best trigger we have right now unless we create a dedicated event
+		-- object.
+		screenGui.AncestryChanged:Connect(function(_, parent)
+			if parent == nil then
+				self:restart()
+			end
+		end)
 	end
 
 	return self
@@ -66,7 +95,11 @@ end
 function Plugin:restart()
 	warn("Rojo: The server has changed since the last request, reloading plugin...")
 
-	self._reconciler:clear()
+	self:stopPolling()
+
+	self._reconciler:destruct()
+	self._reconciler = Reconciler.new()
+
 	self._api = nil
 	self._polling = false
 	self._syncInProgress = false
@@ -122,7 +155,7 @@ function Plugin:stopPolling()
 		return Promise.resolve(false)
 	end
 
-	print("Rojo Stopped polling server for changes.")
+	print("Rojo: Stopped polling server for changes.")
 
 	self._polling = false
 	self._label.Enabled = false

plugin/src/Reconciler.lua

@@ -1,15 +1,32 @@
 local RouteMap = require(script.Parent.RouteMap)
 
-local function classEqual(rbx, className)
-	if className == "*" then
+local function classEqual(a, b)
+	if a == "*" or b == "*" then
 		return true
 	end
 
-	return rbx.ClassName == className
+	return a == b
 end
 
+local function applyProperties(target, properties)
+	for key, property in pairs(properties) do
+		-- TODO: Transform property value based on property.Type
+		-- Right now, we assume that 'value' is primitive!
+		target[key] = property.Value
+	end
+end
+
+--[[
+	Attempt to parent `rbx` to `parent`, doing nothing if:
+	* parent is already `parent`
+	* Changing parent threw an error
+]]
 local function reparent(rbx, parent)
 	if rbx then
+		if rbx.Parent == parent then
+			return
+		end
+
 		-- It's possible that 'rbx' is a service or some other object that we
 		-- can't change the parent of. That's the only reason why Parent would
 		-- fail except for rbx being previously destroyed!
@@ -38,7 +55,7 @@ local function findNextChildPair(primaryChildren, secondaryChildren, visited)
 			visited[primaryChild] = true
 
 			for _, secondaryChild in ipairs(secondaryChildren) do
-				if primaryChild.ClassName == secondaryChild.ClassName and primaryChild.Name == secondaryChild.Name then
+				if classEqual(primaryChild.ClassName, secondaryChild.ClassName) and primaryChild.Name == secondaryChild.Name then
 					visited[secondaryChild] = true
 
 					return primaryChild, secondaryChild
@@ -110,12 +127,11 @@ function Reconciler:_reify(item)
 	local rbx = Instance.new(className)
 	rbx.Name = item.Name
 
-	for key, property in pairs(item.Properties) do
-		-- TODO: Check for compound types, like Vector3!
-		rbx[key] = property.Value
-	end
+	applyProperties(rbx, item.Properties)
 
-	self:_reconcileChildren(rbx, item)
+	for _, child in ipairs(item.Children) do
+		reparent(self:_reify(child), rbx)
+	end
 
 	if item.Route then
 		self._routeMap:insert(item.Route, rbx)
@@ -125,10 +141,10 @@ function Reconciler:_reify(item)
 end
 
 --[[
-	Clears any state that the Reconciler has, effectively restarting it.
+	Clears any state that the Reconciler has, stopping it completely.
 ]]
-function Reconciler:clear()
-	self._routeMap:clear()
+function Reconciler:destruct()
+	self._routeMap:destruct()
 end
 
 --[[
@@ -139,6 +155,7 @@ function Reconciler:reconcile(rbx, item)
 	-- Item was deleted
 	if not item then
 		if rbx then
+			self._routeMap:removeByRbx(rbx)
 			rbx:Destroy()
 		end
 
@@ -151,27 +168,16 @@ function Reconciler:reconcile(rbx, item)
 	end
 
 	-- Item changed type!
-	if not classEqual(rbx, item.ClassName) then
+	if not classEqual(rbx.ClassName, item.ClassName) then
+		self._routeMap:removeByRbx(rbx)
 		rbx:Destroy()
 
-		rbx = self:_reify(item)
+		return self:_reify(item)
 	end
 
-	-- Apply all properties, Roblox will de-duplicate changes
-	for key, property in pairs(item.Properties) do
-		-- TODO: Transform property value based on property.Type
-		-- Right now, we assume that 'value' is primitive!
-
-		rbx[key] = property.Value
-	end
-
-	-- Use a dumb algorithm for reconciling children
+	applyProperties(rbx, item.Properties)
 	self:_reconcileChildren(rbx, item)
 
-	if item.Route then
-		self._routeMap:insert(item.Route, rbx)
-	end
-
 	return rbx
 end
 

plugin/src/RouteMap.lua

@@ -25,6 +25,10 @@ end
 function RouteMap:insert(route, rbx)
 	local hashed = hashRoute(route)
 
+	-- Make sure that each route and instance are only present in RouteMap once.
+	self:removeByRoute(route)
+	self:removeByRbx(rbx)
+
 	self._map[hashed] = rbx
 	self._reverseMap[rbx] = hashed
 	self._connectionsByRbx[rbx] = rbx.AncestryChanged:Connect(function(_, parent)
@@ -42,24 +46,36 @@ function RouteMap:removeByRoute(route)
 	local hashedRoute = hashRoute(route)
 	local rbx = self._map[hashedRoute]
 
-	if rbx then
-		self._map[hashedRoute] = nil
-		self._reverseMap[rbx] = nil
-		self._connectionsByRbx[rbx] = nil
+	if rbx ~= nil then
+		self:_removeInternal(rbx, hashedRoute)
 	end
 end
 
 function RouteMap:removeByRbx(rbx)
 	local hashedRoute = self._reverseMap[rbx]
 
-	if hashedRoute then
-		self._map[hashedRoute] = nil
-		self._reverseMap[rbx] = nil
-		self._connectionsByRbx[rbx] = nil
+	if hashedRoute ~= nil then
+		self:_removeInternal(rbx, hashedRoute)
 	end
 end
 
-function RouteMap:removeRbxDescendants(parentRbx)
+--[[
+	Correcly removes the given Roblox Instance/Route pair from the RouteMap.
+]]
+function RouteMap:_removeInternal(rbx, hashedRoute)
+	self._map[hashedRoute] = nil
+	self._reverseMap[rbx] = nil
+	self._connectionsByRbx[rbx]:Disconnect()
+	self._connectionsByRbx[rbx] = nil
+
+	self:_removeRbxDescendants(rbx)
+end
+
+--[[
+	Ensure that there are no descendants of the given Roblox Instance still
+	present in the map, guaranteeing that it has been cleaned out.
+]]
+function RouteMap:_removeRbxDescendants(parentRbx)
 	for rbx in pairs(self._reverseMap) do
 		if rbx:IsDescendantOf(parentRbx) then
 			self:removeByRbx(rbx)
@@ -67,7 +83,11 @@ function RouteMap:removeRbxDescendants(parentRbx)
 	end
 end
 
-function RouteMap:clear()
+--[[
+	Remove all items from the map and disconnect all connections, cleaning up
+	the RouteMap.
+]]
+function RouteMap:destruct()
 	self._map = {}
 	self._reverseMap = {}
 

server/Cargo.lock

@@ -636,7 +636,7 @@ dependencies = [
 
 [[package]]
 name = "rojo"
-version = "0.4.5"
+version = "0.4.9"
 dependencies = [
  "clap 2.31.2 (registry+https://github.com/rust-lang/crates.io-index)",
  "lazy_static 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)",

server/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rojo"
-version = "0.4.5"
+version = "0.4.9"
 authors = ["Lucien Greathouse <me@lpghatguy.com>"]
 description = "A tool to create robust Roblox projects"
 license = "MIT"

server/src/commands/serve.rs

@@ -44,6 +44,13 @@ pub fn serve(project_path: &PathBuf, verbose: bool, port: Option<u64>) {
         },
     };
 
+    if project.partitions.len() == 0 {
+        println!("");
+        println!("This project has no partitions and will not do anything when served!");
+        println!("This is usually a mistake -- edit rojo.json!");
+        println!("");
+    }
+
     lazy_static! {
         static ref PLUGIN_CHAIN: PluginChain = PluginChain::new(vec![
             Box::new(ScriptPlugin::new()),

server/src/plugin.rs

@@ -9,13 +9,6 @@ pub enum TransformFileResult {
     // TODO: Error case
 }
 
-pub enum RbxChangeResult {
-    Write(Option<VfsItem>),
-    Pass,
-
-    // TODO: Error case
-}
-
 pub enum FileChangeResult {
     MarkChanged(Option<Vec<Route>>),
     Pass,
@@ -26,10 +19,6 @@ pub trait Plugin {
     /// into a Roblox instance.
     fn transform_file(&self, plugins: &PluginChain, vfs_item: &VfsItem) -> TransformFileResult;
 
-    /// Invoked when a Roblox Instance change is reported by the Roblox Studio
-    /// plugin and needs to be turned into a file to save.
-    fn handle_rbx_change(&self, route: &Route, rbx_item: &RbxInstance) -> RbxChangeResult;
-
     /// Invoked when a file changes on the filesystem. The result defines what
     /// routes are marked as needing to be refreshed.
     fn handle_file_change(&self, route: &Route) -> FileChangeResult;
@@ -58,17 +47,6 @@ impl PluginChain {
         None
     }
 
-    pub fn handle_rbx_change(&self, route: &Route, rbx_item: &RbxInstance) -> Option<VfsItem> {
-        for plugin in &self.plugins {
-            match plugin.handle_rbx_change(route, rbx_item) {
-                RbxChangeResult::Write(vfs_item) => return vfs_item,
-                RbxChangeResult::Pass => {},
-            }
-        }
-
-        None
-    }
-
     pub fn handle_file_change(&self, route: &Route) -> Option<Vec<Route>> {
         for plugin in &self.plugins {
             match plugin.handle_file_change(route) {

server/src/plugins/default_plugin.rs

@@ -1,7 +1,7 @@
 use std::collections::HashMap;
 
 use core::Route;
-use plugin::{Plugin, PluginChain, TransformFileResult, RbxChangeResult, FileChangeResult};
+use plugin::{Plugin, PluginChain, TransformFileResult, FileChangeResult};
 use rbx::{RbxInstance, RbxValue};
 use vfs::VfsItem;
 
@@ -60,8 +60,4 @@ impl Plugin for DefaultPlugin {
     fn handle_file_change(&self, route: &Route) -> FileChangeResult {
         FileChangeResult::MarkChanged(Some(vec![route.clone()]))
     }
-
-    fn handle_rbx_change(&self, _route: &Route, _rbx_item: &RbxInstance) -> RbxChangeResult {
-        RbxChangeResult::Pass
-    }
 }

server/src/plugins/json_model_plugin.rs

@@ -2,7 +2,7 @@ use regex::Regex;
 use serde_json;
 
 use core::Route;
-use plugin::{Plugin, PluginChain, TransformFileResult, RbxChangeResult, FileChangeResult};
+use plugin::{Plugin, PluginChain, TransformFileResult, FileChangeResult};
 use rbx::RbxInstance;
 use vfs::VfsItem;
 
@@ -48,8 +48,4 @@ impl Plugin for JsonModelPlugin {
     fn handle_file_change(&self, _route: &Route) -> FileChangeResult {
         FileChangeResult::Pass
     }
-
-    fn handle_rbx_change(&self, _route: &Route, _rbx_item: &RbxInstance) -> RbxChangeResult {
-        RbxChangeResult::Pass
-    }
 }

server/src/plugins/script_plugin.rs

@@ -3,7 +3,7 @@ use std::collections::HashMap;
 use regex::Regex;
 
 use core::Route;
-use plugin::{Plugin, PluginChain, TransformFileResult, RbxChangeResult, FileChangeResult};
+use plugin::{Plugin, PluginChain, TransformFileResult, FileChangeResult};
 use rbx::{RbxInstance, RbxValue};
 use vfs::VfsItem;
 
@@ -117,8 +117,4 @@ impl Plugin for ScriptPlugin {
             FileChangeResult::Pass
         }
     }
-
-    fn handle_rbx_change(&self, _route: &Route, _rbx_item: &RbxInstance) -> RbxChangeResult {
-        RbxChangeResult::Pass
-    }
 }

server/src/rbx.rs

@@ -6,7 +6,11 @@ use std::collections::HashMap;
 pub struct RbxInstance {
     pub name: String,
     pub class_name: String,
+
+    #[serde(default = "Vec::new")]
     pub children: Vec<RbxInstance>,
+
+    #[serde(default = "HashMap::new")]
     pub properties: HashMap<String, RbxValue>,
 
     /// The route that this instance was generated from, if there was one.

test-project/src/a/b.lua

@@ -0,0 +1 @@
+print("HEY!")

test-project/src/hello.model.json

@@ -4,14 +4,11 @@
   "Children": [
     {
       "Name": "Some Part",
-      "ClassName": "Part",
-      "Children": [],
-      "Properties": {}
+      "ClassName": "Part"
     },
     {
       "Name": "Some StringValue",
       "ClassName": "StringValue",
-      "Children": [],
       "Properties": {
         "Value": {
           "Type": "String",
@@ -19,6 +16,5 @@
         }
       }
     }
-  ],
-  "Properties": {}
+  ]
 }