@vrplatform/kysely 1.3.45-stage.438 → 1.3.45-stage.43806806421

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (206) hide show
  1. package/build/.data.tar +2 -2
  2. package/build/main/camel-case/index.d.ts +4 -4
  3. package/build/main/camel-case/index.js +2 -1
  4. package/build/main/camel-case/index.js.map +1 -1
  5. package/build/main/connect-handoff.d.ts +12 -0
  6. package/build/main/connect-handoff.js +73 -0
  7. package/build/main/connect-handoff.js.map +1 -0
  8. package/build/main/control-plane/index.d.ts +54 -1
  9. package/build/main/control-plane/index.js +10 -0
  10. package/build/main/control-plane/index.js.map +1 -1
  11. package/build/main/error.d.ts +2 -2
  12. package/build/main/error.js.map +1 -1
  13. package/build/main/index.d.ts +50 -4
  14. package/build/main/index.js +389 -63
  15. package/build/main/index.js.map +1 -1
  16. package/build/main/isomorphic.d.ts +1 -1
  17. package/build/main/isomorphic.js +3 -1
  18. package/build/main/isomorphic.js.map +1 -1
  19. package/build/main/local/digest.js.map +1 -1
  20. package/build/main/local/generate.js +4 -3
  21. package/build/main/local/generate.js.map +1 -1
  22. package/build/main/local/index.js +34 -10
  23. package/build/main/local/index.js.map +1 -1
  24. package/build/main/local/prune-pulled-schema.js.map +1 -1
  25. package/build/main/migration-source.d.ts +4 -0
  26. package/build/main/migration-source.js +45 -0
  27. package/build/main/migration-source.js.map +1 -0
  28. package/build/main/migration.d.ts +5 -5
  29. package/build/main/pganalyze-comment-plugin/comment-transformer.js +3 -1
  30. package/build/main/pganalyze-comment-plugin/comment-transformer.js.map +1 -1
  31. package/build/main/pganalyze-comment-plugin/index.js.map +1 -1
  32. package/build/main/plugins.js.map +1 -1
  33. package/build/main/postgres-error.d.ts +1 -0
  34. package/build/main/postgres-error.js +12 -6
  35. package/build/main/postgres-error.js.map +1 -1
  36. package/build/main/query/listing/status.d.ts +2 -2
  37. package/build/main/query/listing/status.js +6 -2
  38. package/build/main/query/listing/status.js.map +1 -1
  39. package/build/main/query/tenant/billing-partner.js.map +1 -1
  40. package/build/main/query/tenant/feature-enabled.d.ts +6 -0
  41. package/build/main/query/tenant/feature-enabled.js +30 -0
  42. package/build/main/query/tenant/feature-enabled.js.map +1 -0
  43. package/build/main/query/tenant/index.d.ts +2 -0
  44. package/build/main/query/tenant/index.js +2 -0
  45. package/build/main/query/tenant/index.js.map +1 -1
  46. package/build/main/query/tenant/status.d.ts +1 -6
  47. package/build/main/query/tenant/status.js +4 -12
  48. package/build/main/query/tenant/status.js.map +1 -1
  49. package/build/main/query/tenant/where-uuid-in.d.ts +2 -0
  50. package/build/main/query/tenant/where-uuid-in.js +14 -0
  51. package/build/main/query/tenant/where-uuid-in.js.map +1 -0
  52. package/build/main/regional.d.ts +2 -1
  53. package/build/main/regional.js +1 -0
  54. package/build/main/regional.js.map +1 -1
  55. package/build/main/test/index.d.ts +7 -9
  56. package/build/main/test/index.js +11 -14
  57. package/build/main/test/index.js.map +1 -1
  58. package/build/main/transaction.js.map +1 -1
  59. package/build/main/v1.generated.d.ts +509 -70
  60. package/build/main/v1.generated.js.map +1 -1
  61. package/build/migrations-v2/0000000000033-plaid-connect-session-telemetry.ts +31 -0
  62. package/build/migrations-v2/0000000000050-connection-oauth-state.ts +43 -0
  63. package/build/migrations-v2/0000000000051-owner-statement-email-delivery.ts +134 -0
  64. package/build/migrations-v2/0000000000052-fee-journal-lock-skip-operations.ts +59 -0
  65. package/build/migrations-v2/0000000000053-fee-journal-lock-skip-null-attempt.ts +44 -0
  66. package/build/migrations-v2/0000000000054-journal-refresh-issue-codes.ts +16 -0
  67. package/build/migrations-v2/0000000000055-tenant-billing-subscription.ts +8 -0
  68. package/build/migrations-v2/0000000000056-journal-operation-failure-precedence.ts +306 -0
  69. package/build/migrations-v2/0000000000057-journal-invalidation-failure-code.ts +28 -0
  70. package/build/migrations-v2/0000000000058-journal-invalidation-locked-failure.ts +16 -0
  71. package/build/migrations-v2/0000000000059-billing-active-listing-cross-region-partner.ts +135 -0
  72. package/build/migrations-v2/0000000000060-accounting-integrity-change-driven.ts +99 -0
  73. package/build/migrations-v2/0000000000061-tenant-pending-onboarding-status.ts +37 -0
  74. package/build/migrations-v2/0000000000062-statement-payout-operations.ts +16 -0
  75. package/build/migrations-v2/0000000000063-missing-account-assignments-issue-code.ts +13 -0
  76. package/build/migrations-v2/0000000000064-journal-invalidation-source-lookup-index.ts +26 -0
  77. package/build/migrations-v2/0000000000065-hasura-connection-event-credentials.ts +42 -0
  78. package/build/migrations-v2/0000000000066-recurring-fee-listing-subscription-match-by.ts +51 -0
  79. package/build/migrations-v2/0000000000067-connection-credential-metadata.ts +60 -0
  80. package/build/migrations-v2/0000000000068-connection-credential-version.ts +34 -0
  81. package/build/migrations-v2/0000000000069-owner-statement-contact-email-delivery.ts +84 -0
  82. package/build/migrations-v2/0000000000070-payment-writer-compatibility.ts +69 -0
  83. package/build/migrations-v2/0000000000071-payments.ts +532 -0
  84. package/build/migrations-v2/0000000000072-journal-entry-payment-index.ts +21 -0
  85. package/build/migrations-v2/0000000000073-batch-invalidation-operation-registration.ts +74 -0
  86. package/build/migrations-v2/0000000000074-owner-statement-email-history.ts +34 -0
  87. package/build/migrations-v2/0000000000075-tenant-deletion-lookup-indexes.ts +46 -0
  88. package/build/migrations-v2/0000000000076-tenant-onboarding-not-null.ts +23 -0
  89. package/build/migrations-v2/0000000000077-payment-writer-statement-attachment.ts +92 -0
  90. package/build/migrations-v2/0000000000078-trigger-timeout-indexes.ts +44 -0
  91. package/build/migrations-v2/0000000000079-core-change-tenant-statistics.ts +26 -0
  92. package/build/migrations-v2/0000000000080-drop-legacy-tracking-event.ts +60 -0
  93. package/build/migrations-v2/0000000000081-recurring-fee-planner-operation-status.ts +35 -0
  94. package/build/migrations-v2/0000000000082-reservation-search-trigram-indexes.ts +54 -0
  95. package/build/migrations-v2/0000000000083-journal-entry-deposit-lookup-index.ts +31 -0
  96. package/build/migrations-v2/0000000000084-journal-entry-reservation-revenue-indexes.ts +57 -0
  97. package/build/migrations-v2/0000000000085-owner-statement-link-email-template.ts +23 -0
  98. package/build/migrations-v2/0000000000086-contact-payment-setup.ts +72 -0
  99. package/build/migrations-v2/0000000000087-address-delete-fk-indexes.ts +30 -0
  100. package/build/migrations-v2/0000000000088-owner-statement-email-switch.ts +76 -0
  101. package/build/migrations-v2/0000000000089-contact-bank-details-requested-at.ts +21 -0
  102. package/build/migrations-v2/0000000000090-contact-bank-account-api-key.ts +22 -0
  103. package/build/migrations-v2/0000000000091-contact-bank-details-request.ts +78 -0
  104. package/build/migrations-v2/0000000000092-payment-provider-reference.ts +22 -0
  105. package/build/migrations-v2/0000000000093-payment-reversal-offline-undo.ts +18 -0
  106. package/build/migrations-v2/0000000000094-reservation-status-checkout-index.ts +37 -0
  107. package/build/migrations-v2/0000000000095-payment-batches.ts +196 -0
  108. package/build/migrations-v2/0000000000096-guide-ongoing-tasks-issue-codes.ts +26 -0
  109. package/build/migrations-v2/0000000000097-reservation-line-mapping-suggestions.ts +53 -0
  110. package/build/migrations-v2/0000000000098-cancelled-reservation-balances-issue-code.ts +13 -0
  111. package/build/migrations-v2/0000000000099-contact-bank-account-request-source.ts +28 -0
  112. package/build/migrations-v2/0000000000100-drop-regional-feature-flags.ts +105 -0
  113. package/build/migrations-v2/0000000000101-bank-record-match-source.ts +45 -0
  114. package/build/migrations-v2/0000000000102-owner-statement-email-one-template.ts +63 -0
  115. package/build/migrations-v2/0000000000103-reservation-line-mapping-update-operation.ts +10 -0
  116. package/build/migrations-v2/0000000000104-export-job-payment-batch-pdf.ts +12 -0
  117. package/build/migrations-v2/0000000000105-drop-regional-token.ts +60 -0
  118. package/build/migrations-v2/0000000000106-incremental-audit-action-source.ts +158 -0
  119. package/build/migrations-v2/0000000000107-audit-mutation-transaction-insert-index.ts +44 -0
  120. package/build/migrations-v2/0000000000108-reservation-stay-type.ts +24 -0
  121. package/build/migrations-v2/0000000000109-long-term-liabilities-category-order.ts +21 -0
  122. package/build/migrations-v2/0000000000110-pms-sync-failures-issue-code.ts +13 -0
  123. package/build/migrations-v2/0000000000110-reservation-line-type-taxable.ts +21 -0
  124. package/build/migrations-v2/0000000000111-reservation-line-type-suggestion-taxable.ts +20 -0
  125. package/build/migrations-v2/0000000000112-contact-payment-method-outside-default.ts +44 -0
  126. package/build/migrations-v2/0000000000113-merchant-fee-reference-assignment.ts +25 -0
  127. package/build/migrations-v2/0000000000114-recurring-fee-nights-filter.ts +32 -0
  128. package/build/migrations-v2/0000000000115-bank-records-with-suggested-rule-issue-code.ts +13 -0
  129. package/build/migrations-v2/0000000000116-guest-review.ts +45 -0
  130. package/build/migrations-v2/0000000000117-ramp-external-funding-accounts.ts +91 -0
  131. package/build/migrations-v2/0000000000118-pm-payout-assignment.ts +25 -0
  132. package/build/migrations-v2/0000000000119-chart-of-accounts-classifications.ts +46 -0
  133. package/build/migrations-v2/0000000000120-feedback.ts +41 -0
  134. package/build/migrations-v2/0000000000121-source-owner-block-calendar-index.ts +43 -0
  135. package/build/migrations-v2/0000000000122-recurring-fee-stay-types-filter.ts +20 -0
  136. package/build/migrations-v2/0000000000123-reservation-owner-stay-type-index.ts +40 -0
  137. package/build/migrations-v2/0000000000124-remove-tenant-test-and-billable-columns.ts +63 -0
  138. package/build/migrations-v2/0000000000125-ramp-application.ts +56 -0
  139. package/build/migrations-v2/0000000000126-advanced-deposits-update-operation.ts +10 -0
  140. package/build/migrations-v2/0000000000127-contact-1099-tax-details.ts +46 -0
  141. package/build/migrations-v2/0000000000128-tax-1099-email-templates.ts +36 -0
  142. package/build/migrations-v2/0000000000129-tenant-locked-at.ts +18 -0
  143. package/build/migrations-v2/0000000000130-second-factor-reset.ts +65 -0
  144. package/build/migrations-v2/0000000000131-payout-hold.ts +49 -0
  145. package/build/migrations-v2/0000000000132-member-invite-approval.ts +62 -0
  146. package/build/migrations-v2/0000000000133-audit-action-client-ip.ts +38 -0
  147. package/build/migrations-v2/0000000000134-drop-orphaned-hasura-triggers.ts +39 -0
  148. package/build/migrations-v2/0000000000135-drop-orphaned-hasura-triggers-literal.ts +42 -0
  149. package/build/migrations-v2/0000000000136-drop-all-hasura-triggers.ts +43 -0
  150. package/build/migrations-v2/0000000000137-webhook-event.ts +57 -0
  151. package/build/migrations-v2/0000000000138-contact-tax-details-requested-at.ts +24 -0
  152. package/build/module/camel-case/index.d.ts +4 -4
  153. package/build/module/camel-case/index.js +3 -2
  154. package/build/module/camel-case/index.js.map +1 -1
  155. package/build/module/connect-handoff.d.ts +12 -0
  156. package/build/module/connect-handoff.js +70 -0
  157. package/build/module/connect-handoff.js.map +1 -0
  158. package/build/module/control-plane/index.d.ts +54 -1
  159. package/build/module/control-plane/index.js +9 -0
  160. package/build/module/control-plane/index.js.map +1 -1
  161. package/build/module/error.d.ts +2 -2
  162. package/build/module/error.js.map +1 -1
  163. package/build/module/index.d.ts +50 -4
  164. package/build/module/index.js +387 -63
  165. package/build/module/index.js.map +1 -1
  166. package/build/module/isomorphic.d.ts +1 -1
  167. package/build/module/isomorphic.js +1 -1
  168. package/build/module/isomorphic.js.map +1 -1
  169. package/build/module/local/generate.js +4 -3
  170. package/build/module/local/generate.js.map +1 -1
  171. package/build/module/local/index.js +34 -10
  172. package/build/module/local/index.js.map +1 -1
  173. package/build/module/local/prune-pulled-schema.js.map +1 -1
  174. package/build/module/migration-source.d.ts +4 -0
  175. package/build/module/migration-source.js +42 -0
  176. package/build/module/migration-source.js.map +1 -0
  177. package/build/module/migration.d.ts +5 -5
  178. package/build/module/pganalyze-comment-plugin/comment-transformer.js +3 -1
  179. package/build/module/pganalyze-comment-plugin/comment-transformer.js.map +1 -1
  180. package/build/module/postgres-error.d.ts +1 -0
  181. package/build/module/postgres-error.js +11 -6
  182. package/build/module/postgres-error.js.map +1 -1
  183. package/build/module/query/listing/status.d.ts +2 -2
  184. package/build/module/query/listing/status.js +6 -2
  185. package/build/module/query/listing/status.js.map +1 -1
  186. package/build/module/query/tenant/feature-enabled.d.ts +6 -0
  187. package/build/module/query/tenant/feature-enabled.js +27 -0
  188. package/build/module/query/tenant/feature-enabled.js.map +1 -0
  189. package/build/module/query/tenant/index.d.ts +2 -0
  190. package/build/module/query/tenant/index.js +2 -0
  191. package/build/module/query/tenant/index.js.map +1 -1
  192. package/build/module/query/tenant/status.d.ts +1 -6
  193. package/build/module/query/tenant/status.js +4 -11
  194. package/build/module/query/tenant/status.js.map +1 -1
  195. package/build/module/query/tenant/where-uuid-in.d.ts +2 -0
  196. package/build/module/query/tenant/where-uuid-in.js +11 -0
  197. package/build/module/query/tenant/where-uuid-in.js.map +1 -0
  198. package/build/module/regional.d.ts +2 -1
  199. package/build/module/regional.js +1 -0
  200. package/build/module/regional.js.map +1 -1
  201. package/build/module/test/index.d.ts +7 -9
  202. package/build/module/test/index.js +11 -14
  203. package/build/module/test/index.js.map +1 -1
  204. package/build/module/v1.generated.d.ts +509 -70
  205. package/build/module/v1.generated.js.map +1 -1
  206. package/package.json +10 -8
