Skip to content

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

Open
xperiandri with Copilot wants to merge 40 commits into
devfrom
copilot/fix-documentid-issue
Open

Make documentId deterministic SHA-256 string and keep schemaId as in-memory int cache key#575
xperiandri with Copilot wants to merge 40 commits into
devfrom
copilot/fix-documentid-issue

Conversation

CopilotAI commented May 17, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Review new actionable comment and related ExecutionTests code path
  • Investigate recent CI workflow failures via GitHub MCP logs
  • Run baseline build/tests before changes
  • Update ExecutionTests to assert/avoid validation-error-only path for escaped-string documentId
  • Format changed files with Fantomas
  • Run targeted build/tests for touched area
  • Run parallel validation
  • Reply to the new comment with commit hash

CopilotAI linked an issue May 17, 2026 that may be closed by this pull request
documentId has different values for the same query content #573
Open
CopilotAI changed the title [WIP] Fix documentId consistency for the same query contentMake documentId deterministic for identical GraphQL document contentMay 17, 2026
CopilotAI requested a review from xperiandriMay 17, 2026 18:50
xperiandri
xperiandri requested changes May 17, 2026
View reviewed changes
Comment threadtests/FSharp.Data.GraphQL.IntegrationTests/introspection.json
Comment threadtests/FSharp.Data.GraphQL.Tests/Literals.fs Outdated
Comment threadsrc/FSharp.Data.GraphQL.Server/Executor.fs Outdated
CopilotAI requested a review from xperiandriMay 17, 2026 19:34
xperiandri
xperiandri reviewed May 17, 2026
View reviewed changes
Comment threadsrc/FSharp.Data.GraphQL.Server/Executor.fs Outdated
CopilotAI changed the title Make documentId deterministic for identical GraphQL document contentMake documentId deterministic as a SHA-256 string for identical GraphQL document contentMay 17, 2026
CopilotAI requested a review from xperiandriMay 17, 2026 20:10
xperiandri
xperiandri requested changes May 17, 2026
View reviewed changes

@xperiandrixperiandri left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot

Comment threaddocs/execution-pipeline.md Outdated
Comment threadsrc/FSharp.Data.GraphQL.Server/Executor.fs Outdated
Comment threadsrc/FSharp.Data.GraphQL.Shared/Helpers/DocumentId.fs Outdated
Comment threadsrc/FSharp.Data.GraphQL.Shared/FSharp.Data.GraphQL.Shared.fsproj Outdated
CopilotAI requested a review from xperiandriMay 17, 2026 20:29
@xperiandri
xperiandri requested a review from CopilotMay 17, 2026 20:31
Copilot stopped work on behalf of xperiandri due to an error May 17, 2026 20:33
The session was cancelled by the user.
CopilotAI requested a review from xperiandriMay 17, 2026 20:33
CopilotAI reviewed May 17, 2026
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR changes GraphQL execution metadata so documentId is generated as a deterministic SHA-256 lowercase hex string from the printed query document instead of using unstable AST hash codes.

Changes:

  • Adds shared DocumentId.fromCanonicalQuery hashing helper and uses it in server execution and design-time validation cache key creation.
  • Updates DocumentId-related contract types, tests, docs, and JSON fixtures from int to string.
  • Replaces an inline introspection literal with a file-backed literal provider dependency.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 5 comments.

Show a summary per file
FileDescription
src/FSharp.Data.GraphQL.Shared/Helpers/DocumentId.fsAdds SHA-256 document ID helper.
src/FSharp.Data.GraphQL.Shared/FSharp.Data.GraphQL.Shared.fsprojIncludes the new helper in compilation.
src/FSharp.Data.GraphQL.Shared/ValidationResultCache.fsChanges validation cache key document ID type to string.
src/FSharp.Data.GraphQL.Shared/TypeSystem.fsChanges planning/execution plan document ID types to string.
src/FSharp.Data.GraphQL.Server/Executor.fsComputes document IDs via SHA-256 over ToQueryString().
src/FSharp.Data.GraphQL.Server/IO.fsUpdates response/result document ID contracts to string.
src/FSharp.Data.GraphQL.Client.DesignTime/ProvidedTypesHelper.fsUses deterministic document ID in design-time validation keys.
tests/FSharp.Data.GraphQL.Tests/ExecutionTests.fsUpdates document ID assertions for deterministic string hashes.
tests/FSharp.Data.GraphQL.Tests/Literals.fsReplaces inline JSON literal with file-backed literal provider.
tests/FSharp.Data.GraphQL.Tests/FSharp.Data.GraphQL.Tests.fsprojAdds literal provider package reference.
tests/FSharp.Data.GraphQL.IntegrationTests/introspection.jsonUpdates fixture document ID to string hash.
tests/FSharp.Data.GraphQL.IntegrationTests/integration-introspection.jsonUpdates fixture document ID to string hash.
Packages.propsAdds central package version for literal provider.
README.mdUpdates sample output document ID to string hash.
docs/execution-pipeline.mdDocuments deterministic SHA-256 string document IDs.

Comment threadsrc/FSharp.Data.GraphQL.Shared/ValidationResultCache.fs
Comment threadsrc/FSharp.Data.GraphQL.Shared/Helpers/DocumentId.fs
Comment threadsrc/FSharp.Data.GraphQL.Server/Executor.fs Outdated
Comment threadREADME.md Outdated
Comment threadtests/FSharp.Data.GraphQL.Tests/FSharp.Data.GraphQL.Tests.fsproj
CopilotAIand others added 29 commits August 11, 2026 15:16
@xperiandri
Make SchemaId deterministic using SHA-256 hash of introspection schem…
12845a6
…a JSON
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/ce0fba11-9043-452f-b948-e03c8b644f26
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Apply code review feedback: use uppercase hex for Unicode escapes and…
72a71df
… object initializer syntax
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/ce0fba11-9043-452f-b948-e03c8b644f26
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Optimize: cache JsonSerializerOptions and reduce StringBuilder overhead
4566f37
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/ce0fba11-9043-452f-b948-e03c8b644f26
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Minor optimization: avoid sprintf in character loop for better perfor…
f092046
…mance
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/ce0fba11-9043-452f-b948-e03c8b644f26
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Fix trailing whitespace in string escaping code
29a7eb4
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/ce0fba11-9043-452f-b948-e03c8b644f26
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Ensure deterministic JSON serialization and use lowercase hex for Uni…
632c8c9
…code escapes
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/ce0fba11-9043-452f-b948-e03c8b644f26
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Add documentation for UnsafeRelaxedJsonEscaping usage and SHA256 inst…
aaf216e
…ance creation
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/ce0fba11-9043-452f-b948-e03c8b644f26
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Optimize SchemaId serialization and improve code formatting
7de7fbf
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/fec46b15-afce-40da-85b4-306eae430ce0
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Add comprehensive test coverage for documentId and validation cache
06212d5
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/fec46b15-afce-40da-85b4-306eae430ce0
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
AI review fix
5962d18
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@xperiandri
Cache schema ID at Executor level to avoid recomputing on every request
6da8d6d
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/38a5449a-9904-46f6-b33a-acf9f32a7151
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Fix schema ID computation to run after middleware compilation
e726cff
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/38a5449a-9904-46f6-b33a-acf9f32a7151
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Add comprehensive test coverage for ToQueryString string escaping
4921bf2
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/5ee4bb8d-2ee3-4b01-ad1e-b1052d41e738
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Simplify SchemaId generation to use GetHashCode
b9e55fa
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/70eb1609-2aab-4948-8d69-52c900443420
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Clarify SchemaId GetHashCode scope in XML docs
3db55a2
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/70eb1609-2aab-4948-8d69-52c900443420
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Change validation SchemaId type to int
a7de093
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/50df7657-a96d-4b4f-89a9-b012c920b492
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Remove unnecessary SchemaId helper module
c5fbaf8
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/345ce2da-408c-4257-81ba-49eeac04c122
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Formatted changed files
a963959
@xperiandri
Escape U+2028/U+2029 in ToQueryString and add regression tests
73f394f
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/fe5050da-a1a6-43d1-978f-18d01b969c4c
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Made ExecutionTests asynchronous
3a85fd8
@xperiandri
Fixed comments
de8621b
@xperiandri
Removed unnecessary test
1b33a38
@xperiandri
Make concurrent cache test actually run in parallel
c3eb6a9
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/95956635-01ea-45da-a2fc-e89c2faafbbd
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Rename worker readiness gate in concurrent cache test
71891c1
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/95956635-01ea-45da-a2fc-e89c2faafbbd
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Fix cross-platform documentId hashing and AstExtensions List.choose
6a1e518
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/7ce8c26c-d831-4c14-a520-93ba8f1f1622
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@xperiandri
Improved query normalization
08d0f90
@xperiandri
Simplified cache test
30bdf0c
@xperiandri
Execution plan cache fix
e3dc5c4
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@xperiandri
Fix escaped-string documentId test to execute valid argument path
5393fd9
Agent-Logs-Url: https://github.com/fsprojects/FSharp.Data.GraphQL/sessions/1b4b4e4f-e994-4b23-92e4-8f31ed38a207
Co-authored-by: xperiandri <2365592+xperiandri@users.noreply.github.com>
@github-actions

github-actionsBot commented Aug 11, 2026

Copy link
Copy Markdown

Test Results

3 files 3 suites 10m 17s ⏱️
621 tests 616 ✅ 5 💤 0 ❌
1 863 runs 1 848 ✅ 15 💤 0 ❌

Results for commit 5393fd9.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@xperiandrixperiandriAwaiting requested review from xperiandri

Requested changes must be addressed to merge this pull request.

Assignees

@xperiandrixperiandri

Copilot code reviewCopilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

documentId has different values for the same query content

3 participants

@xperiandri