Refined Query Conventions (#6880)

Author: michaelstaib

.github/workflows/ci.yml

@@ -275,11 +275,7 @@ jobs:
           path: |
             **/__mismatch__/*
 
-      - name: Fail if tests failed or were cancelled
-        run: exit 1
-        if: |
-          steps.run-tests.outcome == 'failure' ||
-          steps.run-tests.outcome == 'cancelled'
+
 
   codeql:
     name: CodeQL

src/CookieCrumble/src/CookieCrumble/Formatters/ExecutionResultSnapshotValueFormatter.cs

@@ -1,5 +1,4 @@
 using System.Buffers;
-using System.Runtime.InteropServices;
 using System.Text.Json;
 using System.Text.Json.Nodes;
 using HotChocolate;
@@ -21,6 +20,26 @@ protected override void Format(IBufferWriter<byte> snapshot, IExecutionResult va
             FormatStreamAsync(snapshot, (IResponseStream)value).Wait();
         }
     }
+    
+    protected override void FormatMarkdown(IBufferWriter<byte> snapshot, IExecutionResult value)
+    {
+        if (value.Kind is ExecutionResultKind.SingleResult)
+        {
+            snapshot.Append("```json");
+            snapshot.AppendLine();
+            snapshot.Append(value.ToJson());
+        }
+        else
+        {
+            snapshot.Append("```text");
+            snapshot.AppendLine();
+            FormatStreamAsync(snapshot, (IResponseStream)value).Wait();
+        }
+        
+        snapshot.AppendLine();
+        snapshot.Append("```");
+        snapshot.AppendLine();
+    }
 
     private static async Task FormatStreamAsync(
         IBufferWriter<byte> snapshot,
@@ -79,7 +98,7 @@ private static async Task FormatStreamAsync(
     }
 }
 
-internal class JsonResultPatcher
+internal sealed class JsonResultPatcher
 {
     private const string _data = "data";
     private const string _items = "items";

src/CookieCrumble/src/CookieCrumble/Formatters/GraphQLHttpResponseFormatter.cs

@@ -65,4 +65,4 @@ private static async Task FormatStreamAsync(
             }
         }
     }
-}
+}

src/CookieCrumble/src/CookieCrumble/Formatters/GraphQLSnapshotValueFormatter.cs

@@ -1,5 +1,4 @@
 using System.Buffers;
-using HotChocolate;
 using HotChocolate.Language;
 using HotChocolate.Language.Utilities;
 
@@ -27,4 +26,14 @@ protected override void Format(IBufferWriter<byte> snapshot, ISyntaxNode value)
 
         ArrayPool<char>.Shared.Return(buffer);
     }
+    
+    protected override void FormatMarkdown(IBufferWriter<byte> snapshot, ISyntaxNode value)
+    {
+        snapshot.Append("```graphql");
+        snapshot.AppendLine();
+        Format(snapshot, value);
+        snapshot.AppendLine();
+        snapshot.Append("```");
+        snapshot.AppendLine();
+    }
 }

src/CookieCrumble/src/CookieCrumble/Formatters/IMarkdownSnapshotValueFormatter.cs

@@ -0,0 +1,32 @@
+using System.Buffers;
+
+namespace CookieCrumble.Formatters;
+
+/// <summary>
+/// Formats a snapshot segment value for the snapshot file.
+/// </summary>
+public interface IMarkdownSnapshotValueFormatter
+{
+    /// <summary>
+    /// Specifies if the formatter can handle the snapshot segment value.
+    /// </summary>
+    /// <param name="value">
+    /// The snapshot segment value.
+    /// </param>
+    /// <returns>
+    /// <c>true</c> if the formatter can handle the snapshot segment value;
+    /// otherwise, <c>false</c>.
+    /// </returns>
+    bool CanHandle(object? value);
+
+    /// <summary>
+    /// Formats the specified snapshot segment value for the snapshot file.
+    /// </summary>
+    /// <param name="snapshot">
+    /// The snapshot file writer.
+    /// </param>
+    /// <param name="value">
+    ///  The snapshot segment vale.
+    /// </param>
+    void FormatMarkdown(IBufferWriter<byte> snapshot, object? value);
+}

src/CookieCrumble/src/CookieCrumble/Formatters/ISnapshotValueFormatter.cs

@@ -29,4 +29,4 @@ public interface ISnapshotValueFormatter
     ///  The snapshot segment vale.
     /// </param>
     void Format(IBufferWriter<byte> snapshot, object? value);
-}
+}

src/CookieCrumble/src/CookieCrumble/Formatters/JsonElementSnapshotValueFormatter.cs

@@ -0,0 +1,33 @@
+using System.Buffers;
+using System.Text.Encodings.Web;
+using System.Text.Json;
+
+namespace CookieCrumble.Formatters;
+
+internal sealed class JsonElementSnapshotValueFormatter : SnapshotValueFormatter<JsonElement>
+{
+    private readonly JsonSerializerOptions _options =
+        new(JsonSerializerDefaults.Web)
+        {
+            WriteIndented = true, 
+            Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
+        };
+
+    protected override void Format(IBufferWriter<byte> snapshot, JsonElement value)
+    {
+        var buffer = JsonSerializer.SerializeToUtf8Bytes(value, _options);
+        var span = snapshot.GetSpan(buffer.Length);
+        buffer.AsSpan().CopyTo(span);
+        snapshot.Advance(buffer.Length);
+    }
+
+    protected override void FormatMarkdown(IBufferWriter<byte> snapshot, JsonElement value)
+    {
+        snapshot.Append("```json");
+        snapshot.AppendLine();
+        Format(snapshot, value);
+        snapshot.AppendLine();
+        snapshot.Append("```");
+        snapshot.AppendLine();
+    }
+}

src/CookieCrumble/src/CookieCrumble/Formatters/QueryPlanSnapshotValueFormatter.cs

@@ -1,7 +1,6 @@
 #if NET7_0_OR_GREATER
 using System.Buffers;
 using HotChocolate.Fusion.Execution.Nodes;
-using HotChocolate.Fusion.Planning;
 
 namespace CookieCrumble.Formatters;
 

src/CookieCrumble/src/CookieCrumble/Formatters/SchemaSnapshotValueFormatter.cs

@@ -7,4 +7,14 @@ internal sealed class SchemaSnapshotValueFormatter : SnapshotValueFormatter<ISch
 {
     protected override void Format(IBufferWriter<byte> snapshot, ISchema value)
         => snapshot.Append(value.ToString());
+
+    protected override void FormatMarkdown(IBufferWriter<byte> snapshot, ISchema value)
+    {
+        snapshot.Append("```graphql");
+        snapshot.AppendLine();
+        Format(snapshot, value);
+        snapshot.AppendLine();
+        snapshot.Append("```");
+        snapshot.AppendLine();
+    }
 }

src/CookieCrumble/src/CookieCrumble/Formatters/SnapshotValueFormatter.cs

@@ -5,7 +5,9 @@ namespace CookieCrumble.Formatters;
 /// <summary>
 /// Formats a snapshot segment value for the snapshot file.
 /// </summary>
-public abstract class SnapshotValueFormatter<TValue> : ISnapshotValueFormatter
+public abstract class SnapshotValueFormatter<TValue>
+    : ISnapshotValueFormatter
+    , IMarkdownSnapshotValueFormatter
 {
     public bool CanHandle(object? value)
         => value is TValue casted && CanHandle(casted);
@@ -15,6 +17,19 @@ protected virtual bool CanHandle(TValue? value)
 
     public void Format(IBufferWriter<byte> snapshot, object? value)
         => Format(snapshot, (TValue)value!);
+    
+    public void FormatMarkdown(IBufferWriter<byte> snapshot, object? value)
+        => FormatMarkdown(snapshot, (TValue)value!);
 
     protected abstract void Format(IBufferWriter<byte> snapshot, TValue value);
+
+    protected virtual void FormatMarkdown(IBufferWriter<byte> snapshot, TValue value)
+    {
+        snapshot.Append("```text");
+        snapshot.AppendLine();
+        Format(snapshot, value);
+        snapshot.AppendLine();
+        snapshot.Append("```");
+        snapshot.AppendLine();
+    }
 }