[WIP] File System persisted queries

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added new syntax visitor API.
 - Added Redis subscription provider [#902](https://github.com/ChilliCream/hotchocolate/pull/902)
 - Added support for batching over HTTP [#933](https://github.com/ChilliCream/hotchocolate/pull/933)
+- Added support for persisted queries and added a middleware to enable the active persisted query flow. [#858](https://github.com/ChilliCream/hotchocolate/pull/858)
 
 ### Changed
 

src/Core/Abstractions.Tests/Execution/QueryDocumentTests.cs

@@ -1,7 +1,9 @@
+using System.IO;
 using System;
 using HotChocolate.Language;
 using Snapshooter.Xunit;
 using Xunit;
+using System.Threading.Tasks;
 
 namespace HotChocolate.Execution.Tests
 {
@@ -55,7 +57,49 @@ public void QueryDocument_ToSource()
 
             // assert
             QuerySyntaxSerializer.Serialize(
-                Utf8GraphQLParser.Parse(query.ToSource()))
+                Utf8GraphQLParser.Parse(query.ToSpan()))
+                .ToString().MatchSnapshot();
+        }
+
+        [Fact]
+        public async Task QueryDocument_WriteToAsync()
+        {
+            // arrange
+            DocumentNode document = Utf8GraphQLParser.Parse("{ a }");
+            var query = new QueryDocument(document);
+            byte[] buffer;
+
+            // act
+            using (var stream = new MemoryStream())
+            {
+                await query.WriteToAsync(stream);
+                buffer = stream.ToArray();
+            }
+
+            // assert
+            QuerySyntaxSerializer.Serialize(
+                Utf8GraphQLParser.Parse(buffer))
+                .ToString().MatchSnapshot();
+        }
+
+        [Fact]
+        public void QueryDocument_WriteTo()
+        {
+            // arrange
+            DocumentNode document = Utf8GraphQLParser.Parse("{ a }");
+            var query = new QueryDocument(document);
+            byte[] buffer;
+
+            // act
+            using (var stream = new MemoryStream())
+            {
+                query.WriteTo(stream);
+                buffer = stream.ToArray();
+            }
+
+            // assert
+            QuerySyntaxSerializer.Serialize(
+                Utf8GraphQLParser.Parse(buffer))
                 .ToString().MatchSnapshot();
         }
     }

src/Core/Abstractions.Tests/Execution/QueryRequestBuilderTests.cs

@@ -394,5 +394,188 @@ public void BuildRequest_QueryAndTryAddVariable_VariableIsNotSet()
             // assert
             request.MatchSnapshot();
         }