@@ -6,6 +6,8 @@ import postgres from 'postgres';
6
6
  import { withControlPlaneSchema } from './control-plane';
7
7
  import { KyselyError } from './error';
8
8
  import { getKysely } from './plugins';
9
+ import { isPostgresError } from './postgres-error';
10
+ export * from './connect-handoff';
9
11
  export * from './error';
10
12
  export * from './isomorphic';
11
13
  export * from './postgres-error';
@@ -18,28 +20,207 @@ const retryableMessages = [
18
20
  'CONNECT_TIMEOUT',
19
21
  'Idle connection closed by Hyperdrive.',
20
22
  'server_login_retry',
23
+ 'Timed out while creating a new server connection.',
24
+ // Neon rejects the login before any statement runs (PRO-19169).
25
+ 'Failed to acquire permit to connect to the database',
21
26
  ];
22
27
  const postgresRetryAttempts = 3;
28
+ /**
29
+ * Parameter types PostgreSQL described per statement signature (PRO-18871).
30
+ * Postgres.js describes a statement in a round trip of its own before it can
31
+ * execute it when a parameter type is unknown, and a Worker request always
32
+ * starts on new connections. The patched driver reads and fills this map
33
+ * through its `statement_types` option and then parses, describes, binds and
34
+ * executes a known statement in one round trip. It forgets a statement's
35
+ * types when the statement fails, so a schema change is described again.
36
+ */
37
+ class StatementTypes extends Map {
38
+ set(signature, types) {
39
+ if (!this.has(signature) && this.size >= 2000) {
40
+ this.delete(this.keys().next().value);
41
+ }
42
+ return super.set(signature, types);
43
+ }
44
+ }
45
+ /**
46
+ * Named prepared statements one reserved Hyperdrive connection may hold (PRO-19814).
47
+ * Hyperdrive drops a connection that holds about 105: with a limit of 108 or more
48
+ * the paid payout move answered 503 on staging, with 104 or less it passed. A
49
+ * transaction pins its connection, so a statement past the limit runs unnamed
50
+ * there, without the cross-connection mismatch of PRO-17965; one already named
51
+ * stays named. The margin covers statements earlier reservations named on the
52
+ * same connection.
53
+ */
54
+ const hyperdriveNamedStatementLimit = 64;
55
+ /**
56
+ * Statement types and array types, kept for the isolate's lifetime per
57
+ * database: the control plane, and the regional database of each data region
58
+ * (`''` for the Worker's own). Enum type OIDs differ between databases.
59
+ *
60
+ * Array types map element type OIDs to their array type OIDs. Postgres.js looks
61
+ * them up on every new connection, an origin round trip each, about 100 ms
62
+ * from Frankfurt and 220 ms from Singapore to the control plane (PRO-19580).
63
+ * The first connection fills the map and later connections reuse it. A
64
+ * migration that adds an enum reaches an isolate when it restarts; until then
65
+ * arrays of that enum are neither parsed nor serialized.
66
+ */
67
+ const hyperdriveTypes = new Map();
23
68
  function isRetryableConnectionError(error) {
24
69
  const message = error instanceof Error ? error.message : String(error);
25
70
  return retryableMessages.some((retryable) => message.includes(retryable));
26
71
  }
