@dbos-inc/dbos-sdk 0.8.39-preview → 0.8.41-preview

package/packages/dbos-cloud/dist/src/debugger/debug_workflow.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowContextDebug = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const dbos_executor_1 = require("../dbos-executor");
+const transaction_1 = require("../transaction");
+const error_1 = require("../error");
+const serialize_error_1 = require("serialize-error");
+const context_1 = require("../context");
+const decorators_1 = require("../decorators");
+/**
+ * Context used for debugging a workflow
+ */
+class WorkflowContextDebug extends context_1.DBOSContextImpl {
+    workflowConfig;
+    functionID = 0;
+    #dbosExec;
+    isTempWorkflow;
+    constructor(dbosExec, parentCtx, workflowUUID, workflowConfig, workflowName) {
+        const span = dbosExec.tracer.startSpan(workflowName, {
+            operationUUID: workflowUUID,
+            operationType: dbos_executor_1.OperationType.WORKFLOW,
+            authenticatedUser: parentCtx?.authenticatedUser ?? "",
+            authenticatedRoles: parentCtx?.authenticatedRoles ?? [],
+            assumedRole: parentCtx?.assumedRole ?? "",
+        }, parentCtx?.span);
+        super(workflowName, span, dbosExec.logger, parentCtx);
+        this.workflowConfig = workflowConfig;
+        this.workflowUUID = workflowUUID;
+        this.#dbosExec = dbosExec;
+        this.isTempWorkflow = dbos_executor_1.DBOSExecutor.tempWorkflowName === workflowName;
+        if (dbosExec.config.application) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            this.applicationConfig = dbosExec.config.application;
+        }
+    }
+    functionIDGetIncrement() {
+        return this.functionID++;
+    }
+    invoke(object) {
+        const ops = (0, decorators_1.getRegisteredOperations)(object);
+        const proxy = {};
+        for (const op of ops) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            proxy[op.name] = op.txnConfig
+                ? // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                    (...args) => this.transaction(op.registeredFunction, ...args)
+                : op.commConfig
+                    ? // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                        (...args) => this.external(op.registeredFunction, ...args)
+                    : undefined;
+        }
+        return proxy;
+    }
+    async checkExecution(client, funcID) {
+        // Note: we read the recorded snapshot and transaction ID!
+        const query = "SELECT output, error, txn_snapshot, txn_id FROM dbos.transaction_outputs WHERE workflow_uuid=$1 AND function_id=$2";
+        const rows = await this.#dbosExec.userDatabase.queryWithClient(client, query, this.workflowUUID, funcID);
+        if (rows.length === 0 || rows.length > 1) {
+            this.logger.error("Unexpected! This should never happen during debug. Returned rows: " + rows.toString() + `. WorkflowUUID ${this.workflowUUID}, function ID ${funcID}`);
+            throw new error_1.DBOSDebuggerError(`This should never happen during debug. Returned ${rows.length} rows: ` + rows.toString());
+        }
+        if (JSON.parse(rows[0].error) != null) {
+            throw (0, serialize_error_1.deserializeError)(JSON.parse(rows[0].error)); // We don't replay errors.
+        }
+        const res = {
+            output: JSON.parse(rows[0].output),
+            txn_snapshot: rows[0].txn_snapshot,
+            txn_id: rows[0].txn_id,
+        };
+        // Send a signal to the debug proxy.
+        // TODO: use the real command once the proxy is fully implemented.
+        await this.#dbosExec.userDatabase.queryWithClient(client, `--proxy:${res.txn_id ?? ''}:${res.txn_snapshot}`);
+        return res;
+    }
+    /**
+     * Execute a transactional function in debug mode.
+     * It connects to a debug proxy and everything should be read-only.
+     */
+    async transaction(txn, ...args) {
+        const txnInfo = this.#dbosExec.transactionInfoMap.get(txn.name);
+        if (txnInfo === undefined) {
+            throw new error_1.DBOSDebuggerError(`Transaction ${txn.name} not registered!`);
+        }
+        // const readOnly = true; // TODO: eventually, this transaction must be read-only.
+        const funcID = this.functionIDGetIncrement();
+        const span = this.#dbosExec.tracer.startSpan(txn.name, {
+            operationUUID: this.workflowUUID,
+            operationType: dbos_executor_1.OperationType.TRANSACTION,
+            authenticatedUser: this.authenticatedUser,
+            authenticatedRoles: this.authenticatedRoles,
+            assumedRole: this.assumedRole,
+            readOnly: txnInfo.config.readOnly ?? false, // For now doing as in src/workflow.ts:272
+            isolationLevel: txnInfo.config.isolationLevel,
+        }, this.span);
+        let check;
+        const wrappedTransaction = async (client) => {
+            // Original result must exist during replay.
+            const tCtxt = new transaction_1.TransactionContextImpl(this.#dbosExec.userDatabase.getName(), client, this, span, this.#dbosExec.logger, funcID, txn.name);
+            check = await this.checkExecution(client, funcID);
+            // Execute the user's transaction.
+            const result = await txn(tCtxt, ...args);
+            return result;
+        };
+        const result = await this.#dbosExec.userDatabase.transaction(wrappedTransaction, txnInfo.config);
+        // If returned nothing and the recorded value is also null/undefined, we just return it
+        if (result === undefined && !check.output) {
+            return result;
+        }
+        if (JSON.stringify(check.output) !== JSON.stringify(result)) {
+            this.logger.error(`Detected different transaction output than the original one!\n Result: ${JSON.stringify(result)}\n Original: ${JSON.stringify(check.output)}`);
+        }
+        return check.output; // Always return the recorded result.
+    }
+    async external(commFn, ..._args) {
+        const commConfig = this.#dbosExec.communicatorInfoMap.get(commFn.name);
+        if (commConfig === undefined) {
+            throw new error_1.DBOSDebuggerError(`Communicator ${commFn.name} not registered!`);
+        }
+        const funcID = this.functionIDGetIncrement();
+        // FIXME: we do not create a span for the replay communicator. Do we want to?
+        // Original result must exist during replay.
+        const check = await this.#dbosExec.systemDatabase.checkOperationOutput(this.workflowUUID, funcID);
+        if (check === dbos_executor_1.dbosNull) {
+            throw new error_1.DBOSDebuggerError(`Cannot find recorded communicator output for ${commFn.name}. Shouldn't happen in debug mode!`);
+        }
+        this.logger.debug("Use recorded communicator output.");
+        return check;
+    }
+    // Invoke the debugWorkflow() function instead.
+    async childWorkflow(wf, ...args) {
+        const funcId = this.functionIDGetIncrement();
+        const childUUID = this.workflowUUID + "-" + funcId;
+        return this.#dbosExec.debugWorkflow(wf, { parentCtx: this, workflowUUID: childUUID }, this.workflowUUID, funcId, ...args);
+    }
+    async send(_destinationUUID, _message, _topic) {
+        const functionID = this.functionIDGetIncrement();
+        // Original result must exist during replay.
+        const check = await this.#dbosExec.systemDatabase.checkOperationOutput(this.workflowUUID, functionID);
+        if (check === dbos_executor_1.dbosNull) {
+            throw new error_1.DBOSDebuggerError(`Cannot find recorded send. Shouldn't happen in debug mode!`);
+        }
+        this.logger.debug("Use recorded send output.");
+        return;
+    }
+    async recv(_topic, _timeoutSeconds) {
+        const functionID = this.functionIDGetIncrement();
+        // Original result must exist during replay.
+        const check = await this.#dbosExec.systemDatabase.checkOperationOutput(this.workflowUUID, functionID);
+        if (check === dbos_executor_1.dbosNull) {
+            throw new error_1.DBOSDebuggerError(`Cannot find recorded recv. Shouldn't happen in debug mode!`);
+        }
+        this.logger.debug("Use recorded recv output.");
+        return check;
+    }
+    async setEvent(_key, _value) {
+        const functionID = this.functionIDGetIncrement();
+        // Original result must exist during replay.
+        const check = await this.#dbosExec.systemDatabase.checkOperationOutput(this.workflowUUID, functionID);
+        if (check === dbos_executor_1.dbosNull) {
+            throw new error_1.DBOSDebuggerError(`Cannot find recorded setEvent. Shouldn't happen in debug mode!`);
+        }
+        this.logger.debug("Use recorded setEvent output.");
+    }
+    async getEvent(_workflowUUID, _key, _timeoutSeconds) {
+        const functionID = this.functionIDGetIncrement();
+        // Original result must exist during replay.
+        const check = await this.#dbosExec.systemDatabase.checkOperationOutput(this.workflowUUID, functionID);
+        if (check === dbos_executor_1.dbosNull) {
+            throw new error_1.DBOSDebuggerError(`Cannot find recorded getEvent. Shouldn't happen in debug mode!`);
+        }
+        this.logger.debug("Use recorded getEvent output.");
+        return check;
+    }
+    retrieveWorkflow(targetUUID) {
+        // TODO: write a proper test for this.
+        const functionID = this.functionIDGetIncrement();
+        return new RetrievedHandleDebug(this.#dbosExec.systemDatabase, targetUUID, this.workflowUUID, functionID);
+    }
+}
+exports.WorkflowContextDebug = WorkflowContextDebug;
+/**
+ * The handle returned when retrieving a workflow with Debug workflow's retrieve
+ */
+class RetrievedHandleDebug {
+    systemDatabase;
+    workflowUUID;
+    callerUUID;
+    callerFunctionID;
+    constructor(systemDatabase, workflowUUID, callerUUID, callerFunctionID) {
+        this.systemDatabase = systemDatabase;
+        this.workflowUUID = workflowUUID;
+        this.callerUUID = callerUUID;
+        this.callerFunctionID = callerFunctionID;
+    }
+    getWorkflowUUID() {
+        return this.workflowUUID;
+    }
+    async getStatus() {
+        // Must use original result.
+        const check = await this.systemDatabase.checkOperationOutput(this.callerUUID, this.callerFunctionID);
+        if (check === dbos_executor_1.dbosNull) {
+            throw new error_1.DBOSDebuggerError(`Cannot find recorded workflow status. Shouldn't happen in debug mode!`);
+        }
+        return check;
+    }
+    async getResult() {
+        return await this.systemDatabase.getWorkflowResult(this.workflowUUID);
+    }
+}
+//# sourceMappingURL=debug_workflow.js.map

package/packages/dbos-cloud/dist/src/debugger/debug_workflow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug_workflow.js","sourceRoot":"","sources":["../../../../../src/debugger/debug_workflow.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,oDAAmF;AAEnF,gDAAqE;AAErE,oCAA4C;AAC5C,qDAAmD;AAInD,wCAA6C;AAC7C,8CAAwD;AASxD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,yBAAe;IAKoD;IAJ3G,UAAU,GAAW,CAAC,CAAC;IACd,SAAS,CAAC;IACV,cAAc,CAAU;IAEjC,YAAY,QAAsB,EAAE,SAAsC,EAAE,YAAoB,EAAW,cAA8B,EAAE,YAAoB;QAC7J,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CACpC,YAAY,EACZ;YACE,aAAa,EAAE,YAAY;YAC3B,aAAa,EAAE,6BAAa,CAAC,QAAQ;YACrC,iBAAiB,EAAE,SAAS,EAAE,iBAAiB,IAAI,EAAE;YACrD,kBAAkB,EAAE,SAAS,EAAE,kBAAkB,IAAI,EAAE;YACvD,WAAW,EAAE,SAAS,EAAE,WAAW,IAAI,EAAE;SAC1C,EACD,SAAS,EAAE,IAAI,CAChB,CAAC;QACF,KAAK,CAAC,YAAY,EAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAZmD,mBAAc,GAAd,cAAc,CAAgB;QAavI,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,cAAc,GAAG,4BAAY,CAAC,gBAAgB,KAAK,YAAY,CAAC;QACrE,IAAI,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAChC,mEAAmE;YACnE,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;QACvD,CAAC;IACH,CAAC;IAED,sBAAsB;QACpB,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAED,MAAM,CAAmB,MAAS;QAChC,MAAM,GAAG,GAAG,IAAA,oCAAuB,EAAC,MAAM,CAAC,CAAC;QAE5C,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACrB,sEAAsE;YACtE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS;gBAC3B,CAAC,CAAC,iEAAiE;oBACjE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,kBAA6C,EAAE,GAAG,IAAI,CAAC;gBACjG,CAAC,CAAC,EAAE,CAAC,UAAU;oBACf,CAAC,CAAC,iEAAiE;wBACjE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,kBAA8C,EAAE,GAAG,IAAI,CAAC;oBAC/F,CAAC,CAAC,SAAS,CAAC;QAChB,CAAC;QACD,OAAO,KAAyB,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,cAAc,CAAI,MAA0B,EAAE,MAAc;QAChE,0DAA0D;QAC1D,MAAM,KAAK,GAAG,oHAAoH,CAAC;QAEnI,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,eAAe,CAAsB,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAE9H,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oEAAoE,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,kBAAkB,IAAI,CAAC,YAAY,iBAAiB,MAAM,EAAE,CAAC,CAAC;YACzK,MAAM,IAAI,yBAAiB,CAAC,mDAAmD,IAAI,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACzH,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;YACtC,MAAM,IAAA,kCAAgB,EAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,0BAA0B;QAC/E,CAAC;QAED,MAAM,GAAG,GAAsB;YAC7B,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAM;YACvC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY;YAClC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM;SACvB,CAAC;QAEF,oCAAoC;QACpC,kEAAkE;QAClE,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,eAAe,CAAC,MAAM,EAAE,WAAW,GAAG,CAAC,MAAM,IAAI,EAAE,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC;QAE7G,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAqB,GAAsB,EAAE,GAAG,IAAO;QACtE,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChE,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,yBAAiB,CAAC,eAAe,GAAG,CAAC,IAAI,kBAAkB,CAAC,CAAC;QACzE,CAAC;QACD,kFAAkF;QAClF,MAAM,MAAM,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAS,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAChD,GAAG,CAAC,IAAI,EACR;YACE,aAAa,EAAE,IAAI,CAAC,YAAY;YAChC,aAAa,EAAE,6BAAa,CAAC,WAAW;YACxC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;YACzC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,IAAI,KAAK,EAAE,0CAA0C;YACtF,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc;SAC9C,EACD,IAAI,CAAC,IAAI,CACV,CAAC;QACF,IAAI,KAAwB,CAAC;QAE7B,MAAM,kBAAkB,GAAG,KAAK,EAAE,MAA0B,EAAc,EAAE;YAC1E,4CAA4C;YAC5C,MAAM,KAAK,GAAG,IAAI,oCAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;YAC7I,KAAK,GAAG,MAAM,IAAI,CAAC,cAAc,CAAI,MAAM,EAAE,MAAM,CAAC,CAAC;YAErD,kCAAkC;YAClC,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;YACzC,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjG,uFAAuF;QACvF,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,KAAM,CAAC,MAAM,EAAE,CAAC;YAC3C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,KAAM,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0EAA0E,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,KAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACrK,CAAC;QACD,OAAO,KAAM,CAAC,MAAM,CAAC,CAAC,qCAAqC;IAC7D,CAAC;IAED,KAAK,CAAC,QAAQ,CAAqB,MAA0B,EAAE,GAAG,KAAQ;QACxE,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACvE,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,yBAAiB,CAAC,gBAAgB,MAAM,CAAC,IAAI,kBAAkB,CAAC,CAAC;QAC7E,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE7C,6EAA6E;QAE7E,4CAA4C;QAC5C,MAAM,KAAK,GAAiB,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,oBAAoB,CAAI,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QACnH,IAAI,KAAK,KAAK,wBAAQ,EAAE,CAAC;YACvB,MAAM,IAAI,yBAAiB,CAAC,gDAAgD,MAAM,CAAC,IAAI,mCAAmC,CAAC,CAAC;QAC9H,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,OAAO,KAAU,CAAC;IACpB,CAAC;IAED,+CAA+C;IAC/C,KAAK,CAAC,aAAa,CAAqB,EAAkB,EAAE,GAAG,IAAO;QACpE,MAAM,MAAM,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC7C,MAAM,SAAS,GAAW,IAAI,CAAC,YAAY,GAAG,GAAG,GAAG,MAAM,CAAC;QAC3D,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAC5H,CAAC;IAED,KAAK,CAAC,IAAI,CAA6B,gBAAwB,EAAE,QAAW,EAAE,MAA2B;QACvG,MAAM,UAAU,GAAW,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAEzD,4CAA4C;QAC5C,MAAM,KAAK,GAAyB,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,oBAAoB,CAAY,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACvI,IAAI,KAAK,KAAK,wBAAQ,EAAE,CAAC;YACvB,MAAM,IAAI,yBAAiB,CAAC,4DAA4D,CAAC,CAAC;QAC5F,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,OAAO;IACT,CAAC;IAED,KAAK,CAAC,IAAI,CAA6B,MAA2B,EAAE,eAAoC;QACtG,MAAM,UAAU,GAAW,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAEzD,4CAA4C;QAC5C,MAAM,KAAK,GAAwB,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,oBAAoB,CAAW,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACrI,IAAI,KAAK,KAAK,wBAAQ,EAAE,CAAC;YACvB,MAAM,IAAI,yBAAiB,CAAC,4DAA4D,CAAC,CAAC;QAC5F,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,OAAO,KAAiB,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,QAAQ,CAA6B,IAAY,EAAE,MAAS;QAChE,MAAM,UAAU,GAAW,IAAI,CAAC,sBAAsB,EAAE,CAAC;QACzD,4CAA4C;QAC5C,MAAM,KAAK,GAAyB,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,oBAAoB,CAAY,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACvI,IAAI,KAAK,KAAK,wBAAQ,EAAE,CAAC;YACvB,MAAM,IAAI,yBAAiB,CAAC,gEAAgE,CAAC,CAAC;QAChG,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,QAAQ,CAA6B,aAAqB,EAAE,IAAY,EAAE,eAAoC;QAClH,MAAM,UAAU,GAAW,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAEzD,4CAA4C;QAC5C,MAAM,KAAK,GAAwB,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,oBAAoB,CAAW,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACrI,IAAI,KAAK,KAAK,wBAAQ,EAAE,CAAC;YACvB,MAAM,IAAI,yBAAiB,CAAC,gEAAgE,CAAC,CAAC;QAChG,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,OAAO,KAAiB,CAAC;IAC3B,CAAC;IAED,gBAAgB,CAAI,UAAkB;QACpC,sCAAsC;QACtC,MAAM,UAAU,GAAW,IAAI,CAAC,sBAAsB,EAAE,CAAC;QACzD,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,UAAU,EAAE,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IAC5G,CAAC;CACF;AAzMD,oDAyMC;AAED;;GAEG;AACH,MAAM,oBAAoB;IACH;IAAyC;IAA+B;IAA6B;IAA1H,YAAqB,cAA8B,EAAW,YAAoB,EAAW,UAAkB,EAAW,gBAAwB;QAA7H,mBAAc,GAAd,cAAc,CAAgB;QAAW,iBAAY,GAAZ,YAAY,CAAQ;QAAW,eAAU,GAAV,UAAU,CAAQ;QAAW,qBAAgB,GAAhB,gBAAgB,CAAQ;IAAG,CAAC;IAEtJ,eAAe;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,SAAS;QACb,4BAA4B;QAC5B,MAAM,KAAK,GAAqC,MAAM,IAAI,CAAC,cAAc,CAAC,oBAAoB,CAAwB,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9J,IAAI,KAAK,KAAK,wBAAQ,EAAE,CAAC;YACvB,MAAM,IAAI,yBAAiB,CAAC,uEAAuE,CAAC,CAAC;QACvG,CAAC;QACD,OAAO,KAA8B,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,SAAS;QACb,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAI,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,CAAC;CACF"}

package/packages/dbos-cloud/dist/src/decorators.d.ts

@@ -0,0 +1,118 @@
+import "reflect-metadata";
+import { TransactionConfig, TransactionContext } from "./transaction";
+import { WorkflowConfig, WorkflowContext } from "./workflow";
+import { DBOSContext, InitContext } from "./context";
+import { CommunicatorConfig, CommunicatorContext } from "./communicator";
+/**
+ * Any column type column can be.
+ */
+export type DBOSFieldType = "integer" | "double" | "decimal" | "timestamp" | "text" | "varchar" | "boolean" | "uuid" | "json";
+export declare class DBOSDataType {
+    dataType: DBOSFieldType;
+    length: number;
+    precision: number;
+    scale: number;
+    /** Varchar has length */
+    static varchar(length: number): DBOSDataType;
+    /** Some decimal has precision / scale (as opposed to floating point decimal) */
+    static decimal(precision: number, scale: number): DBOSDataType;
+    /** Take type from reflect metadata */
+    static fromArg(arg: Function): DBOSDataType;
+    formatAsString(): string;
+}
+export declare enum LogMasks {
+    NONE = "NONE",
+    HASH = "HASH",
+    SKIP = "SKIP"
+}
+export declare enum ArgRequiredOptions {
+    REQUIRED = "REQUIRED",
+    OPTIONAL = "OPTIONAL",
+    DEFAULT = "DEFAULT"
+}
+export declare class MethodParameter {
+    name: string;
+    required: ArgRequiredOptions;
+    validate: boolean;
+    logMask: LogMasks;
+    argType: Function;
+    dataType: DBOSDataType;
+    index: number;
+    constructor(idx: number, at: Function);
+}
+export interface RegistrationDefaults {
+    name: string;
+    requiredRole: string[] | undefined;
+    defaultArgRequired: ArgRequiredOptions;
+}
+export interface MethodRegistrationBase {
+    name: string;
+    args: MethodParameter[];
+    defaults?: RegistrationDefaults;
+    getRequiredRoles(): string[];
+    workflowConfig?: WorkflowConfig;
+    txnConfig?: TransactionConfig;
+    commConfig?: CommunicatorConfig;
+    registeredFunction: Function | undefined;
+    invoke(pthis: unknown, args: unknown[]): unknown;
+}
+export declare class MethodRegistration<This, Args extends unknown[], Return> implements MethodRegistrationBase {
+    defaults?: RegistrationDefaults | undefined;
+    name: string;
+    requiredRole: string[] | undefined;
+    args: MethodParameter[];
+    constructor(origFunc: (this: This, ...args: Args) => Promise<Return>);
+    debug: boolean;
+    needInitialized: boolean;
+    origFunction: (this: This, ...args: Args) => Promise<Return>;
+    registeredFunction: ((this: This, ...args: Args) => Promise<Return>) | undefined;
+    workflowConfig?: WorkflowConfig;
+    txnConfig?: TransactionConfig;
+    commConfig?: CommunicatorConfig;
+    init: boolean;
+    invoke(pthis: This, args: Args): Promise<Return>;
+    getRequiredRoles(): string[];
+}
+export declare class ClassRegistration<CT extends {
+    new (...args: unknown[]): object;
+}> implements RegistrationDefaults {
+    name: string;
+    requiredRole: string[] | undefined;
+    defaultArgRequired: ArgRequiredOptions;
+    needsInitialized: boolean;
+    ormEntities: Function[];
+    ctor: CT;
+    constructor(ctor: CT);
+}
+export declare function getRegisteredOperations(target: object): ReadonlyArray<MethodRegistrationBase>;
+export declare function getOrCreateMethodArgsRegistration(target: object, propertyKey: string | symbol): MethodParameter[];
+export declare function registerAndWrapFunction<This, Args extends unknown[], Return>(target: object, propertyKey: string, descriptor: TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>): {
+    descriptor: TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>;
+    registration: MethodRegistration<This, Args, Return>;
+};
+export declare function getOrCreateClassRegistration<CT extends {
+    new (...args: unknown[]): object;
+}>(ctor: CT): ClassRegistration<CT>;
+export declare function ArgRequired(target: object, propertyKey: string | symbol, parameterIndex: number): void;
+export declare function ArgOptional(target: object, propertyKey: string | symbol, parameterIndex: number): void;
+export declare function SkipLogging(target: object, propertyKey: string | symbol, parameterIndex: number): void;
+export declare function LogMask(mask: LogMasks): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
+export declare function ArgName(name: string): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
+export declare function ArgDate(): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
+export declare function ArgVarchar(length: number): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
+export declare function DefaultRequiredRole(anyOf: string[]): <T extends new (...args: unknown[]) => object>(ctor: T) => void;
+export declare function DefaultArgRequired<T extends {
+    new (...args: unknown[]): object;
+}>(ctor: T): void;
+export declare function DefaultArgOptional<T extends {
+    new (...args: unknown[]): object;
+}>(ctor: T): void;
+export declare function Debug(): <This, Ctx extends DBOSContext, Args extends unknown[], Return>(target: object, propertyKey: string, inDescriptor: TypedPropertyDescriptor<(this: This, ctx: Ctx, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ctx: Ctx, ...args: Args) => Promise<Return>>;
+export declare function RequiredRole(anyOf: string[]): <This, Ctx extends DBOSContext, Args extends unknown[], Return>(target: object, propertyKey: string, inDescriptor: TypedPropertyDescriptor<(this: This, ctx: Ctx, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ctx: Ctx, ...args: Args) => Promise<Return>>;
+export declare function Workflow(config?: WorkflowConfig): <This, Args extends unknown[], Return>(target: object, propertyKey: string, inDescriptor: TypedPropertyDescriptor<(this: This, ctx: WorkflowContext, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ctx: WorkflowContext, ...args: Args) => Promise<Return>>;
+export declare function Transaction(config?: TransactionConfig): <This, Args extends unknown[], Return>(target: object, propertyKey: string, inDescriptor: TypedPropertyDescriptor<(this: This, ctx: TransactionContext<any>, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ctx: TransactionContext<any>, ...args: Args) => Promise<Return>>;
+export declare function Communicator(config?: CommunicatorConfig): <This, Args extends unknown[], Return>(target: object, propertyKey: string, inDescriptor: TypedPropertyDescriptor<(this: This, ctx: CommunicatorContext, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ctx: CommunicatorContext, ...args: Args) => Promise<Return>>;
+export declare function OrmEntities(entities: Function[]): <T extends new (...args: unknown[]) => object>(ctor: T) => void;
+export declare function DBOSInitializer(): <This, Args extends unknown[], Return>(target: object, propertyKey: string, inDescriptor: TypedPropertyDescriptor<(this: This, ctx: InitContext, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ctx: InitContext, ...args: Args) => Promise<Return>>;
+export declare function DBOSDeploy(): <This, Args extends unknown[], Return>(target: object, propertyKey: string, inDescriptor: TypedPropertyDescriptor<(this: This, ctx: InitContext, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ctx: InitContext, ...args: Args) => Promise<Return>>;
+//# sourceMappingURL=decorators.d.ts.map

package/packages/dbos-cloud/dist/src/decorators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../../../src/decorators.ts"],"names":[],"mappings":"AAEA,OAAO,kBAAkB,CAAC;AAG1B,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAmB,WAAW,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAIzE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAE9H,qBAAa,YAAY;IACvB,QAAQ,EAAE,aAAa,CAAU;IACjC,MAAM,EAAE,MAAM,CAAM;IACpB,SAAS,EAAE,MAAM,CAAM;IACvB,KAAK,EAAE,MAAM,CAAM;IAEnB,yBAAyB;IACzB,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM;IAO7B,gFAAgF;IAChF,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAS/C,sCAAsC;IAEtC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ;IAkB5B,cAAc,IAAI,MAAM;CAczB;AAqBD,oBAAY,QAAQ;IAClB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAED,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB;AAED,qBAAa,eAAe;IAC1B,IAAI,EAAE,MAAM,CAAM;IAClB,QAAQ,EAAE,kBAAkB,CAA8B;IAC1D,QAAQ,EAAE,OAAO,CAAQ;IACzB,OAAO,EAAE,QAAQ,CAAiB;IAGlC,OAAO,EAAE,QAAQ,CAAU;IAC3B,QAAQ,EAAE,YAAY,CAAC;IACvB,KAAK,EAAE,MAAM,CAAM;gBAGP,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ;CAKtC;AAMD,MAAM,WAAW,oBAAoB;IAEnC,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACnC,kBAAkB,EAAE,kBAAkB,CAAC;CACxC;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,eAAe,EAAE,CAAC;IAExB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAEhC,gBAAgB,IAAI,MAAM,EAAG,CAAC;IAE9B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAGhC,kBAAkB,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEzC,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;CAClD;AAED,qBAAa,kBAAkB,CAAE,IAAI,EAAE,IAAI,SAAS,OAAO,EAAE,EAAE,MAAM,CACrE,YAAW,sBAAsB;IAE/B,QAAQ,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAE5C,IAAI,EAAE,MAAM,CAAM;IAElB,YAAY,EAAE,MAAM,EAAE,GAAG,SAAS,CAAa;IAE/C,IAAI,EAAE,eAAe,EAAE,CAAM;gBAEjB,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC;IAIpE,KAAK,EAAE,OAAO,CAAS;IACvB,eAAe,EAAE,OAAO,CAAQ;IAChC,YAAY,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7D,kBAAkB,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;IACjF,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,IAAI,EAAE,OAAO,CAAS;IAEtB,MAAM,CAAC,KAAK,EAAC,IAAI,EAAE,IAAI,EAAE,IAAI,GAAI,OAAO,CAAC,MAAM,CAAC;IAIhD,gBAAgB;CAMjB;AAED,qBAAa,iBAAiB,CAAE,EAAE,SAAS;IAAE,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAI,MAAM,CAAA;CAAE,CAAE,YAAW,oBAAoB;IAE/G,IAAI,EAAE,MAAM,CAAM;IAClB,YAAY,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACnC,kBAAkB,EAAE,kBAAkB,CAA+B;IACrE,gBAAgB,EAAE,OAAO,CAAQ;IAEjC,WAAW,EAAE,QAAQ,EAAE,CAAM;IAE7B,IAAI,EAAE,EAAE,CAAC;gBACG,IAAI,EAAE,EAAE;CAGrB;AASD,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC,sBAAsB,CAAC,CAS7F;AAED,wBAAgB,iCAAiC,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,eAAe,EAAE,CAYjH;AA4GD,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,IAAI,SAAS,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,uBAAuB,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;+CAAxC,IAAI,WAAW,IAAI,KAAK,QAAQ,MAAM,CAAC;;EAQpM;AAED,wBAAgB,4BAA4B,CAAC,EAAE,SAAS;IAAE,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAI,MAAM,CAAA;CAAE,EAC3F,IAAI,EAAE,EAAE,yBAgBT;AAMD,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,cAAc,EAAE,MAAM,QAK/F;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,cAAc,EAAE,MAAM,QAK/F;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,cAAc,EAAE,MAAM,QAK/F;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,QAAQ,YACZ,MAAM,eAAe,MAAM,GAAG,MAAM,kBAAkB,MAAM,UAMrF;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,YACT,MAAM,eAAe,MAAM,GAAG,MAAM,kBAAkB,MAAM,UAMtF;AAED,wBAAgB,OAAO,aACI,MAAM,eAAe,MAAM,GAAG,MAAM,kBAAkB,MAAM,UAMtF;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,YACd,MAAM,eAAe,MAAM,GAAG,MAAM,kBAAkB,MAAM,UAMtF;AAMD,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,4BACP,OAAO,EAAE,KAAI,MAAM,mBAM9D;AAED,wBAAgB,kBAAkB,CAAC,CAAC,SAAS;IAAE,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAI,MAAM,CAAA;CAAE,EAAE,IAAI,EAAE,CAAC,QAI1F;AAED,wBAAgB,kBAAkB,CAAC,CAAC,SAAS;IAAE,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAI,MAAM,CAAA;CAAE,EAAE,IAAI,EAAE,CAAC,QAI1F;AAOD,wBAAgB,KAAK,4EAET,MAAM,eACD,MAAM,wLAQtB;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,2EAEhC,MAAM,eACD,MAAM,wLAStB;AAED,wBAAgB,QAAQ,CAAC,MAAM,GAAE,cAAiB,kDAEtC,MAAM,eACD,MAAM,0DACqC,eAAe,uIAO1E;AAED,wBAAgB,WAAW,CAAC,MAAM,GAAE,iBAAoB,kDAE5C,MAAM,eACD,MAAM,0DAEqC,mBAAmB,GAAG,CAAC,+IAOlF;AAED,wBAAgB,YAAY,CAAC,MAAM,GAAE,kBAAqB,kDAE9C,MAAM,eACD,MAAM,0DACqC,mBAAmB,2IAQ9E;AAGD,wBAAgB,WAAW,CAAC,QAAQ,EAAE,QAAQ,EAAE,4BAEJ,OAAO,EAAE,KAAI,MAAM,mBAM9D;AAED,wBAAgB,eAAe,mDAEnB,MAAM,eACD,MAAM,0DAEqC,WAAW,mIAOtE;AAGD,wBAAgB,UAAU,mDAEd,MAAM,eACD,MAAM,0DAEqC,WAAW,mIAOtE"}