From c5c593b7098360f3cf04a99b873fd5133b239828 Mon Sep 17 00:00:00 2001 From: Kinflou Date: Wed, 2 Sep 2026 16:43:32 +0800 Subject: [PATCH] =?UTF-8?q?feat(runtime):=20@comline/runtime=20=E2=80=94?= =?UTF-8?q?=20the=20contract=20layer?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit First cut of the TypeScript runtime generated bindings will link against (the counterpart of the Rust comline-runtime crate). MPL-2.0, Node, zero runtime dependencies. - contract.ts — RuntimeError, Kind + resolveKind, Call, Envelope, Outcome, Reply, CallError, the Codec and Dispatch interfaces. - handshake.ts — Handshake (the fixed 31-byte frame), FNV-1a nameHash, check(). Byte-compatible with comline-runtime's contract::handshake — the nameHash reference vectors are cross-checked against the Rust constants, so a TS peer and a Rust peer generated from one schema negotiate the same frame. - codec.ts — JsonCodec (name "json", pairs with Rust format::Json). Framing (datagram + JSON-RPC), Transport, Client, Server, and a generator that emits Client / dispatcher against this package follow. CI gains a Node job (npm ci / typecheck / node --test) alongside the existing cargo one. --- .github/workflows/ci.yml | 17 +- .gitignore | 4 + README.md | 26 ++- runtime/LICENSE | 373 +++++++++++++++++++++++++++++++++ runtime/README.md | 47 +++++ runtime/package-lock.json | 48 +++++ runtime/package.json | 26 +++ runtime/src/codec.ts | 34 +++ runtime/src/contract.ts | 143 +++++++++++++ runtime/src/handshake.ts | 105 ++++++++++ runtime/src/index.ts | 33 +++ runtime/test/contract.test.ts | 65 ++++++ runtime/test/handshake.test.ts | 71 +++++++ runtime/tsconfig.json | 20 ++ 14 files changed, 1005 insertions(+), 7 deletions(-) create mode 100644 runtime/LICENSE create mode 100644 runtime/README.md create mode 100644 runtime/package-lock.json create mode 100644 runtime/package.json create mode 100644 runtime/src/codec.ts create mode 100644 runtime/src/contract.ts create mode 100644 runtime/src/handshake.ts create mode 100644 runtime/src/index.ts create mode 100644 runtime/test/contract.test.ts create mode 100644 runtime/test/handshake.test.ts create mode 100644 runtime/tsconfig.json diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 10e3def..77f4a92 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,4 +1,4 @@ -name: Cargo Build & Test +name: CI on: push: @@ -16,3 +16,18 @@ jobs: - run: rustup update stable && rustup default stable - run: cargo build --verbose - run: cargo test --verbose + + runtime: + name: runtime - Node + runs-on: ubuntu-latest + defaults: + run: + working-directory: runtime + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + node-version: 20 + - run: npm ci + - run: npm run typecheck + - run: npm test diff --git a/.gitignore b/.gitignore index ba0ab78..c3ca7a6 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,7 @@ Cargo.lock .idea/ __TEMP__/ + +# runtime/ (Node) +runtime/node_modules/ +runtime/dist/ diff --git a/README.md b/README.md index f1c0c2e..268dbce 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,19 @@ The **TypeScript target** for [Comline](https://github.com/ComlineProject) — o repo per language, holding that language's codegen, libgen, runtime and std-extra together. -Today: just `codegen/` (`comline-codegen-typescript`), the `code`-mode generator, -extracted from `ComlineProject/generation`. `lib` mode, a runtime, and -std-extra follow. +Today: `codegen/` (`comline-codegen-typescript`, the `code`-mode generator, +extracted from `ComlineProject/generation`) and `runtime/` (`@comline/runtime`, +the contract layer so far). `lib` mode, the rest of the runtime, and std-extra +follow. ## `codegen/` `comline-codegen-typescript` — frozen IR → `.ts` source: `export interface` per -struct, `export enum` (string values) per enum, `export interface` per protocol. -It depends on `comline-codegen` (the language-neutral contract + `Registry`) and -`comline-core` (the IR), both by git rev. +struct / `error`, `export enum` (string values) per enum, and per `protocol` the +RPC shape (an `IR_HASH`, params interfaces, discriminated-union error types, and +an `export interface` of `Promise`-returning methods). It depends on +`comline-codegen` (the language-neutral contract + `Registry`) and `comline-core` +(the IR), both by git rev. `register(&mut Registry)` contributes the generator under `typescript` / `ts` at version `5.0`; the Comline CLI composes it into its `Registry` at startup. @@ -22,6 +25,17 @@ version `5.0`; the Comline CLI composes it into its `Registry` at startup. cargo test ``` +## `runtime/` + +`@comline/runtime` — the package generated bindings link against. So far the +framing-agnostic contract (`RuntimeError`, `Kind`, `Envelope`, `Reply`, +`CallError`, `Dispatch`), a `Handshake` byte-compatible with the Rust +`comline-runtime`, and a `JsonCodec`. Node, zero runtime dependencies. + +```sh +cd runtime && npm ci && npm test +``` + ## Design See `ComlineProject/docs` → Design: diff --git a/runtime/LICENSE b/runtime/LICENSE new file mode 100644 index 0000000..d0a1fa1 --- /dev/null +++ b/runtime/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at https://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/runtime/README.md b/runtime/README.md new file mode 100644 index 0000000..a2c0011 --- /dev/null +++ b/runtime/README.md @@ -0,0 +1,47 @@ +# @comline/runtime + +The **TypeScript runtime** that Comline-generated RPC bindings link against — +the counterpart of the Rust `comline-runtime` crate. + +## Status + +First cut: the framing-agnostic **contract** plus a JSON codec. No `Framing`, +`Transport`, `Client`, or `Server` yet — those, and a generator that emits a +`Client` / dispatcher against this package, follow. + +| Piece | State | +|---|---| +| `RuntimeError`, `Kind` / `resolveKind`, `Call`, `Envelope`, `Outcome`, `Reply`, `CallError` | ✅ | +| `Codec` interface + `JsonCodec` (`name === "json"`) | ✅ | +| `Handshake` — 31-byte frame, FNV-1a `nameHash`, `check` — byte-compatible with `comline-runtime` | ✅ | +| `Dispatch` interface | ✅ (shape only) | +| `Framing` (datagram + JSON-RPC), `Transport`, `Client`, `Server` | — | + +The `Handshake` wire format and `nameHash` are cross-checked against +`comline-runtime`'s reference vectors, so a TypeScript peer and a Rust peer +generated from the same schema negotiate the same frame. + +## Layout + +``` +src/ + contract.ts RuntimeError, Kind, Call, Envelope, Outcome, Reply, CallError, Codec, Dispatch + handshake.ts Handshake, nameHash, FRAMING_DATAGRAM + codec.ts JsonCodec + index.ts public surface +test/ node:test, zero runtime deps +``` + +## Develop + +```sh +npm ci +npm run typecheck +npm test # tsc + node --test +``` + +## License + +**Mozilla Public License 2.0** ([LICENSE](LICENSE)). Generated bindings link +this package, not the GPL toolchain — same split as the Rust `comline-runtime`. +See `ComlineProject/docs` → Design → *licensing*. diff --git a/runtime/package-lock.json b/runtime/package-lock.json new file mode 100644 index 0000000..21664c4 --- /dev/null +++ b/runtime/package-lock.json @@ -0,0 +1,48 @@ +{ + "name": "@comline/runtime", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "@comline/runtime", + "version": "0.0.0", + "license": "MPL-2.0", + "devDependencies": { + "@types/node": "^20.14.0", + "typescript": "^5.6.0" + } + }, + "node_modules/@types/node": { + "version": "20.19.43", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.43.tgz", + "integrity": "sha512-6oYBAi5ikg4Pl+kGsoYtawUMBT2zZMCvPNF7pVLnHZfd1zf38DRiWn/gT01RYCdUqkv7Fhr+C9ot4/tb+2sVvA==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~6.21.0" + } + }, + "node_modules/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/undici-types": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz", + "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==", + "dev": true, + "license": "MIT" + } + } +} diff --git a/runtime/package.json b/runtime/package.json new file mode 100644 index 0000000..4d132e3 --- /dev/null +++ b/runtime/package.json @@ -0,0 +1,26 @@ +{ + "name": "@comline/runtime", + "version": "0.0.0", + "description": "TypeScript runtime that Comline-generated RPC bindings link against.", + "license": "MPL-2.0", + "type": "module", + "exports": { + ".": { + "types": "./dist/src/index.d.ts", + "import": "./dist/src/index.js" + } + }, + "files": [ + "dist", + "src" + ], + "scripts": { + "build": "tsc -p tsconfig.json", + "typecheck": "tsc -p tsconfig.json --noEmit", + "test": "tsc -p tsconfig.json && node --test dist/test/*.test.js" + }, + "devDependencies": { + "@types/node": "^20.14.0", + "typescript": "^5.6.0" + } +} diff --git a/runtime/src/codec.ts b/runtime/src/codec.ts new file mode 100644 index 0000000..14b8227 --- /dev/null +++ b/runtime/src/codec.ts @@ -0,0 +1,34 @@ +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at https://mozilla.org/MPL/2.0/. + +/** + * Wire formats. {@link JsonCodec} pairs with the Rust runtime's `format::Json` + * (`name === "json"`); a MessagePack codec matching `format::MsgPack` is a + * later addition. + */ + +import type { Codec } from "./contract.js"; + +/** + * UTF-8 JSON. `bigint` fields (only 128-bit IDL integers map to `bigint`) are + * written as JSON numbers and read back as `number` — lossless below 2^53. A + * precise `bigint` round-trip waits on the tagged binary codec. + */ +export class JsonCodec implements Codec { + readonly name = "json"; + + encode(value: unknown): Uint8Array { + const json = JSON.stringify(value, (_key, v) => + typeof v === "bigint" ? Number(v) : v, + ); + if (json === undefined) { + throw new TypeError("JsonCodec: value is not JSON-serializable"); + } + return new TextEncoder().encode(json); + } + + decode(bytes: Uint8Array): T { + return JSON.parse(new TextDecoder().decode(bytes)) as T; + } +} diff --git a/runtime/src/contract.ts b/runtime/src/contract.ts new file mode 100644 index 0000000..15ab1f5 --- /dev/null +++ b/runtime/src/contract.ts @@ -0,0 +1,143 @@ +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at https://mozilla.org/MPL/2.0/. + +/** + * The framing-agnostic RPC contract — the TypeScript mirror of + * `comline-runtime`'s `contract` module. Generated bindings and (later) a + * `Client` / `Server` are written against these types. + */ + +/** Every way a call can fail below the application layer. */ +export type RuntimeErrorKind = + | "transport" // the transport failed to send or receive + | "serialization" // a payload would not encode / decode against its type + | "framing" // the call frame was malformed + | "timeout" // no response within the call's window + | "unknownCall" // the peer addressed a call this side does not have + | "remote" // the peer raised a schema error this side's code does not know + | "handshake"; // the connection handshake disagreed + +export class RuntimeError extends Error { + override readonly name = "RuntimeError"; + readonly kind: RuntimeErrorKind; + /** Schema-global error ordinal, set only when `kind === "remote"`. */ + readonly remoteId?: number; + + constructor(kind: RuntimeErrorKind, remoteId?: number) { + super(remoteId === undefined ? kind : `${kind} (#${remoteId})`); + this.kind = kind; + this.remoteId = remoteId; + } + + static transport(): RuntimeError { + return new RuntimeError("transport"); + } + static serialization(): RuntimeError { + return new RuntimeError("serialization"); + } + static framing(): RuntimeError { + return new RuntimeError("framing"); + } + static timeout(): RuntimeError { + return new RuntimeError("timeout"); + } + static unknownCall(): RuntimeError { + return new RuntimeError("unknownCall"); + } + static remote(id: number): RuntimeError { + return new RuntimeError("remote", id); + } + static handshake(): RuntimeError { + return new RuntimeError("handshake"); + } + + is(kind: RuntimeErrorKind): boolean { + return this.kind === kind; + } +} + +/** + * How a call is addressed on the wire. A datagram framing carries the ordinal + * (`id`); a name-oriented framing (JSON-RPC) carries the method `name`. A + * generated stub supplies both and lets the framing pick. + */ +export type Kind = { id: number } | { name: string }; + +/** Resolve a {@link Kind} to a call ordinal against the protocol's call list. */ +export function resolveKind(kind: Kind, calls: readonly string[]): number | undefined { + if ("id" in kind) { + return kind.id < calls.length ? kind.id : undefined; + } + const i = calls.indexOf(kind.name); + return i === -1 ? undefined : i; +} + +/** A `Call` a generated stub passes — both addresses, the framing picks one. */ +export interface Call { + readonly id: number; + readonly name: string; +} + +export function call(id: number, name: string): Call { + return { id, name }; +} + +/** + * A decoded response body: an `ok` payload for the stub to decode as its return + * type, or an `err` payload keyed by the schema-global error ordinal for the + * generated error table to map. + */ +export type Envelope = + | { readonly ok: Uint8Array } + | { readonly err: { readonly id: number; readonly body: Uint8Array } }; + +/** What a dispatched handler recorded — nothing (one-way), an ok, or an error. */ +export type Outcome = + | { readonly kind: "none" } + | { readonly kind: "ok" } + | { readonly kind: "err"; readonly id: number }; + +/** + * The framing-agnostic sink a generated dispatcher writes its result into. The + * `Server` (a later PR) turns the {@link Outcome} + body into whatever envelope + * the active framing wants. + */ +export class Reply { + outcome: Outcome = { kind: "none" }; + body: Uint8Array = new Uint8Array(0); + + ok(body: Uint8Array): void { + this.body = body; + this.outcome = { kind: "ok" }; + } + + err(id: number, body: Uint8Array): void { + this.body = body; + this.outcome = { kind: "err", id }; + } +} + +/** A call outcome for a generated client method: an app error, or a runtime one. */ +export type CallError = { readonly app: E } | { readonly runtime: RuntimeError }; + +/** + * A serialization format — the TypeScript `WireFormat`. `name` is folded into + * the {@link Handshake} so the two ends can catch "one side JSON, one side + * MessagePack" before exchanging real frames. + */ +export interface Codec { + readonly name: string; + encode(value: unknown): Uint8Array; + decode(bytes: Uint8Array): T; +} + +/** + * A generated dispatcher implements this: the ordered call list, and a + * `dispatch` that decodes params, runs the handler, and records the result on + * the {@link Reply}. + */ +export interface Dispatch { + calls(): readonly string[]; + dispatch(call: Kind, params: Uint8Array, codec: Codec, reply: Reply): Promise; +} diff --git a/runtime/src/handshake.ts b/runtime/src/handshake.ts new file mode 100644 index 0000000..ed3a2e8 --- /dev/null +++ b/runtime/src/handshake.ts @@ -0,0 +1,105 @@ +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at https://mozilla.org/MPL/2.0/. + +/** + * The connection handshake — byte-compatible with `comline-runtime`'s + * `contract::handshake`. Each end sends one fixed 31-byte frame first and + * refuses on a schema / wire-format / framing mismatch. + */ + +import { RuntimeError } from "./contract.js"; + +const MAGIC = Uint8Array.of(0x43, 0x4f); // "CO" +const VERSION = 1; +/** `[MAGIC:2][VERSION:1][ir_hash:u64][wire_format:u64][framing:u64][caps:u32]`, LE. */ +const LEN = 2 + 1 + 8 + 8 + 8 + 4; + +const U64_MASK = (1n << 64n) - 1n; +const FNV_OFFSET = 0xcbf29ce484222325n; +const FNV_PRIME = 0x00000100000001b3n; + +/** Name of Comline's default datagram framing. Pass it to {@link Handshake}. */ +export const FRAMING_DATAGRAM = "comline.datagram"; + +/** + * 64-bit FNV-1a over a name's UTF-8 bytes. Folds a wire-format / framing name + * into the fixed-size handshake without a registry; matches + * `comline_runtime::contract::name_hash`. + */ +export function nameHash(name: string): bigint { + let h = FNV_OFFSET; + for (const b of new TextEncoder().encode(name)) { + h = (h ^ BigInt(b)) & U64_MASK; + h = (h * FNV_PRIME) & U64_MASK; + } + return h; +} + +export interface HandshakeInit { + /** Fingerprint of the frozen IR both ends generated from (the `IR_HASH` const). */ + irHash: bigint; + /** The wire format's name, e.g. `"json"` — hashed in. */ + wireFormat: string; + /** The framing's name, e.g. {@link FRAMING_DATAGRAM} — hashed in. */ + framing: string; + /** Transport capability bits. Advisory: a difference here is not a mismatch. */ + capabilities?: number; +} + +/** What each end declares when a connection opens. */ +export class Handshake { + readonly irHash: bigint; + readonly wireFormat: bigint; + readonly framing: bigint; + readonly capabilities: number; + + constructor(init: HandshakeInit) { + this.irHash = init.irHash & U64_MASK; + this.wireFormat = nameHash(init.wireFormat); + this.framing = nameHash(init.framing); + this.capabilities = (init.capabilities ?? 0) >>> 0; + } + + /** The fixed 31-byte frame. */ + encode(): Uint8Array { + const frame = new Uint8Array(LEN); + const view = new DataView(frame.buffer); + frame.set(MAGIC, 0); + frame[2] = VERSION; + view.setBigUint64(3, this.irHash, true); + view.setBigUint64(11, this.wireFormat, true); + view.setBigUint64(19, this.framing, true); + view.setUint32(27, this.capabilities, true); + return frame; + } + + /** Parse a frame; `undefined` if truncated or the magic / version is wrong. */ + static decode(frame: Uint8Array): Handshake | undefined { + if (frame.length < LEN) return undefined; + if (frame[0] !== MAGIC[0] || frame[1] !== MAGIC[1] || frame[2] !== VERSION) { + return undefined; + } + const view = new DataView(frame.buffer, frame.byteOffset, LEN); + const h = Object.create(Handshake.prototype) as Handshake; + return Object.assign(h, { + irHash: view.getBigUint64(3, true), + wireFormat: view.getBigUint64(11, true), + framing: view.getBigUint64(19, true), + capabilities: view.getUint32(27, true), + }); + } + + /** + * Check a peer's declaration against this one. Throws + * `RuntimeError("handshake")` if `irHash`, `wireFormat`, or `framing` + * disagree; capability bits are allowed to differ. + */ + check(peer: Handshake): void { + const agree = + this.irHash === peer.irHash && + this.wireFormat === peer.wireFormat && + this.framing === peer.framing; + if (!agree) throw RuntimeError.handshake(); + } +} diff --git a/runtime/src/index.ts b/runtime/src/index.ts new file mode 100644 index 0000000..40b1b26 --- /dev/null +++ b/runtime/src/index.ts @@ -0,0 +1,33 @@ +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at https://mozilla.org/MPL/2.0/. + +/** + * `@comline/runtime` — the TypeScript runtime that Comline-generated RPC + * bindings link against. This first cut is the framing-agnostic contract plus + * a JSON codec; `Framing`, `Transport`, `Client`, and `Server` follow. + */ + +export { + RuntimeError, + type RuntimeErrorKind, + type Kind, + resolveKind, + type Call, + call, + type Envelope, + type Outcome, + Reply, + type CallError, + type Codec, + type Dispatch, +} from "./contract.js"; + +export { + FRAMING_DATAGRAM, + nameHash, + Handshake, + type HandshakeInit, +} from "./handshake.js"; + +export { JsonCodec } from "./codec.js"; diff --git a/runtime/test/contract.test.ts b/runtime/test/contract.test.ts new file mode 100644 index 0000000..e21c43c --- /dev/null +++ b/runtime/test/contract.test.ts @@ -0,0 +1,65 @@ +import assert from "node:assert/strict"; +import { test } from "node:test"; + +import { + JsonCodec, + Reply, + RuntimeError, + call, + resolveKind, + type Envelope, +} from "../src/index.js"; + +const CALLS = ["send", "history", "poke"] as const; + +test("resolveKind maps an id or a name to an ordinal", () => { + assert.equal(resolveKind({ id: 1 }, CALLS), 1); + assert.equal(resolveKind({ id: 9 }, CALLS), undefined); + assert.equal(resolveKind({ name: "poke" }, CALLS), 2); + assert.equal(resolveKind({ name: "nope" }, CALLS), undefined); +}); + +test("call carries both addresses", () => { + assert.deepEqual(call(0, "send"), { id: 0, name: "send" }); +}); + +test("Reply starts as none, then records ok / err", () => { + const r = new Reply(); + assert.equal(r.outcome.kind, "none"); + + r.ok(Uint8Array.of(1, 2, 3)); + assert.deepEqual(r.outcome, { kind: "ok" }); + assert.deepEqual([...r.body], [1, 2, 3]); + + r.err(4, Uint8Array.of(9)); + assert.deepEqual(r.outcome, { kind: "err", id: 4 }); + assert.deepEqual([...r.body], [9]); +}); + +test("RuntimeError carries a discriminant and an optional remote id", () => { + const e = RuntimeError.remote(7); + assert.equal(e.kind, "remote"); + assert.equal(e.remoteId, 7); + assert.ok(e.is("remote")); + assert.ok(e instanceof Error); + assert.equal(RuntimeError.timeout().remoteId, undefined); +}); + +test("JsonCodec round-trips a value and hashes as \"json\"", () => { + const codec = new JsonCodec(); + assert.equal(codec.name, "json"); + + const value = { body: "hi", seq: 42, tags: ["a", "b"] }; + const decoded = codec.decode(codec.encode(value)); + assert.deepEqual(decoded, value); + + // bigint degrades to a JS number (documented) rather than throwing + assert.equal(codec.decode(codec.encode(10n)), 10); +}); + +test("an Envelope is a discriminated ok / err", () => { + const ok: Envelope = { ok: Uint8Array.of(1) }; + const err: Envelope = { err: { id: 2, body: Uint8Array.of(3) } }; + assert.ok("ok" in ok); + assert.ok("err" in err && err.err.id === 2); +}); diff --git a/runtime/test/handshake.test.ts b/runtime/test/handshake.test.ts new file mode 100644 index 0000000..3614182 --- /dev/null +++ b/runtime/test/handshake.test.ts @@ -0,0 +1,71 @@ +import assert from "node:assert/strict"; +import { test } from "node:test"; + +import { FRAMING_DATAGRAM, Handshake, nameHash, RuntimeError } from "../src/index.js"; + +const sample = () => + new Handshake({ + irHash: 0xdeadbeef01020304n, + wireFormat: "msgpack", + framing: FRAMING_DATAGRAM, + capabilities: 0b101, + }); + +test("nameHash is deterministic and name-specific", () => { + assert.equal(nameHash("msgpack"), nameHash("msgpack")); + assert.notEqual(nameHash("msgpack"), nameHash("json")); + assert.notEqual(nameHash("msgpack"), nameHash("com.acme.msgpack")); +}); + +test("nameHash matches the Rust FNV-1a reference vectors", () => { + // Cross-checked against `comline_runtime::contract::name_hash`. + assert.equal(nameHash(""), 0xcbf29ce484222325n); + assert.equal(nameHash("json"), 0x20bc6ede170e3803n); + assert.equal(nameHash("msgpack"), 0xc77cac73dc6306abn); + assert.equal(nameHash(FRAMING_DATAGRAM), 0x061d8c9e6a1421b9n); + assert.equal(nameHash("jsonrpc-2.0"), 0x25f94d83bdb63677n); +}); + +test("the frame is 31 bytes and round-trips", () => { + const frame = sample().encode(); + assert.equal(frame.length, 31); + + const back = Handshake.decode(frame); + assert.ok(back); + assert.equal(back.irHash, sample().irHash); + assert.equal(back.wireFormat, sample().wireFormat); + assert.equal(back.framing, sample().framing); + assert.equal(back.capabilities, 0b101); +}); + +test("decode rejects a truncated or foreign frame", () => { + assert.equal(Handshake.decode(new Uint8Array(0)), undefined); + assert.equal(Handshake.decode(new Uint8Array(31)), undefined); // bad magic + assert.equal(Handshake.decode(sample().encode().subarray(0, 30)), undefined); +}); + +test("check agrees, ignores capability bits, and rejects real mismatches", () => { + assert.doesNotThrow(() => sample().check(sample())); + + const capsDiffer = new Handshake({ + irHash: 0xdeadbeef01020304n, + wireFormat: "msgpack", + framing: FRAMING_DATAGRAM, + capabilities: 0, + }); + assert.doesNotThrow(() => sample().check(capsDiffer), "capability bits may differ"); + + const fmtDiffer = new Handshake({ + irHash: 0xdeadbeef01020304n, + wireFormat: "json", + framing: FRAMING_DATAGRAM, + }); + assert.throws(() => sample().check(fmtDiffer), (e: unknown) => e instanceof RuntimeError && e.is("handshake")); + + const schemaDiffer = new Handshake({ + irHash: 0n, + wireFormat: "msgpack", + framing: FRAMING_DATAGRAM, + }); + assert.throws(() => sample().check(schemaDiffer), RuntimeError); +}); diff --git a/runtime/tsconfig.json b/runtime/tsconfig.json new file mode 100644 index 0000000..81404f5 --- /dev/null +++ b/runtime/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "target": "ES2022", + "lib": ["ES2022"], + "module": "NodeNext", + "moduleResolution": "NodeNext", + "outDir": "dist", + "rootDir": ".", + "declaration": true, + "sourceMap": true, + "strict": true, + "noUncheckedIndexedAccess": true, + "noImplicitOverride": true, + "verbatimModuleSyntax": true, + "forceConsistentCasingInFileNames": true, + "skipLibCheck": true, + "types": ["node"] + }, + "include": ["src/**/*.ts", "test/**/*.ts"] +}