RobustToolbox/Robust.Shared/Prototypes/PrototypeManager.YamlValidate.cs

using System;
using System.Collections.Generic;
using System.Linq;
using Robust.Shared.Serialization.Manager;
using Robust.Shared.Serialization.Markdown;
using Robust.Shared.Serialization.Markdown.Mapping;
using Robust.Shared.Serialization.Markdown.Validation;
using Robust.Shared.Serialization.Markdown.Value;
using Robust.Shared.Utility;
using YamlDotNet.RepresentationModel;

namespace Robust.Shared.Prototypes;

public partial class PrototypeManager
{
    // Characters that we don't allow in prototype IDs. Spaces and periods both
    // break generated localization strings for entity prototypes, so we just
    // disallow them for all prototypes.
    private static readonly char[] DisallowedIdChars = [' ', '.'];

    public Dictionary<string, HashSet<ErrorNode>> ValidateDirectory(ResPath path) => ValidateDirectory(path, out _);

    public Dictionary<string, HashSet<ErrorNode>> ValidateDirectory(ResPath path,
        out Dictionary<Type, HashSet<string>> protos)
    {
        var streams = Resources.ContentFindFiles(path).ToList().AsParallel()
            .Where(filePath => filePath.Extension == "yml" && !filePath.Filename.StartsWith("."));

        var dict = new Dictionary<string, HashSet<ErrorNode>>();
        var prototypes = new Dictionary<Type, Dictionary<string, PrototypeValidationData>>();

        foreach (var resourcePath in streams)
        {
            using var reader = ReadFile(resourcePath);

            if (reader == null)
            {
                continue;
            }

            var yamlStream = new YamlStream();
            try
            {
                yamlStream.Load(reader);
            }
            catch (Exception e)
            {
                throw new PrototypeLoadException($"Error loading file: '{resourcePath}'\n{e}");
            }

            foreach (var doc in yamlStream.Documents)
            {
                var rootNode = (YamlSequenceNode)doc.RootNode;
                foreach (YamlMappingNode node in rootNode.Cast<YamlMappingNode>())
                {
                    var typeId = node.GetNode("type").AsString();
                    if (_ignoredPrototypeTypes.Contains(typeId))
                        continue;

                    if (!_kindNames.TryGetValue(typeId, out var type))
                    {
                        throw new PrototypeLoadException($"Unknown prototype type: '{typeId}'");
                    }

                    var mapping = node.ToDataNodeCast<MappingDataNode>();
                    var id = mapping.Get<ValueDataNode>("id").Value;

                    var data = new PrototypeValidationData(id, mapping, resourcePath.ToString());
                    mapping.Remove("type");

                    if (DisallowedIdChars.TryFirstOrNull(c => id.Contains(c), out var letter))
                    {
                        dict.GetOrNew(data.File)
                            .Add(new ErrorNode(mapping, $"Prototype '{id}' ({type}) contains disallowed "
                                                        + $"character '{letter}'."));
                    }

                    if (prototypes.GetOrNew(type).TryAdd(id, data))
                        continue;

                    var error = new ErrorNode(mapping, $"Found dupe prototype ID of {id} for {type}");
                    dict.GetOrNew(data.File).Add(error);
                }
            }
        }

        var ctx = new YamlValidationContext();
        var errors = new List<ErrorNode>();
        foreach (var (type, instances) in prototypes)
        {
            foreach (var (id, data) in instances)
            {
                errors.Clear();
                EnsurePushed(data, instances, type);
                if (data.Mapping.TryGet("abstract", out ValueDataNode? abstractNode)
                    && bool.Parse(abstractNode.Value))
                {
                    continue;
                }

                // Validate yaml directly
                errors.AddRange(_serializationManager.ValidateNode(type, data.Mapping).GetErrors());
                if (errors.Count > 0)
                    dict.GetOrNew(data.File).UnionWith(errors);

                // Create instance & re-serialize it, to validate the default values of data-fields. We still validate
                // the yaml directly just in case reading & writing the fields somehow modifies their values.
                try
                {
                    var instance = _serializationManager.Read(type, data.Mapping, ctx);
                    var mapping = _serializationManager.WriteValue(type, instance, alwaysWrite: true, ctx);
                    errors.AddRange(_serializationManager.ValidateNode(type, mapping, ctx).GetErrors());
                    if (errors.Count > 0)
                        dict.GetOrNew(data.File).UnionWith(errors);
                }
                catch (Exception ex)
                {
                    errors.Add(new ErrorNode(new ValueDataNode(), $"Caught Exception while validating {type} prototype {id}. Exception: {ex}"));
                }
            }
        }

        protos = new(prototypes.Count);
        foreach (var (type, typeDict) in prototypes)
        {
            protos[type] = typeDict.Keys.ToHashSet();
        }

        return dict;
    }

