Add RunContext support for script outputs (#765)

Resolves #667

This PR:

- Introduces a new field in the project file: `scriptType` which has the
default value of `Class` (in parity with previous versions), but can
also be `RunContext`.
- This is then passed to `InstanceContext` from the `Project` struct.
- This then changes the RunContext in the lua `snapshot_middleware`

---------

Co-authored-by: Micah <dekkonot@rocketmail.com>

src/snapshot_middleware/lua.rs

@@ -1,8 +1,8 @@
-use std::{path::Path, str};
+use std::{collections::HashMap, path::Path, str};
 
 use anyhow::Context;
-use maplit::hashmap;
 use memofs::{IoResultExt, Vfs};
+use rbx_dom_weak::types::Enum;
 
 use crate::snapshot::{InstanceContext, InstanceMetadata, InstanceSnapshot};
 
@@ -12,6 +12,13 @@ use super::{
     util::match_trailing,
 };
 
+#[derive(Debug)]
+enum ScriptType {
+    Server,
+    Client,
+    Module,
+}
+
 /// Core routine for turning Lua files into snapshots.
 pub fn snapshot_lua(
     context: &InstanceContext,
@@ -20,36 +27,58 @@ pub fn snapshot_lua(
 ) -> anyhow::Result<Option<InstanceSnapshot>> {
     let file_name = path.file_name().unwrap().to_string_lossy();
 
-    let (class_name, instance_name) = if let Some(name) = match_trailing(&file_name, ".server.lua")
+    let run_context_enums = &rbx_reflection_database::get()
+        .enums
+        .get("RunContext")
+        .expect("Unable to get RunContext enums!")
+        .items;
+
+    let (script_type, instance_name) = if let Some(name) = match_trailing(&file_name, ".server.lua")
     {
-        ("Script", name)
+        (ScriptType::Server, name)
     } else if let Some(name) = match_trailing(&file_name, ".client.lua") {
-        ("LocalScript", name)
+        (ScriptType::Client, name)
     } else if let Some(name) = match_trailing(&file_name, ".lua") {
-        ("ModuleScript", name)
+        (ScriptType::Module, name)
     } else if let Some(name) = match_trailing(&file_name, ".server.luau") {
-        ("Script", name)
+        (ScriptType::Server, name)
     } else if let Some(name) = match_trailing(&file_name, ".client.luau") {
-        ("LocalScript", name)
+        (ScriptType::Client, name)
     } else if let Some(name) = match_trailing(&file_name, ".luau") {
-        ("ModuleScript", name)
+        (ScriptType::Module, name)
     } else {
         return Ok(None);
     };
 
+    let (class_name, run_context) = match (context.emit_legacy_scripts, script_type) {
+        (false, ScriptType::Server) => ("Script", run_context_enums.get("Server")),
+        (false, ScriptType::Client) => ("Script", run_context_enums.get("Client")),
+        (true, ScriptType::Server) => ("Script", run_context_enums.get("Legacy")),
+        (true, ScriptType::Client) => ("LocalScript", None),
+        (_, ScriptType::Module) => ("ModuleScript", None),
+    };
+
     let contents = vfs.read(path)?;
     let contents_str = str::from_utf8(&contents)
         .with_context(|| format!("File was not valid UTF-8: {}", path.display()))?
         .to_owned();
 
+    let mut properties = HashMap::with_capacity(2);
+    properties.insert("Source".to_owned(), contents_str.into());
+
+    if let Some(run_context) = run_context {
+        properties.insert(
+            "RunContext".to_owned(),
+            Enum::from_u32(run_context.to_owned()).into(),
+        );
+    }
+
     let meta_path = path.with_file_name(format!("{}.meta.json", instance_name));
 
     let mut snapshot = InstanceSnapshot::new()
         .name(instance_name)
         .class_name(class_name)
-        .properties(hashmap! {
-            "Source".to_owned() => contents_str.into(),
-        })
+        .properties(properties)
         .metadata(
             InstanceMetadata::new()
                 .instigating_source(path)
@@ -107,26 +136,53 @@ pub fn snapshot_lua_init(
 mod test {
     use super::*;
 
+    use maplit::hashmap;
     use memofs::{InMemoryFs, VfsSnapshot};
 
     #[test]
-    fn module_from_vfs() {
+    fn class_module_from_vfs() {
         let mut imfs = InMemoryFs::new();
         imfs.load_snapshot("/foo.lua", VfsSnapshot::file("Hello there!"))
             .unwrap();
 
         let mut vfs = Vfs::new(imfs);
 
-        let instance_snapshot =
-            snapshot_lua(&InstanceContext::default(), &mut vfs, Path::new("/foo.lua"))
-                .unwrap()
-                .unwrap();
+        let instance_snapshot = snapshot_lua(
+            &InstanceContext::with_emit_legacy_scripts(Some(true)),
+            &mut vfs,
+            Path::new("/foo.lua"),
+        )
+        .unwrap()
+        .unwrap();
 
-        insta::assert_yaml_snapshot!(instance_snapshot);
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
     }
 
     #[test]
-    fn server_from_vfs() {
+    fn runcontext_module_from_vfs() {
+        let mut imfs = InMemoryFs::new();
+        imfs.load_snapshot("/foo.lua", VfsSnapshot::file("Hello there!"))
+            .unwrap();
+
+        let mut vfs = Vfs::new(imfs);
+
+        let instance_snapshot = snapshot_lua(
+            &InstanceContext::with_emit_legacy_scripts(Some(false)),
+            &mut vfs,
+            Path::new("/foo.lua"),
+        )
+        .unwrap()
+        .unwrap();
+
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
+    }
+
+    #[test]
+    fn class_server_from_vfs() {
         let mut imfs = InMemoryFs::new();
         imfs.load_snapshot("/foo.server.lua", VfsSnapshot::file("Hello there!"))
             .unwrap();
@@ -134,18 +190,41 @@ mod test {
         let mut vfs = Vfs::new(imfs);
 
         let instance_snapshot = snapshot_lua(
-            &InstanceContext::default(),
+            &InstanceContext::with_emit_legacy_scripts(Some(true)),
             &mut vfs,
             Path::new("/foo.server.lua"),
         )
         .unwrap()
         .unwrap();
 
-        insta::assert_yaml_snapshot!(instance_snapshot);
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
     }
 
     #[test]
-    fn client_from_vfs() {
+    fn runcontext_server_from_vfs() {
+        let mut imfs = InMemoryFs::new();
+        imfs.load_snapshot("/foo.server.lua", VfsSnapshot::file("Hello there!"))
+            .unwrap();
+
+        let mut vfs = Vfs::new(imfs);
+
+        let instance_snapshot = snapshot_lua(
+            &InstanceContext::with_emit_legacy_scripts(Some(false)),
+            &mut vfs,
+            Path::new("/foo.server.lua"),
+        )
+        .unwrap()
+        .unwrap();
+
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
+    }
+
+    #[test]
+    fn class_client_from_vfs() {
         let mut imfs = InMemoryFs::new();
         imfs.load_snapshot("/foo.client.lua", VfsSnapshot::file("Hello there!"))
             .unwrap();
@@ -153,14 +232,37 @@ mod test {
         let mut vfs = Vfs::new(imfs);
 
         let instance_snapshot = snapshot_lua(
-            &InstanceContext::default(),
+            &InstanceContext::with_emit_legacy_scripts(Some(true)),
             &mut vfs,
             Path::new("/foo.client.lua"),
         )
         .unwrap()
         .unwrap();
 
-        insta::assert_yaml_snapshot!(instance_snapshot);
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
+    }
+
+    #[test]
+    fn runcontext_client_from_vfs() {
+        let mut imfs = InMemoryFs::new();
+        imfs.load_snapshot("/foo.client.lua", VfsSnapshot::file("Hello there!"))
+            .unwrap();
+
+        let mut vfs = Vfs::new(imfs);
+
+        let instance_snapshot = snapshot_lua(
+            &InstanceContext::with_emit_legacy_scripts(Some(false)),
+            &mut vfs,
+            Path::new("/foo.client.lua"),
+        )
+        .unwrap()
+        .unwrap();
+
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
     }
 
     #[ignore = "init.lua functionality has moved to the root snapshot function"]
@@ -177,16 +279,21 @@ mod test {
 
         let mut vfs = Vfs::new(imfs);
 
-        let instance_snapshot =
-            snapshot_lua(&InstanceContext::default(), &mut vfs, Path::new("/root"))
-                .unwrap()
-                .unwrap();
+        let instance_snapshot = snapshot_lua(
+            &InstanceContext::with_emit_legacy_scripts(Some(true)),
+            &mut vfs,
+            Path::new("/root"),
+        )
+        .unwrap()
+        .unwrap();
 
-        insta::assert_yaml_snapshot!(instance_snapshot);
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
     }
 
     #[test]
-    fn module_with_meta() {
+    fn class_module_with_meta() {
         let mut imfs = InMemoryFs::new();
         imfs.load_snapshot("/foo.lua", VfsSnapshot::file("Hello there!"))
             .unwrap();
@@ -204,16 +311,53 @@ mod test {
 
         let mut vfs = Vfs::new(imfs);
 
-        let instance_snapshot =
-            snapshot_lua(&InstanceContext::default(), &mut vfs, Path::new("/foo.lua"))
-                .unwrap()
-                .unwrap();
+        let instance_snapshot = snapshot_lua(
+            &InstanceContext::with_emit_legacy_scripts(Some(true)),
+            &mut vfs,
+            Path::new("/foo.lua"),
+        )
+        .unwrap()
+        .unwrap();
 
-        insta::assert_yaml_snapshot!(instance_snapshot);
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
     }
 
     #[test]
-    fn script_with_meta() {
+    fn runcontext_module_with_meta() {
+        let mut imfs = InMemoryFs::new();
+        imfs.load_snapshot("/foo.lua", VfsSnapshot::file("Hello there!"))
+            .unwrap();
+        imfs.load_snapshot(
+            "/foo.meta.json",
+            VfsSnapshot::file(
+                r#"
+                    {
+                        "ignoreUnknownInstances": true
+                    }
+                "#,
+            ),
+        )
+        .unwrap();
+
+        let mut vfs = Vfs::new(imfs);
+
+        let instance_snapshot = snapshot_lua(
+            &InstanceContext::with_emit_legacy_scripts(Some(false)),
+            &mut vfs,
+            Path::new("/foo.lua"),
+        )
+        .unwrap()
+        .unwrap();
+
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
+    }
+
+    #[test]
+    fn class_script_with_meta() {
         let mut imfs = InMemoryFs::new();
         imfs.load_snapshot("/foo.server.lua", VfsSnapshot::file("Hello there!"))
             .unwrap();
@@ -232,18 +376,52 @@ mod test {
         let mut vfs = Vfs::new(imfs);
 
         let instance_snapshot = snapshot_lua(
-            &InstanceContext::default(),
+            &InstanceContext::with_emit_legacy_scripts(Some(true)),
             &mut vfs,
             Path::new("/foo.server.lua"),
         )
         .unwrap()
         .unwrap();
 
-        insta::assert_yaml_snapshot!(instance_snapshot);
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
     }
 
     #[test]
-    fn script_disabled() {
+    fn runcontext_script_with_meta() {
+        let mut imfs = InMemoryFs::new();
+        imfs.load_snapshot("/foo.server.lua", VfsSnapshot::file("Hello there!"))
+            .unwrap();
+        imfs.load_snapshot(
+            "/foo.meta.json",
+            VfsSnapshot::file(
+                r#"
+                    {
+                        "ignoreUnknownInstances": true
+                    }
+                "#,
+            ),
+        )
+        .unwrap();
+
+        let mut vfs = Vfs::new(imfs);
+
+        let instance_snapshot = snapshot_lua(
+            &InstanceContext::with_emit_legacy_scripts(Some(false)),
+            &mut vfs,
+            Path::new("/foo.server.lua"),
+        )
+        .unwrap()
+        .unwrap();
+
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
+    }
+
+    #[test]
+    fn class_script_disabled() {
         let mut imfs = InMemoryFs::new();
         imfs.load_snapshot("/bar.server.lua", VfsSnapshot::file("Hello there!"))
             .unwrap();
@@ -264,7 +442,41 @@ mod test {
         let mut vfs = Vfs::new(imfs);
 
         let instance_snapshot = snapshot_lua(
-            &InstanceContext::default(),
+            &InstanceContext::with_emit_legacy_scripts(Some(true)),
+            &mut vfs,
+            Path::new("/bar.server.lua"),
+        )
+        .unwrap()
+        .unwrap();
+
+        insta::with_settings!({ sort_maps => true }, {
+            insta::assert_yaml_snapshot!(instance_snapshot);
+        });
+    }
+
+    #[test]
+    fn runcontext_script_disabled() {
+        let mut imfs = InMemoryFs::new();
+        imfs.load_snapshot("/bar.server.lua", VfsSnapshot::file("Hello there!"))
+            .unwrap();
+        imfs.load_snapshot(
+            "/bar.meta.json",
+            VfsSnapshot::file(
+                r#"
+                    {
+                        "properties": {
+                            "Disabled": true
+                        }
+                    }
+                "#,
+            ),
+        )
+        .unwrap();
+
+        let mut vfs = Vfs::new(imfs);
+
+        let instance_snapshot = snapshot_lua(
+            &InstanceContext::with_emit_legacy_scripts(Some(false)),
             &mut vfs,
             Path::new("/bar.server.lua"),
         )