merge: #3460

3460: feat(sdf, dal): Bring back get_diff endpoint r=stack72 a=stack72

Bring back the sdf endpoint for get_diff.

~~**NOTE**: I don't believe this is quite right to merge yet - I still need to test the way through the system where a change happens in a new changeset and we see a diff from HEAD~~

Co-authored-by: stack72 <public@paulstack.co.uk>

Author: si-bors-ng[bot]

lib/dal/src/code_view.rs

@@ -110,11 +110,25 @@ impl CodeView {
 
         let message = code_gen_entry.message.clone();
 
-        Ok(Some(CodeView {
+        Ok(Some(CodeView::assemble(
             language,
             code,
             message,
-            func: Some(code_view_name),
-        }))
+            Some(code_view_name),
+        )))
+    }
+
+    pub fn assemble(
+        language: CodeLanguage,
+        code: Option<String>,
+        message: Option<String>,
+        func: Option<String>,
+    ) -> CodeView {
+        CodeView {
+            language,
+            code,
+            message,
+            func,
+        }
     }
 }

lib/dal/src/component.rs

@@ -45,19 +45,16 @@ use crate::{
     TransactionsError, WsEvent, WsEventError, WsEventResult, WsPayload,
 };
 
-pub mod resource;
-
-// pub mod code;
-// pub mod diff;
-mod code;
+pub mod code;
+pub mod diff;
 pub mod frame;
+pub mod properties;
 pub mod qualification;
+pub mod resource;
 // pub mod status;
 // pub mod validation;
 // pub mod view;
 
-// pub use view::{ComponentView, ComponentViewError, ComponentViewProperties};
-
 pub const DEFAULT_COMPONENT_X_POSITION: &str = "0";
 pub const DEFAULT_COMPONENT_Y_POSITION: &str = "0";
 pub const DEFAULT_COMPONENT_WIDTH: &str = "500";
