@lesomnus/grpc-dgram 0.0.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 lesomnus
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,245 @@
+# @lesomnus/grpc-dgram
+
+TypeScript port of [gRPC-dgram](../): gRPC-style RPC over unreliable datagram
+channels, implementing the **dRPC wire protocol v1.1** (`../docs/PROTOCOL.md`).
+Wire-compatible with the Go implementation — the §5 golden byte vectors are
+shared between the two test suites — so a TS client interoperates with a Go
+server and vice versa.
+
+- **Zero runtime dependencies.** The three wire messages (`Frame`, `Envelop`,
+  `Metadata`) are hand-encoded; user payloads go through pluggable
+  per-method marshallers (protobuf-es, JSON, anything that produces bytes).
+  A **protobuf-es binding** (`@lesomnus/grpc-dgram/transport/protobuf-es`, optional peer
+  dep) derives the whole method descriptor — path, streaming kind, codec —
+  from a generated `protoc-gen-es` service, so RPC types are never re-declared
+  by hand. The core itself stays dependency-free.
+- **Both endpoints.** `Conn` (client) and `Server`, with the full unreliable-
+  mode machinery: seq windows and dedup, epoch/`peer_epoch` incarnation
+  isolation, control-frame retransmission, tombstones + aged watermark,
+  PING/probe liveness, and the §15 resource caps. On a reliable transport all
+  timers are off, sequencing is strict fail-loud (§10.6), and **per-stream
+  flow control** (§4.2.1) keeps one slow consumer from stalling the other
+  calls on the channel — the browser case where a blocked receive path would
+  otherwise wedge the whole event loop.
+- **v1.1 surface.** Binary metadata (`-bin` keys carry arbitrary octets;
+  base64 at the TS API, raw bytes on the wire), rich status details on the
+  terminal frame, per-message compression (`gzip` via the platform's
+  `CompressionStream`, never expanding a payload), per-call recv/send size
+  caps, and the shape/modifier flag split (§7.1) — an unimplemented flag bit
+  fails the call instead of silently corrupting or gapping it.
+- **WebSocket adapter** (`@lesomnus/grpc-dgram/transport/websocket`), the TS
+  twin of the Go `transport/gorilla` adapter: reliable mode, one Envelop per
+  message, and the §4.5 teardown duty carried by `onclose`/`onerror` plus a
+  keepalive — browser-safe (WhatWG `WebSocket`, `binaryType='arraybuffer'`).
+  `dialWebSocket(url)` is a `Conn` in one line; `new WebSocketTransport(ws)` is
+  the path for a socket you brought yourself.
+- **Message-port adapter** (`@lesomnus/grpc-dgram/transport/port`), the TS twin
+  of the Go `transport/jsport` adapter: `PortTransport`/`PortGateway` over
+  anything with `postMessage` and a `message` event — a `MessagePort`, a
+  `Worker`, a worker's own `self` — plus `dialWorker(worker)`, which transfers
+  a port to a worker of yours and hands back a `Conn`, one independent peer per
+  call. Always reliable, since a port in one process loses nothing, and since
+  nothing dies that a port can report, teardown is spoken: an empty message is the
+  goodbye, and `close(cause)` carries what only the host knows (a wasm instance
+  that exited, a terminated worker).
+- **A Go server in the browser** (`@lesomnus/grpc-dgram/wasm`): `open()` starts
+  a **Go `drpc.Server` compiled to `js/wasm`** — in a Worker this package
+  ships, so a computing handler does not freeze the page — and hands back
+  connections to it. It is the JS half of `jsport.Gateway.Serve`: the readiness
+  publish, the instantiation, one channel per `dial()`, and the §4.5 teardown a
+  dying instance cannot perform for itself. `../examples/browser-wasm` is it
+  running, and `test/wasm.test.ts` drives a real Go server through it.
+- **WebRTC DataChannel adapter** (`@lesomnus/grpc-dgram/transport/webrtc`), the TS twin
+  of the Go `transport/pion` adapter: the protocol mode is derived from the
+  channel's own configuration — an ordered channel with no retransmit or
+  lifetime cap runs reliable, anything else unreliable. Client `Transport`
+  and a mixed-mode server `Gateway` (a reliable control channel and
+  unreliable telemetry channels on one peer connection serve side by side,
+  each peer in its channel's mode).
+- **Node UDP adapter** (`@lesomnus/grpc-dgram/transport/node-udp`, Node only), the TS
+  twin of the Go `transport/udp` adapter — `UdpTransport`/`UdpGateway`, with
+  `dialUdp` (a connected socket and a `Conn` over it, in one line) and
+  `listenUdp`. A TS client over this adapter interoperates with a Go
+  `drpc.Server` on the wire; this is exercised by a cross-language conformance
+  test (`test/conformance.test.ts`) that drives a real Go server.
+- **Connect-ES transport** (`@lesomnus/grpc-dgram/transport/connect`, optional peer dep
+  on `@connectrpc/connect`): use the standard `createClient(Service, transport)`
+  ergonomics while the traffic runs over drpc. `createDrpcTransport(conn)`
+  turns a dRPC `Conn` into a Connect `Transport` — the conformance suite drives
+  a **real Go `drpc.Server` through a Connect client** end to end.
+
+## Usage
+
+**Getting a connection.** Four cases, and the verb says which:
+`new Conn(new XTransport(ch), opts)` when you already hold the channel;
+`dialUdp` / `dialWebSocket` / `dialWorker` when the library should make it —
+each hands back a `Conn`, and takes one options bag, since `ConnOptions` and an
+adapter's own options share no key; `open(app)` when there is no peer yet,
+which returns a `Sock` whose `dial()` is the connection; and, on the serving
+side, a `Gateway` — `listenUdp` where the library opens the socket, then
+`serve` when the gateway owns the whole endpoint, or `bind` + `servePeer` per
+channel handed in from outside.
+[Transports](../docs/transports.md#the-four-ways-in) spells out the whole rule.
+
+**With protobuf-es (recommended).** Point the binding at a generated service —
+paths, streaming kinds, and codecs are all derived from the `.proto`, so
+there is nothing to keep in sync and a TS client interoperates with a Go
+server addressing the same methods:
+
+```ts
+import { fromService } from '@lesomnus/grpc-dgram/transport/protobuf-es'
+import { create } from '@bufbuild/protobuf'
+import { EchoService, EchoRequestSchema } from './echo_pb' // protoc-gen-es output
+
+const Echo = fromService(EchoService) // { once, many, count, live }, fully typed
+
+await conn.invoke(Echo.once, create(EchoRequestSchema, { text: 'hi' }))
+server.register(Echo.once, (req) => create(EchoResponseSchema, { text: req.text }))
+```
+
+**With a Connect client.** If you already use Connect-ES, keep its client
+ergonomics and swap only the transport:
+
+```ts
+import { createClient } from '@connectrpc/connect'
+import { createDrpcTransport } from '@lesomnus/grpc-dgram/transport/connect'
+import { EchoService } from './echo_pb'
+
+const client = createClient(EchoService, createDrpcTransport(conn))
+await client.once({ message: 'hi' })                 // unary
+for await (const m of client.many({ message: 'x' })) // server streaming
+```
+
+**Without codegen.** Describe methods explicitly with any byte serializer
+(the core is codec-agnostic — this is what the test suite uses):
+
+```ts
+import { unaryMethod, bidiMethod, type PayloadCodec } from '@lesomnus/grpc-dgram'
+
+const json = <T>(): PayloadCodec<T> => ({
+  marshal: (v) => new TextEncoder().encode(JSON.stringify(v)),
+  unmarshal: (b) => JSON.parse(new TextDecoder().decode(b)),
+})
+
+const Once = unaryMethod<Req, Res>('/echo.Echo/Once', { request: json(), response: json() })
+const Live = bidiMethod<Req, Res>('/echo.Echo/Live', { request: json(), response: json() })
+```
+
+**Against a Go server compiled to wasm.** The page starts it and calls it; the
+Worker, the `wasm_exec.js` load, the readiness handshake and the teardown are
+`open()`'s (`src/wasm`, `../transport/jsport` on the Go side):
+
+```ts
+import { open } from '@lesomnus/grpc-dgram/wasm'
+
+const sock = await open('/app.wasm')
+const conn = sock.dial()   // one connection; call it again for another peer (§6.4)
+
+await conn.invoke(Once, { text: 'hi' })
+sock.close()               // fails every live call, then terminates the worker
+```
+
+Client over an `RTCDataChannel`:
+
+```ts
+import { Conn } from '@lesomnus/grpc-dgram'
+import { DataChannelTransport } from '@lesomnus/grpc-dgram/transport/webrtc'
+
+const dc = pc.createDataChannel('rpc') // ordered, no caps → reliable mode, no timers
+const conn = new Conn(new DataChannelTransport(dc)) // pump attaches itself
+
+const res = await conn.invoke(Once, { text: 'hi' })
+
+const stream = conn.newStream(Live, {})
+await stream.send({ text: 'x' })
+for await (const msg of stream) console.log(msg)
+
+conn.close() // one close tears everything down, channel included
+```
+
+Server behind a gateway (any number of peers, mixed reliability):
+
+```ts
+import { Server } from '@lesomnus/grpc-dgram'
+import { DataChannelGateway } from '@lesomnus/grpc-dgram/transport/webrtc'
+
+const gw = new DataChannelGateway()
+const server = new Server(gw)
+server.register(Once, (req) => ({ text: `echo:${req.text}` }))
+server.register(Live, async (stream) => {
+  for await (const msg of stream) await stream.send(msg)
+})
+
+pc.ondatachannel = ({ channel }) => {
+  gw.bind(channel) // synchronously, so no early message is lost
+  void gw.servePeer(server, channel) // §4.5 teardown on every exit
+}
+```
+
+Handlers are plain functions per RPC type:
+
+| Type | Signature |
+|---|---|
+| unary | `(req, ctx) => Res \| Promise<Res>` |
+| server-streaming | `(req, stream, ctx) => Promise<void>` |
+| client-streaming | `(stream, ctx) => Res \| Promise<Res>` — the return value is the response |
+| bidi | `(stream, ctx) => Promise<void>` |
+
+`ctx.signal` is an `AbortSignal` aborted when the call ends for any reason
+(client abort, RESET, deadline, liveness expiry, `stop()`), with the
+`StatusError` cause as its reason; `ctx.setHeader` / `ctx.sendHeader` /
+`ctx.setTrailer` follow §11. Handler failures are `StatusError`s (anything
+else maps to `UNKNOWN`).
+
+## Translation notes (Go ↔ TS)
+
+| Go | TS |
+|---|---|
+| `context.Context` cancellation/deadline | `CallOptions.signal` (`AbortSignal`) + `timeoutMs`; handler `ctx.signal` |
+| `*status.Status` errors | `StatusError { code, desc }` |
+| `metadata.MD` | `Metadata = Record<string, string[]>`; a `-bin` key holds base64 (raw octets on the wire) |
+| `grpc.ClientConnInterface` / generated stubs | `conn.invoke(desc, req)` / `conn.newStream(desc)` |
+| `RegisterService` + codegen | `server.register(desc, handler)` per method |
+| `TransportInfo` / `ConnAttacher` discovery | same, structural (`reliable()`, `attachConn()`) |
+| `drpc.ErrMessageTooLarge` | `MessageTooLargeError` (adapters throw it or set it as `cause`) |
+| `NewPeerContext` / `NewReliableContext` | `FrameContext { peer, reliable, signal }` argument to `handle` |
+| mutexes + atomics | none needed: state transitions are synchronous between `await` points |
+
+Deliberately not ported (yet): client/server interceptors, the observability
+surface (Go's `stats.Handler` + `ProtocolStats`), and `Envelop` batching
+(`Coalescer` — deferred to M8 in Go; every envelop carries one frame, as the
+shipped Go adapters do).
+
+Receive-path note for browsers: an `RTCDataChannel` cannot pause delivery, so
+adapter-level buffering is unavoidable — but since v1.1 the *protocol* paces
+the sender instead of the receiver (§4.2.1 flow control), so a slow consumer
+no longer needs the receive path to block at all, and never stalls the other
+calls sharing the channel.
+
+## Tests
+
+`pnpm test` — 353 tests mirroring the Go suites: the §5 golden wire vectors
+byte-for-byte (including the v1.1 vectors generated from the Go
+implementation), e2e for all four RPC types, the §10 timeout system under
+deterministic fake-timer loss (blackhole, lost terminals/acks/half-closes,
+probes, liveness), the §6.5 restart walkthroughs, §15 caps and §4.2 drop
+policies, §4.2.1 flow control (advertisement, parking, grants, `T_stall`,
+overrun), compression, size caps and binary metadata, each adapter
+(WebRTC/WebSocket/Port/UDP/protobuf-es/Connect) next to its source, `open()`
+and the worker it ships against a fake `Go` (`src/wasm/`), and two
+cross-language conformance tests driving a real Go `drpc.Server`: one over
+loopback UDP, one a `js/wasm` build of the server loaded into the test process
+and talked to across a `MessageChannel` — the second being where reliable mode
+is genuinely reliable rather than asserted, so the §4.2.1 windows are exercised
+between the two implementations.
+
+**Layout.** Unit and per-adapter tests are **co-located** next to their source
+(`src/wire.test.ts`, `src/transport/webrtc/index.test.ts`, …); cross-cutting
+integration tests (e2e, timeout, restart, limits, conformance) stay in
+`test/`. Shared test infrastructure — the echo fixtures and the generated
+`protoc-gen-es` code — lives in `src/testing/` (not an entry, not published).
+None of it reaches `dist/` (tsdown builds only the `exports` entries).
+
+## Licence
+
+[Apache 2.0](https://github.com/lesomnus/grpc-dgram/blob/main/LICENSE).