[SG2] Add tests for node models (#7796)

* Remove registry singleton access when model is available

* Update SGGraphModelMock

* Add node model test to demo SGGraphModelMock

* Remove direct access of UI data in StaticPortsInspector

* Fix singleton Registry references, update SGGraphModelMock

* Model tests: CreateGraphDataNode, TryGetNodeHandler, existsInGraphData

* Fix TryGetNodeHandler return, test get registryKey

TryGetNodeHandler could return true despite assigning its out param
to null, violating its contract.

* Add preliminary tests for ChangeNodeFunction, reader -> handler

* Naming, update selected function tests

* Post-rebase fix

* Add asset stub for SGGraphModelMock, write option list tests

* Add remaining test cases incl. versioning

* Add GetNodeHandler, use when success is implied

* Add stub ShaderGraphStencilMock, split mock classes into own files

Author: dhsavell

com.unity.sg2/Editor/GraphUI/DataModel/SGGraphModel.cs

@@ -27,7 +27,7 @@ class SGGraphModel : GraphModel
         private bool isSubGraph = false;
 
         internal GraphHandler GraphHandler => graphHandlerBox.Graph;
-        internal ShaderGraphRegistry RegistryInstance => ShaderGraphRegistry.Instance;
+        internal virtual ShaderGraphRegistry RegistryInstance => ShaderGraphRegistry.Instance;
         internal List<JsonData<Target>> Targets => targetSettingsBox.Targets; // TODO: Store the active editing target in the box?
         internal Target ActiveTarget => Targets.FirstOrDefault();
         internal SGMainPreviewModel MainPreviewData => mainPreviewModel;
@@ -57,7 +57,7 @@ class SGGraphModel : GraphModel
 
         internal void Init(GraphHandler graph, bool isSubGraph, Target target)
         {
-            graphHandlerBox.Init(graph);
+            graphHandlerBox.Init(graph, RegistryInstance.Registry);
             this.isSubGraph = isSubGraph;
             if (!isSubGraph && target != null)
             {
@@ -78,7 +78,7 @@ internal void Init(GraphHandler graph, bool isSubGraph, Target target)
 
         public override void OnEnable()
         {
-            graphHandlerBox.OnEnable(false);
+            graphHandlerBox.OnEnable(RegistryInstance.Registry, false);
 
             targetSettingsBox.OnEnable();
             foreach (var target in Targets)

com.unity.sg2/Editor/GraphUI/DataModel/SGNodeModel.cs

@@ -57,10 +57,11 @@ public RegistryKey registryKey
                 if (!existsInGraphData)
                     return m_PreviewRegistryKey;
 
-                Assert.IsTrue(TryGetNodeHandler(out var reader));
+                Debug.Assert(TryGetNodeHandler(out var handler));
+
                 // Store the registry key to use for node duplication
-                duplicationRegistryKey = reader.GetRegistryKey();
-                return reader.GetRegistryKey();
+                duplicationRegistryKey = handler.GetRegistryKey();
+                return handler.GetRegistryKey();
             }
         }
 
@@ -80,22 +81,17 @@ public RegistryKey registryKey
         public bool existsInGraphData =>
             m_GraphDataName != null && TryGetNodeHandler(out _);
 
-        protected GraphHandler graphHandler =>
+        GraphHandler graphHandler =>
             ((SGGraphModel)GraphModel).GraphHandler;
 
         ShaderGraphRegistry registry =>
-            ((ShaderGraphStencil)GraphModel.Stencil).GetRegistry();
+            ((SGGraphModel)GraphModel).RegistryInstance;
 
         public bool TryGetNodeHandler(out NodeHandler reader)
         {
             try
             {
-                if (graphDataName == null)
-                {
-                    reader = registry.GetDefaultTopology(m_PreviewRegistryKey);
-                    return true;
-                }
-                reader = graphHandler.GetNode(graphDataName);
+                reader = GetNodeHandler();
                 return reader != null;
             }
             catch (Exception exception)
@@ -106,6 +102,15 @@ public bool TryGetNodeHandler(out NodeHandler reader)
             }
         }
 
+        public NodeHandler GetNodeHandler()
+        {
+            // Use the default topology handler for preview nodes.
+            var isPreview = graphDataName == null;
+            return isPreview ?
+                registry.GetDefaultTopology(m_PreviewRegistryKey) :
+                graphHandler.GetNode(graphDataName);
+        }
+
         public virtual bool HasPreview { get; private set; }
 
         // By default every node's preview is visible
@@ -171,7 +176,12 @@ internal int latestAvailableVersion
 
         public void UpgradeToLatestVersion()
         {
-            var nodeHandler = graphHandler.GetNode(graphDataName);
+            if (!existsInGraphData)
+            {
+                return;
+            }
+
+            var nodeHandler = GetNodeHandler();
 
             if (latestAvailableVersion < currentVersion)
             {
@@ -214,9 +224,15 @@ public void SetSearcherPreviewRegistryKey(RegistryKey key)
 
         public void ChangeNodeFunction(string newFunctionName)
         {
-            NodeHandler nodeHandler = graphHandler.GetNode(graphDataName);
-            string fieldName = NodeDescriptorNodeBuilder.SELECTED_FUNCTION_FIELD_NAME;
-            FieldHandler selectedFunctionField = nodeHandler.GetField<string>(fieldName);
+            if (!existsInGraphData)
+            {
+                return;
+            }
+
+            var nodeHandler = GetNodeHandler();
+            var fieldName = NodeDescriptorNodeBuilder.SELECTED_FUNCTION_FIELD_NAME;
+            var selectedFunctionField = nodeHandler.GetField<string>(fieldName);
+
             if (selectedFunctionField == null)
             {
                 Debug.LogError("Unable to update selected function. Node has no selected function field.");
@@ -245,7 +261,13 @@ public void ChangeNodeFunction(string newFunctionName)
         /// <param name="optionIndex">Index of the Option in the port's parameter descriptor to use.</param>
         public void SetPortOption(string portName, int optionIndex)
         {
-            if (!TryGetNodeHandler(out var handler)) return;
+            // If not backed by real data (i.e., we are a searcher preview), changing options doesn't make sense.
+            if (!existsInGraphData)
+            {
+                return;
+            }
+
+            var nodeHandler = GetNodeHandler();
             var parameterInfo = GetViewModel().GetParameterInfo(portName);
             var (_, optionValue) = parameterInfo.Options[optionIndex];
 
@@ -255,7 +277,7 @@ public void SetPortOption(string portName, int optionIndex)
                 return;
             }
 
-            var port = handler.GetPort(portName);
+            var port = nodeHandler.GetPort(portName);
             var existing = GetCurrentPortOption(portName);
             if (existing != -1)
             {
@@ -277,10 +299,12 @@ public void SetPortOption(string portName, int optionIndex)
         /// <returns>Index into the Options list for the given port, or -1 if there are no options or no option is selected.</returns>
         public int GetCurrentPortOption(string portName)
         {
+            if (!TryGetNodeHandler(out var handler)) return -1;
+            if (string.IsNullOrEmpty(m_GraphDataName)) return 0;  // default to first option
+
             var paramInfo = GetViewModel().GetParameterInfo(portName);
-            if (!existsInGraphData) return 0;  // default to first option
+            if (paramInfo.Options == null || paramInfo.Options.Count < 1) return -1;
 
-            if (!TryGetNodeHandler(out var handler)) return -1;
             var port = handler.GetPort(portName);
 
             var connection = graphHandler.graphDelta.GetDefaultConnectionToPort(port.ID);
@@ -302,11 +326,6 @@ public void OnPreviewTextureUpdated(Texture newTexture)
             PreviewShaderIsCompiling = false;
         }
 
-        public void OnPreviewShaderCompiling()
-        {
-            PreviewShaderIsCompiling = true;
-        }
-
         SGNodeViewModel CreateNodeViewModel(NodeUIDescriptor nodeUIInfo, NodeHandler node)
         {
             var portViewModels = new List<SGPortViewModel>();
@@ -421,21 +440,18 @@ bool CreatePortViewModel(PortHandler portInfo, ParameterUIDescriptor parameter,
 
         protected override void OnDefineNode()
         {
-            if (!TryGetNodeHandler(out var nodeReader))
+            if (!TryGetNodeHandler(out var nodeHandler))
             {
                 Debug.LogErrorFormat("Node \"{0}\" is missing from graph data", graphDataName);
                 return;
             }
 
-            NodeUIDescriptor nodeUIDescriptor = new();
-            if(GraphModel.Stencil is ShaderGraphStencil shaderGraphStencil)
-                nodeUIDescriptor = shaderGraphStencil.GetUIHints(registryKey, nodeReader);
-
-            bool nodeHasPreview = nodeUIDescriptor.HasPreview && existsInGraphData;
-            m_NodeViewModel = CreateNodeViewModel(nodeUIDescriptor, nodeReader);
+            var nodeUIDescriptor = registry.GetNodeUIDescriptor(registryKey, nodeHandler);
+            var nodeHasPreview = nodeUIDescriptor.HasPreview && existsInGraphData;
+            m_NodeViewModel = CreateNodeViewModel(nodeUIDescriptor, nodeHandler);
 
             // TODO: Convert this to a NodePortsPart maybe?
-            foreach (var portReader in nodeReader.GetPorts().Where(e => !e.LocalID.Contains("out_")))
+            foreach (var portReader in nodeHandler.GetPorts().Where(e => !e.LocalID.Contains("out_")))
             {
                 if (!portReader.IsHorizontal)
                     continue;
@@ -449,7 +465,7 @@ protected override void OnDefineNode()
 
                 // var type = ShaderGraphTypes.GetTypeHandleFromKey(portReader.GetRegistryKey());
                 var type = ShaderGraphExampleTypes.GetGraphType(portReader);
-                var nodeId = nodeReader.ID;
+                var nodeId = nodeHandler.ID;
                 void initCallback(Constant e)
                 {
                     var constant = e as BaseShaderGraphConstant;
@@ -476,7 +492,7 @@ void initCallback(Constant e)
                     var newPortModel = this.AddDataInputPort(portReader.LocalID, type, orientation: orientation, initializationCallback: initCallback);
                     // If we were deserialized, the InitCallback doesn't get triggered.
                     if (newPortModel != null)
-                        ((BaseShaderGraphConstant)newPortModel.EmbeddedValue).Initialize(((SGGraphModel)GraphModel), nodeReader.ID.LocalPath, portReader.LocalID);
+                        ((BaseShaderGraphConstant)newPortModel.EmbeddedValue).Initialize(((SGGraphModel)GraphModel), nodeHandler.ID.LocalPath, portReader.LocalID);
                 }
                 else
                     this.AddDataOutputPort(portReader.LocalID, type, orientation: orientation);

com.unity.sg2/Editor/GraphUI/GraphElements/ModelUI/Inspector/StaticPortsInspector.cs

@@ -25,7 +25,7 @@ protected override IEnumerable<BaseModelPropertyField> GetFields()
 
             var graphModel = (SGGraphModel)nodeModel.GraphModel;
             var stencil = (ShaderGraphStencil)graphModel.Stencil;
-            var nodeUIDescriptor = stencil.GetUIHints(nodeModel.registryKey, nodeReader);
+            var nodeViewModel = nodeModel.GetViewModel();
 
             foreach (var port in nodeReader.GetPorts())
             {
@@ -34,9 +34,9 @@ protected override IEnumerable<BaseModelPropertyField> GetFields()
                 if (!isStatic) continue;
 
                 var portName = port.ID.LocalPath;
-                var parameterUIDescriptor = nodeUIDescriptor.GetParameterInfo(portName);
+                var portViewModel = nodeViewModel.GetParameterInfo(portName);
 
-                if (!parameterUIDescriptor.InspectorOnly) continue;
+                if (!portViewModel.InspectorOnly) continue;
 
                 var constant = stencil.CreateConstantValue(ShaderGraphExampleTypes.GetGraphType(port));
                 if (constant is BaseShaderGraphConstant cldsConstant)

com.unity.sg2/Editor/GraphUI/Importers/ShaderGraphAssetUtils.cs

@@ -193,10 +193,9 @@ internal class SerializableGraphHandler : ISerializationCallbackReceiver
         GraphHandler m_graph;
 
         // Provide a previously initialized graphHandler-- round-trip it for ownership.
-        public void Init(GraphHandler value)
+        public void Init(GraphHandler value, Registry reg)
         {
             json = value.ToSerializedFormat();
-            var reg = ShaderGraphRegistry.Instance.Registry; // TODO: Singleton?
             m_graph = GraphHandler.FromSerializedFormat(json, reg);
             m_graph.ReconcretizeAll();
         }
@@ -214,9 +213,8 @@ public void OnBeforeSerialize()
 
         public void OnAfterDeserialize() { }
 
-        public void OnEnable(bool reconcretize = true)
+        public void OnEnable(Registry reg, bool reconcretize = true)
         {
-            var reg = ShaderGraphRegistry.Instance.Registry;
             m_graph = GraphHandler.FromSerializedFormat(json, reg);
             if (reconcretize)
             {

com.unity.sg2/Editor/GraphUI/ShaderGraphStencil.cs

@@ -77,16 +77,6 @@ public override ILibraryFilterProvider GetLibraryFilterProvider()
             return new ShaderGraphSearcherFilterProvider();
         }
 
-        internal ShaderGraphRegistry GetRegistry()
-        {
-            return ShaderGraphRegistry.Instance;
-        }
-
-        internal NodeUIDescriptor GetUIHints(RegistryKey nodeKey, NodeHandler node = null)
-        {
-            return ShaderGraphRegistry.Instance.GetNodeUIDescriptor(nodeKey, node);
-        }
-
         protected override void CreateGraphProcessors()
         {
             GetGraphProcessorContainer().AddGraphProcessor(new ShaderGraphProcessor());

com.unity.sg2/Editor/GraphUI/Utilities/GraphModelExtensions.cs

@@ -30,7 +30,6 @@ public static SGNodeModel CreateGraphDataNode(
                     }
                     else
                     {
-                        var registry = ((ShaderGraphStencil)graphModel.Stencil).GetRegistry().Registry;
                         // Use this node's generated guid to bind it to an underlying element in the graph data.
                         var graphDataName = nodeModel.Guid.ToString();
                         ((SGGraphModel)graphModel).GraphHandler.AddNode(registryKey, graphDataName);