@@ -102,6 +99,8 @@ pub enum ComponentError {
     MissingCodeValue(ComponentId),
     #[error("component {0} missing attribute value for qualifications")]
     MissingQualificationsValue(ComponentId),
+    #[error("component {0} missing attribute value for root")]
+    MissingRootProp(ComponentId),
     #[error("found multiple parents for component: {0}")]
     MultipleParentsForComponent(ComponentId),
     #[error("found multiple root attribute values ({0} and {1}, at minimum) for component: {2}")]

lib/dal/src/component/code.rs

@@ -1,10 +1,11 @@
-use super::{ComponentError, ComponentResult};
 use crate::workspace_snapshot::edge_weight::EdgeWeightKindDiscriminants;
 use crate::{
     code_view::CodeView, schema::variant::root_prop::RootPropChild, AttributeValueId, Component,
     ComponentId, DalContext,
 };
 
+use super::{ComponentError, ComponentResult};
+
 impl Component {
     /// List all [`CodeViews`](crate::CodeView) for based on the "code generation"
     /// [`leaves`](crate::schema::variant::leaves) for a given [`ComponentId`](Self).

lib/dal/src/component/diff.rs

@@ -1,23 +1,15 @@
 //! This module contains [`ComponentDiff`].
-
 use serde::{Deserialize, Serialize};
 use serde_json::json;
 
+use crate::code_view::{CodeLanguage, CodeView};
+use crate::component::properties::ComponentProperties;
 use crate::component::ComponentResult;
-use crate::{
-    CodeLanguage, CodeView, Component, ComponentError, ComponentId, ComponentView,
-    ComponentViewProperties, DalContext, StandardModel,
-};
+use crate::{Component, ComponentId, DalContext};
 
+//
 const NEWLINE: &str = "\n";
 
-// NOTE(nick): while the destination is the browser, we may want to consider platform-specific
-// newline characters.
-// #[cfg(target_os != "windows")]
-// const NEWLINE: &str = "\n";
-// #[cfg(target_os = "windows")]
-// const NEWLINE: &str = "\r\n";
-
 /// Contains the "diffs" for a given [`Component`](crate::Component). Generated by
 /// [`Self::new()`].
 #[derive(Deserialize, Serialize, Debug)]
@@ -34,66 +26,55 @@ pub struct ComponentDiff {
     pub diffs: Vec<CodeView>,
 }
 
-impl ComponentDiff {
-    pub async fn new(ctx: &DalContext, component_id: ComponentId) -> ComponentResult<Self> {
-        // We take a clone of the original ctx for comparisons against the head visibility.
-        // Importantly, this `head_ctx` will be dropped at the end of this function and will not
-        // live any longer (that is, it's garbage collected at a reasonable time)
-        let head_ctx = ctx.clone_with_head();
-
-        if ctx.visibility().deleted_at.is_some() {
-            return Err(ComponentError::InvalidContextForDiff);
+impl Component {
+    pub async fn get_diff(
+        ctx: &DalContext,
+        component_id: ComponentId,
+    ) -> ComponentResult<ComponentDiff> {
+        let component = Self::get_by_id(ctx, component_id).await?;
+        let curr_json: String;
+        let materialized_view = component.materialized_view(ctx).await?;
+        if let Some(view) = materialized_view {
+            let mut current_component_view = ComponentProperties::try_from(view)?;
+            current_component_view.drop_private();
+            curr_json = serde_json::to_string_pretty(&current_component_view)?;
+        } else {
+            curr_json = serde_json::to_string_pretty(&json!(null))?;
         }
 
-        let curr_component_view = ComponentView::new(ctx, component_id).await?;
-        if curr_component_view.properties.is_null() {
-            return Ok(Self {
+        let head_ctx = ctx.clone_with_head().await?;
+        if ctx.change_set_id() == head_ctx.get_workspace_default_change_set_id().await? {
+            // We are on HEAD and need to react as so!
+            return Ok(ComponentDiff {
                 component_id,
-                current: CodeView::new(CodeLanguage::Json, Some("{}".to_owned()), None, None),
-                diffs: Vec::new(),
+                current: CodeView::assemble(CodeLanguage::Json, Some(curr_json), None, None),
+                diffs: vec![],
             });
         }
 
-        let mut curr_component_view = ComponentViewProperties::try_from(curr_component_view)?;
-        curr_component_view.drop_private();
-
-        let curr_json = serde_json::to_string_pretty(&curr_component_view)?;
-
-        if ctx.visibility().is_head() {
-            return Ok(Self {
-                component_id,
-                current: CodeView::new(CodeLanguage::Json, Some(curr_json), None, None),
-                diffs: Vec::new(),
-            });
-        }
-
-        // Find the "diffs" given the head dal context only if the component exists on head.
-        let mut is_new_component = false;
-        let prev_json: String;
-        if Component::get_by_id(&head_ctx, &component_id)
-            .await?
-            .is_some()
-        {
-            let prev_component_view = ComponentView::new(&head_ctx, component_id).await?;
-            if prev_component_view.properties.is_null() {
-                return Ok(Self {
-                    component_id,
-                    current: CodeView::new(CodeLanguage::Json, Some(curr_json), None, None),
-                    diffs: Vec::new(),
-                });
+        let head_json: String;
+        let mut is_new_comp = false;
+        let head_component = Self::get_by_id(&head_ctx, component_id).await;
+        match head_component {
+            Ok(comp) => {
+                let materialized_view = comp.materialized_view(&head_ctx).await?;
+                if let Some(view) = materialized_view {
+                    let mut head_component_view = ComponentProperties::try_from(view)?;
+                    head_component_view.drop_private();
+                    head_component_view.drop_private();
+                    head_json = serde_json::to_string_pretty(&head_component_view)?;
+                } else {
+                    head_json = serde_json::to_string_pretty(&json!(null))?;
+                }
             }
-
-            let mut prev_component_view = ComponentViewProperties::try_from(prev_component_view)?;
-            prev_component_view.drop_private();
-
-            prev_json = serde_json::to_string_pretty(&prev_component_view)?;
-        } else {
-            is_new_component = true;
-            prev_json = serde_json::to_string_pretty(&json!(null))?;
-        };
+            Err(_) => {
+                is_new_comp = true;
+                head_json = serde_json::to_string_pretty(&json!(null))?;
+            }
+        }
 
         let mut lines = Vec::new();
-        for diff_object in diff::lines(&prev_json, &curr_json) {
+        for diff_object in diff::lines(&head_json, &curr_json) {
             let line = match diff_object {
                 diff::Result::Left(left) => format!("-{left}"),
                 diff::Result::Both(unchanged, _) => format!(" {unchanged}"),
@@ -103,18 +84,14 @@ impl ComponentDiff {
                 lines.push(line);
             }
         }
-        let diff = CodeView::new(CodeLanguage::Diff, Some(lines.join(NEWLINE)), None, None);
+        let diff = CodeView::assemble(CodeLanguage::Diff, Some(lines.join(NEWLINE)), None, None);
         let diffs: Vec<CodeView> = vec![diff];
 
-        Ok(Self {
+        Ok(ComponentDiff {
             component_id,
-            current: CodeView::new(
+            current: CodeView::assemble(
                 CodeLanguage::Json,
-                if is_new_component {
-                    Some(curr_json)
-                } else {
-                    None
-                },
+                if is_new_comp { Some(curr_json) } else { None },
                 None,
                 None,
             ),

lib/dal/src/component/view/properties.rs lib/dal/src/component/properties.rslib/dal/src/component/view/properties.rs renamed to lib/dal/src/component/properties.rs

@@ -1,36 +1,27 @@
-//! This module provides [`ComponentViewProperties`], which is a builder-pattern struct that enables
-//! users to modify an existing [`ComponentView`] safely.
+//! This module provides [`ComponentProperties`], which is a builder-pattern struct that enables
+//! users to modify an existing component safely.
 
+use crate::ComponentError;
 use serde::{Deserialize, Serialize};
+use serde_json::Value;
 
-use crate::component::view::ComponentViewResult;
-use crate::component::ComponentViewError;
-use crate::ComponentView;
-
-/// This struct provides the ability to drop fields from a [`ComponentView`](crate::ComponentView)
-/// properties tree and then re-render the view using [`Self::to_value()`].
-///
-/// - It is not recommended to use [`self`] "as-is" in assertions.
-/// - It is recommended to use [`Self::to_value()`] in assertions.
-///
-/// The fields on this struct are **intentionally private**.
 #[derive(Deserialize, Serialize, Debug, Default)]
-pub struct ComponentViewProperties {
-    si: serde_json::Value,
+pub struct ComponentProperties {
+    pub(crate) si: serde_json::Value,
     #[serde(skip_serializing_if = "Option::is_none")]
-    domain: Option<serde_json::Value>,
+    pub(crate) domain: Option<serde_json::Value>,
     #[serde(skip_serializing_if = "Option::is_none")]
-    resource: Option<ResourceProperties>,
+    pub(crate) resource: Option<ResourceProperties>,
     #[serde(skip_serializing_if = "Option::is_none")]
-    code: Option<serde_json::Value>,
+    pub(crate) code: Option<serde_json::Value>,
     #[serde(skip_serializing_if = "Option::is_none")]
-    qualification: Option<serde_json::Value>,
+    pub(crate) qualification: Option<serde_json::Value>,
 }
 
 /// This _private_ struct provides the ability to drop fields for the "/root/resource" tree at a
 /// more granular level than [`ComponentViewProperties`].
 #[derive(Deserialize, Serialize, Debug, Default, Clone)]
-struct ResourceProperties {
+pub struct ResourceProperties {
     #[serde(skip_serializing_if = "Option::is_none")]
     status: Option<serde_json::Value>,
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -43,13 +34,7 @@ struct ResourceProperties {
     last_synced: Option<serde_json::Value>,
 }
 
-impl ComponentViewProperties {
-    /// Create a new [`ComponentViewProperties`] object by using [`Self::try_from`] with a
-    /// [`ComponentView`].
-    pub fn new(view: ComponentView) -> ComponentViewResult<Self> {
-        Self::try_from(view)
-    }
-
+impl ComponentProperties {
     pub fn drop_private(&mut self) -> &mut Self {
         *self = Self {
             si: self.si.take(),
@@ -79,18 +64,12 @@ impl ComponentViewProperties {
         }
         self
     }
-
-    /// Converts [`self`](ComponentViewProperties) into a serialized [`Value`](serde_json::Value).
-    pub fn to_value(&self) -> ComponentViewResult<serde_json::Value> {
-        let value = serde_json::to_value(self)?;
-        Ok(value)
-    }
 }
 
-impl TryFrom<ComponentView> for ComponentViewProperties {
-    type Error = ComponentViewError;
+impl TryFrom<serde_json::Value> for ComponentProperties {
+    type Error = ComponentError;
 
-    fn try_from(view: ComponentView) -> Result<Self, Self::Error> {
-        Ok(serde_json::from_value(view.properties)?)
+    fn try_from(view: Value) -> Result<Self, Self::Error> {
+        Ok(serde_json::from_value(view)?)
     }
 }