+
+        [Fact]
+        public void BuildRequest_QueryAndTryAddExtension_ExtensionIsSet()
+        {
+            // arrange
+            // act
+            IReadOnlyQueryRequest request =
+                QueryRequestBuilder.New()
+                    .SetQuery("{ foo }")
+                    .TryAddExtension("one", "bar")
+                    .Create();
+
+            // assert
+            request.MatchSnapshot();
+        }
+
+        [Fact]
+        public void BuildRequest_QueryAndTryAddExtension_ExtensionIsNotSet()
+        {
+            // arrange
+            // act
+            IReadOnlyQueryRequest request =
+                QueryRequestBuilder.New()
+                    .SetQuery("{ foo }")
+                    .AddExtension("one", "foo")
+                    .TryAddExtension("one", "bar")
+                    .Create();
+
+            // assert
+            request.MatchSnapshot();
+        }
+
+        [Fact]
+        public void BuildRequest_QueryAndAddExtension_RequestIsCreated()
+        {
+            // arrange
+            // act
+            IReadOnlyQueryRequest request =
+                QueryRequestBuilder.New()
+                    .SetQuery("{ foo }")
+                    .AddExtension("one", "foo")
+                    .AddExtension("two", "bar")
+                    .Create();
+
+            // assert
+            request.MatchSnapshot();
+        }
+
+        [Fact]
+        public void BuildRequest_QueryAndSetExtensions_RequestIsCreated_1()
+        {
+            // arrange
+            // act
+            IReadOnlyQueryRequest request =
+                QueryRequestBuilder.New()
+                    .SetQuery("{ foo }")
+                    .AddExtension("one", "foo")
+                    .AddExtension("two", "bar")
+                    .SetExtensions(new Dictionary<string, object>
+                    {
+                        { "three", "baz" }
+                    })
+                    .Create();
+
+            // assert
+            // only three should exist
+            request.MatchSnapshot();
+        }
+
+        [Fact]
+        public void BuildRequest_QueryAndSetExtensions_RequestIsCreated_2()
+        {
+            // arrange
+            IReadOnlyDictionary<string, object> ext =
+                new Dictionary<string, object>
+                {
+                    { "three", "baz" }
+                };
+
+            // act
+            IReadOnlyQueryRequest request =
+                QueryRequestBuilder.New()
+                    .SetQuery("{ foo }")
+                    .AddExtension("one", "foo")
+                    .AddExtension("two", "bar")
+                    .SetExtensions(ext)
+                    .Create();
+
+            // assert
+            // only three should exist
+            request.MatchSnapshot();
+        }
+
+        [Fact]
+        public void BuildRequest_QueryAndSetExtensions_RequestIsCreated_3()
+        {
+            // arrange
+            IReadOnlyDictionary<string, object> ext =
+                new Dictionary<string, object>
+                {
+                    { "three", "baz" }
+                };
+
+            // act
+            IReadOnlyQueryRequest request =
+                QueryRequestBuilder.New()
+                    .SetQuery("{ foo }")
+                    .AddExtension("one", "foo")
+                    .AddExtension("two", "bar")
+                    .SetExtensions(ext)
+                    .AddExtension("four", "bar")
+                    .Create();
+
+            // assert
+            // only three should exist
+            request.MatchSnapshot();
+        }
+
+        [Fact]
+        public void BuildRequest_QueryAndSetExtensions_RequestIsCreated_4()
+        {
+            // arrange
+            IDictionary<string, object> ext =
+                new Dictionary<string, object>
+                {
+                    { "three", "baz" }
+                };
+
+            // act
+            IReadOnlyQueryRequest request =
+                QueryRequestBuilder.New()
+                    .SetQuery("{ foo }")
+                    .AddExtension("one", "foo")
+                    .AddExtension("two", "bar")
+                    .SetExtensions(ext)
+                    .Create();
+
+            // assert
+            // only three should exist
+            request.MatchSnapshot();
+        }
+
+        [Fact]
+        public void BuildRequest_QueryAndSetExtensions_RequestIsCreated_5()
+        {
+            // arrange
+            IDictionary<string, object> ext =
+                new Dictionary<string, object>
+                {
+                    { "three", "baz" }
+                };
+
+            // act
+            IReadOnlyQueryRequest request =
+                QueryRequestBuilder.New()
+                    .SetQuery("{ foo }")
+                    .AddExtension("one", "foo")
+                    .AddExtension("two", "bar")
+                    .SetExtensions(ext)
+                    .AddExtension("four", "bar")
+                    .Create();
+
+            // assert
+            // only three should exist
+            request.MatchSnapshot();
+        }
+
+        [Fact]
+        public void BuildRequest_QueryAndSetExtension_RequestIsCreated()
+        {
+            // arrange
+            // act
+            IReadOnlyQueryRequest request =
+                QueryRequestBuilder.New()
+                    .SetQuery("{ foo }")
+                    .AddExtension("one", "foo")
+                    .SetExtension("one", "bar")
+                    .Create();
+
+            // assert
+            // one should be bar
+            request.MatchSnapshot();
+        }
     }
 }

src/Core/Abstractions.Tests/Execution/QuerySourceTextTests.cs

@@ -1,4 +1,6 @@
 using System;
+using System.IO;
+using System.Threading.Tasks;
 using HotChocolate.Language;
 using Snapshooter.Xunit;
 using Xunit;
