pi-cursor-sdk 0.1.47 → 0.1.49
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.
- package/CHANGELOG.md +17 -0
- package/README.md +2 -2
- package/node_modules/@connectrpc/connect-node/README.md +141 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/compression.d.ts +15 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/compression.js +89 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/connect-node-adapter.d.ts +42 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/connect-node-adapter.js +61 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/connect-transport.d.ts +100 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/connect-transport.js +25 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-transport.d.ts +96 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-transport.js +25 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-web-transport.d.ts +96 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-web-transport.js +25 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/http2-session-manager.d.ts +146 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/http2-session-manager.js +536 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/index.d.ts +15 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/index.js +36 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-error.d.ts +45 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-error.js +154 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-headers-polyfill.d.ts +1 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-headers-polyfill.js +29 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-transport-options.d.ts +89 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-transport-options.js +58 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-client.d.ts +54 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-client.js +326 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-handler.d.ts +41 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-handler.js +234 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-header.d.ts +19 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-header.js +97 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/package.json +1 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/compression.d.ts +15 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/compression.js +86 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/connect-node-adapter.d.ts +42 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/connect-node-adapter.js +58 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/connect-transport.d.ts +100 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/connect-transport.js +22 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/grpc-transport.d.ts +96 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/grpc-transport.js +22 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/grpc-web-transport.d.ts +96 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/grpc-web-transport.js +22 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/http2-session-manager.d.ts +146 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/http2-session-manager.js +532 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/index.d.ts +15 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/index.js +23 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-error.d.ts +45 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-error.js +147 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-headers-polyfill.d.ts +1 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-headers-polyfill.js +27 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-transport-options.d.ts +89 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-transport-options.js +58 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-client.d.ts +54 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-client.js +324 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-handler.d.ts +41 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-handler.js +230 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-header.d.ts +19 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-header.js +93 -0
- package/node_modules/@connectrpc/connect-node/package.json +46 -0
- package/node_modules/undici/LICENSE +21 -0
- package/node_modules/undici/README.md +741 -0
- package/node_modules/undici/docs/docs/api/Agent.md +84 -0
- package/node_modules/undici/docs/docs/api/BalancedPool.md +99 -0
- package/node_modules/undici/docs/docs/api/CacheStorage.md +30 -0
- package/node_modules/undici/docs/docs/api/CacheStore.md +164 -0
- package/node_modules/undici/docs/docs/api/Client.md +288 -0
- package/node_modules/undici/docs/docs/api/ClientStats.md +27 -0
- package/node_modules/undici/docs/docs/api/Connector.md +115 -0
- package/node_modules/undici/docs/docs/api/ContentType.md +57 -0
- package/node_modules/undici/docs/docs/api/Cookies.md +128 -0
- package/node_modules/undici/docs/docs/api/Debug.md +62 -0
- package/node_modules/undici/docs/docs/api/DiagnosticsChannel.md +315 -0
- package/node_modules/undici/docs/docs/api/Dispatcher.md +1392 -0
- package/node_modules/undici/docs/docs/api/EnvHttpProxyAgent.md +159 -0
- package/node_modules/undici/docs/docs/api/Errors.md +49 -0
- package/node_modules/undici/docs/docs/api/EventSource.md +45 -0
- package/node_modules/undici/docs/docs/api/Fetch.md +60 -0
- package/node_modules/undici/docs/docs/api/GlobalInstallation.md +139 -0
- package/node_modules/undici/docs/docs/api/H2CClient.md +263 -0
- package/node_modules/undici/docs/docs/api/MockAgent.md +603 -0
- package/node_modules/undici/docs/docs/api/MockCallHistory.md +197 -0
- package/node_modules/undici/docs/docs/api/MockCallHistoryLog.md +43 -0
- package/node_modules/undici/docs/docs/api/MockClient.md +81 -0
- package/node_modules/undici/docs/docs/api/MockErrors.md +12 -0
- package/node_modules/undici/docs/docs/api/MockPool.md +555 -0
- package/node_modules/undici/docs/docs/api/Pool.md +84 -0
- package/node_modules/undici/docs/docs/api/PoolStats.md +35 -0
- package/node_modules/undici/docs/docs/api/ProxyAgent.md +229 -0
- package/node_modules/undici/docs/docs/api/RedirectHandler.md +93 -0
- package/node_modules/undici/docs/docs/api/RetryAgent.md +50 -0
- package/node_modules/undici/docs/docs/api/RetryHandler.md +118 -0
- package/node_modules/undici/docs/docs/api/RoundRobinPool.md +145 -0
- package/node_modules/undici/docs/docs/api/SnapshotAgent.md +616 -0
- package/node_modules/undici/docs/docs/api/Socks5ProxyAgent.md +275 -0
- package/node_modules/undici/docs/docs/api/Util.md +25 -0
- package/node_modules/undici/docs/docs/api/WebSocket.md +141 -0
- package/node_modules/undici/docs/docs/api/api-lifecycle.md +91 -0
- package/node_modules/undici/docs/docs/best-practices/client-certificate.md +64 -0
- package/node_modules/undici/docs/docs/best-practices/crawling.md +58 -0
- package/node_modules/undici/docs/docs/best-practices/mocking-request.md +190 -0
- package/node_modules/undici/docs/docs/best-practices/proxy.md +127 -0
- package/node_modules/undici/docs/docs/best-practices/undici-vs-builtin-fetch.md +224 -0
- package/node_modules/undici/docs/docs/best-practices/writing-tests.md +63 -0
- package/node_modules/undici/index-fetch.js +65 -0
- package/node_modules/undici/index.d.ts +3 -0
- package/node_modules/undici/index.js +234 -0
- package/node_modules/undici/lib/api/abort-signal.js +59 -0
- package/node_modules/undici/lib/api/api-connect.js +110 -0
- package/node_modules/undici/lib/api/api-pipeline.js +252 -0
- package/node_modules/undici/lib/api/api-request.js +214 -0
- package/node_modules/undici/lib/api/api-stream.js +209 -0
- package/node_modules/undici/lib/api/api-upgrade.js +111 -0
- package/node_modules/undici/lib/api/index.js +7 -0
- package/node_modules/undici/lib/api/readable.js +580 -0
- package/node_modules/undici/lib/cache/memory-cache-store.js +234 -0
- package/node_modules/undici/lib/cache/sqlite-cache-store.js +461 -0
- package/node_modules/undici/lib/core/connect.js +153 -0
- package/node_modules/undici/lib/core/constants.js +143 -0
- package/node_modules/undici/lib/core/diagnostics.js +227 -0
- package/node_modules/undici/lib/core/errors.js +477 -0
- package/node_modules/undici/lib/core/request.js +453 -0
- package/node_modules/undici/lib/core/socks5-client.js +422 -0
- package/node_modules/undici/lib/core/socks5-utils.js +212 -0
- package/node_modules/undici/lib/core/symbols.js +75 -0
- package/node_modules/undici/lib/core/tree.js +160 -0
- package/node_modules/undici/lib/core/util.js +992 -0
- package/node_modules/undici/lib/dispatcher/agent.js +158 -0
- package/node_modules/undici/lib/dispatcher/balanced-pool.js +219 -0
- package/node_modules/undici/lib/dispatcher/client-h1.js +1722 -0
- package/node_modules/undici/lib/dispatcher/client-h2.js +995 -0
- package/node_modules/undici/lib/dispatcher/client.js +664 -0
- package/node_modules/undici/lib/dispatcher/dispatcher-base.js +184 -0
- package/node_modules/undici/lib/dispatcher/dispatcher.js +48 -0
- package/node_modules/undici/lib/dispatcher/env-http-proxy-agent.js +146 -0
- package/node_modules/undici/lib/dispatcher/fixed-queue.js +135 -0
- package/node_modules/undici/lib/dispatcher/h2c-client.js +51 -0
- package/node_modules/undici/lib/dispatcher/pool-base.js +214 -0
- package/node_modules/undici/lib/dispatcher/pool.js +118 -0
- package/node_modules/undici/lib/dispatcher/proxy-agent.js +319 -0
- package/node_modules/undici/lib/dispatcher/retry-agent.js +35 -0
- package/node_modules/undici/lib/dispatcher/round-robin-pool.js +137 -0
- package/node_modules/undici/lib/dispatcher/socks5-proxy-agent.js +260 -0
- package/node_modules/undici/lib/encoding/index.js +33 -0
- package/node_modules/undici/lib/global.js +59 -0
- package/node_modules/undici/lib/handler/cache-handler.js +578 -0
- package/node_modules/undici/lib/handler/cache-revalidation-handler.js +124 -0
- package/node_modules/undici/lib/handler/decorator-handler.js +67 -0
- package/node_modules/undici/lib/handler/deduplication-handler.js +460 -0
- package/node_modules/undici/lib/handler/redirect-handler.js +238 -0
- package/node_modules/undici/lib/handler/retry-handler.js +394 -0
- package/node_modules/undici/lib/handler/unwrap-handler.js +106 -0
- package/node_modules/undici/lib/handler/wrap-handler.js +105 -0
- package/node_modules/undici/lib/interceptor/cache.js +495 -0
- package/node_modules/undici/lib/interceptor/decompress.js +259 -0
- package/node_modules/undici/lib/interceptor/deduplicate.js +117 -0
- package/node_modules/undici/lib/interceptor/dns.js +571 -0
- package/node_modules/undici/lib/interceptor/dump.js +112 -0
- package/node_modules/undici/lib/interceptor/redirect.js +21 -0
- package/node_modules/undici/lib/interceptor/response-error.js +95 -0
- package/node_modules/undici/lib/interceptor/retry.js +19 -0
- package/node_modules/undici/lib/llhttp/.gitkeep +0 -0
- package/node_modules/undici/lib/llhttp/constants.d.ts +195 -0
- package/node_modules/undici/lib/llhttp/constants.js +531 -0
- package/node_modules/undici/lib/llhttp/llhttp-wasm.js +15 -0
- package/node_modules/undici/lib/llhttp/llhttp_simd-wasm.js +15 -0
- package/node_modules/undici/lib/llhttp/utils.d.ts +2 -0
- package/node_modules/undici/lib/llhttp/utils.js +12 -0
- package/node_modules/undici/lib/mock/mock-agent.js +232 -0
- package/node_modules/undici/lib/mock/mock-call-history.js +248 -0
- package/node_modules/undici/lib/mock/mock-client.js +68 -0
- package/node_modules/undici/lib/mock/mock-errors.js +29 -0
- package/node_modules/undici/lib/mock/mock-interceptor.js +209 -0
- package/node_modules/undici/lib/mock/mock-pool.js +68 -0
- package/node_modules/undici/lib/mock/mock-symbols.js +32 -0
- package/node_modules/undici/lib/mock/mock-utils.js +486 -0
- package/node_modules/undici/lib/mock/pending-interceptors-formatter.js +43 -0
- package/node_modules/undici/lib/mock/snapshot-agent.js +353 -0
- package/node_modules/undici/lib/mock/snapshot-recorder.js +588 -0
- package/node_modules/undici/lib/mock/snapshot-utils.js +158 -0
- package/node_modules/undici/lib/util/cache.js +414 -0
- package/node_modules/undici/lib/util/date.js +653 -0
- package/node_modules/undici/lib/util/promise.js +28 -0
- package/node_modules/undici/lib/util/runtime-features.js +124 -0
- package/node_modules/undici/lib/util/stats.js +32 -0
- package/node_modules/undici/lib/util/timers.js +425 -0
- package/node_modules/undici/lib/web/cache/cache.js +864 -0
- package/node_modules/undici/lib/web/cache/cachestorage.js +152 -0
- package/node_modules/undici/lib/web/cache/util.js +45 -0
- package/node_modules/undici/lib/web/cookies/constants.js +12 -0
- package/node_modules/undici/lib/web/cookies/index.js +199 -0
- package/node_modules/undici/lib/web/cookies/parse.js +314 -0
- package/node_modules/undici/lib/web/cookies/util.js +282 -0
- package/node_modules/undici/lib/web/eventsource/eventsource-stream.js +399 -0
- package/node_modules/undici/lib/web/eventsource/eventsource.js +501 -0
- package/node_modules/undici/lib/web/eventsource/util.js +29 -0
- package/node_modules/undici/lib/web/fetch/LICENSE +21 -0
- package/node_modules/undici/lib/web/fetch/body.js +509 -0
- package/node_modules/undici/lib/web/fetch/constants.js +131 -0
- package/node_modules/undici/lib/web/fetch/data-url.js +596 -0
- package/node_modules/undici/lib/web/fetch/formdata-parser.js +586 -0
- package/node_modules/undici/lib/web/fetch/formdata.js +259 -0
- package/node_modules/undici/lib/web/fetch/global.js +40 -0
- package/node_modules/undici/lib/web/fetch/headers.js +719 -0
- package/node_modules/undici/lib/web/fetch/index.js +2413 -0
- package/node_modules/undici/lib/web/fetch/request.js +1115 -0
- package/node_modules/undici/lib/web/fetch/response.js +641 -0
- package/node_modules/undici/lib/web/fetch/util.js +1522 -0
- package/node_modules/undici/lib/web/infra/index.js +229 -0
- package/node_modules/undici/lib/web/subresource-integrity/Readme.md +9 -0
- package/node_modules/undici/lib/web/subresource-integrity/subresource-integrity.js +307 -0
- package/node_modules/undici/lib/web/webidl/index.js +1006 -0
- package/node_modules/undici/lib/web/websocket/connection.js +329 -0
- package/node_modules/undici/lib/web/websocket/constants.js +126 -0
- package/node_modules/undici/lib/web/websocket/events.js +331 -0
- package/node_modules/undici/lib/web/websocket/frame.js +133 -0
- package/node_modules/undici/lib/web/websocket/permessage-deflate.js +100 -0
- package/node_modules/undici/lib/web/websocket/receiver.js +507 -0
- package/node_modules/undici/lib/web/websocket/sender.js +109 -0
- package/node_modules/undici/lib/web/websocket/stream/websocketerror.js +104 -0
- package/node_modules/undici/lib/web/websocket/stream/websocketstream.js +498 -0
- package/node_modules/undici/lib/web/websocket/util.js +347 -0
- package/node_modules/undici/lib/web/websocket/websocket.js +758 -0
- package/node_modules/undici/package.json +152 -0
- package/node_modules/undici/scripts/strip-comments.js +10 -0
- package/node_modules/undici/types/README.md +6 -0
- package/node_modules/undici/types/agent.d.ts +32 -0
- package/node_modules/undici/types/api.d.ts +43 -0
- package/node_modules/undici/types/balanced-pool.d.ts +30 -0
- package/node_modules/undici/types/cache-interceptor.d.ts +179 -0
- package/node_modules/undici/types/cache.d.ts +36 -0
- package/node_modules/undici/types/client-stats.d.ts +15 -0
- package/node_modules/undici/types/client.d.ts +139 -0
- package/node_modules/undici/types/connector.d.ts +36 -0
- package/node_modules/undici/types/content-type.d.ts +21 -0
- package/node_modules/undici/types/cookies.d.ts +30 -0
- package/node_modules/undici/types/diagnostics-channel.d.ts +74 -0
- package/node_modules/undici/types/dispatcher.d.ts +275 -0
- package/node_modules/undici/types/env-http-proxy-agent.d.ts +22 -0
- package/node_modules/undici/types/errors.d.ts +177 -0
- package/node_modules/undici/types/eventsource.d.ts +66 -0
- package/node_modules/undici/types/fetch.d.ts +231 -0
- package/node_modules/undici/types/formdata.d.ts +114 -0
- package/node_modules/undici/types/global-dispatcher.d.ts +9 -0
- package/node_modules/undici/types/global-origin.d.ts +7 -0
- package/node_modules/undici/types/h2c-client.d.ts +73 -0
- package/node_modules/undici/types/handlers.d.ts +14 -0
- package/node_modules/undici/types/header.d.ts +160 -0
- package/node_modules/undici/types/index.d.ts +91 -0
- package/node_modules/undici/types/interceptors.d.ts +80 -0
- package/node_modules/undici/types/mock-agent.d.ts +68 -0
- package/node_modules/undici/types/mock-call-history.d.ts +111 -0
- package/node_modules/undici/types/mock-client.d.ts +27 -0
- package/node_modules/undici/types/mock-errors.d.ts +12 -0
- package/node_modules/undici/types/mock-interceptor.d.ts +94 -0
- package/node_modules/undici/types/mock-pool.d.ts +27 -0
- package/node_modules/undici/types/patch.d.ts +29 -0
- package/node_modules/undici/types/pool-stats.d.ts +19 -0
- package/node_modules/undici/types/pool.d.ts +41 -0
- package/node_modules/undici/types/proxy-agent.d.ts +29 -0
- package/node_modules/undici/types/readable.d.ts +68 -0
- package/node_modules/undici/types/retry-agent.d.ts +8 -0
- package/node_modules/undici/types/retry-handler.d.ts +125 -0
- package/node_modules/undici/types/round-robin-pool.d.ts +41 -0
- package/node_modules/undici/types/snapshot-agent.d.ts +109 -0
- package/node_modules/undici/types/socks5-proxy-agent.d.ts +25 -0
- package/node_modules/undici/types/util.d.ts +18 -0
- package/node_modules/undici/types/utility.d.ts +7 -0
- package/node_modules/undici/types/webidl.d.ts +347 -0
- package/node_modules/undici/types/websocket.d.ts +188 -0
- package/package.json +161 -156
- package/src/context.ts +1 -1
- package/src/cursor-context-tools.ts +1 -1
- package/src/cursor-live-run-accounting.ts +1 -1
- package/src/cursor-live-run-coordinator.ts +1 -1
- package/src/cursor-native-replay-routing.ts +1 -1
- package/src/cursor-partial-content-emitter.ts +1 -1
- package/src/cursor-pi-tool-bridge-mcp.ts +1 -1
- package/src/cursor-pi-tool-bridge-run.ts +1 -1
- package/src/cursor-pi-tool-bridge-types.ts +1 -1
- package/src/cursor-provider-lazy.ts +1 -1
- package/src/cursor-provider-live-run-drain.ts +1 -1
- package/src/cursor-provider-run-finalizer.ts +1 -1
- package/src/cursor-provider-turn-coordinator.ts +1 -1
- package/src/cursor-provider-turn-lifecycle-emitter.ts +1 -1
- package/src/cursor-provider-turn-prepare.ts +1 -1
- package/src/cursor-provider-turn-types.ts +1 -1
- package/src/cursor-provider.ts +1 -1
- package/src/cursor-run-final-text.ts +1 -1
- package/src/cursor-sdk-event-debug.ts +1 -1
- package/src/cursor-session-agent.ts +1 -1
- package/src/cursor-session-send-policy.ts +1 -1
- package/src/cursor-usage-accounting.ts +1 -1
- package/src/model-discovery.ts +1 -1
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import * as http2 from "http2";
|
|
2
|
+
export interface Http2SessionOptions {
|
|
3
|
+
/**
|
|
4
|
+
* The interval to send PING frames to keep a connection alive. The interval
|
|
5
|
+
* is reset whenever a stream receives data. If a PING frame is not responded
|
|
6
|
+
* to within pingTimeoutMs, the connection and all open streams close.
|
|
7
|
+
*
|
|
8
|
+
* By default, no PING frames are sent. If a value is provided, PING frames
|
|
9
|
+
* are sent only for connections that have open streams, unless
|
|
10
|
+
* pingIdleConnections is enabled.
|
|
11
|
+
*
|
|
12
|
+
* Sensible values can be between 10 seconds and 2 hours, depending on your
|
|
13
|
+
* infrastructure.
|
|
14
|
+
*
|
|
15
|
+
* This option is equivalent to GRPC_ARG_KEEPALIVE_TIME_MS in gRPC Core.
|
|
16
|
+
*/
|
|
17
|
+
pingIntervalMs?: number;
|
|
18
|
+
/**
|
|
19
|
+
* Enable PING frames for connections that are have no open streams.
|
|
20
|
+
* This option is only effective if a value for pingIntervalMs is provided.
|
|
21
|
+
*
|
|
22
|
+
* Note that it may not be necessary to enable this option. If a request is
|
|
23
|
+
* made on a connection that has not been used for longer than pingIntervalMs,
|
|
24
|
+
* a PING frame is sent to verify that the connection is still alive, and a
|
|
25
|
+
* new connection is opened transparently if necessary.
|
|
26
|
+
*
|
|
27
|
+
* Defaults to false.
|
|
28
|
+
*
|
|
29
|
+
* This option is equivalent to GRPC_ARG_KEEPALIVE_PERMIT_WITHOUT_CALLS in
|
|
30
|
+
* gRPC Core.
|
|
31
|
+
*/
|
|
32
|
+
pingIdleConnection?: boolean;
|
|
33
|
+
/**
|
|
34
|
+
* Timeout for PING frames. If a PING is not answered within this time, the
|
|
35
|
+
* connection is considered dead.
|
|
36
|
+
*
|
|
37
|
+
* Defaults to 15 seconds. This option is only used if a value for
|
|
38
|
+
* pingIntervalMs is provided.
|
|
39
|
+
*
|
|
40
|
+
* This option is equivalent to GRPC_ARG_KEEPALIVE_TIMEOUT_MS in gRPC Core.
|
|
41
|
+
*/
|
|
42
|
+
pingTimeoutMs?: number;
|
|
43
|
+
/**
|
|
44
|
+
* Automatically close a connection if the time since the last request stream
|
|
45
|
+
* exceeds this value.
|
|
46
|
+
*
|
|
47
|
+
* Defaults to 15 minutes.
|
|
48
|
+
*
|
|
49
|
+
* This option is equivalent to GRPC_ARG_CLIENT_IDLE_TIMEOUT_MS of gRPC core.
|
|
50
|
+
*/
|
|
51
|
+
idleConnectionTimeoutMs?: number;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Manage an HTTP/2 connection and keep it alive with PING frames.
|
|
55
|
+
*
|
|
56
|
+
* The logic is based on "Basic Keepalive" described in
|
|
57
|
+
* https://github.com/grpc/proposal/blob/0ba0c1905050525f9b0aee46f3f23c8e1e515489/A8-client-side-keepalive.md#basic-keepalive
|
|
58
|
+
* as well as the client channel arguments described in
|
|
59
|
+
* https://github.com/grpc/grpc/blob/8e137e524a1b1da7bbf4603662876d5719563b57/doc/keepalive.md
|
|
60
|
+
*
|
|
61
|
+
* Usually, the managers tracks exactly one connection, but if a connection
|
|
62
|
+
* receives a GOAWAY frame with NO_ERROR, the connection is maintained until
|
|
63
|
+
* all streams have finished, and new requests will open a new connection.
|
|
64
|
+
*/
|
|
65
|
+
export declare class Http2SessionManager {
|
|
66
|
+
/**
|
|
67
|
+
* The host this session manager connect to.
|
|
68
|
+
*/
|
|
69
|
+
authority: string;
|
|
70
|
+
/**
|
|
71
|
+
* The current state of the connection:
|
|
72
|
+
*
|
|
73
|
+
* - "closed"
|
|
74
|
+
* The connection is closed, or no connection has been opened yet.
|
|
75
|
+
* - connecting
|
|
76
|
+
* Currently establishing a connection.
|
|
77
|
+
*
|
|
78
|
+
* - "open"
|
|
79
|
+
* A connection is open and has open streams. PING frames are sent every
|
|
80
|
+
* pingIntervalMs, unless a stream received data.
|
|
81
|
+
* If a PING frame is not responded to within pingTimeoutMs, the connection
|
|
82
|
+
* and all open streams close.
|
|
83
|
+
*
|
|
84
|
+
* - "idle"
|
|
85
|
+
* A connection is open, but it does not have any open streams.
|
|
86
|
+
* If pingIdleConnection is enabled, PING frames are used to keep the
|
|
87
|
+
* connection alive, similar to an "open" connection.
|
|
88
|
+
* If a connection is idle for longer than idleConnectionTimeoutMs, it closes.
|
|
89
|
+
* If a request is made on an idle connection that has not been used for
|
|
90
|
+
* longer than pingIntervalMs, the connection is verified.
|
|
91
|
+
*
|
|
92
|
+
* - "verifying"
|
|
93
|
+
* Verifying a connection after a long period of inactivity before issuing a
|
|
94
|
+
* request. A PING frame is sent, and if it times out within pingTimeoutMs, a
|
|
95
|
+
* new connection is opened.
|
|
96
|
+
*
|
|
97
|
+
* - "error"
|
|
98
|
+
* The connection is closed because of a transient error. A connection
|
|
99
|
+
* may have failed to reach the host, or the connection may have died,
|
|
100
|
+
* or it may have been aborted.
|
|
101
|
+
*/
|
|
102
|
+
state(): "closed" | "connecting" | "open" | "idle" | "verifying" | "error";
|
|
103
|
+
/**
|
|
104
|
+
* Returns the error object if the connection is in the "error" state,
|
|
105
|
+
* `undefined` otherwise.
|
|
106
|
+
*/
|
|
107
|
+
error(): unknown;
|
|
108
|
+
private s;
|
|
109
|
+
private shuttingDown;
|
|
110
|
+
private readonly http2SessionOptions;
|
|
111
|
+
private readonly options;
|
|
112
|
+
private verifying;
|
|
113
|
+
constructor(url: URL | string, pingOptions?: Http2SessionOptions, http2SessionOptions?: http2.ClientSessionOptions | http2.SecureClientSessionOptions);
|
|
114
|
+
/**
|
|
115
|
+
* Open a connection if none exists, verify an existing connection if
|
|
116
|
+
* necessary.
|
|
117
|
+
*/
|
|
118
|
+
connect(): Promise<"open" | "idle" | "error">;
|
|
119
|
+
/**
|
|
120
|
+
* Issue a request.
|
|
121
|
+
*
|
|
122
|
+
* This method automatically opens a connection if none exists, and verifies
|
|
123
|
+
* an existing connection if necessary. It calls http2.ClientHttp2Session.request(),
|
|
124
|
+
* and keeps track of all open http2.ClientHttp2Stream.
|
|
125
|
+
*
|
|
126
|
+
* Clients must call notifyResponseByteRead() whenever they successfully read
|
|
127
|
+
* data from the http2.ClientHttp2Stream.
|
|
128
|
+
*/
|
|
129
|
+
request(method: string, path: string, headers: http2.OutgoingHttpHeaders, options: Omit<http2.ClientSessionRequestOptions, "signal">): Promise<http2.ClientHttp2Stream>;
|
|
130
|
+
/**
|
|
131
|
+
* Notify the manager of a successful read from a http2.ClientHttp2Stream.
|
|
132
|
+
*
|
|
133
|
+
* Clients must call this function whenever they successfully read data from
|
|
134
|
+
* a http2.ClientHttp2Stream obtained from request(). This informs the
|
|
135
|
+
* keep-alive logic that the connection is alive, and prevents it from sending
|
|
136
|
+
* unnecessary PING frames.
|
|
137
|
+
*/
|
|
138
|
+
notifyResponseByteRead(stream: http2.ClientHttp2Stream): void;
|
|
139
|
+
/**
|
|
140
|
+
* If there is an open connection, close it. This also closes any open streams.
|
|
141
|
+
*/
|
|
142
|
+
abort(reason?: Error): void;
|
|
143
|
+
private gotoReady;
|
|
144
|
+
private setState;
|
|
145
|
+
private verify;
|
|
146
|
+
}
|
|
@@ -0,0 +1,532 @@
|
|
|
1
|
+
// Copyright 2021-2024 The Connect Authors
|
|
2
|
+
//
|
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
// you may not use this file except in compliance with the License.
|
|
5
|
+
// You may obtain a copy of the License at
|
|
6
|
+
//
|
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
//
|
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
// See the License for the specific language governing permissions and
|
|
13
|
+
// limitations under the License.
|
|
14
|
+
import * as http2 from "http2";
|
|
15
|
+
import { Code, ConnectError } from "@connectrpc/connect";
|
|
16
|
+
import { connectErrorFromNodeReason } from "./node-error.js";
|
|
17
|
+
/**
|
|
18
|
+
* Manage an HTTP/2 connection and keep it alive with PING frames.
|
|
19
|
+
*
|
|
20
|
+
* The logic is based on "Basic Keepalive" described in
|
|
21
|
+
* https://github.com/grpc/proposal/blob/0ba0c1905050525f9b0aee46f3f23c8e1e515489/A8-client-side-keepalive.md#basic-keepalive
|
|
22
|
+
* as well as the client channel arguments described in
|
|
23
|
+
* https://github.com/grpc/grpc/blob/8e137e524a1b1da7bbf4603662876d5719563b57/doc/keepalive.md
|
|
24
|
+
*
|
|
25
|
+
* Usually, the managers tracks exactly one connection, but if a connection
|
|
26
|
+
* receives a GOAWAY frame with NO_ERROR, the connection is maintained until
|
|
27
|
+
* all streams have finished, and new requests will open a new connection.
|
|
28
|
+
*/
|
|
29
|
+
export class Http2SessionManager {
|
|
30
|
+
/**
|
|
31
|
+
* The current state of the connection:
|
|
32
|
+
*
|
|
33
|
+
* - "closed"
|
|
34
|
+
* The connection is closed, or no connection has been opened yet.
|
|
35
|
+
* - connecting
|
|
36
|
+
* Currently establishing a connection.
|
|
37
|
+
*
|
|
38
|
+
* - "open"
|
|
39
|
+
* A connection is open and has open streams. PING frames are sent every
|
|
40
|
+
* pingIntervalMs, unless a stream received data.
|
|
41
|
+
* If a PING frame is not responded to within pingTimeoutMs, the connection
|
|
42
|
+
* and all open streams close.
|
|
43
|
+
*
|
|
44
|
+
* - "idle"
|
|
45
|
+
* A connection is open, but it does not have any open streams.
|
|
46
|
+
* If pingIdleConnection is enabled, PING frames are used to keep the
|
|
47
|
+
* connection alive, similar to an "open" connection.
|
|
48
|
+
* If a connection is idle for longer than idleConnectionTimeoutMs, it closes.
|
|
49
|
+
* If a request is made on an idle connection that has not been used for
|
|
50
|
+
* longer than pingIntervalMs, the connection is verified.
|
|
51
|
+
*
|
|
52
|
+
* - "verifying"
|
|
53
|
+
* Verifying a connection after a long period of inactivity before issuing a
|
|
54
|
+
* request. A PING frame is sent, and if it times out within pingTimeoutMs, a
|
|
55
|
+
* new connection is opened.
|
|
56
|
+
*
|
|
57
|
+
* - "error"
|
|
58
|
+
* The connection is closed because of a transient error. A connection
|
|
59
|
+
* may have failed to reach the host, or the connection may have died,
|
|
60
|
+
* or it may have been aborted.
|
|
61
|
+
*/
|
|
62
|
+
state() {
|
|
63
|
+
if (this.s.t == "ready") {
|
|
64
|
+
if (this.verifying !== undefined) {
|
|
65
|
+
return "verifying";
|
|
66
|
+
}
|
|
67
|
+
return this.s.streamCount() > 0 ? "open" : "idle";
|
|
68
|
+
}
|
|
69
|
+
return this.s.t;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Returns the error object if the connection is in the "error" state,
|
|
73
|
+
* `undefined` otherwise.
|
|
74
|
+
*/
|
|
75
|
+
error() {
|
|
76
|
+
if (this.s.t == "error") {
|
|
77
|
+
return this.s.reason;
|
|
78
|
+
}
|
|
79
|
+
return undefined;
|
|
80
|
+
}
|
|
81
|
+
constructor(url, pingOptions, http2SessionOptions) {
|
|
82
|
+
var _a, _b, _c, _d;
|
|
83
|
+
this.s = closed();
|
|
84
|
+
this.shuttingDown = [];
|
|
85
|
+
this.authority = new URL(url).origin;
|
|
86
|
+
this.http2SessionOptions = http2SessionOptions;
|
|
87
|
+
this.options = {
|
|
88
|
+
pingIntervalMs: (_a = pingOptions === null || pingOptions === void 0 ? void 0 : pingOptions.pingIntervalMs) !== null && _a !== void 0 ? _a : Number.POSITIVE_INFINITY,
|
|
89
|
+
pingTimeoutMs: (_b = pingOptions === null || pingOptions === void 0 ? void 0 : pingOptions.pingTimeoutMs) !== null && _b !== void 0 ? _b : 1000 * 15,
|
|
90
|
+
pingIdleConnection: (_c = pingOptions === null || pingOptions === void 0 ? void 0 : pingOptions.pingIdleConnection) !== null && _c !== void 0 ? _c : false,
|
|
91
|
+
idleConnectionTimeoutMs: (_d = pingOptions === null || pingOptions === void 0 ? void 0 : pingOptions.idleConnectionTimeoutMs) !== null && _d !== void 0 ? _d : 1000 * 60 * 15,
|
|
92
|
+
};
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Open a connection if none exists, verify an existing connection if
|
|
96
|
+
* necessary.
|
|
97
|
+
*/
|
|
98
|
+
async connect() {
|
|
99
|
+
try {
|
|
100
|
+
const ready = await this.gotoReady();
|
|
101
|
+
return ready.streamCount() > 0 ? "open" : "idle";
|
|
102
|
+
}
|
|
103
|
+
catch (e) {
|
|
104
|
+
return "error";
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Issue a request.
|
|
109
|
+
*
|
|
110
|
+
* This method automatically opens a connection if none exists, and verifies
|
|
111
|
+
* an existing connection if necessary. It calls http2.ClientHttp2Session.request(),
|
|
112
|
+
* and keeps track of all open http2.ClientHttp2Stream.
|
|
113
|
+
*
|
|
114
|
+
* Clients must call notifyResponseByteRead() whenever they successfully read
|
|
115
|
+
* data from the http2.ClientHttp2Stream.
|
|
116
|
+
*/
|
|
117
|
+
async request(method, path, headers, options) {
|
|
118
|
+
// Request sometimes fails with goaway/destroyed
|
|
119
|
+
// errors, we use a loop to retry.
|
|
120
|
+
//
|
|
121
|
+
// This is not expected to happen often, but it is possible that a
|
|
122
|
+
// connection is closed while we are trying to open a stream.
|
|
123
|
+
//
|
|
124
|
+
// Ref: https://github.com/nodejs/help/issues/2105
|
|
125
|
+
for (;;) {
|
|
126
|
+
const ready = await this.gotoReady();
|
|
127
|
+
try {
|
|
128
|
+
const stream = ready.conn.request(Object.assign(Object.assign({}, headers), { ":method": method, ":path": path }), options);
|
|
129
|
+
ready.registerRequest(stream);
|
|
130
|
+
return stream;
|
|
131
|
+
}
|
|
132
|
+
catch (e) {
|
|
133
|
+
// Check to see if the connection is closed or destroyed
|
|
134
|
+
// and if so, we try again.
|
|
135
|
+
if (ready.conn.closed || ready.conn.destroyed) {
|
|
136
|
+
continue;
|
|
137
|
+
}
|
|
138
|
+
throw e;
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Notify the manager of a successful read from a http2.ClientHttp2Stream.
|
|
144
|
+
*
|
|
145
|
+
* Clients must call this function whenever they successfully read data from
|
|
146
|
+
* a http2.ClientHttp2Stream obtained from request(). This informs the
|
|
147
|
+
* keep-alive logic that the connection is alive, and prevents it from sending
|
|
148
|
+
* unnecessary PING frames.
|
|
149
|
+
*/
|
|
150
|
+
notifyResponseByteRead(stream) {
|
|
151
|
+
if (this.s.t == "ready") {
|
|
152
|
+
this.s.responseByteRead(stream);
|
|
153
|
+
}
|
|
154
|
+
for (const s of this.shuttingDown) {
|
|
155
|
+
s.responseByteRead(stream);
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* If there is an open connection, close it. This also closes any open streams.
|
|
160
|
+
*/
|
|
161
|
+
abort(reason) {
|
|
162
|
+
var _a, _b, _c;
|
|
163
|
+
const err = reason !== null && reason !== void 0 ? reason : new ConnectError("connection aborted", Code.Canceled);
|
|
164
|
+
(_b = (_a = this.s).abort) === null || _b === void 0 ? void 0 : _b.call(_a, err);
|
|
165
|
+
for (const s of this.shuttingDown) {
|
|
166
|
+
(_c = s.abort) === null || _c === void 0 ? void 0 : _c.call(s, err);
|
|
167
|
+
}
|
|
168
|
+
this.setState(closedOrError(err));
|
|
169
|
+
}
|
|
170
|
+
async gotoReady() {
|
|
171
|
+
if (this.s.t == "ready") {
|
|
172
|
+
if (this.s.isShuttingDown() ||
|
|
173
|
+
this.s.conn.closed ||
|
|
174
|
+
this.s.conn.destroyed) {
|
|
175
|
+
this.setState(connect(this.authority, this.http2SessionOptions));
|
|
176
|
+
}
|
|
177
|
+
else if (this.s.requiresVerify()) {
|
|
178
|
+
await this.verify(this.s);
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
else if (this.s.t == "closed" || this.s.t == "error") {
|
|
182
|
+
this.setState(connect(this.authority, this.http2SessionOptions));
|
|
183
|
+
}
|
|
184
|
+
while (this.s.t !== "ready") {
|
|
185
|
+
if (this.s.t === "error") {
|
|
186
|
+
throw this.s.reason;
|
|
187
|
+
}
|
|
188
|
+
if (this.s.t === "connecting") {
|
|
189
|
+
await this.s.conn;
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
return this.s;
|
|
193
|
+
}
|
|
194
|
+
setState(state) {
|
|
195
|
+
var _a, _b;
|
|
196
|
+
(_b = (_a = this.s).onExitState) === null || _b === void 0 ? void 0 : _b.call(_a);
|
|
197
|
+
if (this.s.t == "ready" && this.s.isShuttingDown()) {
|
|
198
|
+
// Maintain connections that have been asked to shut down.
|
|
199
|
+
const sd = this.s;
|
|
200
|
+
this.shuttingDown.push(sd);
|
|
201
|
+
sd.onClose = sd.onError = () => {
|
|
202
|
+
const i = this.shuttingDown.indexOf(sd);
|
|
203
|
+
if (i !== -1) {
|
|
204
|
+
this.shuttingDown.splice(i, 1);
|
|
205
|
+
}
|
|
206
|
+
};
|
|
207
|
+
}
|
|
208
|
+
switch (state.t) {
|
|
209
|
+
case "connecting":
|
|
210
|
+
state.conn.then((value) => {
|
|
211
|
+
this.setState(ready(value, this.options));
|
|
212
|
+
}, (reason) => {
|
|
213
|
+
this.setState(closedOrError(reason));
|
|
214
|
+
});
|
|
215
|
+
break;
|
|
216
|
+
case "ready":
|
|
217
|
+
state.onClose = () => this.setState(closed());
|
|
218
|
+
state.onError = (err) => this.setState(closedOrError(err));
|
|
219
|
+
break;
|
|
220
|
+
case "closed":
|
|
221
|
+
break;
|
|
222
|
+
case "error":
|
|
223
|
+
break;
|
|
224
|
+
}
|
|
225
|
+
this.s = state;
|
|
226
|
+
}
|
|
227
|
+
verify(stateReady) {
|
|
228
|
+
if (this.verifying !== undefined) {
|
|
229
|
+
return this.verifying;
|
|
230
|
+
}
|
|
231
|
+
this.verifying = stateReady
|
|
232
|
+
.verify()
|
|
233
|
+
.then((success) => {
|
|
234
|
+
if (success) {
|
|
235
|
+
return;
|
|
236
|
+
}
|
|
237
|
+
// verify() has destroyed the old connection
|
|
238
|
+
this.setState(connect(this.authority, this.http2SessionOptions));
|
|
239
|
+
}, (reason) => {
|
|
240
|
+
this.setState(closedOrError(reason));
|
|
241
|
+
})
|
|
242
|
+
.finally(() => {
|
|
243
|
+
this.verifying = undefined;
|
|
244
|
+
});
|
|
245
|
+
return this.verifying;
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
function closed() {
|
|
249
|
+
return {
|
|
250
|
+
t: "closed",
|
|
251
|
+
};
|
|
252
|
+
}
|
|
253
|
+
function error(reason) {
|
|
254
|
+
return {
|
|
255
|
+
t: "error",
|
|
256
|
+
reason,
|
|
257
|
+
};
|
|
258
|
+
}
|
|
259
|
+
function closedOrError(reason) {
|
|
260
|
+
const isCancel = reason instanceof ConnectError &&
|
|
261
|
+
ConnectError.from(reason).code == Code.Canceled;
|
|
262
|
+
return isCancel ? closed() : error(reason);
|
|
263
|
+
}
|
|
264
|
+
function connect(authority, http2SessionOptions) {
|
|
265
|
+
let resolve;
|
|
266
|
+
let reject;
|
|
267
|
+
const conn = new Promise((res, rej) => {
|
|
268
|
+
resolve = res;
|
|
269
|
+
reject = rej;
|
|
270
|
+
});
|
|
271
|
+
const newConn = http2.connect(authority, http2SessionOptions);
|
|
272
|
+
newConn.on("connect", onConnect);
|
|
273
|
+
newConn.on("error", onError);
|
|
274
|
+
function onConnect() {
|
|
275
|
+
resolve === null || resolve === void 0 ? void 0 : resolve(newConn);
|
|
276
|
+
cleanup();
|
|
277
|
+
}
|
|
278
|
+
function onError(err) {
|
|
279
|
+
reject === null || reject === void 0 ? void 0 : reject(connectErrorFromNodeReason(err));
|
|
280
|
+
cleanup();
|
|
281
|
+
}
|
|
282
|
+
function cleanup() {
|
|
283
|
+
newConn.off("connect", onConnect);
|
|
284
|
+
newConn.off("error", onError);
|
|
285
|
+
}
|
|
286
|
+
return {
|
|
287
|
+
t: "connecting",
|
|
288
|
+
conn,
|
|
289
|
+
abort(reason) {
|
|
290
|
+
if (!newConn.destroyed) {
|
|
291
|
+
newConn.destroy(undefined, http2.constants.NGHTTP2_CANCEL);
|
|
292
|
+
}
|
|
293
|
+
// According to the documentation, destroy() should immediately terminate
|
|
294
|
+
// the session and the socket, but we still receive a "connect" event.
|
|
295
|
+
// We must not resolve a broken connection, so we reject it manually here.
|
|
296
|
+
reject === null || reject === void 0 ? void 0 : reject(reason);
|
|
297
|
+
},
|
|
298
|
+
onExitState() {
|
|
299
|
+
cleanup();
|
|
300
|
+
},
|
|
301
|
+
};
|
|
302
|
+
}
|
|
303
|
+
function ready(conn, options) {
|
|
304
|
+
// Users have reported an error "The session has been destroyed" raised
|
|
305
|
+
// from H2SessionManager.request(), see https://github.com/connectrpc/connect-es/issues/683
|
|
306
|
+
// This assertion will show whether the session already died in the
|
|
307
|
+
// "connecting" state.
|
|
308
|
+
assertSessionOpen(conn);
|
|
309
|
+
// Do not block Node.js from exiting on an idle connection.
|
|
310
|
+
// Note that we ref() again for the first stream to open, and unref() again
|
|
311
|
+
// for the last stream to close.
|
|
312
|
+
conn.unref();
|
|
313
|
+
// the last time we were sure that the connection is alive, via a PING
|
|
314
|
+
// response, or via received response bytes
|
|
315
|
+
let lastAliveAt = Date.now();
|
|
316
|
+
// how many streams are currently open on this session
|
|
317
|
+
let streamCount = 0;
|
|
318
|
+
// timer for the keep-alive interval
|
|
319
|
+
let pingIntervalId;
|
|
320
|
+
// timer for waiting for a PING response
|
|
321
|
+
let pingTimeoutId;
|
|
322
|
+
// keep track of GOAWAY - gracefully shut down open streams / wait for connection to error
|
|
323
|
+
let receivedGoAway = false;
|
|
324
|
+
// keep track of GOAWAY with ENHANCE_YOUR_CALM and with debug data too_many_pings
|
|
325
|
+
let receivedGoAwayEnhanceYourCalmTooManyPings = false;
|
|
326
|
+
// timer for closing connections without open streams, must be initialized
|
|
327
|
+
let idleTimeoutId;
|
|
328
|
+
resetIdleTimeout();
|
|
329
|
+
const state = {
|
|
330
|
+
t: "ready",
|
|
331
|
+
conn,
|
|
332
|
+
streamCount() {
|
|
333
|
+
return streamCount;
|
|
334
|
+
},
|
|
335
|
+
requiresVerify() {
|
|
336
|
+
const elapsedMs = Date.now() - lastAliveAt;
|
|
337
|
+
return elapsedMs > options.pingIntervalMs;
|
|
338
|
+
},
|
|
339
|
+
isShuttingDown() {
|
|
340
|
+
return receivedGoAway;
|
|
341
|
+
},
|
|
342
|
+
onClose: undefined,
|
|
343
|
+
onError: undefined,
|
|
344
|
+
registerRequest(stream) {
|
|
345
|
+
streamCount++;
|
|
346
|
+
if (streamCount == 1) {
|
|
347
|
+
conn.ref();
|
|
348
|
+
resetPingInterval(); // reset to ping with the appropriate interval for "open"
|
|
349
|
+
stopIdleTimeout();
|
|
350
|
+
}
|
|
351
|
+
stream.once("response", () => {
|
|
352
|
+
lastAliveAt = Date.now();
|
|
353
|
+
resetPingInterval();
|
|
354
|
+
});
|
|
355
|
+
stream.once("close", () => {
|
|
356
|
+
streamCount--;
|
|
357
|
+
if (streamCount == 0) {
|
|
358
|
+
conn.unref();
|
|
359
|
+
resetPingInterval(); // reset to ping with the appropriate interval for "idle"
|
|
360
|
+
resetIdleTimeout();
|
|
361
|
+
}
|
|
362
|
+
});
|
|
363
|
+
},
|
|
364
|
+
responseByteRead(stream) {
|
|
365
|
+
if (stream.session !== conn) {
|
|
366
|
+
return;
|
|
367
|
+
}
|
|
368
|
+
if (conn.closed || conn.destroyed) {
|
|
369
|
+
return;
|
|
370
|
+
}
|
|
371
|
+
if (streamCount <= 0) {
|
|
372
|
+
return;
|
|
373
|
+
}
|
|
374
|
+
lastAliveAt = Date.now();
|
|
375
|
+
resetPingInterval();
|
|
376
|
+
},
|
|
377
|
+
verify() {
|
|
378
|
+
conn.ref();
|
|
379
|
+
return new Promise((resolve) => {
|
|
380
|
+
commonPing(() => {
|
|
381
|
+
if (streamCount == 0)
|
|
382
|
+
conn.unref();
|
|
383
|
+
resolve(true);
|
|
384
|
+
});
|
|
385
|
+
conn.once("error", () => resolve(false));
|
|
386
|
+
});
|
|
387
|
+
},
|
|
388
|
+
abort(reason) {
|
|
389
|
+
if (!conn.destroyed) {
|
|
390
|
+
conn.once("error", () => {
|
|
391
|
+
// conn.destroy() may raise an error after onExitState() was called
|
|
392
|
+
// and our error listeners are removed.
|
|
393
|
+
// We attach this one to swallow uncaught exceptions.
|
|
394
|
+
});
|
|
395
|
+
conn.destroy(reason, http2.constants.NGHTTP2_CANCEL);
|
|
396
|
+
}
|
|
397
|
+
},
|
|
398
|
+
onExitState() {
|
|
399
|
+
if (state.isShuttingDown()) {
|
|
400
|
+
// Per the interface, this method is called when the manager is leaving
|
|
401
|
+
// the state. We maintain this connection in the session manager until
|
|
402
|
+
// all streams have finished, so we do not detach event listeners here.
|
|
403
|
+
return;
|
|
404
|
+
}
|
|
405
|
+
cleanup();
|
|
406
|
+
this.onError = undefined;
|
|
407
|
+
this.onClose = undefined;
|
|
408
|
+
},
|
|
409
|
+
};
|
|
410
|
+
// start or restart the ping interval
|
|
411
|
+
function resetPingInterval() {
|
|
412
|
+
stopPingInterval();
|
|
413
|
+
if (streamCount > 0 || options.pingIdleConnection) {
|
|
414
|
+
pingIntervalId = safeSetTimeout(onPingInterval, options.pingIntervalMs);
|
|
415
|
+
}
|
|
416
|
+
}
|
|
417
|
+
function stopPingInterval() {
|
|
418
|
+
clearTimeout(pingIntervalId);
|
|
419
|
+
clearTimeout(pingTimeoutId);
|
|
420
|
+
}
|
|
421
|
+
function onPingInterval() {
|
|
422
|
+
commonPing(resetPingInterval);
|
|
423
|
+
}
|
|
424
|
+
function commonPing(onSuccess) {
|
|
425
|
+
clearTimeout(pingTimeoutId);
|
|
426
|
+
pingTimeoutId = safeSetTimeout(() => {
|
|
427
|
+
conn.destroy(new ConnectError("PING timed out", Code.Unavailable), http2.constants.NGHTTP2_CANCEL);
|
|
428
|
+
}, options.pingTimeoutMs);
|
|
429
|
+
conn.ping((err, duration) => {
|
|
430
|
+
clearTimeout(pingTimeoutId);
|
|
431
|
+
if (err !== null) {
|
|
432
|
+
// We will receive an ERR_HTTP2_PING_CANCEL here if we destroy the
|
|
433
|
+
// connection with a pending ping.
|
|
434
|
+
// We might also see other errors, but they should be picked up by the
|
|
435
|
+
// "error" event listener.
|
|
436
|
+
return;
|
|
437
|
+
}
|
|
438
|
+
if (duration > options.pingTimeoutMs) {
|
|
439
|
+
// setTimeout is not precise, and HTTP/2 pings take less than 1ms in
|
|
440
|
+
// tests.
|
|
441
|
+
conn.destroy(new ConnectError("PING timed out", Code.Unavailable), http2.constants.NGHTTP2_CANCEL);
|
|
442
|
+
return;
|
|
443
|
+
}
|
|
444
|
+
lastAliveAt = Date.now();
|
|
445
|
+
onSuccess();
|
|
446
|
+
});
|
|
447
|
+
}
|
|
448
|
+
function stopIdleTimeout() {
|
|
449
|
+
clearTimeout(idleTimeoutId);
|
|
450
|
+
}
|
|
451
|
+
function resetIdleTimeout() {
|
|
452
|
+
idleTimeoutId = safeSetTimeout(onIdleTimeout, options.idleConnectionTimeoutMs);
|
|
453
|
+
}
|
|
454
|
+
function onIdleTimeout() {
|
|
455
|
+
conn.close();
|
|
456
|
+
onClose(); // trigger a state change right away, so we are not open to races
|
|
457
|
+
}
|
|
458
|
+
function onGoaway(errorCode, lastStreamID, opaqueData) {
|
|
459
|
+
receivedGoAway = true;
|
|
460
|
+
const tooManyPingsAscii = Buffer.from("too_many_pings", "ascii");
|
|
461
|
+
if (errorCode === http2.constants.NGHTTP2_ENHANCE_YOUR_CALM &&
|
|
462
|
+
opaqueData != null &&
|
|
463
|
+
opaqueData.equals(tooManyPingsAscii)) {
|
|
464
|
+
// double pingIntervalMs, following the last paragraph of https://github.com/grpc/proposal/blob/0ba0c1905050525f9b0aee46f3f23c8e1e515489/A8-client-side-keepalive.md#basic-keepalive
|
|
465
|
+
options.pingIntervalMs = options.pingIntervalMs * 2;
|
|
466
|
+
receivedGoAwayEnhanceYourCalmTooManyPings = true;
|
|
467
|
+
}
|
|
468
|
+
if (errorCode === http2.constants.NGHTTP2_NO_ERROR) {
|
|
469
|
+
const nodeMajor = parseInt(process.versions.node.split(".")[0], 10);
|
|
470
|
+
// Node.js v16 closes a connection on its own when it receives a GOAWAY
|
|
471
|
+
// frame and there are no open streams (emitting a "close" event and
|
|
472
|
+
// destroying the session), but more recent versions do not.
|
|
473
|
+
// Calling close() ourselves is ineffective here - it appears that the
|
|
474
|
+
// method is already being called, see https://github.com/nodejs/node/blob/198affc63973805ce5102d246f6b7822be57f5fc/lib/internal/http2/core.js#L681
|
|
475
|
+
if (streamCount == 0 && nodeMajor >= 18) {
|
|
476
|
+
conn.destroy(new ConnectError("received GOAWAY without any open streams", Code.Canceled), http2.constants.NGHTTP2_NO_ERROR);
|
|
477
|
+
}
|
|
478
|
+
}
|
|
479
|
+
}
|
|
480
|
+
function onClose() {
|
|
481
|
+
var _a;
|
|
482
|
+
cleanup();
|
|
483
|
+
(_a = state.onClose) === null || _a === void 0 ? void 0 : _a.call(state);
|
|
484
|
+
}
|
|
485
|
+
function onError(err) {
|
|
486
|
+
var _a, _b;
|
|
487
|
+
cleanup();
|
|
488
|
+
if (receivedGoAwayEnhanceYourCalmTooManyPings) {
|
|
489
|
+
// We cannot prevent node from destroying session and streams with its own
|
|
490
|
+
// error that does not carry debug data, but at least we can wrap the error
|
|
491
|
+
// we surface on the manager.
|
|
492
|
+
const ce = new ConnectError(`http/2 connection closed with error code ENHANCE_YOUR_CALM (0x${http2.constants.NGHTTP2_ENHANCE_YOUR_CALM.toString(16)}), too_many_pings, doubled the interval`, Code.ResourceExhausted);
|
|
493
|
+
(_a = state.onError) === null || _a === void 0 ? void 0 : _a.call(state, ce);
|
|
494
|
+
}
|
|
495
|
+
else {
|
|
496
|
+
(_b = state.onError) === null || _b === void 0 ? void 0 : _b.call(state, connectErrorFromNodeReason(err));
|
|
497
|
+
}
|
|
498
|
+
}
|
|
499
|
+
function cleanup() {
|
|
500
|
+
stopPingInterval();
|
|
501
|
+
stopIdleTimeout();
|
|
502
|
+
conn.off("error", onError);
|
|
503
|
+
conn.off("close", onClose);
|
|
504
|
+
conn.off("goaway", onGoaway);
|
|
505
|
+
}
|
|
506
|
+
conn.on("error", onError);
|
|
507
|
+
conn.on("close", onClose);
|
|
508
|
+
conn.on("goaway", onGoaway);
|
|
509
|
+
return state;
|
|
510
|
+
}
|
|
511
|
+
/**
|
|
512
|
+
* setTimeout(), but simply ignores values larger than the maximum supported
|
|
513
|
+
* value (signed 32-bit integer) instead of calling the callback right away,
|
|
514
|
+
* and does not block Node.js from exiting.
|
|
515
|
+
*/
|
|
516
|
+
function safeSetTimeout(callback, ms) {
|
|
517
|
+
if (ms > 0x7fffffff) {
|
|
518
|
+
return;
|
|
519
|
+
}
|
|
520
|
+
return setTimeout(callback, ms).unref();
|
|
521
|
+
}
|
|
522
|
+
function assertSessionOpen(conn) {
|
|
523
|
+
if (conn.connecting) {
|
|
524
|
+
throw new ConnectError("expected open session, but it is connecting", Code.Internal);
|
|
525
|
+
}
|
|
526
|
+
if (conn.destroyed) {
|
|
527
|
+
throw new ConnectError("expected open session, but it is destroyed", Code.Internal);
|
|
528
|
+
}
|
|
529
|
+
if (conn.closed) {
|
|
530
|
+
throw new ConnectError("expected open session, but it is closed", Code.Internal);
|
|
531
|
+
}
|
|
532
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import "./node-headers-polyfill.js";
|
|
2
|
+
export { createGrpcWebTransport } from "./grpc-web-transport.js";
|
|
3
|
+
export type { GrpcWebTransportOptions } from "./grpc-web-transport.js";
|
|
4
|
+
export { createGrpcTransport } from "./grpc-transport.js";
|
|
5
|
+
export type { GrpcTransportOptions } from "./grpc-transport.js";
|
|
6
|
+
export { createConnectTransport } from "./connect-transport.js";
|
|
7
|
+
export type { ConnectTransportOptions } from "./connect-transport.js";
|
|
8
|
+
export { compressionBrotli, compressionGzip } from "./compression.js";
|
|
9
|
+
export { connectNodeAdapter } from "./connect-node-adapter.js";
|
|
10
|
+
export type { ConnectNodeAdapterOptions } from "./connect-node-adapter.js";
|
|
11
|
+
export { universalRequestFromNodeRequest, universalResponseToNodeResponse, } from "./node-universal-handler.js";
|
|
12
|
+
export { createNodeHttpClient } from "./node-universal-client.js";
|
|
13
|
+
export type { NodeHttpClientOptions } from "./node-universal-client.js";
|
|
14
|
+
export { Http2SessionManager } from "./http2-session-manager.js";
|
|
15
|
+
export type { Http2SessionOptions } from "./http2-session-manager.js";
|