@keri-ts/hosting 0.0.0-stage → 2.0.0

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 [yyyy] [name of copyright owner]
+
+   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

@@ -1,3 +1,23 @@
-# Temporary Holding Version
+# @keri-ts/hosting
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Concrete Deno/Node HTTP hosting, app middleware and protocol route composition
+for KERI runtimes. The package borrows public `keri-ts/runtime` and `cesr-ts`
+operations; KERI continues to own protocol evidence and acceptance.
+
+```ts
+import { createProtocolHandler, createTufaApp, runHostKernel, startServer } from "@keri-ts/hosting";
+```
+
+`runHostKernel` composes the existing runtime and HTTP listener over a borrowed
+Habery. It joins companion tasks, workers, active responses and owned resources
+before teardown. `startServer` owns the concrete Deno/Node adapter lifecycle.
+`createTufaApp` retains the existing Hono middleware/error policy around
+`createProtocolHandler`; direct handler consumers close its artifact responses.
+Names, routes, shutdown ordering and HTTP behavior are unchanged by extraction.
+
+Tufa retains CLI registration and indirect/role/witness TCP composition. This
+package introduces no role router, provider abstraction or alternate scheduler.
+Import hosting APIs from this package directly; Tufa publishes its CLI surface.
+
+Run `deno task check`, `deno task test` and `deno task build:npm` in this directory.
+Licensed under Apache-2.0; see the repository's `LICENSE`.

package/esm/hosting/npm/src/_dnt.shims.js

@@ -0,0 +1,61 @@
+import { Deno } from "@deno/shim-deno";
+export { Deno } from "@deno/shim-deno";
+const dntGlobals = {
+    Deno,
+};
+export const dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
+function createMergeProxy(baseObj, extObj) {
+    return new Proxy(baseObj, {
+        get(_target, prop, _receiver) {
+            if (prop in extObj) {
+                return extObj[prop];
+            }
+            else {
+                return baseObj[prop];
+            }
+        },
+        set(_target, prop, value) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            baseObj[prop] = value;
+            return true;
+        },
+        deleteProperty(_target, prop) {
+            let success = false;
+            if (prop in extObj) {
+                delete extObj[prop];
+                success = true;
+            }
+            if (prop in baseObj) {
+                delete baseObj[prop];
+                success = true;
+            }
+            return success;
+        },
+        ownKeys(_target) {
+            const baseKeys = Reflect.ownKeys(baseObj);
+            const extKeys = Reflect.ownKeys(extObj);
+            const extKeysSet = new Set(extKeys);
+            return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
+        },
+        defineProperty(_target, prop, desc) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            Reflect.defineProperty(baseObj, prop, desc);
+            return true;
+        },
+        getOwnPropertyDescriptor(_target, prop) {
+            if (prop in extObj) {
+                return Reflect.getOwnPropertyDescriptor(extObj, prop);
+            }
+            else {
+                return Reflect.getOwnPropertyDescriptor(baseObj, prop);
+            }
+        },
+        has(_target, prop) {
+            return prop in extObj || prop in baseObj;
+        },
+    });
+}

package/esm/hosting/npm/src/mod.js

@@ -0,0 +1,7 @@
+/** HTTP hosting package entrypoint. */
+export { startServer } from "./src/host/http-server.js";
+export { runHostKernel, } from "./src/host/kernel.js";
+export { createTufaApp } from "./src/http/app.js";
+export { createProtocolHandler } from "./src/http/protocol-handler.js";
+export { handleWitnessReceiptPost } from "./src/http/protocol/endpoints/witness-http.js";
+export { sourceRequest, SourceTrust } from "./src/http/source.js";

package/esm/hosting/npm/src/src/host/http-server.js