@@ -49,7 +51,49 @@ public void QueryDocument_ToSource()
 
             // assert
             QuerySyntaxSerializer.Serialize(
-                Utf8GraphQLParser.Parse(query.ToSource()))
+                Utf8GraphQLParser.Parse(query.ToSpan()))
+                .ToString().MatchSnapshot();
+        }
+
+        [Fact]
+        public async Task QuerySourceText_WriteToAsync()
+        {
+            // arrange
+            DocumentNode document = Utf8GraphQLParser.Parse("{ a }");
+            var query = new QuerySourceText("{ a }");
+            byte[] buffer;
+
+            // act
+            using (var stream = new MemoryStream())
+            {
+                await query.WriteToAsync(stream);
+                buffer = stream.ToArray();
+            }
+
+            // assert
+            QuerySyntaxSerializer.Serialize(
+                Utf8GraphQLParser.Parse(buffer))
+                .ToString().MatchSnapshot();
+        }
+
+        [Fact]
+        public void QuerySourceText_WriteTo()
+        {
+            // arrange
+            DocumentNode document = Utf8GraphQLParser.Parse("{ a }");
+            var query = new QuerySourceText("{ a }");
+            byte[] buffer;
+
+            // act
+            using (var stream = new MemoryStream())
+            {
+                query.WriteTo(stream);
+                buffer = stream.ToArray();
+            }
+
+            // assert
+            QuerySyntaxSerializer.Serialize(
+                Utf8GraphQLParser.Parse(buffer))
                 .ToString().MatchSnapshot();
         }
     }

src/Core/Abstractions.Tests/Execution/__snapshots__/QueryDocumentTests.QueryDocument_WriteTo.snap

@@ -0,0 +1,3 @@
+{
+  a
+}

src/Core/Abstractions.Tests/Execution/__snapshots__/QueryDocumentTests.QueryDocument_WriteToAsync.snap

@@ -0,0 +1,3 @@
+{
+  a
+}

src/Core/Abstractions.Tests/Execution/__snapshots__/QueryRequestBuilderTests.BuildRequest_OnlyQueryDocIsSet_RequestHasOnlyQuery.snap

@@ -62,8 +62,9 @@
   "QueryName": null,
   "QueryHash": null,
   "OperationName": null,
-  "VariableValues": null,
+  "VariableValues": {},
   "InitialValue": null,
-  "Properties": null,
-  "Services": null
+  "Properties": {},
+  "Services": null,
+  "Extensions": {}
 }

src/Core/Abstractions.Tests/Execution/__snapshots__/QueryRequestBuilderTests.BuildRequest_OnlyQueryIsSet_RequestHasOnlyQuery.snap

@@ -5,8 +5,9 @@
   "QueryName": null,
   "QueryHash": null,
   "OperationName": null,
-  "VariableValues": null,
+  "VariableValues": {},
   "InitialValue": null,
-  "Properties": null,
-  "Services": null
+  "Properties": {},
+  "Services": null,
+  "Extensions": {}
 }

src/Core/Abstractions.Tests/Execution/__snapshots__/QueryRequestBuilderTests.BuildRequest_QueryAndAddExtension_RequestIsCreated.snap

@@ -0,0 +1,16 @@
+{
+  "Query": {
+    "Text": "{ foo }"
+  },
+  "QueryName": null,
+  "QueryHash": null,
+  "OperationName": null,
+  "VariableValues": {},
+  "InitialValue": null,
+  "Properties": {},
+  "Services": null,
+  "Extensions": {
+    "one": "foo",
+    "two": "bar"
+  }
+}

src/Core/Abstractions.Tests/Execution/__snapshots__/QueryRequestBuilderTests.BuildRequest_QueryAndAddProperties_RequestIsCreated.snap

@@ -5,11 +5,12 @@
   "QueryName": null,
   "QueryHash": null,
   "OperationName": null,
-  "VariableValues": null,
+  "VariableValues": {},
   "InitialValue": null,
   "Properties": {
     "one": "foo",
     "two": "bar"
   },
-  "Services": null
+  "Services": null,
+  "Extensions": {}
 }

src/Core/Abstractions.Tests/Execution/__snapshots__/QueryRequestBuilderTests.BuildRequest_QueryAndAddVariables_RequestIsCreated.snap

@@ -10,6 +10,7 @@
     "two": "bar"
   },
   "InitialValue": null,
-  "Properties": null,
-  "Services": null
+  "Properties": {},
+  "Services": null,
+  "Extensions": {}
 }