Switch documentId to deterministic SHA-256 string

Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/1cf6548c-e575-44c8-832d-e662b59c9121

Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>

Author: Copilot

README.md

@@ -230,7 +230,7 @@ printfn "Custom data: %A\n" result.CustomData
 
 // Errors: <null>
 
-// Custom data: map [("documentId", 1221427401)]
+// Custom data: map [("documentId", "84fbf8cde7d1ce2c00b8e92e5f3472919b89c97c8c853b6c95619a0cb7fb3c6f")]
 ```
 
 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.

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.fromDocument queryAst; SchemaId = schema.GetHashCode() }
                                 let refMaker = lazy Validation.Ast.validateDocument schema queryAst
                                 if clientQueryValidation then
                                     refMaker.Force

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

@@ -3,10 +3,7 @@ namespace FSharp.Data.GraphQL
 open System
 open System.Collections.Concurrent
 open System.Collections.Immutable
-open System.Buffers.Binary
-open System.Security.Cryptography
 open System.Runtime.InteropServices
-open System.Text
 open System.Text.Json
 open FsToolkit.ErrorHandling
 
@@ -83,18 +80,8 @@ type Executor<'Root>(schema: ISchema<'Root>, middlewares : IExecutorMiddleware s
     let middlewaresList = Seq.toList middlewares
 
     /// Generates a deterministic document identifier from the canonical query string.
-    /// The full SHA-256 hash is folded into 32 bits to preserve the existing int32 documentId contract.
     let getDocumentId (document : Document) =
-        let canonicalQuery = document.ToQueryString()
-        let queryBytes = Encoding.UTF8.GetBytes canonicalQuery
-        let hash = SHA256.HashData queryBytes
-        [ 0 .. 7 ]
-        |> List.fold
-            (fun acc index ->
-                let start = index * 4
-                let hashChunk = BinaryPrimitives.ReadInt32BigEndian(hash.AsSpan(start, 4))
-                acc ^^^ hashChunk)
-            0
+        DocumentId.fromDocument document
 
     let rec runMiddlewares (phaseSel : IExecutorMiddleware -> ('ctx -> ('ctx -> 'res) -> 'res) option)
                            (initialCtx : 'ctx)

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/FSharp.Data.GraphQL.Shared.fsproj

@@ -55,6 +55,7 @@
     <Compile Include="AsyncVal.fs" />
     <Compile Include="Ast.fs" />
     <Compile Include="AstExtensions.fs" />
+    <Compile Include="Helpers\DocumentId.fs" />
     <Compile Include="TypeSystem.fs" />
     <Compile Include="SchemaDefinitions.fs" />
     <Compile Include="SchemaDefinitionsExtensions.fs" />

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

@@ -0,0 +1,19 @@
+module FSharp.Data.GraphQL.DocumentId
+
+open System.Globalization
+open System.Security.Cryptography
+open System.Text
+open FSharp.Data.GraphQL.Ast
+open FSharp.Data.GraphQL.Ast.Extensions
+
+let private formatByteAsLowerHex (value : byte) =
+    value.ToString("x2", CultureInfo.InvariantCulture)
+
+let fromDocument (document : Document) =
+    let canonicalQuery = document.ToQueryString()
+    let queryBytes = Encoding.UTF8.GetBytes canonicalQuery
+    use sha256 = SHA256.Create()
+    let hash = sha256.ComputeHash queryBytes
+    hash
+    |> Array.map formatByteAsLowerHex
+    |> String.concat ""

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

@@ -671,7 +671,7 @@ and PlanningContext = {
     RootDef : ObjectDef
     Document : Document
     Operation : OperationDefinition
-    DocumentId : int
+    DocumentId : string
     Metadata : Metadata
 }
 
@@ -888,7 +888,7 @@ and SchemaCompileContext = {
 /// It is used by the execution process to execute an operation.
 and ExecutionPlan = {
     /// Unique identifier of the current execution plan.
-    DocumentId : int
+    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 =

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

@@ -1,5 +1,5 @@
 {
-  "documentId": 1890859023,
+  "documentId": "547d9dc982284840b3e020dfcbf43ae96cef7595afa007145ed954794363d148",
   "data": {
     "__schema": {
       "queryType": {