PgClient: add statementTimeout and queryTimeout options#6387
Draft
agcty wants to merge 1 commit into
Draft
Conversation
🦋 Changeset detectedLatest commit: 06b9f02 The changes in this PR will be included in the next version bump. This PR includes changesets to release 27 packages
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 |
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.
Migration
Replacement for Effect-TS/effect-smol#2617, opened after Effect V4 development moved back to this repository. Please refer to the original PR for its existing discussion and review history.
This is a direct migration of the original two-file change onto the current
Effect-TS/effect:mainbranch.Motivation
PgClientConfigexposesconnectTimeout, but there is no way to bound statement execution: thepgdriverstatement_timeout(server-side cancel) andquery_timeout(client-side) options are not passed through, so a hung or runaway statement waits indefinitely unless the caller rebuilds pool acquisition viafromPool.This hardening gap affects Cloudflare Workers Durable Objects, where a wedged socket may otherwise only be recovered by the platform resetting the object.
Changes
statementTimeoutandqueryTimeout(Duration.Input) toPgClientConfig.pgasstatement_timeoutandquery_timeoutin bothmake(pool) andmakeClient(single client).@effect/sql-pg.Validation
pnpm lint-fixpnpm checkpnpm test packages/sql/pg/test/Client.test.ts --run(23 tests passed)