hakowork/rojo
3
0
Fork 0
mirror of https://github.com/rojo-rbx/rojo.git synced 2026-10-23 14:01:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Enhance script handling and UI consistency

Browse source 
- Added support for encoding the RunContext property in the Script class to determine file suffixes (.server.luau, .client.luau, .plugin.luau, .legacy.luau).
- Updated the Confirming.lua file to improve UI consistency in the confirmation message display.
- Modified snapshot middleware and syncback logic to accommodate new file extensions and ensure proper handling of plugin scripts.
- Refactored tests to align with the new naming conventions for script suffixes and improved path uniqueness checks.
This commit is contained in:
Joe 2026-01-30 10:31:36 -06:00
parent 38cbc582f4
commit 18a74c8e4d
7 changed files with 95 additions and 87 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/snapshot_middleware/mod.rs
View file

@ -96,7 +96,7 @@ pub fn snapshot_from_vfs(
match file_name {
// Modern extensions
"init.server.luau" | "init.client.luau" | "init.local.luau" | "init.legacy.luau"
| "init.luau" | "init.csv" |
| "init.plugin.luau" | "init.luau" | "init.csv" |
// Legacy extensions (for backwards compatibility)
"init.server.lua" | "init.client.lua" | "init.lua" => return Ok(None),
_ => {}
@ -129,6 +129,7 @@ fn get_dir_middleware<'path>(
(Middleware::ModuleScriptDir, "init.luau"),
(Middleware::ServerScriptDir, "init.server.luau"),
(Middleware::ClientScriptDir, "init.client.luau"),
(Middleware::PluginScriptDir, "init.plugin.luau"),
(Middleware::LocalScriptDir, "init.local.luau"),
(Middleware::LegacyScriptDir, "init.legacy.luau"),
(Middleware::CsvDir, "init.csv"),
@ -222,6 +223,8 @@ pub enum Middleware {
#[serde(skip_deserializing)]
ModuleScriptDir,
#[serde(skip_deserializing)]
PluginScriptDir,
#[serde(skip_deserializing)]
LocalScriptDir,
#[serde(skip_deserializing)]
LegacyScriptDir,
@ -267,6 +270,9 @@ impl Middleware {
Self::ModuleScriptDir => {
snapshot_lua_init(context, vfs, path, name, ScriptType::Module)
}
Self::PluginScriptDir => {
snapshot_lua_init(context, vfs, path, name, ScriptType::Plugin)
}
Self::LocalScriptDir => snapshot_lua_init(context, vfs, path, name, ScriptType::Local),
Self::LegacyScriptDir => {
snapshot_lua_init(context, vfs, path, name, ScriptType::Legacy)
@ -316,6 +322,7 @@ impl Middleware {
Middleware::ModuleScriptDir => syncback_lua_init(ScriptType::Module, snapshot),
Middleware::LocalScriptDir => syncback_lua_init(ScriptType::Local, snapshot),
Middleware::LegacyScriptDir => syncback_lua_init(ScriptType::Legacy, snapshot),
Middleware::PluginScriptDir => syncback_lua_init(ScriptType::Plugin, snapshot),
Middleware::CsvDir => syncback_csv_init(snapshot),
}
}
@ -329,6 +336,7 @@ impl Middleware {
| Middleware::ServerScriptDir
| Middleware::ClientScriptDir
| Middleware::ModuleScriptDir
| Middleware::PluginScriptDir
| Middleware::LocalScriptDir
| Middleware::LegacyScriptDir
| Middleware::CsvDir

2
src/syncback/file_names.rs
View file

@ -39,6 +39,7 @@ pub fn name_for_inst<'old>(
| Middleware::ServerScriptDir
| Middleware::ClientScriptDir
| Middleware::ModuleScriptDir
| Middleware::PluginScriptDir
| Middleware::LocalScriptDir
| Middleware::LegacyScriptDir => {
let name = if encode_invalid_chars {
@ -110,6 +111,7 @@ pub fn extension_for_middleware(middleware: Middleware) -> &'static str {
| Middleware::ServerScriptDir
| Middleware::ClientScriptDir
| Middleware::ModuleScriptDir
| Middleware::PluginScriptDir
| Middleware::LocalScriptDir
| Middleware::LegacyScriptDir => {
unimplemented!("directory middleware requires special treatment")

2
src/syncback/mod.rs
View file

@ -383,7 +383,7 @@ pub fn get_best_middleware(snapshot: &SyncbackSnapshot) -> Middleware {
Middleware::ServerScript => Middleware::ServerScriptDir,
Middleware::ClientScript => Middleware::ClientScriptDir,
Middleware::ModuleScript => Middleware::ModuleScriptDir,
Middleware::PluginScript => Middleware::ServerScriptDir, // Plugin scripts with children use server script dir for now
Middleware::PluginScript => Middleware::PluginScriptDir,
Middleware::LegacyScript => Middleware::LegacyScriptDir,
Middleware::LocalScript => Middleware::LocalScriptDir,
Middleware::Csv => Middleware::CsvDir,

11
src/syncback/ref_properties.rs
View file

@ -71,7 +71,10 @@ fn compute_refs_with_duplicate_siblings(dom: &WeakDom) -> HashSet<Ref> {
let mut name_to_refs: HashMap<&str, Vec<Ref>> = HashMap::new();
for child_ref in inst.children() {
if let Some(child) = dom.get_by_ref(*child_ref) {
name_to_refs.entry(&child.name).or_default().push(*child_ref);
name_to_refs
.entry(&child.name)
.or_default()
.push(*child_ref);
}
queue.push_back(*child_ref);
}
@ -157,9 +160,9 @@ pub fn collect_referents(dom: &WeakDom, pre_prune_paths: &HashMap<Ref, String>)
// Check if target exists in current DOM
if let Some(_target) = dom.get_by_ref(*target_ref) {
// Target exists - check if path is unique (with caching)
let is_unique = *path_unique_cache
.entry(*target_ref)
.or_insert_with(|| is_path_unique_with_cache(dom, *target_ref, &has_duplicate_siblings));
let is_unique = *path_unique_cache.entry(*target_ref).or_insert_with(|| {
is_path_unique_with_cache(dom, *target_ref, &has_duplicate_siblings)
});
if is_unique {
// Path is unique - use path-based system

121
src/web/api.rs
View file

@ -273,9 +273,7 @@ impl ApiService {
///
/// This is O(N) where N is the number of instances, and allows subsequent
/// path uniqueness checks to be O(d) instead of O(d × s) where d=depth, s=siblings.
fn compute_tree_refs_with_duplicate_siblings(
tree: &crate::snapshot::RojoTree,
) -> HashSet<Ref> {
fn compute_tree_refs_with_duplicate_siblings(tree: &crate::snapshot::RojoTree) -> HashSet<Ref> {
use std::collections::VecDeque;
let mut has_duplicate_siblings = HashSet::new();
@ -292,7 +290,10 @@ impl ApiService {
let mut name_to_refs: HashMap<&str, Vec<Ref>> = HashMap::new();
for child_ref in inst.children() {
if let Some(child) = tree.get_instance(*child_ref) {
name_to_refs.entry(child.name()).or_default().push(*child_ref);
name_to_refs
.entry(child.name())
.or_default()
.push(*child_ref);
}
queue.push_back(*child_ref);
}
@ -2295,7 +2296,7 @@ mod tests {
.and_then(|e| e.items.get(name).copied())
}
/// Simulates suffix determination logic
/// Simulates suffix determination logic (matches get_script_suffix_for_run_context)
fn determine_suffix_from_run_context(run_context_value: Option<u32>) -> &'static str {
let run_context_enums = rbx_reflection_database::get()
.ok()
@ -2308,14 +2309,14 @@ mod tests {
return match name.as_ref() {
"Client" => "client",
"Server" => "server",
"Legacy" => "server",
"Legacy" => "legacy",
"Plugin" => "plugin",
_ => "server",
_ => "legacy",
};
}
}
}
"server"
"legacy"
}
#[test]
@ -2354,13 +2355,13 @@ mod tests {
}
#[test]
fn test_run_context_legacy_produces_server_suffix() {
fn test_run_context_legacy_produces_legacy_suffix() {
let value = get_run_context_value("Legacy");
assert!(value.is_some(), "Legacy RunContext should exist");
let suffix = determine_suffix_from_run_context(value);
assert_eq!(
suffix, "server",
"RunContext::Legacy should produce 'server' suffix"
suffix, "legacy",
"RunContext::Legacy should produce 'legacy' suffix"
);
}
@ -2376,21 +2377,21 @@ mod tests {
}
#[test]
fn test_no_run_context_defaults_to_server() {
fn test_no_run_context_defaults_to_legacy() {
let suffix = determine_suffix_from_run_context(None);
assert_eq!(
suffix, "server",
"No RunContext should default to 'server' suffix"
suffix, "legacy",
"No RunContext should default to 'legacy' suffix"
);
}
#[test]
fn test_invalid_run_context_defaults_to_server() {
fn test_invalid_run_context_defaults_to_legacy() {
// Some unlikely value that doesn't match any known RunContext
let suffix = determine_suffix_from_run_context(Some(99999));
assert_eq!(
suffix, "server",
"Invalid RunContext should default to 'server' suffix"
suffix, "legacy",
"Invalid RunContext should default to 'legacy' suffix"
);
}
@ -2399,18 +2400,18 @@ mod tests {
// Verify expected file extension patterns
let test_cases = vec![
("ModuleScript", None, ".luau"),
("LocalScript", None, ".client.luau"),
("LocalScript", None, ".local.luau"),
("Script", get_run_context_value("Server"), ".server.luau"),
("Script", get_run_context_value("Client"), ".client.luau"),
("Script", get_run_context_value("Legacy"), ".server.luau"),
("Script", get_run_context_value("Legacy"), ".legacy.luau"),
("Script", get_run_context_value("Plugin"), ".plugin.luau"),
("Script", None, ".server.luau"),
("Script", None, ".legacy.luau"),
];
for (class_name, run_context, expected_ext) in test_cases {
let suffix = match class_name {
"ModuleScript" => "",
"LocalScript" => "client",
"LocalScript" => "local",
"Script" => determine_suffix_from_run_context(run_context),
_ => panic!("Unknown class"),
};
@ -2434,7 +2435,7 @@ mod tests {
// Verify init file patterns for scripts with children
let test_cases = vec![
("ModuleScript", None, "init.luau"),
("LocalScript", None, "init.client.luau"),
("LocalScript", None, "init.local.luau"),
(
"Script",
get_run_context_value("Server"),
@ -2448,7 +2449,7 @@ mod tests {
(
"Script",
get_run_context_value("Legacy"),
"init.server.luau",
"init.legacy.luau",
),
(
"Script",
@ -2460,7 +2461,7 @@ mod tests {
for (class_name, run_context, expected_init) in test_cases {
let suffix = match class_name {
"ModuleScript" => "",
"LocalScript" => "client",
"LocalScript" => "local",
"Script" => determine_suffix_from_run_context(run_context),
_ => panic!("Unknown class"),
};
@ -3088,62 +3089,44 @@ mod tests {
}
#[test]
fn test_emit_legacy_scripts_compatibility() {
// Test that our syncback is compatible with emitLegacyScripts mode
fn test_new_script_naming_convention() {
// Test that syncback produces the correct file extensions with the new naming convention
//
// emitLegacyScripts: true
// - .client.luau -> LocalScript
// - .server.luau -> Script with RunContext::Legacy
// New naming convention (emitLegacyScripts removed):
// - LocalScript -> .local.luau
// - Script + RunContext::Server -> .server.luau
// - Script + RunContext::Client -> .client.luau
// - Script + RunContext::Plugin -> .plugin.luau
// - Script + RunContext::Legacy -> .legacy.luau
// - Script (no RunContext) -> .legacy.luau (default)
//
// emitLegacyScripts: false
// - .client.luau -> Script with RunContext::Client
// - .server.luau -> Script with RunContext::Server
// Backwards compatibility for READING old files:
// - .client.lua -> LocalScript
// - .server.lua -> Script with RunContext::Legacy
// Our syncback produces:
// - LocalScript -> .client.luau (compatible with legacy: true)
// - Script + RunContext::Client -> .client.luau (compatible with legacy: false)
// - Script + RunContext::Server -> .server.luau (compatible with legacy: false)
// - Script + RunContext::Legacy -> .server.luau (compatible with legacy: true)
// This test verifies the design is correct
let legacy_mode_read = vec![
(".client.luau", "LocalScript", None),
(".server.luau", "Script", Some("Legacy")),
// Test expected syncback extensions
let test_cases = vec![
("LocalScript", None, ".local.luau"),
("Script", Some("Server"), ".server.luau"),
("Script", Some("Client"), ".client.luau"),
("Script", Some("Plugin"), ".plugin.luau"),
("Script", Some("Legacy"), ".legacy.luau"),
("Script", None, ".legacy.luau"),
];
let non_legacy_mode_read = vec![
(".client.luau", "Script", Some("Client")),
(".server.luau", "Script", Some("Server")),
];
// Verify legacy mode round-trips correctly
for (extension, class, run_context) in &legacy_mode_read {
// If we syncback this class with this RunContext, what extension do we get?
for (class, run_context, expected_ext) in &test_cases {
let syncback_ext = match (*class, *run_context) {
("LocalScript", _) => ".client.luau",
("Script", Some("Legacy")) => ".server.luau",
("LocalScript", _) => ".local.luau",
("Script", Some("Server")) => ".server.luau",
("Script", Some("Client")) => ".client.luau",
("Script", None) => ".server.luau",
("Script", Some("Plugin")) => ".plugin.luau",
("Script", Some("Legacy")) => ".legacy.luau",
("Script", None) => ".legacy.luau",
_ => panic!("Unexpected combo"),
};
assert_eq!(
syncback_ext, *extension,
"Legacy mode round-trip failed for {} {:?}",
class, run_context
);
}
// Verify non-legacy mode round-trips correctly
for (extension, class, run_context) in &non_legacy_mode_read {
let syncback_ext = match (*class, *run_context) {
("Script", Some("Client")) => ".client.luau",
("Script", Some("Server")) => ".server.luau",
_ => panic!("Unexpected combo"),
};
assert_eq!(
syncback_ext, *extension,
"Non-legacy mode round-trip failed for {} {:?}",
syncback_ext, *expected_ext,
"New naming convention failed for {} {:?}",
class, run_context
);
}