@restatedev/restate-sdk 0.7.3-worker → 0.8.1

package/dist/connection/http_connection.js

@@ -0,0 +1,203 @@
+"use strict";
+/*
+ * Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
+ *
+ * This file is part of the Restate SDK for Node.js/TypeScript,
+ * which is released under the MIT license.
+ *
+ * You can find a copy of the license in file LICENSE in the root
+ * directory of this repository or package, or at
+ * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestateHttp2Connection = void 0;
+const decoder_1 = require("../io/decoder");
+const logger_1 = require("../logger");
+const promises_1 = require("stream/promises");
+const buffered_connection_1 = require("./buffered_connection");
+// utility promise, for cases where we want to save allocation of an extra promise
+const RESOLVED = Promise.resolve();
+/**
+ * A duplex stream with Restate Messages over HTTP2.
+ *
+ * This stream handles the following concerns:
+ *
+ * (1) encoding and decoding of messages from  and from raw bytes
+ *
+ * (2) buffering the outgoing messages, because the call sites that produce (potentially) large
+ *     messages might not await their transfer. Aside from the fact that we achieve better pipelining
+ *     that way, we also simply cannot guarantee that users of the Restate SDK actually await the
+ *     relevant async API methods.
+ *
+ *     This stream essentially buffers messages and, upon flush, sends them asynchronously, as the
+ *     stream has availability. Flush requests queue up, if new data gets flushed while the previous
+ *     data is still being sent.
+ *
+ * (3) Input messages can be pipelined to a sequence of consumers. For example, first to a journal,
+ *     and afterwards to the state machine.
+ *
+ * (4) Handling the relevant stream events for errors and consolidating them to one error handler, plus
+ *     notifications for cleanly closed input (to trigger suspension).
+ */
+class RestateHttp2Connection {
+    rawStream;
+    /**
+     * create a RestateDuplex stream from an http2 (duplex) stream.
+     */
+    static from(http2stream) {
+        return new RestateHttp2Connection(http2stream);
+    }
+    // --------------------------------------------------------------------------
+    // input as decoded messages
+    sdkInput;
+    // consumer handling
+    currentConsumer = null;
+    inputBuffer = [];
+    consumerError;
+    consumerInputClosed = false;
+    outputBuffer;
+    constructor(rawStream) {
+        this.rawStream = rawStream;
+        this.sdkInput = rawStream.pipe((0, decoder_1.streamDecoder)());
+        this.outputBuffer = new buffered_connection_1.BufferedConnection((buffer) => {
+            const hasMoreCapacity = rawStream.write(buffer);
+            if (hasMoreCapacity) {
+                return RESOLVED;
+            }
+            else {
+                return new Promise((resolve) => rawStream.once("drain", resolve));
+            }
+        });
+        // remember and forward messages
+        this.sdkInput.on("data", (m) => {
+            // deliver message, if we have a consumer. otherwise buffer the message.
+            if (this.currentConsumer) {
+                if (this.currentConsumer.handleMessage(m)) {
+                    this.removeCurrentConsumer();
+                }
+            }
+            else {
+                this.inputBuffer.push(m);
+            }
+        });
+        // remember and forward close events
+        this.sdkInput.on("end", () => {
+            this.consumerInputClosed = true;
+            if (this.currentConsumer) {
+                this.currentConsumer.handleInputClosed();
+            }
+        });
+        // --------- error handling --------
+        // - a.k.a. node event wrangling...
+        // the error handler for all sorts of errors coming from streams
+        const errorHandler = (e) => {
+            // make sure we don't overwrite the initial error
+            if (this.consumerError !== undefined) {
+                return;
+            }
+            this.consumerError = e;
+            if (this.currentConsumer) {
+                this.currentConsumer.handleStreamError(e);
+            }
+        };
+        // those two event types should cover all types of connection losses
+        rawStream.on("aborted", () => {
+            logger_1.rlog.error("Connection to Restate was lost");
+            errorHandler(new Error("Connection to Restate was lost"));
+        });
+        // this is both the raw http2 stream and the output SDK->Restate
+        rawStream.on("error", (e) => {
+            logger_1.rlog.error("Error in http2 stream to Restate: " + (e.stack ?? e.message));
+            errorHandler(e);
+        });
+        // these events notify of errors in the decoding pipeline
+        this.sdkInput.on("error", (e) => {
+            logger_1.rlog.error("Error in input stream (Restate to Service): " + (e.stack ?? e.message));
+            errorHandler(e);
+        });
+        // see if streams get torn down before they end cleanly
+        this.sdkInput.on("close", () => {
+            if (!this.consumerInputClosed) {
+                errorHandler(new Error("stream was destroyed before end"));
+            }
+        });
+    }
+    // --------------------------------------------------------------------------
+    //  input stream handling
+    // --------------------------------------------------------------------------
+    /**
+     * Pipes the messages from this connection to the given consumer. The consumer
+     * will also receive error and stream closing notifications.
+     *
+     * Once the 'handleMessage()' method returns 'true', the consumer is immediately removed.
+     * That way, consumers can consume a bounded amount of messages (like just the initial journal).
+     *
+     * There can only be one consumer at a time.
+     */
+    pipeToConsumer(consumer) {
+        if (this.currentConsumer !== null) {
+            throw new Error("Already piping to a consumer");
+        }
+        this.currentConsumer = consumer;
+        // propagate pre-existing information
+        if (this.consumerError) {
+            consumer.handleStreamError(this.consumerError);
+        }
+        if (this.consumerInputClosed) {
+            consumer.handleInputClosed();
+        }
+        // pipe the buffered input messages, if we buffered some before the consumer was registered
+        const input = this.inputBuffer;
+        if (input.length > 0) {
+            let i = 0;
+            while (i < input.length) {
+                const done = consumer.handleMessage(input[i]);
+                i++;
+                if (done) {
+                    this.removeCurrentConsumer();
+                    break;
+                }
+            }
+            this.inputBuffer = i === input.length ? [] : this.inputBuffer.slice(i);
+        }
+    }
+    /**
+     * Removes the current consumer, if there is one.
+     */
+    removeCurrentConsumer() {
+        this.currentConsumer = null;
+    }
+    // --------------------------------------------------------------------------
+    //  output stream handling
+    // --------------------------------------------------------------------------
+    /**
+     * Adds a message to the output stream.
+     *
+     * This always puts the message into the node stream, but will return a promise that is resolved once
+     * further messages can be written.
+     *
+     * The reasoning is that some, but not all Restate operations return promises and are typically
+     * awaited. For example, rpc, sleep, side-effect have promises and are awaited, while one-way-sends and
+     * state updates don't return promises.
+     *
+     * As a pragmatic solution, we always accept messages, but return a promise for when the output has
+     * capacity again, so that at least the operations that await results will respect backpressure.
+     */
+    send(msg) {
+        return this.outputBuffer.send(msg);
+    }
+    /**
+     * Ends the stream, awaiting pending writes.
+     */
+    async end() {
+        await this.outputBuffer.end();
+        this.rawStream.end();
+        const options = {
+            error: true,
+            cleanup: true,
+        };
+        await (0, promises_1.finished)(this.rawStream, options);
+    }
+}
+exports.RestateHttp2Connection = RestateHttp2Connection;
+//# sourceMappingURL=http_connection.js.map

