Make documentId deterministic SHA-256 string and keep schemaId as in-memory int cache key

Packages.props

@@ -17,6 +17,7 @@
     </PackageReference>
     <PackageReference Update="FSharp.Control.FusionTasks" Version="2.6.*" />
     <PackageReference Update="FSharp.Control.Reactive" Version="6.*" />
+    <PackageReference Update="FSharp.Data.LiteralProviders" Version="1.0.3" />
     <PackageReference Update="FSharp.SystemTextJson" Version="1.*" />
     <PackageReference Update="FsToolkit.ErrorHandling" Version="$(FsToolkitVersion)" />
     <PackageReference Update="FsToolkit.ErrorHandling.TaskResult" Version="$(FsToolkitVersion)" />

README.md

@@ -230,7 +230,7 @@ printfn "Custom data: %A\n" result.CustomData
 
 // Errors: <null>
 
-// Custom data: map [("documentId", 1221427401)]
+// Custom data: map [("documentId", "<SHA-256 of the executed query document>")]
 ```
 
 For more information about how to use the client provider, see the [examples folder](samples/client-provider).

docs/execution-pipeline.md

@@ -52,8 +52,8 @@ The execution phase can be performed using one of the two strategies:
 
 The result of a GraphQL query execution is a `GQLResponse` object with the following fields:
 
-- `documentId`: which is the hash code of the query's AST document - it can be used to implement execution plan caching (persistent queries).
+- `documentId`: deterministic SHA-256 hash (lowercase hex string) of the canonical query document – it can be used to implement execution plan caching (persistent queries).
 - `data`: optional, a formatted GraphQL response matching the requested query (`KeyValuePair seq`). Absent in case of an error that does not allow continuing processing and returning any GraphQL results.
 - `errors`: optional, contains a list of errors (`GQLProblemDetails`) that occurred during query execution.
 
-This result can then be serialized and returned to the client.
+This result can then be serialized and returned to the client.

samples/star-wars-fabulous-client/StarWars/Common.fs

@@ -9,6 +9,6 @@ module Commands =
     let IntrospectionPath = "../../../tests/FSharp.Data.GraphQL.IntegrationTests/introspection.json"
 
     type GraphQLApi = GraphQLProvider<IntrospectionPath>
-    let GetCharactersData = GraphQLApi.Operation<"queries/FetchCharacters.graphql">()
+    let GetCharactersData = GraphQLApi.Operation<"queries/FetchCharacters.graphql"> ()
 
     type Character = GraphQLApi.Operations.FetchCharacters.Types.CharactersFields.Character

src/FSharp.Data.GraphQL.Client.DesignTime/ProvidedTypesHelper.fs

@@ -799,7 +799,7 @@ module internal Provider =
                                     match validationResult with
                                     | ValidationError msgs -> failwith (formatValidationExceptionMessage msgs)
                                     | Success -> ()
-                                let key = { DocumentId = queryAst.GetHashCode(); SchemaId = schema.GetHashCode() }
+                                let key = { DocumentId = DocumentId.fromCanonicalQueryUnsafe (queryAst.ToQueryString()); SchemaId = schema.GetHashCode() }
                                 let refMaker = lazy Validation.Ast.validateDocument schema queryAst
                                 if clientQueryValidation then
                                     refMaker.Force

src/FSharp.Data.GraphQL.Server/Executor.fs

@@ -1,5 +1,6 @@
 namespace FSharp.Data.GraphQL
 
+open System
 open System.Collections.Concurrent
 open System.Collections.Immutable
 open System.Runtime.InteropServices
@@ -9,6 +10,7 @@ open FsToolkit.ErrorHandling
 open FSharp.Data.GraphQL.Types
 open FSharp.Data.GraphQL.Execution
 open FSharp.Data.GraphQL.Ast
+open FSharp.Data.GraphQL.Ast.Extensions
 open FSharp.Data.GraphQL.Validation
 open FSharp.Data.GraphQL.Parser
 open FSharp.Data.GraphQL.Planning
@@ -99,6 +101,9 @@ type Executor<'Root>(schema: ISchema<'Root>, middlewares : IExecutorMiddleware s
         | Success -> ()
         | ValidationError errors -> raise (GQLMessageException (System.String.Join("\n", errors)))
 
+    // Compute schema ID once after middleware has run and cache it for the lifetime of this Executor instance
+    let schemaId = schema.Introspected.GetHashCode()
+
     let eval (executionPlan: ExecutionPlan, data: 'Root option, variables: ImmutableDictionary<string, JsonElement>, getInputContext : InputExecutionContextProvider): Async<GQLExecutionResult> =
         let documentId = executionPlan.DocumentId
         let prepareOutput res =
@@ -137,7 +142,7 @@ type Executor<'Root>(schema: ISchema<'Root>, middlewares : IExecutorMiddleware s
         eval (executionPlan, data, variables, getInputContext)
 
     let createExecutionPlan (ast: Document, operationName: string option, meta : Metadata) =
-        let documentId = ast.GetHashCode()
+        let documentId = DocumentId.fromCanonicalQueryUnsafe (ast.ToQueryString())
         result {
             match findOperation ast operationName with
             | Some operation ->
@@ -159,7 +164,6 @@ type Executor<'Root>(schema: ISchema<'Root>, middlewares : IExecutorMiddleware s
                             ErrorKind.Validation
                         )]
                 do!
-                    let schemaId = schema.Introspected.GetHashCode()
                     let key = { DocumentId = documentId; SchemaId = schemaId }
                     let producer = fun () -> Validation.Ast.validateDocument schema.Introspected ast
                     validationCache.GetOrAdd producer key
@@ -185,7 +189,7 @@ type Executor<'Root>(schema: ISchema<'Root>, middlewares : IExecutorMiddleware s
     /// Asynchronously executes a provided execution plan. In case of repetitive queries, execution plan may be preprocessed
     /// and cached using `documentId` as an identifier.
     /// Returned value is a readonly dictionary consisting of following top level entries:
-    /// 'documentId' (unique identifier of current document's AST, it can be used as a key/identifier of ExecutionPlan as well),
+    /// 'documentId' (unique identifier of the current document's AST, it can be used as a key/identifier of ExecutionPlan as well),
     /// 'data' (GraphQL response matching the structure provided in GraphQL query string), and
     /// 'errors' (optional, contains a list of errors that occurred while executing a GraphQL operation).
     /// </summary>
@@ -198,7 +202,7 @@ type Executor<'Root>(schema: ISchema<'Root>, middlewares : IExecutorMiddleware s
 
     /// <summary>
     /// Asynchronously executes parsed GraphQL query AST. Returned value is a readonly dictionary consisting of following top level entries:
-    /// 'documentId' (unique identifier of current document's AST, it can be used as a key/identifier of ExecutionPlan as well),
+    /// 'documentId' (unique identifier of the current document's AST, it can be used as a key/identifier of ExecutionPlan as well),
     /// 'data' (GraphQL response matching the structure provided in GraphQL query string), and
     /// 'errors' (optional, contains a list of errors that occurred while executing a GraphQL operation).
     /// </summary>
@@ -216,7 +220,7 @@ type Executor<'Root>(schema: ISchema<'Root>, middlewares : IExecutorMiddleware s
 
     /// <summary>
     /// Asynchronously executes unparsed GraphQL query AST. Returned value is a readonly dictionary consisting of following top level entries:
-    /// 'documentId' (unique identifier of current document's AST, it can be used as a key/identifier of ExecutionPlan as well),
+    /// 'documentId' (unique identifier of the current document's AST, it can be used as a key/identifier of ExecutionPlan as well),
     /// 'data' (GraphQL response matching the structure provided in GraphQL query string), and
     /// 'errors' (optional, contains a list of errors that occurred while executing a GraphQL operation).
     /// </summary>

src/FSharp.Data.GraphQL.Server/IO.fs

@@ -10,7 +10,7 @@ open FSharp.Data.GraphQL.Types
 type Output = IDictionary<string, obj>
 
 type GQLResponse =
-    { DocumentId: int
+    { DocumentId: string
       Data : Output Skippable
       Errors : GQLProblemDetails list Skippable }
     static member Direct(documentId, data, errors) =
@@ -27,7 +27,7 @@ type GQLResponse =
           Errors = Include errors }
 
 type GQLExecutionResult =
-    { DocumentId: int
+    { DocumentId: string
       Content : GQLResponseContent
       Metadata : Metadata }
     static member Direct(documentId, data, errors, meta) =
@@ -59,7 +59,7 @@ type GQLExecutionResult =
     static member Error(documentId, msg, meta) =
         GQLExecutionResult.RequestError(documentId, [ GQLProblemDetails.Create msg ], meta)
 
-    static member ErrorFromException(documentId : int, ex : Exception, meta : Metadata) =
+    static member ErrorFromException(documentId : string, ex : Exception, meta : Metadata) =
         GQLExecutionResult.RequestError(documentId, [ GQLProblemDetails.Create (ex.Message, ex) ], meta)
 
     static member Invalid(documentId, errors, meta) =

src/FSharp.Data.GraphQL.Shared/AstExtensions.fs

@@ -36,13 +36,16 @@ and internal AstSelectionInfo = {
 } with
 
     member x.AliasOrName = x.Alias |> ValueOption.defaultValue x.Name
-    static member Create (typeCondition : string voption, path : FieldPath, name : string, alias : string voption, [<Optional>] fields : AstSelectionInfo list) = {
-        TypeCondition = typeCondition
-        Name = name
-        Alias = alias
-        Path = path
-        Fields = if obj.ReferenceEquals (fields, null) then [] else fields
-    }
+    static member Create
+        (typeCondition : string voption, path : FieldPath, name : string, alias : string voption, [<Optional>] fields : AstSelectionInfo list)
+        =
+        {
+            TypeCondition = typeCondition
+            Name = name
+            Alias = alias
+            Path = path
+            Fields = if obj.ReferenceEquals (fields, null) then [] else fields
+        }
     member x.SetFields (fields : AstSelectionInfo list) = x.Fields <- fields
 
 and AstFieldInfo =
@@ -102,9 +105,30 @@ type Document with
     /// Generates a GraphQL query string from this document.
     /// </summary>
     /// <param name="options">Specify custom printing voptions for the query string.</param>
-    member x.ToQueryString ([<Optional; DefaultParameterValue (QueryStringPrintingOptions.None)>] options : QueryStringPrintingOptions) =
+    member x.ToQueryString ([<Optional; DefaultParameterValue(QueryStringPrintingOptions.None)>] options : QueryStringPrintingOptions) =
         let sb = PaddedStringBuilder ()
-        let withQuotes (s : string) = "\"" + s + "\""
+        let escapeGraphQLString (s : string) =
+            let escaped = StringBuilder (s.Length + s.Length / 4 + 2)
+            escaped.Append ('"') |> ignore
+            for c in s do
+                let appendStr =
+                    match c with
+                    | '"' -> "\\\""
+                    | '\\' -> "\\\\"
+                    | '\b' -> "\\b"
+                    | '\f' -> "\\f"
+                    | '\n' -> "\\n"
+                    | '\r' -> "\\r"
+                    | '\t' -> "\\t"
+                    | '\u2028' -> "\\u2028"
+                    | '\u2029' -> "\\u2029"
+                    | c when c < '\u0020' ->
+                        let hex = (int c).ToString ("x4", CultureInfo.InvariantCulture)
+                        "\\u" + hex
+                    | c -> string c
+                escaped.Append (appendStr) |> ignore
+            escaped.Append('"').ToString ()
+        let withQuotes = escapeGraphQLString
         let rec printValue x =
             let printObjectValue (name, value) =
                 sb.Append (name)

src/FSharp.Data.GraphQL.Shared/FSharp.Data.GraphQL.Shared.fsproj

@@ -49,6 +49,7 @@
     <Compile Include="Helpers\Extensions.fs" />
     <Compile Include="Helpers\Reflection.fs" />
     <Compile Include="Helpers\MemoryCache.fs" />
+    <Compile Include="Helpers\DocumentId.fs" />
     <Compile Include="Errors.fs" />
     <Compile Include="Exception.fs" />
     <Compile Include="ValidationTypes.fs" />

src/FSharp.Data.GraphQL.Shared/Helpers/DocumentId.fs

@@ -0,0 +1,44 @@
+module FSharp.Data.GraphQL.DocumentId
+
+open System.Globalization
+open System.Runtime.CompilerServices
+open System.Security.Cryptography
+open System.Text
+
+let private formatByteAsLowerHex (value : byte) = value.ToString ("x2", CultureInfo.InvariantCulture)
+
+let internal fromCanonicalQueryUnsafe (canonicalQuery : string) =
+    let queryBytes = Encoding.UTF8.GetBytes canonicalQuery
+    use sha256 = SHA256.Create ()
+    let hash = sha256.ComputeHash queryBytes
+    hash |> Seq.map formatByteAsLowerHex |> String.concat ""
+
+
+/// <summary>
+/// Computes a deterministic document identifier from a canonical GraphQL query string.
+/// </summary>
+/// <param name="canonicalQuery">The canonical GraphQL query string (must already be properly escaped according to GraphQL specification).</param>
+/// <returns>A lowercase hexadecimal SHA-256 hash string that uniquely identifies the document content.</returns>
+[<CompiledName("FromCanonicalQuery")>]
+let fromCanonicalQuery (canonicalQuery : string) =
+    let normalizedCanonicalQuery =
+        let crIndex = canonicalQuery.IndexOf '\r'
+        if crIndex < 0 then
+            canonicalQuery
+        else
+            let sb = StringBuilder (canonicalQuery.Length)
+            sb.Append (canonicalQuery, 0, crIndex) |> ignore
+            let mutable i = crIndex
+            while i < canonicalQuery.Length do
+                let c = canonicalQuery[i]
+                if c = '\r' then
+                    sb.Append '\n' |> ignore
+                    if i + 1 < canonicalQuery.Length && canonicalQuery[i + 1] = '\n' then
+                        i <- i + 2
+                    else
+                        i <- i + 1
+                else
+                    sb.Append c |> ignore
+                    i <- i + 1
+            sb.ToString ()
+    fromCanonicalQueryUnsafe normalizedCanonicalQuery

src/FSharp.Data.GraphQL.Shared/TypeSystem.fs

@@ -671,7 +671,8 @@ and PlanningContext = {
     RootDef : ObjectDef
     Document : Document
     Operation : OperationDefinition
-    DocumentId : int
+    /// Unique identifier of the current document's AST.
+    DocumentId : string
     Metadata : Metadata
 }
 
@@ -887,8 +888,8 @@ and SchemaCompileContext = {
 /// A planning of an execution phase.
 /// It is used by the execution process to execute an operation.
 and ExecutionPlan = {
-    /// Unique identifier of the current execution plan.
-    DocumentId : int
+    /// Unique identifier of the current document's AST.
+    DocumentId : string
     /// AST definition of current operation.
     Operation : OperationDefinition
     /// Definition of the root type (either query or mutation) used by the

src/FSharp.Data.GraphQL.Shared/ValidationResultCache.fs

@@ -4,7 +4,7 @@ open FSharp.Data.GraphQL
 open System
 
 type ValidationResultKey =
-    { DocumentId : int
+    { DocumentId : string
       SchemaId : int }
 
 type ValidationResultProducer =
@@ -13,12 +13,10 @@ type ValidationResultProducer =
 type IValidationResultCache =
     abstract GetOrAdd : ValidationResultProducer -> ValidationResultKey -> ValidationResult<GQLProblemDetails>
 
-
 /// An in-memory cache for the results of schema/document validations, with a lifetime of 30 seconds.
 type MemoryValidationResultCache () =
     let expirationPolicy = CacheExpirationPolicy.SlidingExpiration(TimeSpan.FromSeconds 30.0)
-    let internalCache = MemoryCache<int, ValidationResult<GQLProblemDetails>>(expirationPolicy)
+    let internalCache = MemoryCache<ValidationResultKey, ValidationResult<GQLProblemDetails>>(expirationPolicy)
     interface IValidationResultCache with
         member _.GetOrAdd producer key =
-            let internalKey = key.GetHashCode()
-            internalCache.GetOrAddResult internalKey producer
+            internalCache.GetOrAddResult key producer

tests/FSharp.Data.GraphQL.IntegrationTests/integration-introspection.json

@@ -1,5 +1,5 @@
 {
-  "documentId": 986164407,
+  "documentId": "547d9dc982284840b3e020dfcbf43ae96cef7595afa007145ed954794363d148",
   "data": {
     "__schema": {
       "queryType": {
@@ -1926,4 +1926,4 @@
       ]
     }
   }
-}
+}

tests/FSharp.Data.GraphQL.IntegrationTests/introspection.json

@@ -1,5 +1,5 @@
 {
-  "documentId": 195530235,
+  "documentId": "547d9dc982284840b3e020dfcbf43ae96cef7595afa007145ed954794363d148",
   "data": {
     "__schema": {
       "queryType": {
@@ -1862,4 +1862,4 @@
       ]
     }
   }
-}
+}