72
+ function isNodeShuttingDown(error) {
73
+ return (error instanceof Error &&
74
+ (error.message === 'Node shutting down' ||
75
+ error.message === 'Node shutting down.' ||
76
+ error.message === 'shutting down'));
77
+ }
27
78
  function isConnectionReset(error) {
28
79
  return (error instanceof Error && 'code' in error && error.code === 'ECONNRESET');
29
80
  }
30
- function retryPostgres(operation, retry) {
31
- return backOff(operation, {
32
- numOfAttempts: postgresRetryAttempts,
33
- startingDelay: parseDuration('1s'),
34
- maxDelay: parseDuration('5s'),
35
- retry: (error, attemptNumber) => attemptNumber < postgresRetryAttempts && retry(error, attemptNumber),
36
- });
81
+ function isRetryableConnectionAcquisitionError(error) {
82
+ return (isRetryableConnectionError(error) ||
83
+ isConnectionReset(error) ||
84
+ // Hyperdrive refuses any new connection while its node shuts down
85
+ // (PRO-19168).
86
+ isNodeShuttingDown(error) ||
87
+ (error instanceof Error &&
88
+ (error.message === 'connection attempt failed' ||
89
+ // Opening a connection happens before any statement runs, so the
90
+ // open is safe to retry (PRO-18866).
91
+ error.message === 'Egress connection severed outside of Hyperdrive' ||
92
+ error.message === 'Network connection lost.' ||
93
+ ('code' in error && error.code === 'CONNECTION_DESTROYED'))));
94
+ }
95
+ /**
96
+ * Postgres.js closes a reserved connection when its socket dies, whether the
97
+ * statement in flight fails with `CONNECTION_CLOSED` or with the socket error.
98
+ * A statement sent to it afterwards is never answered: it throws in a timer
99
+ * callback or is silently never written (PRO-17710). A destroyed connection
100
+ * rejects at once, so it needs no guard.
101
+ */
102
+ function isConnectionClosed(error) {
103
+ return (isConnectionReset(error) ||
104
+ (error instanceof Error &&
105
+ 'code' in error &&
106
+ (error.code === 'CONNECTION_CLOSED' ||
107
+ error.code === 'EPIPE' ||
108
+ error.code === 'ETIMEDOUT')));
109
+ }
110
+ function isQueryRetryDiagnosticError(error) {
111
+ const message = error instanceof Error ? error.message : String(error);
112
+ return (isRetryableConnectionError(error) ||
113
+ isConnectionReset(error) ||
114
+ message === 'Egress connection severed outside of Hyperdrive' ||
115
+ message === 'Network connection lost.' ||
116
+ isNodeShuttingDown(error));
117
+ }
118
+ async function retryPostgres(operation, retry, diagnostic) {
119
+ let attemptCount = 0;
120
+ let retried = false;
121
+ let lastError;
122
+ const emitDiagnostic = (outcome) => {
123
+ if (!diagnostic)
124
+ return;
125
+ diagnostic.emit({
126
+ attemptCount,
127
+ dataRegion: diagnostic.dataRegion,
128
+ errorClass: lastError instanceof Error
129
+ ? 'code' in lastError && typeof lastError.code === 'string'
130
+ ? lastError.code
131
+ : lastError.constructor.name
132
+ : 'unknown',
133
+ operationKind: diagnostic.operationKind,
134
+ outcome,
135
+ repositoryName: diagnostic.repositoryName,
136
+ });
137
+ };
138
+ try {
139
+ return await backOff(async () => {
140
+ attemptCount++;
141
+ return await operation();
142
+ }, {
143
+ numOfAttempts: postgresRetryAttempts,
144
+ startingDelay: parseDuration('1s'),
145
+ maxDelay: parseDuration('5s'),
146
+ // Scheduled chunk fan-outs open many connections at once; full jitter
147
+ // keeps their retries from reconnecting in lockstep.
148
+ jitter: 'full',
149
+ async retry(error, attemptNumber) {
150
+ lastError = error;
151
+ const shouldRetry = attemptNumber < postgresRetryAttempts &&
152
+ (await retry(error, attemptNumber));
153
+ if (shouldRetry && diagnostic) {
154
+ retried = true;
155
+ emitDiagnostic('retrying');
156
+ }
157
+ return shouldRetry;
158
+ },
159
+ });
160
+ }
161
+ catch (error) {
162
+ lastError = error;
163
+ if (diagnostic?.shouldEmit(error)) {
164
+ emitDiagnostic(retried && attemptCount === postgresRetryAttempts
165
+ ? 'exhausted'
166
+ : 'notRetryable');
167
+ }
168
+ throw error;
169
+ }
170
+ }
171
+ /**
172
+ * Replays a complete database operation after a PostgreSQL deadlock (40P01)
173
+ * or lock timeout (55P03), using the same three-attempt jittered budget as
174
+ * connection retries. The operation must own its transaction and must not
175
+ * contain external side effects such as partner API writes.
176
+ */
177
+ export function retryPostgresLockFailure(operation) {
178
+ return retryPostgres(operation, (error) => isPostgresError(error, { code: '40P01' }) ||
179
+ isPostgresError(error, { code: '55P03' }));
180
+ }
181
+ /**
182
+ * Replays a complete database operation whose connection dropped mid-way, such as a Hyperdrive
183
+ * `CONNECTION_CLOSED`, with the same three-attempt jittered budget. The operation must own its
184
+ * transaction, be safe to replay after a commit whose response was lost, and keep external side
185
+ * effects after its commit.
186
+ */
187
+ export function retryPostgresConnectionLoss(operation) {
188
+ return retryPostgres(operation, (error) => isConnectionClosed(error) || isRetryableConnectionError(error));
37
189
  }
38
190
  class RetryingPostgresJSDialect extends PostgresJSDialect {
39
191
  config;
40
- constructor(config) {
192
+ retryDiagnostic;
193
+ closeOnScriptTimeout;
194
+ constructor(config, retryDiagnostic, closeOnScriptTimeout) {
41
195
  super(config);
42
196
  this.config = config;
197
+ this.retryDiagnostic = retryDiagnostic;
198
+ this.closeOnScriptTimeout = closeOnScriptTimeout;
199
+ }
200
+ /** Ends the run when a script's database operation gets no answer (PRO-19037). */
201
+ async withScriptDeadline(operation) {
202
+ if (!this.closeOnScriptTimeout)
203
+ return await operation();
204
+ let timer;
205
+ try {
206
+ return await Promise.race([
207
+ operation(),
208
+ new Promise((_, reject) => {
209
+ timer = setTimeout(() => {
210
+ console.error('Postgres operation timed out', {
211
+ timeoutMs: scriptQueryTimeoutMs,
212
+ });
213
+ this.closeOnScriptTimeout?.();
214
+ reject(new KyselyError('Postgres operation timed out', {
215
+ timeoutMs: scriptQueryTimeoutMs,
216
+ }));
217
+ }, scriptQueryTimeoutMs);
218
+ }),
219
+ ]);
220
+ }
221
+ finally {
222
+ clearTimeout(timer);
223
+ }
43
224
  }
44
225
  createDriver() {
45
226
  const driver = new PostgresJSDriver(this.config);
@@ -58,22 +239,46 @@ class RetryingPostgresJSDialect extends PostgresJSDialect {
58
239
  inTransaction: false,
59
240
  };
60
241
  const connection = {
61
- executeQuery: (compiledQuery) => retryPostgres(() => state.connection.executeQuery(compiledQuery), async (error) => {
62
- const message = error instanceof Error ? error.message : String(error);
63
- if (state.inTransaction ||
64
- (!isRetryableConnectionError(error) &&
65
- (compiledQuery.query.kind !== 'SelectQueryNode' ||
66
- (!isConnectionReset(error) &&
67
- message !==
68
- 'Egress connection severed outside of Hyperdrive' &&
69
- message !== 'Network connection lost.' &&
70
- message !== 'Node shutting down')))) {
71
- return false;
72
- }
73
- // Postgres.js already ejects a severed reserved connection.
74
- // Acquire a new reservation before replaying the safe read.
75
- state.connection = await driver.acquireConnection();
76
- return true;
242
+ executeQuery: (compiledQuery) => this.withScriptDeadline(() => {
243
+ const operationKind = state.inTransaction
244
+ ? 'transaction'
245
+ : compiledQuery.query.kind === 'SelectQueryNode'
246
+ ? 'select'
247
+ : 'mutation';
248
+ return retryPostgres(() => {
249
+ if (state.lost)
250
+ return Promise.reject(state.lost);
251
+ return state.connection
252
+ .executeQuery(compiledQuery)
253
+ .catch((error) => {
254
+ if (isConnectionClosed(error))
255
+ state.lost = error;
256
+ throw error;
257
+ });
258
+ }, async (error) => {
259
+ const message = error instanceof Error ? error.message : String(error);
260
+ if (state.inTransaction ||
261
+ (!isRetryableConnectionError(error) &&
262
+ (compiledQuery.query.kind !== 'SelectQueryNode' ||
263
+ (!isConnectionReset(error) &&
264
+ message !==
265
+ 'Egress connection severed outside of Hyperdrive' &&
266
+ message !== 'Network connection lost.' &&
267
+ !isNodeShuttingDown(error))))) {
268
+ return false;
269
+ }
270
+ // Postgres.js already ejects a severed reserved connection.
271
+ // Acquire a new reservation before replaying the safe read.
272
+ state.connection = await driver.acquireConnection();
273
+ state.lost = undefined;
274
+ return true;
275
+ }, this.retryDiagnostic
276
+ ? {
277
+ ...this.retryDiagnostic,
278
+ operationKind,
279
+ shouldEmit: isQueryRetryDiagnosticError,
280
+ }
281
+ : undefined);
77
282
  }),
78
283
  streamQuery: (compiledQuery, chunkSize) => {
79
284
  if (chunkSize === undefined) {
@@ -89,17 +294,21 @@ class RetryingPostgresJSDialect extends PostgresJSDialect {
89
294
  const state = getConnection(connection);
90
295
  state.inTransaction = true;
91
296
  try {
92
- await driver.beginTransaction(state.connection, settings);
297
+ await this.withScriptDeadline(() => driver.beginTransaction(state.connection, settings));
93
298
  }
94
299
  catch (error) {
95
300
  state.inTransaction = false;
301
+ if (isConnectionClosed(error))
302
+ state.lost = error;
96
303
  throw error;
97
304
  }
98
305
  },
99
306
  commitTransaction: async (connection) => {
100
307
  const state = getConnection(connection);
101
308
  try {
102
- await driver.commitTransaction(state.connection);
309
+ if (state.lost)
310
+ throw state.lost;
311
+ await this.withScriptDeadline(() => driver.commitTransaction(state.connection));
103
312
  }
104
313
  finally {
105
314
  state.inTransaction = false;
@@ -108,18 +317,44 @@ class RetryingPostgresJSDialect extends PostgresJSDialect {
108
317
  rollbackTransaction: async (connection) => {
109
318
  const state = getConnection(connection);
110
319
  try {
111
- await driver.rollbackTransaction(state.connection);
320
+ // PostgreSQL rolls the transaction back when its session ends, and a
321
+ // statement on the closed connection would never be answered.
322
+ if (state.lost)
323
+ return;
324
+ await this.withScriptDeadline(() => driver.rollbackTransaction(state.connection));
112
325
  }
113
326
  finally {
114
327
  state.inTransaction = false;
115
328
  }
116
329
  },
117
- savepoint: (connection, savepointName, compileQuery) => driver.savepoint(getConnection(connection).connection, savepointName, compileQuery),
118
- rollbackToSavepoint: (connection, savepointName, compileQuery) => driver.rollbackToSavepoint(getConnection(connection).connection, savepointName, compileQuery),
119
- releaseSavepoint: (connection, savepointName, compileQuery) => driver.releaseSavepoint(getConnection(connection).connection, savepointName, compileQuery),
330
+ savepoint: (connection, savepointName, compileQuery) => this.withScriptDeadline(() => {
331
+ const state = getConnection(connection);
332
+ if (state.lost)
333
+ throw state.lost;
334
+ return driver.savepoint(state.connection, savepointName, compileQuery);
335
+ }),
336
+ rollbackToSavepoint: (connection, savepointName, compileQuery) => this.withScriptDeadline(() => {
337
+ const state = getConnection(connection);
338
+ if (state.lost)
339
+ throw state.lost;
340
+ return driver.rollbackToSavepoint(state.connection, savepointName, compileQuery);
341
+ }),
342
+ releaseSavepoint: (connection, savepointName, compileQuery) => this.withScriptDeadline(() => {
343
+ const state = getConnection(connection);
344
+ if (state.lost)
345
+ throw state.lost;
346
+ return driver.releaseSavepoint(state.connection, savepointName, compileQuery);
347
+ }),
120
348
  releaseConnection: async (connection) => {
121
- await driver.releaseConnection(getConnection(connection).connection);
349
+ const state = getConnection(connection);
122
350
  connections.delete(connection);
351
+ // Releasing a closed connection would put it back in the open pool,
352
+ // and the next statement on it would hang. Postgres.js reconnects
353
+ // from the closed pool on demand, and a failed reconnect is a
354
+ // retryable CONNECT_TIMEOUT.
355
+ if (state.lost)
356
+ return;
357
+ await driver.releaseConnection(state.connection);
123
358
  },
124
359
  destroy: () => driver.destroy(),
125
360
  };
@@ -127,19 +362,44 @@ class RetryingPostgresJSDialect extends PostgresJSDialect {
127
362
  }
128
363
  export function useKysely(postgres, options) {
129
364
  console.debug('Creating Kysely instance');
365
+ const emitRetryDiagnostic = options?.onRetryDiagnostic ??
366
+ (options?.repositoryName
367
+ ? (diagnostic) => console.warn('Postgres operation retry diagnostic', diagnostic)
368
+ : undefined);
130
369
  const reserveConnection = postgres.reserve.bind(postgres);
131
370
  postgres.reserve = async () => {
132
- const connection = await retryPostgres(reserveConnection, (error) => isRetryableConnectionError(error) ||
133
- isConnectionReset(error) ||
134
- (error instanceof Error &&
135
- error.message === 'connection attempt failed'));
371
+ const connection = await retryPostgres(reserveConnection, isRetryableConnectionAcquisitionError, emitRetryDiagnostic
372
+ ? {
373
+ dataRegion: options?.dataRegion,
374
+ emit: emitRetryDiagnostic,
375
+ operationKind: 'acquisition',
376
+ repositoryName: options?.repositoryName,
377
+ shouldEmit: isRetryableConnectionAcquisitionError,
378
+ }
379
+ : undefined);
136
380
  if (options?.hyperdrive) {
137
381
  const unsafe = connection.unsafe;
138
- connection.unsafe = (query, parameters, queryOptions) => unsafe(query, parameters, { ...queryOptions, prepare: true });
382
+ const named = new Set();
383
+ connection.unsafe = (query, parameters, queryOptions) => {
384
+ // A statement past the limit runs unnamed; one already named stays named.
385
+ const prepare = named.has(query) || named.size < hyperdriveNamedStatementLimit;
386
+ if (prepare)
387
+ named.add(query);
388
+ return unsafe(query, parameters, { ...queryOptions, prepare });
389
+ };
139
390
  }
140
391
  return connection;
141
392
  };
142
- const kysely = getKysely(new RetryingPostgresJSDialect({ postgres }), {
393
+ const kysely = getKysely(new RetryingPostgresJSDialect({ postgres }, emitRetryDiagnostic
394
+ ? {
395
+ dataRegion: options?.dataRegion,
396
+ emit: emitRetryDiagnostic,
397
+ repositoryName: options?.repositoryName,
398
+ shouldEmit: isQueryRetryDiagnosticError,
399
+ }
400
+ : undefined, options?.script
401
+ ? () => void postgres.end({ timeout: 0 }).catch(() => undefined)
402
+ : undefined), {
143
403
  repositoryName: options?.repositoryName,
144
404
  log: options?.log,
145
405
  });
@@ -152,46 +412,103 @@ export function useKysely(postgres, options) {
152
412
  };
153
413
  return kysely;
154
414
  }
415
+ const scriptQueryTimeoutMs = parseDuration('1h');
155
416
  let _connections = [];
417
+ export function usePostgres(connectionString, opt) {
418
+ const ssl = opt?.forceDisableSSL !== true && !opt?.hyperdrive;
419
+ const typesKey = opt?.hyperdrive === 'regional'
420
+ ? `regional/${opt.dataRegion ?? ''}`
421
+ : opt?.hyperdrive;
422
+ let types = typesKey ? hyperdriveTypes.get(typesKey) : undefined;
423
+ if (typesKey && !types) {
424
+ types = { arrays: new Map(), statements: new StatementTypes() };
425
+ hyperdriveTypes.set(typesKey, types);
426
+ }
427
+ const sql = postgres(connectionString, {
428
+ ssl: ssl ? 'require' : false,
429
+ // Named prepared statements: PRO-17965 (Hyperdrive and Crunchy PgBouncer).
430
+ prepare: true,
431
+ ...(opt?.hyperdrive && types
432
+ ? {
433
+ max: 5,
434
+ // Retire idle clients before Hyperdrive can close them asynchronously.
435
+ idle_timeout: 10,
436
+ statement_types: types.statements,
437
+ array_types: types.arrays,
438
+ // PRO-19758: Hyperdrive forwards this name to the origin. A
439
+ // constant, because Hyperdrive pools origin connections across
440
+ // requests, so a route name would be wrong.
441
+ connection: { application_name: `hyperdrive/${opt.hyperdrive}` },
442
+ // No read-write check (PRO-17156): Hyperdrive pools by transaction,
443
+ // so it covered one origin connection, not the ones later statements
444
+ // run on, and cost an origin round trip per connection (PRO-19580).
445
+ }
446
+ : {
447
+ ...(opt?.max ? { max: opt.max } : {}),
448
+ target_session_attrs: 'read-write',
449
+ connect_timeout: 10,
450
+ idle_timeout: 60,
451
+ // PRO-19758: pg_stat_activity shows which client holds a direct
452
+ // connection.
453
+ ...(opt?.repositoryName
454
+ ? {
455
+ connection: {
456
+ application_name: `${opt.script ? 'script:' : ''}${opt.repositoryName}`.slice(0, 63),
457
+ },
458
+ }
459
+ : {}),
460
+ ...(opt?.script ? { keep_alive: 10 } : {}),
461
+ }),
462
+ });
463
+ if (opt?.onReserve) {
464
+ const { onReserve } = opt;
465
+ const reserve = sql.reserve.bind(sql);
466
+ // Innermost wrapper: it times each open or reuse of a connection, the
467
+ // startup probe too, and is not part of the retry loop (PRO-18952).
468
+ sql.reserve = async () => {
469
+ const startedAtEpochMs = Date.now();
470
+ const startedAt = performance.now();
471
+ try {
472
+ return await reserve();
473
+ }
474
+ finally {
475
+ onReserve({
476
+ durationMs: performance.now() - startedAt,
477
+ startedAtEpochMs,
478
+ });
479
+ }
480
+ };
481
+ }
482
+ // statement_timeout/lock_timeout are role-level settings on the cluster
483
+ // (ALTER ROLE application SET ...) so they cover every pooled
484
+ // connection; per-session SETs here only ever applied to one of them
485
+ _connections.push(sql);
486
+ return sql;
487
+ }
156
488
  export async function useAsyncPostgres(connectionString, opt) {
157
489
  const delayMs = 2500;
158
490
  const probe = opt?.probe === true;
159
491
  const retries = probe ? (opt?.retries === false ? 0 : opt?.retries || 3) : 1;
160
- const ssl = opt?.forceDisableSSL !== true && opt?.hyperdrive !== true;
161
492
  const url = new URL(connectionString);
162
- console.debug(`Creating Postgres connection with probe=${probe}, ${retries} attempts, ssl=${ssl}, and port=${url.port}`);
493
+ console.debug(`Creating Postgres connection with probe=${probe}, ${retries} attempts, ssl=${opt?.forceDisableSSL !== true && !opt?.hyperdrive}, and port=${url.port}`);
163
494
  if (_connections.length > 0)
164
495
  console.warn(`We already have ${_connections.length} Postgres connections`);
165
496
  for (let attempt = 1; attempt <= retries; attempt++) {
166
497
  let sql;
167
498
  try {
168
- sql = postgres(connectionString, {
169
- ssl: ssl ? 'require' : false,
170
- target_session_attrs: 'read-write',
171
- // enable prepare statements, pgbouncer on crunchy allows for prepared statements
172
- prepare: true,
173
- ...(opt?.hyperdrive
174
- ? {
175
- max: 5,
176
- // Retire idle clients before Hyperdrive can close them asynchronously.
177
- idle_timeout: 10,
178
- }
179
- : {
180
- connect_timeout: 10,
181
- idle_timeout: 60,
182
- }),
183
- });
499
+ sql = usePostgres(connectionString, opt);
184
500
  if (probe) {
185
- await sql `select 1`;
501
+ // Opening a direct connection already checks that the session is
502
+ // writable; a probe query would add a round trip.
503
+ (await sql.reserve()).release();
186
504
  }
187
- // statement_timeout/lock_timeout are role-level settings on the cluster
188
- // (ALTER ROLE application SET ...) so they cover every pooled
189
- // connection; per-session SETs here only ever applied to one of them
190
- _connections.push(sql);
191
505
  return sql;
192
506
  }
193
507
  catch (err) {
194
- await sql?.end({ timeout: 0 }).catch(() => undefined);
508
+ if (sql) {
509
+ await sql.end({ timeout: 0 }).catch(() => undefined);
510
+ _connections.splice(_connections.indexOf(sql), 1);
511
+ }
195
512
  if (attempt === retries)
196
513
  throw err;
197
514
  console.warn(`Postgres connection failed (attempt ${attempt}), retrying...`);
@@ -216,9 +533,16 @@ export async function useAsyncNeonWebSocketKysely(connectionString, opt) {
216
533
  await pool.query('select 1');
217
534
  return kysely;
218
535
  }
536
+ export function useControlPlaneKysely(postgres, options) {
537
+ const kysely = useKysely(postgres, options);
538
+ const controlPlaneKysely = withControlPlaneSchema(kysely, 'public');
539
+ // `withPlugin` returns a new instance without the `destroy` that removes
540
+ // this client from `_connections` (PRO-20691).
541
+ controlPlaneKysely.destroy = kysely.destroy;
542
+ return controlPlaneKysely;
543
+ }
219
544
  export async function useAsyncControlPlaneKysely(connectionString, opt) {
220
- const sql = await useAsyncPostgres(connectionString, opt);
221
- return withControlPlaneSchema(useKysely(sql, opt), 'public');
545
+ return useControlPlaneKysely(await useAsyncPostgres(connectionString, opt), opt);
222
546
  }
223
547
  export async function forceCloseAllPostgres(timeoutMs = 5000) {
224
548
  await Promise.race([