package/dist/connection/http_connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http_connection.js","sourceRoot":"","sources":["../../src/connection/http_connection.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAGH,2CAA8C;AAG9C,sCAAiC;AACjC,8CAA2C;AAC3C,+DAA2D;AAE3D,kFAAkF;AAClF,MAAM,QAAQ,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,sBAAsB;IAqBJ;IApB7B;;OAEG;IACI,MAAM,CAAC,IAAI,CAAC,WAA0B;QAC3C,OAAO,IAAI,sBAAsB,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IAED,6EAA6E;IAE7E,4BAA4B;IACX,QAAQ,CAAkB;IAE3C,oBAAoB;IACZ,eAAe,GAAiC,IAAI,CAAC;IACrD,WAAW,GAAc,EAAE,CAAC;IAC5B,aAAa,CAAS;IACtB,mBAAmB,GAAG,KAAK,CAAC;IAE5B,YAAY,CAAqB;IAEzC,YAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;QACnD,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,IAAA,uBAAa,GAAE,CAAC,CAAC;QAEhD,IAAI,CAAC,YAAY,GAAG,IAAI,wCAAkB,CAAC,CAAC,MAAM,EAAE,EAAE;YACpD,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAChD,IAAI,eAAe,EAAE;gBACnB,OAAO,QAAQ,CAAC;aACjB;iBAAM;gBACL,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;aACnE;QACH,CAAC,CAAC,CAAC;QAEH,gCAAgC;QAChC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAU,EAAE,EAAE;YACtC,wEAAwE;YACxE,IAAI,IAAI,CAAC,eAAe,EAAE;gBACxB,IAAI,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE;oBACzC,IAAI,CAAC,qBAAqB,EAAE,CAAC;iBAC9B;aACF;iBAAM;gBACL,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aAC1B;QACH,CAAC,CAAC,CAAC;QAEH,oCAAoC;QACpC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YAC3B,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;YAChC,IAAI,IAAI,CAAC,eAAe,EAAE;gBACxB,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,CAAC;aAC1C;QACH,CAAC,CAAC,CAAC;QAEH,oCAAoC;QACpC,mCAAmC;QAEnC,gEAAgE;QAChE,MAAM,YAAY,GAAG,CAAC,CAAQ,EAAE,EAAE;YAChC,iDAAiD;YACjD,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE;gBACpC,OAAO;aACR;YACD,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;YACvB,IAAI,IAAI,CAAC,eAAe,EAAE;gBACxB,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;aAC3C;QACH,CAAC,CAAC;QAEF,oEAAoE;QACpE,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YAC3B,aAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;YAC7C,YAAY,CAAC,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,gEAAgE;QAChE,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAQ,EAAE,EAAE;YACjC,aAAI,CAAC,KAAK,CAAC,oCAAoC,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YAC1E,YAAY,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;QAEH,yDAAyD;QACzD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAQ,EAAE,EAAE;YACrC,aAAI,CAAC,KAAK,CACR,8CAA8C,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,CACxE,CAAC;YACF,YAAY,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;QAEH,uDAAuD;QACvD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC7B,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE;gBAC7B,YAAY,CAAC,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC,CAAC;aAC5D;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,6EAA6E;IAC7E,yBAAyB;IACzB,6EAA6E;IAE7E;;;;;;;;OAQG;IACI,cAAc,CAAC,QAA+B;QACnD,IAAI,IAAI,CAAC,eAAe,KAAK,IAAI,EAAE;YACjC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;QAED,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC;QAEhC,qCAAqC;QACrC,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SAChD;QACD,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC5B,QAAQ,CAAC,iBAAiB,EAAE,CAAC;SAC9B;QAED,2FAA2F;QAC3F,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC;QAC/B,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE;gBACvB,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9C,CAAC,EAAE,CAAC;gBACJ,IAAI,IAAI,EAAE;oBACR,IAAI,CAAC,qBAAqB,EAAE,CAAC;oBAC7B,MAAM;iBACP;aACF;YACD,IAAI,CAAC,WAAW,GAAG,CAAC,KAAK,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACxE;IACH,CAAC;IAED;;OAEG;IACI,qBAAqB;QAC1B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;IAC9B,CAAC;IAED,6EAA6E;IAC7E,0BAA0B;IAC1B,6EAA6E;IAE7E;;;;;;;;;;;;OAYG;IACI,IAAI,CAAC,GAAY;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG;QACd,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;QAE9B,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;QAErB,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,IAAI;SACd,CAAC;QAEF,MAAM,IAAA,mBAAQ,EAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;CACF;AAvLD,wDAuLC"}