@@ -0,0 +1,310 @@
+/**
+ * Shared HTTP host adapters for the HTTP application edge.
+ *
+ * This module owns Deno/Node listener startup, request bridging, and shutdown.
+ * Protocol route composition lives under `hosting/src/http`, while route-facing
+ * policy lives in `keri-ts` through `ProtocolHostPolicy`.
+ */
+import * as dntShim from "../../_dnt.shims.js";
+import { action, call } from "effection";
+import { consoleLogger } from "keri-ts/runtime";
+import { createServer } from "node:http";
+import { createServer as createTlsServer } from "node:https";
+import { Readable } from "node:stream";
+import { createTufaApp } from "../http/app.js";
+/**
+ * Detect whether the current runtime can host directly via `Deno.serve()`.
+ *
+ * The npm build still carries a Deno shim object, so this checks the actual
+ * function presence instead of assuming `globalThis.Deno` means native hosting.
+ */
+function hasDenoServe() {
+    return typeof dntShim.Deno.serve === "function";
+}
+/** Normalize startup policy shared by both HTTP host implementations. */
+function buildServerOptions(port, logger, signal, hostname = "127.0.0.1", onListen, tls) {
+    return {
+        port,
+        hostname,
+        signal,
+        tls,
+        onListen: ({ port }) => {
+            logger.info(`Server running on ${tls ? "https" : "http"}://${hostname}:${port}`);
+            onListen?.({ port, hostname });
+        },
+        onError: (error) => {
+            logger.error("Server error:", error);
+            return new Response("Internal Server Error", { status: 500 });
+        },
+    };
+}
+/** Empty PEM values must fail before native serving can interpret them as plaintext options. */
+function requireTlsIdentity(options) {
+    if (options.tls && (!options.tls.key || !options.tls.cert)) {
+        throw new Error("HTTPS requires both a certificate and private key in PEM format.");
+    }
+}
+/** Open the native Deno HTTP host and join request cleanup after its listener closes. */
+export function openDenoServerHost(options, handler) {
+    requireTlsIdentity(options);
+    const requests = new Set();
+    const server = dntShim.Deno.serve({ ...options, ...options.tls }, (request) => {
+        const response = Promise.resolve().then(() => handler(request));
+        requests.add(response);
+        void response.then(() => requests.delete(response), () => requests.delete(response));
+        return response;
+    });
+    return {
+        server: {
+            // Native server.finished can resolve while a disconnected handler still joins parser/sink cleanup.
+            finished: server.finished.finally(async () => {
+                await Promise.allSettled(requests);
+            }),
+        },
+        close() {
+            // The abort signal passed to `Deno.serve()` owns shutdown.
+        },
+    };
+}
+/** Preserve multiplicity when copying Node headers into Fetch `Headers`. */
+function appendNodeHeader(headers, key, value) {
+    if (Array.isArray(value)) {
+        for (const item of value) {
+            headers.append(key, item);
+        }
+        return;
+    }
+    if (value !== undefined) {
+        headers.set(key, value);
+    }
+}
+/** Convert one Node incoming request into a Fetch `Request`. */
+function toNodeRequest(req, options, signal) {
+    const headers = new Headers();
+    for (const [key, value] of Object.entries(req.headers)) {
+        appendNodeHeader(headers, key, value);
+    }
+    const method = req.method ?? "GET";
+    const host = req.headers.host ?? `${options.hostname}:${options.port}`;
+    const init = {
+        method,
+        headers,
+        signal,
+    };
+    if (method !== "GET" && method !== "HEAD") {
+        init.body = Readable.toWeb(req);
+        init.duplex = "half";
+    }
+    return new Request(`${options.tls ? "https" : "http"}://${host}${req.url ?? "/"}`, init);
+}
+/** Flush one Fetch `Response` back onto Node's `ServerResponse`. */
+async function writeNodeResponse(res, response) {
+    res.statusCode = response.status;
+    response.headers.forEach((value, key) => {
+        res.setHeader(key, value);
+    });
+    if (!response.body) {
+        res.end();
+        return;
+    }
+    const stream = Readable.fromWeb(response.body);
+    try {
+        await new Promise((resolve, reject) => {
+            stream.once("error", reject);
+            res.once("error", reject);
+            res.once("finish", () => resolve());
+            res.once("close", () => {
+                // A disconnect may never emit finish; destroying the Node reader cancels its Fetch body too.
+                stream.destroy();
+                resolve();
+            });
+            stream.pipe(res);
+        });
+    }
+    finally {
+        // fromWeb finishes destruction only after cancelling its source; retain ownership until that joins.
+        await new Promise((resolve) => {
+            if (stream.closed)
+                resolve();
+            else {
+                stream.once("close", resolve);
+                stream.destroy();
+            }
+        });
+    }
+}
+/** Execute the shared Fetch handler for one Node request. */
+async function handleNodeRequest(req, res, options, handler) {
+    const disconnected = new AbortController();
+    /** Carry socket loss into every request-owned parser and storage operation. */
+    const abort = () => disconnected.abort(new DOMException("Client disconnected", "AbortError"));
+    req.once("aborted", abort);
+    res.once("close", abort);
+    const signal = AbortSignal.any([options.signal, disconnected.signal]);
+    try {
+        const response = await handler(toNodeRequest(req, options, signal));
+        if (!res.destroyed)
+            await writeNodeResponse(res, response);
+        else
+            await response.body?.cancel();
+    }
+    catch (error) {
+        if (res.headersSent) {
+            // A streamed body can fail after 200 headers; terminate that transfer instead of rewriting its status.
+            res.destroy();
+            if (!signal.aborted || error !== signal.reason)
+                options.onError(error);
+        }
+        else if (!res.destroyed) {
+            const fallback = options.onError(error);
+            await writeNodeResponse(res, fallback);
+        }
+    }
+    finally {
+        req.removeListener("aborted", abort);
+        res.removeListener("close", abort);
+        disconnected.abort();
+    }
+}
+/** Open the Node fallback host; completion joins every admitted request after the listener closes. */
+export function openNodeServerHost(options, handler) {
+    requireTlsIdentity(options);
+    // A closed socket does not imply that its parser or payload cleanup has finished.
+    const requests = new Set();
+    const listener = (req, res) => {
+        const request = handleNodeRequest(req, res, options, handler);
+        requests.add(request);
+        // Attach both branches immediately: a rejected fallback response must not become detached rejection.
+        void request.then(() => requests.delete(request), () => requests.delete(request));
+    };
+    const server = options.tls ? createTlsServer(options.tls, listener) : createServer(listener);
+    // listen() is asynchronous; an owner can close the host before Node marks it listening.
+    let closing = false;
+    /** Remember early cancellation and close the listener as soon as it becomes available. */
+    const close = () => {
+        closing = true;
+        if (server.listening)
+            server.close();
+    };
+    const onAbort = close;
+    options.signal.addEventListener("abort", onAbort, { once: true });
+    const closed = new Promise((resolve, reject) => {
+        server.once("close", resolve);
+        server.once("error", reject);
+    });
+    const finished = closed.finally(async () => {
+        // Listener closure prevents new admissions; settle every remaining owner before releasing the runtime.
+        await Promise.allSettled(requests);
+    });
+    server.listen(options.port, options.hostname, () => {
+        if (closing || options.signal.aborted) {
+            close();
+            return;
+        }
+        const address = server.address();
+        const port = typeof address === "object" && address !== null ? address.port : options.port;
+        options.onListen({ port });
+    });
+    return {
+        server: { finished },
+        close() {
+            options.signal.removeEventListener("abort", onAbort);
+            close();
+        },
+    };
+}
+/** Open one HTTP host and return its cleanup handle. */
+function openServerHost(port, logger, runtime, options = {}) {
+    const controller = new AbortController();
+    const { signal } = controller;
+    let requestShutdown;
+    const shutdownRequested = new Promise((resolve) => requestShutdown = resolve);
+    const shutdown = () => {
+        logger.info("Shutting down server...");
+        requestShutdown();
+    };
+    const serverOptions = buildServerOptions(port, logger, signal, options.hostname ?? "127.0.0.1", options.onListen, options.tls);
+    const app = createTufaApp({
+        runtime,
+        protocolPolicy: options,
+        protocolHandler: options.protocolHandler,
+        app: { logger },
+    });
+    const handler = (req) => Promise.resolve(app.fetch(req));
+    dntShim.Deno.addSignalListener("SIGINT", shutdown);
+    dntShim.Deno.addSignalListener("SIGTERM", shutdown);
+    const removeSignals = () => {
+        dntShim.Deno.removeSignalListener("SIGINT", shutdown);
+        dntShim.Deno.removeSignalListener("SIGTERM", shutdown);
+    };
+    let host;
+    try {
+        if (hasDenoServe()) {
+            try {
+                host = openDenoServerHost(serverOptions, handler);
+            }
+            catch (error) {
+                logger.warn(`Falling back to Node ${options.tls ? "HTTPS" : "HTTP"} host after Deno.serve() startup failed:`, error);
+                host = openNodeServerHost(serverOptions, handler);
+            }
+        }
+        else {
+            host = openNodeServerHost(serverOptions, handler);
+        }
+    }
+    catch (error) {
+        removeSignals();
+        throw error;
+    }
+    return {
+        server: host.server,
+        shutdownRequested,
+        async close() {
+            // Keep repeated signals graceful until the adapter has actually drained.
+            try {
+                try {
+                    await host.close();
+                }
+                finally {
+                    controller.abort();
+                    try {
+                        await app.close();
+                    }
+                    finally {
+                        await host.server.finished;
+                    }
+                }
+            }
+            finally {
+                removeSignals();
+            }
+        },
+    };
+}
+/** Adapt `server.finished` into an Effection operation. */
+function* waitForServerStop(host) {
+    yield* action((resolve, reject) => {
+        Promise.race([host.server.finished, host.shutdownRequested]).then(resolve).catch(reject);
+        return () => { };
+    });
+}
+/** Start the Tufa HTTP host for one shared `AgentRuntime`. */
+export function* startServer(port = 8000, logger = consoleLogger, runtime, options = {}, beforeDrain) {
+    const host = openServerHost(port, logger, runtime, options);
+    try {
+        yield* waitForServerStop(host);
+    }
+    finally {
+        // Stop accepting work synchronously, then let the owner close response-producing
+        // resources before waiting for active response bodies to drain.
+        const closing = host.close();
+        try {
+            if (beforeDrain) {
+                yield* beforeDrain();
+            }
+        }
+        finally {
+            yield* call(() => Promise.resolve(closing));
+        }
+    }
+}