Improve awaitTxId timeout error with diagnostic info#1175
Open
KyleAMathews wants to merge 5 commits intomainfrom
Open
Improve awaitTxId timeout error with diagnostic info#1175KyleAMathews wants to merge 5 commits intomainfrom
KyleAMathews wants to merge 5 commits intomainfrom
Conversation
Include the txids received during the timeout period in the TimeoutWaitingForTxIdError message. This helps diagnose the common issue where pg_current_xact_id() is called outside the transaction that performs the mutation. The error now shows: - The txid that was being awaited - Which txids were received during the timeout (or none) - A hint about the common cause and link to documentation
🦋 Changeset detectedLatest commit: 2c8c9a1 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
More templates
@tanstack/angular-db
@tanstack/db
@tanstack/db-ivm
@tanstack/electric-db-collection
@tanstack/offline-transactions
@tanstack/powersync-db-collection
@tanstack/query-db-collection
@tanstack/react-db
@tanstack/rxdb-db-collection
@tanstack/solid-db
@tanstack/svelte-db
@tanstack/trailbase-db-collection
@tanstack/vue-db
commit: |
Contributor
|
Size Change: 0 B Total Size: 90.9 kB ℹ️ View Unchanged
|
Contributor
|
Size Change: 0 B Total Size: 3.7 kB ℹ️ View Unchanged
|
Improves readability by replacing nested ternary with explicit conditionals in formatReceivedTxidsInfo helper function. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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
Enhanced
TimeoutWaitingForTxIdErrorto provide actionable debugging information whenawaitTxIdtimes out, showing which txids arrived during the timeout and linking to documentation about the common cause.User impact: Developers debugging timeout issues can now see whether transactions are being received at all, making it much easier to diagnose whether the issue is network-related or a
pg_current_xact_id()placement problem.Root Cause (of the DX problem)
When
awaitTxIdtimes out, users previously got a generic "Timeout waiting for txId: X" message with no context about what went wrong. The most common cause—callingpg_current_xact_id()outside the transaction that performs the mutation—was not surfaced.Approach
Key code path (
electric.ts:639-665):Key Invariants
receivedTxidsparameter is optional for backward compatibilityNon-goals
Verification
pnpm testAll 404 tests pass.
Files Changed
packages/electric-db-collection/src/electric.tspackages/electric-db-collection/src/errors.tsreceivedTxidsparam, format debugging info, add hint with docs linkChecklist
pnpm test🤖 Generated with Claude Code