package/dist/connection/lambda_connection.js

@@ -0,0 +1,58 @@
+"use strict";
+/*
+ * Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
+ *
+ * This file is part of the Restate SDK for Node.js/TypeScript,
+ * which is released under the MIT license.
+ *
+ * You can find a copy of the license in file LICENSE in the root
+ * directory of this repository or package, or at
+ * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LambdaConnection = void 0;
+const encoder_1 = require("../io/encoder");
+const protocol_1 = require("../types/protocol");
+const logger_1 = require("../logger");
+const RESOLVED = Promise.resolve();
+class LambdaConnection {
+    suspendedOrCompleted;
+    // Empty buffer to store journal output messages
+    outputBuffer = Buffer.alloc(0);
+    // Callback to resolve the invocation promise of the Lambda handler when the response is ready
+    completionPromise;
+    resolveOnCompleted;
+    constructor(suspendedOrCompleted = false) {
+        this.suspendedOrCompleted = suspendedOrCompleted;
+        // Promise that signals when the invocation is over, to then flush the messages
+        this.completionPromise = new Promise((resolve) => {
+            this.resolveOnCompleted = resolve;
+        });
+    }
+    // Send a message back to the runtime
+    send(msg) {
+        // Add the header and the body to buffer and add to the output buffer
+        const msgBuffer = (0, encoder_1.encodeMessage)(msg);
+        this.outputBuffer = Buffer.concat([this.outputBuffer, msgBuffer]);
+        // An output message, suspension message or error message is the end of a Lambda invocation
+        if (msg.messageType === protocol_1.OUTPUT_STREAM_ENTRY_MESSAGE_TYPE ||
+            msg.messageType === protocol_1.SUSPENSION_MESSAGE_TYPE ||
+            msg.messageType === protocol_1.ERROR_MESSAGE_TYPE) {
+            this.suspendedOrCompleted = true;
+        }
+        return RESOLVED;
+    }
+    getResult() {
+        return this.completionPromise;
+    }
+    end() {
+        if (this.suspendedOrCompleted) {
+            logger_1.rlog.debug("Flushing output buffer...");
+            this.resolveOnCompleted(this.outputBuffer);
+        }
+        this.outputBuffer = Buffer.alloc(0);
+        return RESOLVED;
+    }
+}
+exports.LambdaConnection = LambdaConnection;
+//# sourceMappingURL=lambda_connection.js.map

package/dist/connection/lambda_connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lambda_connection.js","sourceRoot":"","sources":["../../src/connection/lambda_connection.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAGH,2CAA8C;AAC9C,gDAI2B;AAE3B,sCAAiC;AAEjC,MAAM,QAAQ,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;AAElD,MAAa,gBAAgB;IAQP;IAPpB,gDAAgD;IACxC,YAAY,GAAW,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAE/C,8FAA8F;IAC7E,iBAAiB,CAAkB;IAC5C,kBAAkB,CAAiD;IAE3E,YAAoB,uBAAuB,KAAK;QAA5B,yBAAoB,GAApB,oBAAoB,CAAQ;QAC9C,+EAA+E;QAC/E,IAAI,CAAC,iBAAiB,GAAG,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;YACvD,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,qCAAqC;IACrC,IAAI,CAAC,GAAY;QACf,qEAAqE;QACrE,MAAM,SAAS,GAAG,IAAA,uBAAa,EAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;QAElE,2FAA2F;QAC3F,IACE,GAAG,CAAC,WAAW,KAAK,2CAAgC;YACpD,GAAG,CAAC,WAAW,KAAK,kCAAuB;YAC3C,GAAG,CAAC,WAAW,KAAK,6BAAkB,EACtC;YACA,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;SAClC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED,GAAG;QACD,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC7B,aAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;YACxC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC5C;QACD,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpC,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AA7CD,4CA6CC"}