    public Dictionary<Type, Dictionary<string, HashSet<ErrorNode>>> ValidateAllPrototypesSerializable(ISerializationContext? ctx)
    {
        var result = new Dictionary<Type, Dictionary<string, HashSet<ErrorNode>>>();
        var dict = new Dictionary<string, HashSet<ErrorNode>>();

        foreach (var (type, kinds) in _kinds)
        {
            foreach (var instance in kinds.Instances.Values)
            {
                DebugTools.Assert(type == instance.GetType());
                var errorNodes = ValidateProto(type, instance, ctx, out var caughtException);
                if (errorNodes.Count > 0)
                    dict.GetOrNew(instance.ID).UnionWith(errorNodes);

                // Avoid tests taking forever as they thrown one exception per prototype.
                if (caughtException)
                    break;
            }

            if (dict.Count > 0)
            {
                result[type] = dict;
                dict = new();
            }
        }

        return result;
    }

    private HashSet<ErrorNode> ValidateProto(Type type, IPrototype instance, ISerializationContext? ctx,
        out bool caughtException)
    {
        caughtException = false;
        DataNode node;
        try
        {
            node = _serializationManager.WriteValue(type, instance, alwaysWrite: true, context:ctx);
        }
        catch (Exception e)
        {
            caughtException = true;
            var msg = $"Caught exception while writing. Exception: {e}";
            return new() { new ErrorNode(new ValueDataNode(""), msg) };
        }

        try
        {
            return _serializationManager.ValidateNode(type, node, context:ctx)
                .GetErrors()
                .ToHashSet();
        }
        catch (Exception e)
        {
            caughtException = true;
            var msg = $"Caught exception while validating. Exception: {e}";
            return new() { new ErrorNode(new ValueDataNode(""), msg) };
        }
    }

    private sealed class PrototypeValidationData
    {
        public readonly string Id;
        public MappingDataNode Mapping;
        public readonly string File;
        public bool Pushed;

        public string[]? Parents;
        public MappingDataNode[]? ParentMappings;

        public PrototypeValidationData(string id, MappingDataNode mapping, string file)
        {
            Id = id;
            File = file;
            Mapping = mapping;
        }
    }

    private void EnsurePushed(
        PrototypeValidationData data,
        Dictionary<string, PrototypeValidationData> prototypes,
        Type type)
    {
        if (data.Pushed)
            return;

        data.Pushed = true;

        if (!data.Mapping.TryGet(ParentDataFieldAttribute.Name, out var parentNode))
            return;

        DebugTools.AssertNull(data.Parents);
        DebugTools.AssertNull(data.ParentMappings);
        data.Parents = _serializationManager.Read<string[]>(parentNode, notNullableOverride: true);
        data.ParentMappings = new MappingDataNode[data.Parents.Length];

        var i = 0;
        foreach (var parentId in data.Parents)
        {
            var parent = prototypes[parentId];
            EnsurePushed(parent, prototypes, type);
            data.ParentMappings[i++] = parent.Mapping;
        }

        data.Mapping = _serializationManager.PushCompositionWithGenericNode(
            type,
            data.ParentMappings,
            data.Mapping);
    }
}