Roundtrip schemas in syncback (#1173)

src/snapshot/metadata.rs

@@ -66,6 +66,10 @@ pub struct InstanceMetadata {
     /// The Middleware that was used to create this Instance. Should generally
     /// not be `None` except if the snapshotting process is not completed.
     pub middleware: Option<Middleware>,
+
+    /// A schema provided via a JSON file, if one exists. Will be `None` for
+    /// all non-JSON middleware.
+    pub schema: Option<String>,
 }
 
 impl InstanceMetadata {
@@ -77,6 +81,7 @@ impl InstanceMetadata {
             context: InstanceContext::default(),
             specified_id: None,
             middleware: None,
+            schema: None,
         }
     }
 
@@ -121,6 +126,10 @@ impl InstanceMetadata {
             ..self
         }
     }
+
+    pub fn schema(self, schema: Option<String>) -> Self {
+        Self { schema, ..self }
+    }
 }
 
 impl Default for InstanceMetadata {

src/snapshot/tests/snapshots/librojo__snapshot__tests__apply__add_property.snap

@@ -15,5 +15,5 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 children: []
-

src/snapshot/tests/snapshots/librojo__snapshot__tests__apply__remove_property_after_patch.snap

@@ -13,5 +13,5 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 children: []
-

src/snapshot/tests/snapshots/librojo__snapshot__tests__apply__remove_property_initial.snap

@@ -15,5 +15,5 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 children: []
-

src/snapshot/tests/snapshots/librojo__snapshot__tests__apply__set_name_and_class_name.snap

@@ -13,5 +13,5 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 children: []
-

src/snapshot/tests/snapshots/librojo__snapshot__tests__compute__add_child.snap

@@ -14,9 +14,9 @@ added_instances:
           emit_legacy_scripts: true
         specified_id: ~
         middleware: ~
+        schema: ~
       name: New
       class_name: Folder
       properties: {}
       children: []
 updated_instances: []
-

src/snapshot_middleware/json_model.rs

@@ -50,6 +50,7 @@ pub fn snapshot_json_model(
     instance.name = Some(name.to_owned());
 
     let id = instance.id.take().map(RojoRef::new);
+    let schema = instance.schema.take();
 
     let mut snapshot = instance
         .into_snapshot()
@@ -60,7 +61,8 @@ pub fn snapshot_json_model(
         .instigating_source(path)
         .relevant_paths(vec![path.to_path_buf()])
         .context(context)
-        .specified_id(id);
+        .specified_id(id)
+        .schema(schema);
 
     Ok(Some(snapshot))
 }
@@ -74,6 +76,13 @@ pub fn syncback_json_model<'sync>(
     // We don't need the name on the root, but we do for children.
     model.name = None;
 
+    if let Some(old_inst) = snapshot.old_inst() {
+        // TODO: Is it worth this being an Arc or Rc? I doubt that enough
+        // schemas will ever exist in one project for it to matter, but it
+        // could have a performance cost.
+        model.schema = old_inst.metadata().schema.clone();
+    }
+
     Ok(SyncbackReturn {
         fs_snapshot: FsSnapshot::new().with_added_file(
             &snapshot.path,

src/snapshot_middleware/meta_file.rs

@@ -115,6 +115,10 @@ impl AdjacentMetadata {
             .map(|inst| inst.metadata().ignore_unknown_instances)
             .unwrap_or_default();
 
+        let schema = snapshot
+            .old_inst()
+            .and_then(|inst| inst.metadata().schema.clone());
+
         let class = &snapshot.new_inst().class;
         for (name, value) in snapshot.get_path_filtered_properties(snapshot.new).unwrap() {
             match value {
@@ -150,7 +154,7 @@ impl AdjacentMetadata {
             attributes,
             path,
             id: None,
-            schema: None,
+            schema,
         }))
     }
 
@@ -201,10 +205,19 @@ impl AdjacentMetadata {
         Ok(())
     }
 
+    fn apply_schema(&mut self, snapshot: &mut InstanceSnapshot) -> anyhow::Result<()> {
+        if self.schema.is_some() && snapshot.metadata.schema.is_some() {
+            anyhow::bail!("cannot specify a schema using {} (instance has a schema from somewhere else. how did we get here?)", self.path.display());
+        }
+        snapshot.metadata.schema = self.schema.take();
+        Ok(())
+    }
+
     pub fn apply_all(&mut self, snapshot: &mut InstanceSnapshot) -> anyhow::Result<()> {
         self.apply_ignore_unknown_instances(snapshot);
         self.apply_properties(snapshot)?;
         self.apply_id(snapshot)?;
+        self.apply_schema(snapshot)?;
         Ok(())
     }
 
@@ -330,6 +343,10 @@ impl DirectoryMetadata {
             .map(|inst| inst.metadata().ignore_unknown_instances)
             .unwrap_or_default();
 
+        let schema = snapshot
+            .old_inst()
+            .and_then(|inst| inst.metadata().schema.clone());
+
         let class = &snapshot.new_inst().class;
         for (name, value) in snapshot.get_path_filtered_properties(snapshot.new).unwrap() {
             match value {
@@ -366,7 +383,7 @@ impl DirectoryMetadata {
             class_name: None,
             path,
             id: None,
-            schema: None,
+            schema,
         }))
     }
 
@@ -375,6 +392,7 @@ impl DirectoryMetadata {
         self.apply_class_name(snapshot)?;
         self.apply_properties(snapshot)?;
         self.apply_id(snapshot)?;
+        self.apply_schema(snapshot)?;
 
         Ok(())
     }
@@ -439,6 +457,13 @@ impl DirectoryMetadata {
         Ok(())
     }
 
+    fn apply_schema(&mut self, snapshot: &mut InstanceSnapshot) -> anyhow::Result<()> {
+        if self.schema.is_some() && snapshot.metadata.schema.is_some() {
+            anyhow::bail!("cannot specify a schema using {} (instance has a schema from somewhere else. how did we get here?)", self.path.display());
+        }
+        snapshot.metadata.schema = self.schema.take();
+        Ok(())
+    }
     /// Returns whether the metadata is 'empty', meaning it doesn't have anything
     /// worth persisting in it. Specifically:
     ///

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__csv__test__csv_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: LocalizationTable
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__csv__test__csv_init.snap

@@ -22,6 +22,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: root
 class_name: LocalizationTable
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__csv__test__csv_init_with_meta.snap

@@ -22,6 +22,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: manually specified
   middleware: ~
+  schema: ~
 name: root
 class_name: LocalizationTable
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__csv__test__csv_with_meta.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: LocalizationTable
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__dir__test__empty_folder.snap

@@ -22,6 +22,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: Folder
 properties: {}

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__dir__test__folder_in_folder.snap

@@ -22,6 +22,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: Folder
 properties: {}
@@ -46,6 +47,7 @@ children:
         emit_legacy_scripts: true
       specified_id: ~
       middleware: dir
+      schema: ~
     name: Child
     class_name: Folder
     properties: {}

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__json__test__instance_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: ModuleScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__json__test__with_metadata.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: manually specified
   middleware: ~
+  schema: ~
 name: foo
 class_name: ModuleScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__json_model__test__model_from_vfs.snap

@@ -13,6 +13,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: IntValue
 properties:
@@ -27,8 +28,8 @@ children:
         emit_legacy_scripts: true
       specified_id: ~
       middleware: ~
+      schema: ~
     name: The Child
     class_name: StringValue
     properties: {}
     children: []
-

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__json_model__test__model_from_vfs_legacy.snap

@@ -13,6 +13,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: IntValue
 properties:
@@ -27,8 +28,8 @@ children:
         emit_legacy_scripts: true
       specified_id: ~
       middleware: ~
+      schema: ~
     name: The Child
     class_name: StringValue
     properties: {}
     children: []
-

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__class_client_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: LocalScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__class_module_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: ModuleScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__class_module_with_meta.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: ModuleScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__class_script_disabled.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: bar
 class_name: Script
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__class_script_with_meta.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: Script
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__class_server_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: Script
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__init_module_from_vfs.snap

@@ -22,6 +22,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: root
 class_name: ModuleScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__init_module_from_vfs_with_meta.snap

@@ -22,6 +22,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: manually specified
   middleware: ~
+  schema: ~
 name: root
 class_name: ModuleScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__plugin_module_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: false
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: Script
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__runcontext_client_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: false
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: Script
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__runcontext_module_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: false
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: ModuleScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__runcontext_module_with_meta.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: false
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: ModuleScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__runcontext_script_disabled.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: false
   specified_id: ~
   middleware: ~
+  schema: ~
 name: bar
 class_name: Script
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__runcontext_script_with_meta.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: false
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: Script
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__lua__test__runcontext_server_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: false
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: Script
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__meta_file__test__adjacent_read_json.snap

@@ -12,6 +12,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: manually specified
   middleware: ~
+  schema: ~
 name: DEFAULT
 class_name: DEFAULT
 properties: {}

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__meta_file__test__adjacent_read_jsonc.snap

@@ -12,6 +12,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: manually specified
   middleware: ~
+  schema: ~
 name: DEFAULT
 class_name: DEFAULT
 properties: {}

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__meta_file__test__directory_read_json.snap

@@ -12,6 +12,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: manually specified
   middleware: ~
+  schema: ~
 name: DEFAULT
 class_name: DEFAULT
 properties: {}

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__meta_file__test__directory_read_jsonc.snap

@@ -12,6 +12,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: manually specified
   middleware: ~
+  schema: ~
 name: DEFAULT
 class_name: DEFAULT
 properties: {}

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__no_name_project.snap

@@ -13,6 +13,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: Model
 properties: {}

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_from_direct_file.snap

@@ -13,8 +13,8 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: direct-project
 class_name: Model
 properties: {}
 children: []
-

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_path_property_overrides.snap

@@ -14,10 +14,10 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: project
+  schema: ~
 name: path-property-override
 class_name: StringValue
 properties:
   Value:
     String: Changed
 children: []
-

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_with_children.snap

@@ -13,6 +13,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: children
 class_name: Folder
 properties: {}
@@ -32,8 +33,8 @@ children:
         emit_legacy_scripts: true
       specified_id: ~
       middleware: ~
+      schema: ~
     name: Child
     class_name: Model
     properties: {}
     children: []
-

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_with_path_to_project.snap

@@ -14,8 +14,8 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: project
+  schema: ~
 name: path-project
 class_name: Model
 properties: {}
 children: []
-

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_with_path_to_project_with_children.snap

@@ -14,6 +14,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: project
+  schema: ~
 name: path-child-project
 class_name: Folder
 properties: {}
@@ -33,8 +34,8 @@ children:
         emit_legacy_scripts: true
       specified_id: ~
       middleware: ~
+      schema: ~
     name: SomeChild
     class_name: Model
     properties: {}
     children: []
-

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_with_path_to_txt.snap

@@ -16,6 +16,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: text
+  schema: ~
 name: path-project
 class_name: StringValue
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_with_resolved_properties.snap

@@ -13,10 +13,10 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: resolved-properties
 class_name: StringValue
 properties:
   Value:
     String: "Hello, world!"
 children: []
-

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__project__test__project_with_unresolved_properties.snap

@@ -13,10 +13,10 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: unresolved-properties
 class_name: StringValue
 properties:
   Value:
     String: Hi!
 children: []
-

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__toml__test__instance_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: ModuleScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__toml__test__with_metadata.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: manually specified
   middleware: ~
+  schema: ~
 name: foo
 class_name: ModuleScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__txt__test__instance_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: StringValue
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__txt__test__with_metadata.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: manually specified
   middleware: ~
+  schema: ~
 name: foo
 class_name: StringValue
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__yaml__test__instance_from_vfs.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: ~
   middleware: ~
+  schema: ~
 name: foo
 class_name: ModuleScript
 properties:

src/snapshot_middleware/snapshots/librojo__snapshot_middleware__yaml__test__with_metadata.snap

@@ -15,6 +15,7 @@ metadata:
     emit_legacy_scripts: true
   specified_id: manually specified
   middleware: ~
+  schema: ~
 name: foo
 class_name: ModuleScript
 properties: