Guard published TVP contracts against schema drift - #323
Merged
Conversation
Freeze published TVP shapes in an integration test and document their rolling-upgrade compatibility requirements. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7fe49384-6e2f-42c2-86b1-70b55c20d0a9
Chris Gillum (cgillum)
left a comment
Chris Gillum (cgillum)
left a comment
Member
There was a problem hiding this comment.
Thanks for creating this PR. I do have one question about the maintenance expectations.
Name the compatibility baseline after v1.6.0 and keep detailed maintenance guidance canonical in the schema documentation. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7fe49384-6e2f-42c2-86b1-70b55c20d0a9
Contributor
There was a problem hiding this comment.
Pull request overview
Adds safeguards and guidance to prevent published SQL TVP contracts from drifting during rolling upgrades.
Changes:
- Adds a frozen v1.6.0 TVP compatibility integration test.
- Documents TVP immutability and rolling-upgrade considerations.
- Adds repository-wide Copilot development guidance.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
.github/copilot-instructions.md |
Adds repository development conventions. |
docs/multitenancy.md |
Documents shared-schema rolling upgrades. |
src/DurableTask.SqlServer/Scripts/README.md |
Defines TVP compatibility rules. |
src/DurableTask.SqlServer/Scripts/logic.sql |
Warns against modifying published TVPs. |
test/DurableTask.SqlServer.Tests/Integration/DatabaseManagement.cs |
Adds the frozen TVP contract test. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Chris Gillum (cgillum)
approved these changes
Aug 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This guards the mixed-version deployment scenario reported in #317 without adding runtime metadata checks or hot-path overhead.
Testing
dotnet build test\DurableTask.SqlServer.Tests\DurableTask.SqlServer.Tests.csproj --no-restoredotnet test test\DurableTask.SqlServer.Tests\DurableTask.SqlServer.Tests.csproj --no-build --filter FullyQualifiedName~DatabaseManagement --verbosity minimal